Skip to content

Commit b1b8204

Browse files
committed
Explain utility methods for MSTA manipulation
1 parent bed1234 commit b1b8204

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

structure/alignment-data-model.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Some of the important stored variables are:
1515
* BlockRotationMatrix: rotation component of the superposition transformation.
1616
* BlockShiftVector: translation component of the superposition transformation.
1717

18+
BioJava class: [org.biojava.bio.structure.align.model.AFPChain](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/model/AFPChain.html)
19+
1820
### The Optimal Alignment
1921

2022
The residue equivalencies of the alignment (EQRs) are described in the optimal
@@ -80,6 +82,8 @@ In addtition, the data structure is not limited in the number and types of score
8082
it can store, because the scores are stored in a key:value fashion, as it will be
8183
described later.
8284

85+
BioJava class: [org.biojava.bio.structure.align.multiple.MultipleAlignment](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/multiple/MultipleAlignment.html)
86+
8387
### Object Hierarchy
8488

8589
The biggest difference with `AFPChain` is that the `MultipleAlignment` data
@@ -167,8 +171,20 @@ on a `MultipleAlignment`:
167171
double bsRMSD = alignment.getScore('bsRMSD');
168172
```
169173

170-
Methods and names for some frequent scores are located in a util class called
171-
`MultipleAlignmentScorer`.
174+
### Manipulating Multiple Alignments
175+
176+
Some classes are designed to contain utility methods for manipulating a `MultipleAlignment` object.
177+
The most important ones are ennumerated and briefly described below:
178+
179+
* [MultipleAlignmentScorer](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/multiple/util/MultipleAlignmentScorer.html): contains frequent names for scores and methods to calculate them.
180+
181+
* [MultipleAlignmentTools](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/multiple/util/MultipleAlignmentTools.html): contains helper methods, such as sequence alignment calculation, transform atom arrays of the structures or calculate aligned residue distances between all structures.
182+
183+
* [MultipleAlignmentWriter](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/multiple/util/MultipleAlignmentWriter.html): contains methods to generate different types of String outputs of the alignment, e.g. FASTA, XML, FatCat.
184+
185+
* [MultipleSuperimposer](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/multiple/util/MultipleSuperimposer.html): interface for implementations that calculate the structure superpositions of the alignment. Some examples of implementations are the ReferenceSuperimposer (superimposes all the structures to a reference) and the CoreSuperimposer (only uses EQRs present in all structures, without gaps, to superimpose them).
186+
187+
* [MultipleAlignmentXMLParser](http://www.biojava.org/docs/api/org/biojava/nbio/structure/align/xml/MultipleAlignmentXMLParser.html): contains a method to create a `MultipleAlignment` object from an XML file representation.
172188

173189
### Overview
174190

@@ -207,3 +223,7 @@ the first representation supports any number of structures, while the second is
207223
only supporting pairwise alignments. However, the conversion can be done with some
208224
lines of code if needed (instantiate a new `AFPChain` and copy one by one the
209225
properties that can be represented from the `MultipleAlignment`.
226+
227+
===
228+
229+
Go back to [Chapter 8 : Structure Alignments](alignment.md).

0 commit comments

Comments
 (0)