Package ffx.potential.bonded
Class Rotamer
java.lang.Object
ffx.potential.bonded.Rotamer
The Rotamer Class usually represents one immutable amino acid Rotamer.
It is additionally being extended to represent one nucleic acid Rotamer.
- Since:
- 1.0
- Author:
- Ava M. Lynn, Jacob M. Litman
-
Field Summary
Modifier and TypeFieldDescriptionThe A.A. name of this residue (or null for a N.A.).final double[]
An array of chi angles for this rotamer.final double
Torsions chi 1-4 are used for amino acids and nucleic acids.final double
final double
final double
final double
Torsions chi 5-7 are only currently used for nucleic acids.boolean
Flag to indicate the rotamer was initialized from a Residue state.boolean
If this flag is set, application of a rotamer requires updating force field parameters.final int
Number of chi/sigma values.The N.A. name of this residue (or null for a A.A.).Residue state used to initialize the rotamer.final double[]
An array of sigmas for each chi angle. -
Constructor Summary
ConstructorDescriptionRotamer
(double... values) Constructor for unknown residue types.Rotamer
(AminoAcidUtils.AminoAcid3 aminoAcid3, double... values) Constructor for Rotamer.Rotamer
(AminoAcidUtils.AminoAcid3 aminoAcid3, int rotIndex, double... values) Constructor for Rotamer.Rotamer
(AminoAcidUtils.AminoAcid3 aminoAcid3, ResidueState residueState, double... values) Constructor for Rotamer.Rotamer
(AminoAcidUtils.AminoAcid3 aminoAcid3, ResidueState residueState, TitrationUtils titrationUtils, double... values) Constructor for Rotamer.Rotamer
(AminoAcidUtils.AminoAcid3 aminoAcid3, TitrationUtils titrationUtils, double... values) Constructor for Rotamer.Rotamer
(AminoAcidUtils.AminoAcid3 aminoAcid3, TitrationUtils titrationUtils, int rotIndex, double... values) Rotamer
(NucleicAcidUtils.NucleicAcid3 nucleicAcid3, double... values) Constructor for Rotamer.Rotamer
(NucleicAcidUtils.NucleicAcid3 nucleicAcid3, ResidueState residueState, double... values) Constructor for Rotamer.Rotamer
(NucleicAcidUtils.NucleicAcid3 nucleicAcid3, ResidueState residueState, TitrationUtils titrationUtils, double... values) Constructor for Rotamer.Rotamer
(ResidueState residueState, double... values) Constructor for unknown residue types.Rotamer
(ResidueState residueState, TitrationUtils titrationUtils, double... values) Constructor for unknown residue types. -
Method Summary
Modifier and TypeMethodDescriptionstatic Rotamer[]
defaultRotamerFactory
(Residue residue) Factory method to construct an original-coordinates Rotamer from a residue.static Rotamer[]
defaultRotamerFactory
(Residue residue, TitrationUtils titrationUtils) Factory method to construct an original-coordinates Rotamer from a residue.double[]
getName()
double
int
toAngleString.toString()
void
updateParameters
(Residue residue) Update force field parameters for force field dependent rotamers.
-
Field Details
-
chi1
public final double chi1Torsions chi 1-4 are used for amino acids and nucleic acids. -
chi2
public final double chi2 -
chi3
public final double chi3 -
chi4
public final double chi4 -
chi5
public final double chi5Torsions chi 5-7 are only currently used for nucleic acids. -
angles
public final double[] anglesAn array of chi angles for this rotamer. -
sigmas
public final double[] sigmasAn array of sigmas for each chi angle. -
length
public final int lengthNumber of chi/sigma values. -
originalState
Residue state used to initialize the rotamer. -
isState
public boolean isStateFlag to indicate the rotamer was initialized from a Residue state. -
aminoAcid3
The A.A. name of this residue (or null for a N.A.). -
nucleicAcid3
The N.A. name of this residue (or null for a A.A.). -
isTitrating
public boolean isTitratingIf this flag is set, application of a rotamer requires updating force field parameters.
-
-
Constructor Details
-
Rotamer
public Rotamer(double... values) Constructor for unknown residue types.- Parameters:
values
- a double.
-
Rotamer
Constructor for Rotamer.- Parameters:
aminoAcid3
- aAminoAcidUtils.AminoAcid3
object.values
- a double.
-
Rotamer
Constructor for Rotamer.- Parameters:
aminoAcid3
- aAminoAcidUtils.AminoAcid3
object.values
- a double.
-
Rotamer
Constructor for Rotamer.- Parameters:
nucleicAcid3
- aNucleicAcidUtils.NucleicAcid3
object.values
- a double.
-
Rotamer
public Rotamer(AminoAcidUtils.AminoAcid3 aminoAcid3, TitrationUtils titrationUtils, double... values) Constructor for Rotamer.- Parameters:
aminoAcid3
- aAminoAcidUtils.AminoAcid3
object.titrationUtils
- Use to apply rotamer specific force field parameters.values
- a double.
-
Rotamer
public Rotamer(AminoAcidUtils.AminoAcid3 aminoAcid3, TitrationUtils titrationUtils, int rotIndex, double... values) -
Rotamer
Constructor for unknown residue types.- Parameters:
residueState
- aResidueState
object.values
- a double.
-
Rotamer
Constructor for unknown residue types.- Parameters:
residueState
- aResidueState
object.values
- a double.
-
Rotamer
Constructor for Rotamer.- Parameters:
aminoAcid3
- aAminoAcidUtils.AminoAcid3
object.residueState
- aResidueState
object.values
- a double.
-
Rotamer
public Rotamer(AminoAcidUtils.AminoAcid3 aminoAcid3, ResidueState residueState, TitrationUtils titrationUtils, double... values) Constructor for Rotamer.- Parameters:
aminoAcid3
- aAminoAcidUtils.AminoAcid3
object.residueState
- aResidueState
object.values
- a double.
-
Rotamer
public Rotamer(NucleicAcidUtils.NucleicAcid3 nucleicAcid3, ResidueState residueState, double... values) Constructor for Rotamer.- Parameters:
nucleicAcid3
- aNucleicAcidUtils.NucleicAcid3
object.residueState
- aResidueState
object.values
- a double.
-
Rotamer
public Rotamer(NucleicAcidUtils.NucleicAcid3 nucleicAcid3, ResidueState residueState, TitrationUtils titrationUtils, double... values) Constructor for Rotamer.- Parameters:
nucleicAcid3
- aNucleicAcidUtils.NucleicAcid3
object.residueState
- aResidueState
object.values
- a double.
-
-
Method Details
-
updateParameters
Update force field parameters for force field dependent rotamers.- Parameters:
residue
- Residue to update.
-
defaultRotamerFactory
Factory method to construct an original-coordinates Rotamer from a residue.- Parameters:
residue
- Residue to construct a default rotamer for.- Returns:
- Rotamer based on the coordinates of the residue.
-
defaultRotamerFactory
Factory method to construct an original-coordinates Rotamer from a residue.- Parameters:
residue
- Residue to construct a default rotamer for.- Returns:
- Rotamer based on the coordinates of the residue.
-
toAngleString
toAngleString.- Returns:
- a
String
object.
-
toString
-
getName
-
getRotIndex
public int getRotIndex() -
getRotamerPhBias
public double getRotamerPhBias() -
getAngles
public double[] getAngles()
-