Skip to content

Commit 25bb572

Browse files
authored
Expand docs on Transformation (#81)
This clarifies the direction of the created mapping, and that certain forms require external packages.
1 parent 00d19d1 commit 25bb572

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

src/spatial.jl

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ export
2525
showcontactmap
2626

2727
"""
28-
Transformation(el1, el2, residue_selectors...)
2928
Transformation(coords1, coords2)
29+
Transformation(el1, el2, residue_selectors...)
3030
Transformation(trans1, trans2, rot)
3131
32-
A 3D transformation to map one set of coordinates onto another, found using the
33-
Kabsch algorithm.
32+
A 3D rigid transformation approximately mapping `coords1` to `coords2`, found
33+
using the Kabsch algorithm.
3434
3535
When called with structural elements, carries out a pairwise alignment and
3636
superimposes on atoms from aligned residues.
@@ -47,6 +47,9 @@ The returned `Transformation` object consists of the mean coordinates of the
4747
first set, the mean coordinates of the second set, the rotation to map the
4848
first centred set onto the second centred set, and the indices of the aligned
4949
residues in the first and second elements if relevant.
50+
51+
!!! note
52+
`Transformation(el1, el2, residue_selectors...)` requires that BioAlignments.jl be imported.
5053
"""
5154
struct Transformation
5255
trans1::Vector{Float64}

0 commit comments

Comments
 (0)