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
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final double
protected static final double
protected static final double
protected static final String
protected static final double
protected double
protected double
protected double
protected int
protected int
protected double
protected double
protected double
protected double
protected CeParameters.ScoringStrategy
protected double
protected boolean
protected int
protected SubstitutionMatrix<AminoAcidCompound>
protected int
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionthe Max gap size parameter G .int
Get 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 AFPsdouble
Should 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 atboolean
void
reset()
Set the parameters to the default.void
setDistanceIncrement
(Double distanceIncrement) void
setGapExtension
(Double gapExtension) void
setGapOpen
(Double gapOpen) void
setMaxGapSize
(Integer maxGapSize) Set the Max gap size parameter.void
setMaxNrIterationsForOptimization
(int maxNrIterationsForOptimization) Set the maximum nr of times the (slow) optimiziation of alignment should iterate.void
setMaxOptRMSD
(Double param) set the maximum RMSD cutoff to be applied during alignment optimization.void
setORmsdThr
(Double oRmsdThr) Set the Original RMSD threshold from which the alignment optimization is startedvoid
setRmsdThr
(Double rmsdThr) void
setRmsdThrJoin
(Double rmsdThrJoin) void
setScoringStrategy
(CeParameters.ScoringStrategy scoringStrategy) Set the scoring strategy to use.void
setSeqWeight
(double seqWeight) Should sequence conservation be considered as part of the alignment? If yes, this weight factor allows to determine how much.void
setShowAFPRanges
(boolean showAFPRanges) void
setSubstitutionMatrix
(SubstitutionMatrix<AminoAcidCompound> substitutionMatrix) Sets the substitution matrix to be used for influencing the alignment with sequence conservation information.void
setWinSize
(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:ConfigStrucAligParams
Set the parameters to the default.- Specified by:
reset
in 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:ConfigStrucAligParams
The help text for each of these parameters.- Specified by:
getUserConfigHelp
in interfaceConfigStrucAligParams
- Returns:
- help strings
-
getUserConfigParameters
Description copied from interface:ConfigStrucAligParams
get 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:
getUserConfigParameters
in interfaceConfigStrucAligParams
- Returns:
- list of parameters
-
getUserConfigParameterNames
Description copied from interface:ConfigStrucAligParams
The labels to be displayed to the user for each parameter- Specified by:
getUserConfigParameterNames
in interfaceConfigStrucAligParams
- Returns:
- list of parameter names
-
getUserConfigTypes
Description copied from interface:ConfigStrucAligParams
Get the data types of the parameters- Specified by:
getUserConfigTypes
in 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
-
-