Class CeParameters
java.lang.Object
org.biojava.nbio.structure.align.ce.CeParameters
- All Implemented Interfaces:
 ConfigStrucAligParams
- Direct Known Subclasses:
 CECPParameters,CESymmParameters,OptimalCECPParameters
Contains the parameters that can be sent to CE
- Author:
 - Andreas Prlic
 
- 
Nested Class Summary
Nested Classes - 
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final doubleprotected static final doubleprotected static final doubleprotected static final Stringprotected static final doubleprotected doubleprotected doubleprotected doubleprotected intprotected intprotected doubleprotected doubleprotected doubleprotected doubleprotected CeParameters.ScoringStrategyprotected doubleprotected booleanprotected intprotected SubstitutionMatrix<AminoAcidCompound>protected int - 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptionthe Max gap size parameter G .intGet the maximum nr of times the (slow) optimiziation of alignment should iterate.Returns the maximum RMSD cutoff to be applied during alignment optimization (default: 99 = unlimited)Get the Original RMSD threshold from which the alignment optimization is startedRMSD ThresholdRMSD threshold for joining of AFPsdoubleShould sequence conservation be considered as part of the alignment? If yes, this weight factor allows to determine how much.Sets the substitution matrix to be used for influencing the alignment with sequence conservation information.The help text for each of these parameters.The labels to be displayed to the user for each parameterget the list of parameters that the user can change through the user interface.Get the data types of the parametersThe window size to look atbooleanvoidreset()Set the parameters to the default.voidsetDistanceIncrement(Double distanceIncrement) voidsetGapExtension(Double gapExtension) voidsetGapOpen(Double gapOpen) voidsetMaxGapSize(Integer maxGapSize) Set the Max gap size parameter.voidsetMaxNrIterationsForOptimization(int maxNrIterationsForOptimization) Set the maximum nr of times the (slow) optimiziation of alignment should iterate.voidsetMaxOptRMSD(Double param) set the maximum RMSD cutoff to be applied during alignment optimization.voidsetORmsdThr(Double oRmsdThr) Set the Original RMSD threshold from which the alignment optimization is startedvoidsetRmsdThr(Double rmsdThr) voidsetRmsdThrJoin(Double rmsdThrJoin) voidsetScoringStrategy(CeParameters.ScoringStrategy scoringStrategy) Set the scoring strategy to use.voidsetSeqWeight(double seqWeight) Should sequence conservation be considered as part of the alignment? If yes, this weight factor allows to determine how much.voidsetShowAFPRanges(boolean showAFPRanges) voidsetSubstitutionMatrix(SubstitutionMatrix<AminoAcidCompound> substitutionMatrix) Sets the substitution matrix to be used for influencing the alignment with sequence conservation information.voidsetWinSize(Integer winSize) toString() 
- 
Field Details
- 
winSize
protected int winSize - 
rmsdThr
protected double rmsdThr - 
rmsdThrJoin
protected double rmsdThrJoin - 
maxOptRMSD
protected double maxOptRMSD - 
scoringStrategy
 - 
maxGapSize
protected int maxGapSize - 
showAFPRanges
protected boolean showAFPRanges - 
sideChainScoringType
protected int sideChainScoringType - 
DEFAULT_GAP_OPEN
protected static final double DEFAULT_GAP_OPEN- See Also:
 
 - 
DEFAULT_GAP_EXTENSION
protected static final double DEFAULT_GAP_EXTENSION- See Also:
 
 - 
DISTANCE_INCREMENT
protected static final double DISTANCE_INCREMENT- See Also:
 
 - 
DEFAULT_oRmsdThr
protected static final double DEFAULT_oRmsdThr- See Also:
 
 - 
DEFAULT_SUBSTITUTION_MATRIX
- See Also:
 
 - 
gapOpen
protected double gapOpen - 
gapExtension
protected double gapExtension - 
distanceIncrement
protected double distanceIncrement - 
oRmsdThr
protected double oRmsdThr - 
maxNrIterationsForOptimization
protected int maxNrIterationsForOptimization - 
substitutionMatrix
 - 
seqWeight
protected double seqWeight 
 - 
 - 
Constructor Details
- 
CeParameters
public CeParameters() 
 - 
 - 
Method Details
- 
toString
 - 
reset
public void reset()Description copied from interface:ConfigStrucAligParamsSet the parameters to the default.- Specified by:
 resetin interfaceConfigStrucAligParams
 - 
getWinSize
The window size to look at- Returns:
 - window size
 
 - 
setWinSize
 - 
