Class SymmetryAxes.Axis
java.lang.Object
org.biojava.nbio.structure.symmetry.internal.SymmetryAxes.Axis
- Enclosing class:
 - SymmetryAxes
 
Represents an axis of symmetry
- Author:
 - Spencer Bliven
 
- 
Constructor Summary
ConstructorsConstructorDescriptionAxis(javax.vecmath.Matrix4d operator, int order, CESymmParameters.SymmetryType type, int level, int firstRepeat)  - 
Method Summary
Modifier and TypeMethodDescriptionintGet the index of the first repeat used by this axisintgetLevel()javax.vecmath.Matrix4dGet the transformation operator for this axis as an homogeneous matrixintgetOrder()Get the order of this axis (closed symm) or the number of repeats (open symm)Get the transformation operator as a rotation axis.voidsetFirstRepeat(int firstRepeat) voidsetLevel(int level) voidsetOperator(javax.vecmath.Matrix4d op)  
- 
Constructor Details
- 
Axis
public Axis(javax.vecmath.Matrix4d operator, int order, CESymmParameters.SymmetryType type, int level, int firstRepeat)  
 - 
 - 
Method Details
- 
getOperator
public javax.vecmath.Matrix4d getOperator()Get the transformation operator for this axis as an homogeneous matrix- Returns:
 - the transformation operator
 
 - 
setOperator
public void setOperator(javax.vecmath.Matrix4d op)  - 
getOrder
public int getOrder()Get the order of this axis (closed symm) or the number of repeats (open symm)- Returns:
 - the order
 
 - 
getSymmType
- Returns:
 - the symmType (OPEN or CLOSED only)
 
 - 
getRotationAxis
Get the transformation operator as a rotation axis. For open symmetry this will have a non-zero screw component.- Returns:
 - a RotationAxis for this Axis
 
 - 
getLevel
public int getLevel()- Returns:
 - The level of this axis within it's parent hierarchy, or -1 if unset
 
 - 
setLevel
public void setLevel(int level) - Parameters:
 level- The level of this axis within it's parent hierarchy. Must be positive
 - 
getFirstRepeat
public int getFirstRepeat()Get the index of the first repeat used by this axis- Returns:
 - the firstRepeat
 
 - 
setFirstRepeat
public void setFirstRepeat(int firstRepeat) - Parameters:
 firstRepeat- the index of the first repeat used by this axis
 
 -