Class ReferenceSuperimposer
java.lang.Object
org.biojava.nbio.structure.align.multiple.util.ReferenceSuperimposer
- All Implemented Interfaces:
MultipleSuperimposer
Superimposes each structure in a
MultipleAlignment
onto a reference
structure.
Performs a global superposition of the MultipleAlignment in case
there is only one BlockSet
, and a superposition for every BlockSet
in case there is more than one (flexible alignment).
This class uses the SVDSuperimposer
algorithm.
- Since:
- 4.1.0
- Author:
- Spencer Bliven, Aleix Lafita
-
Constructor Summary
ConstructorDescriptionDefault Constructor.ReferenceSuperimposer
(int reference) Constructor using a specified structure as reference. -
Method Summary
Modifier and TypeMethodDescriptionvoid
superimpose
(MultipleAlignment alignment) Superimpose all structures from aMultipleAlignment
.
-
Constructor Details
-
ReferenceSuperimposer
public ReferenceSuperimposer()Default Constructor. Uses the first structure as the reference. -
ReferenceSuperimposer
public ReferenceSuperimposer(int reference) Constructor using a specified structure as reference.- Parameters:
reference
- Index of the structure to use as a reference (it has to be > 0)
-
-
Method Details
-
superimpose
Description copied from interface:MultipleSuperimposer
Superimpose all structures from aMultipleAlignment
. The superposition is done for all individual BlockSets. If there is only one BlockSet.At a minimum, this should set the transformation matrices for the individual
BlockSet
s.This method only calculates and sets the transformation 4D Matrices. If any score is needed it should be calculated and set separately afterwards with
MultipleAlignmentScorer
.- Specified by:
superimpose
in interfaceMultipleSuperimposer
- Parameters:
alignment
- MultipleAlignment specifying the aligned residues (via theblocksets
) and the atoms to align (via theensemble
).- Throws:
StructureException
-