getRmsdThr
RMSD Threshold- Returns:
 - RMSD threshold
 
 - 
setRmsdThr
 - 
getRmsdThrJoin
RMSD threshold for joining of AFPs- Returns:
 - rmsd threshold
 
 - 
setRmsdThrJoin
 - 
getScoringStrategy
 - 
setScoringStrategy
Set the scoring strategy to use. 0 is default CE scoring scheme. 1 uses Side chain orientation.- Parameters:
 scoringStrategy-
 - 
setMaxGapSize
Set the Max gap size parameter. Default 30. For unlimited gaps set to -1- Parameters:
 maxGapSize-
 - 
getMaxGapSize
the Max gap size parameter G . default is 30, which was described to obtained empirically in the CE paper. the larger the max gap size, the longer the compute time, but in same cases drastically improved results. Set to -1 for unlimited gap size.- Returns:
 - max gap size parameter
 
 - 
getUserConfigHelp
Description copied from interface:ConfigStrucAligParamsThe help text for each of these parameters.- Specified by:
 getUserConfigHelpin interfaceConfigStrucAligParams- Returns:
 - help strings
 
 - 
getUserConfigParameters
Description copied from interface:ConfigStrucAligParamsget the list of parameters that the user can change through the user interface. Parameter names are the same names as the corresponding Get/Set methods.- Specified by:
 getUserConfigParametersin interfaceConfigStrucAligParams- Returns:
 - list of parameters
 
 - 
getUserConfigParameterNames
Description copied from interface:ConfigStrucAligParamsThe labels to be displayed to the user for each parameter- Specified by:
 getUserConfigParameterNamesin interfaceConfigStrucAligParams- Returns:
 - list of parameter names
 
 - 
getUserConfigTypes
Description copied from interface:ConfigStrucAligParamsGet the data types of the parameters- Specified by:
 getUserConfigTypesin interfaceConfigStrucAligParams- Returns:
 - list of parameter classes
 
 - 
isShowAFPRanges
public boolean isShowAFPRanges()- Returns:
 - whether information about AFPs should be printed
 
 - 
setShowAFPRanges
public void setShowAFPRanges(boolean showAFPRanges)  - 
setMaxOptRMSD
set the maximum RMSD cutoff to be applied during alignment optimization. (default: 99 = unlimited)- Parameters:
 param- maxOptRMSD
 - 
getMaxOptRMSD
Returns the maximum RMSD cutoff to be applied during alignment optimization (default: 99 = unlimited)- Returns:
 - maxOptRMSD
 
 - 
getGapOpen
 - 
setGapOpen
 - 
getGapExtension
 - 
setGapExtension
 - 
getDistanceIncrement
 - 
setDistanceIncrement
 - 
getORmsdThr
Get the Original RMSD threshold from which the alignment optimization is started- Returns:
 - oRMSDThreshold
 
 - 
setORmsdThr
Set the Original RMSD threshold from which the alignment optimization is started- Parameters:
 oRmsdThr- the threshold
 - 
getMaxNrIterationsForOptimization
public int getMaxNrIterationsForOptimization()Get the maximum nr of times the (slow) optimiziation of alignment should iterate. Default: unlimited- Parameters:
 maxNrIterationsForOptimization-
 - 
setMaxNrIterationsForOptimization
public void setMaxNrIterationsForOptimization(int maxNrIterationsForOptimization) Set the maximum nr of times the (slow) optimiziation of alignment should iterate. Default: unlimited- Parameters:
 maxNrIterationsForOptimization-
 - 
getSeqWeight
public double getSeqWeight()Should sequence conservation be considered as part of the alignment? If yes, this weight factor allows to determine how much. By default this is set to 0, meaning no contribution of the sequence alignment score.- Returns:
 - seqWeight the weight factor (default 0)
 
 - 
setSeqWeight
public void setSeqWeight(double seqWeight) Should sequence conservation be considered as part of the alignment? If yes, this weight factor allows to determine how much. By default this is set to 0, meaning no contribution of the sequence alignment score.- Parameters:
 seqWeight- the weight factor (default 0)
 - 
getSubstitutionMatrix
Sets the substitution matrix to be used for influencing the alignment with sequence conservation information. Default: SDM matrix (Prlic et al 2000)- Returns:
 - substitutionMatrix
 
 - 
setSubstitutionMatrix
Sets the substitution matrix to be used for influencing the alignment with sequence conservation information. Default: SDM matrix (Prlic et al 2000)- Parameters:
 substitutionMatrix-
 
 -