public class SearchParameters
extends java.lang.Object
implements java.io.Serializable
| Modifier and Type | Class and Description |
|---|---|
static class |
SearchParameters.MassAccuracyType
Possible mass accuracy types.
|
static class |
SearchParameters.PrecursorAccuracyType
Deprecated.
use MassAccuracyType
|
| Constructor and Description |
|---|
SearchParameters()
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
correctPrecursorMass(java.lang.Boolean correctPrecursorMass)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
boolean |
equals(SearchParameters otherSearchParameters)
Returns true of the search parameter objects have identical settings.
|
java.lang.Boolean |
generateQuery()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.util.Set<java.lang.Integer> |
getAlgorithms()
Returns the algorithms for which specific parameters are stored.
|
java.util.HashMap<java.lang.Integer,IdentificationAlgorithmParameter> |
getAlgorithmSpecificParameters()
Returns the algorithm specific parameters in a map: algorithm as indexed
in the Advocate class -> parameters.
|
java.lang.Boolean |
getDiscardLowQualitySpectra()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
Enzyme |
getEnzyme()
Returns the enzyme used for digestion.
|
java.io.File |
getFastaFile()
Returns the sequence database file used for identification.
|
static java.lang.String[] |
getForwardIons()
Returns the list of forward ions.
|
java.util.HashMap<java.lang.String,no.uib.jsparklines.data.XYDataPoint> |
getFractionMolecularWeightRanges()
Returns the user provided molecular weight ranges for the fractions.
|
java.util.HashMap<java.lang.String,java.lang.Double> |
getFractionMolecularWeights()
Deprecated.
use getFractionMolecularWeightRanges instead
|
SearchParameters.MassAccuracyType |
getFragmentAccuracyType()
Returns the fragment accuracy type.
|
java.lang.String |
getFragmentationModel()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Double |
getFragmentIonAccuracy()
Returns the MS2 ion m/z tolerance.
|
java.lang.Integer |
getHitListLength()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Integer |
getHitListLengthDeNovo()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
IdentificationAlgorithmParameter |
getIdentificationAlgorithmParameter(int algorithmID)
Returns the algorithm specific parameters, null if not found.
|
static SearchParameters |
getIdentificationParameters(java.io.File file)
Loads the identification parameters from a serialized file.
|
static java.lang.String[] |
getIons()
Getter for the list of ion symbols used.
|
java.lang.Integer |
getIonSearched1()
Getter for the first kind of ion searched.
|
java.lang.Integer |
getIonSearched2()
Getter for the second kind of ion searched.
|
Charge |
getMaxChargeSearched()
Returns the maximal charge searched.
|
java.lang.Double |
getMaxEValue()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Integer |
getMaxPeptideLength()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
Charge |
getMinChargeSearched()
Returns the minimal charge searched.
|
Charge |
getMinimalChargeForMultipleChargedFragments()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Integer |
getMinPeptideLength()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
ModificationProfile |
getModificationProfile()
Returns the modification profile of the project.
|
java.lang.Integer |
getnMissedCleavages()
Returns the allowed number of missed cleavages.
|
java.io.File |
getParametersFile()
Returns the parameters file loaded.
|
java.util.Map<java.lang.String,java.lang.String> |
getPepNovoPtmMap()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Double |
getPrecursorAccuracy()
Returns the precursor tolerance.
|
java.lang.Double |
getPrecursorAccuracyDalton()
Returns the precursor tolerance in Dalton (for de novo searches).
|
SearchParameters.MassAccuracyType |
getPrecursorAccuracyType()
Returns the precursor accuracy type.
|
static java.lang.String[] |
getRewindIons()
Returns the list of rewind ions.
|
java.lang.Boolean |
isCorrectPrecursorMass()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Boolean |
isEstimateCharge()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Boolean |
isPrecursorAccuracyTypePpm()
Returns true if the current precursor accuracy type is ppm.
|
java.lang.Boolean |
isRemovePrecursor()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.Boolean |
isScalePrecursor()
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
static void |
saveIdentificationParameters(SearchParameters identificationParameters,
java.io.File file)
Saves the identification parameters to a serialized file.
|
void |
saveIdentificationParametersAsTextFile(java.io.File file)
Saves the identification parameters as a human readable text file.
|
void |
setDiscardLowQualitySpectra(java.lang.Boolean discardLowQualitySpectra)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setEnzyme(Enzyme enzyme)
Sets the enzyme used for digestion.
|
void |
setEstimateCharge(java.lang.Boolean estimateCharge)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setFastaFile(java.io.File fastaFile)
Sets the sequence database file used for identification.
|
void |
setFractionMolecularWeightRanges(java.util.HashMap<java.lang.String,no.uib.jsparklines.data.XYDataPoint> fractionMolecularWeightRanges)
Set the user provided molecular weight ranges for the fractions.
|
void |
setFractionMolecularWeights(java.util.HashMap<java.lang.String,java.lang.Double> fractionMolecularWeights)
Deprecated.
use setFractionMolecularWeightRanges instead
|
void |
setFragmentAccuracyType(SearchParameters.MassAccuracyType fragmentAccuracyType)
Sets the fragment accuracy type.
|
void |
setFragmentationModel(java.lang.String fragmentationModel)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setFragmentIonAccuracy(java.lang.Double fragmentIonMZTolerance)
Sets the fragment ion m/z tolerance.
|
void |
setGenerateQuery(java.lang.Boolean generateQuery)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setHitListLength(java.lang.Integer hitListLength)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setHitListLengthDeNovo(java.lang.Integer hitListLengthDeNovo)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setIdentificationAlgorithmParameter(int algorithmID,
IdentificationAlgorithmParameter identificationAlgorithmParameter)
Adds identification algorithm specific paramters
|
void |
setIonSearched1(java.lang.String ionSearched1)
Setter for the first kind of ion searched, indexed by its single letter
code, for example "a".
|
void |
setIonSearched2(java.lang.String ionSearched2)
Setter for the second kind of ion searched, indexed by its single letter
code, for example "a".
|
void |
setMaxChargeSearched(Charge maxChargeSearched)
Sets the maximal charge searched.
|
void |
setMaxEValue(java.lang.Double maxEValue)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setMaxPeptideLength(java.lang.Integer maxPeptideLength)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setMinChargeSearched(Charge minChargeSearched)
Sets the minimal charge searched.
|
void |
setMinimalChargeForMultipleChargedFragments(Charge minimalChargeForMultipleChargedFragments)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setMinPeptideLength(java.lang.Integer minPeptideLength)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setModificationProfile(ModificationProfile modificationProfile)
Sets the modification profile of the project.
|
void |
setnMissedCleavages(java.lang.Integer nMissedCleavages)
Sets the allowed number of missed cleavages.
|
void |
setParametersFile(java.io.File parametersFile)
Sets the parameter file loaded.
|
void |
setPepNovoPtmMap(java.util.Map<java.lang.String,java.lang.String> pepNovoPtmMap)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setPrecursorAccuracy(java.lang.Double precursorTolerance)
Sets the precursor tolerance.
|
void |
setPrecursorAccuracyDalton(java.lang.Double precursorToleranceDalton)
Sets the precursor tolerance in Dalton (for de novo searches).
|
void |
setPrecursorAccuracyType(SearchParameters.MassAccuracyType precursorAccuracyType)
Sets the precursor accuracy type.
|
void |
setRemovePrecursor(java.lang.Boolean removePrecursor)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
void |
setScalePrecursor(java.lang.Boolean scalePrecursor)
Deprecated.
use the appropriated IdentificationAlgorithmParameters
instead
|
java.lang.String |
toString() |
java.lang.String |
toString(boolean html)
Returns the search parameters as a string.
|
public ModificationProfile getModificationProfile()
public void setModificationProfile(ModificationProfile modificationProfile)
modificationProfile - The modification profilepublic java.lang.Double getFragmentIonAccuracy()
public void setFragmentIonAccuracy(java.lang.Double fragmentIonMZTolerance)
fragmentIonMZTolerance - public Enzyme getEnzyme()
public void setEnzyme(Enzyme enzyme)
enzyme - the enzyme used for digestionpublic java.io.File getParametersFile()
public void setParametersFile(java.io.File parametersFile)
parametersFile - the parameter file loadedpublic java.io.File getFastaFile()
public void setFastaFile(java.io.File fastaFile)
fastaFile - the sequence database file used for identificationpublic java.lang.Integer getnMissedCleavages()
public void setnMissedCleavages(java.lang.Integer nMissedCleavages)
nMissedCleavages - the allowed number of missed cleavagespublic java.lang.Integer getIonSearched1()
public void setIonSearched1(java.lang.String ionSearched1)
ionSearched1 - the first kind of ion searchedpublic java.lang.Integer getIonSearched2()
public void setIonSearched2(java.lang.String ionSearched2)
ionSearched2 - the second kind of ion searchedpublic static java.lang.String[] getIons()
public static java.lang.String[] getForwardIons()
public static java.lang.String[] getRewindIons()
public java.lang.Double getPrecursorAccuracy()
public void setPrecursorAccuracy(java.lang.Double precursorTolerance)
precursorTolerance - the precursor tolerancepublic java.lang.Double getPrecursorAccuracyDalton()
public void setPrecursorAccuracyDalton(java.lang.Double precursorToleranceDalton)
precursorToleranceDalton - the precursor tolerancepublic SearchParameters.MassAccuracyType getPrecursorAccuracyType()
public void setPrecursorAccuracyType(SearchParameters.MassAccuracyType precursorAccuracyType)
precursorAccuracyType - the precursor accuracy typepublic SearchParameters.MassAccuracyType getFragmentAccuracyType()
public void setFragmentAccuracyType(SearchParameters.MassAccuracyType fragmentAccuracyType)
fragmentAccuracyType - the fragment accuracy typepublic java.lang.Boolean isPrecursorAccuracyTypePpm()
public java.util.HashMap<java.lang.String,java.lang.Double> getFractionMolecularWeights()
public void setFractionMolecularWeights(java.util.HashMap<java.lang.String,java.lang.Double> fractionMolecularWeights)
fractionMolecularWeights - the fractionMolecularWeights to setpublic java.util.HashMap<java.lang.String,no.uib.jsparklines.data.XYDataPoint> getFractionMolecularWeightRanges()
public void setFractionMolecularWeightRanges(java.util.HashMap<java.lang.String,no.uib.jsparklines.data.XYDataPoint> fractionMolecularWeightRanges)
fractionMolecularWeightRanges - the fractionMolecularWeightRanges to
setpublic Charge getMaxChargeSearched()
public void setMaxChargeSearched(Charge maxChargeSearched)
maxChargeSearched - the maximal charge searchedpublic Charge getMinChargeSearched()
public void setMinChargeSearched(Charge minChargeSearched)
minChargeSearched - the minimal charge searchedpublic java.lang.Double getMaxEValue()
public void setMaxEValue(java.lang.Double maxEValue)
maxEValue - the maximal e-value searched forpublic java.lang.Integer getHitListLength()
public void setHitListLength(java.lang.Integer hitListLength)
hitListLength - the length of the hit list for OMSSApublic java.lang.Integer getHitListLengthDeNovo()
public void setHitListLengthDeNovo(java.lang.Integer hitListLengthDeNovo)
hitListLengthDeNovo - the length of the hit list for PepNovopublic Charge getMinimalChargeForMultipleChargedFragments()
public void setMinimalChargeForMultipleChargedFragments(Charge minimalChargeForMultipleChargedFragments)
minimalChargeForMultipleChargedFragments - the minimal precursor
charge to account for multiply charged fragments in OMSSApublic java.lang.Integer getMaxPeptideLength()
public void setMaxPeptideLength(java.lang.Integer maxPeptideLength)
maxPeptideLength - the maximal peptide length allowedpublic java.lang.Integer getMinPeptideLength()
public void setMinPeptideLength(java.lang.Integer minPeptideLength)
minPeptideLength - the minimal peptide length allowedpublic java.lang.Boolean isEstimateCharge()
public void setEstimateCharge(java.lang.Boolean estimateCharge)
estimateCharge - a boolean indicating whether the precursor charge
shall be estimated for OMSSApublic java.lang.Boolean isRemovePrecursor()
public void setRemovePrecursor(java.lang.Boolean removePrecursor)
removePrecursor - a boolean indicating whether the precursor shall
be removed for OMSSApublic java.lang.Boolean isScalePrecursor()
public void setScalePrecursor(java.lang.Boolean scalePrecursor)
scalePrecursor - a boolean indicating whether the precursor shall be
scaled for OMSSApublic java.util.HashMap<java.lang.Integer,IdentificationAlgorithmParameter> getAlgorithmSpecificParameters()
public IdentificationAlgorithmParameter getIdentificationAlgorithmParameter(int algorithmID)
algorithmID - the index of the search engine as indexed in the
Advocate classpublic void setIdentificationAlgorithmParameter(int algorithmID,
IdentificationAlgorithmParameter identificationAlgorithmParameter)
algorithmID - the algorithm id as indexed in the Advocate classidentificationAlgorithmParameter - the specific parameterspublic java.util.Set<java.lang.Integer> getAlgorithms()
public static SearchParameters getIdentificationParameters(java.io.File file) throws java.io.FileNotFoundException, java.io.IOException, java.lang.ClassNotFoundException
file - the filejava.io.FileNotFoundExceptionjava.io.IOExceptionjava.lang.ClassNotFoundExceptionpublic static void saveIdentificationParameters(SearchParameters identificationParameters, java.io.File file) throws java.io.FileNotFoundException, java.io.IOException, java.lang.ClassNotFoundException
identificationParameters - file - the filejava.io.FileNotFoundExceptionjava.io.IOExceptionjava.lang.ClassNotFoundExceptionpublic void saveIdentificationParametersAsTextFile(java.io.File file)
throws java.io.FileNotFoundException,
java.io.IOException,
java.lang.ClassNotFoundException
file - the filejava.io.FileNotFoundExceptionjava.io.IOExceptionjava.lang.ClassNotFoundExceptionpublic java.lang.String toString()
toString in class java.lang.Objectpublic java.lang.String toString(boolean html)
html - use HTML formattingpublic boolean equals(SearchParameters otherSearchParameters)
otherSearchParameters - the parameters to compare topublic java.lang.Boolean isCorrectPrecursorMass()
public void correctPrecursorMass(java.lang.Boolean correctPrecursorMass)
correctPrecursorMass - a boolean indicating whether the precursor
mass shall be corrected (TagDB setting)public java.lang.Boolean getDiscardLowQualitySpectra()
public void setDiscardLowQualitySpectra(java.lang.Boolean discardLowQualitySpectra)
discardLowQualitySpectra - a boolean indicating whether low quality
spectra shall be discardedpublic java.lang.String getFragmentationModel()
public void setFragmentationModel(java.lang.String fragmentationModel)
fragmentationModel - the name of the fragmentation modelpublic java.lang.Boolean generateQuery()
public void setGenerateQuery(java.lang.Boolean generateQuery)
generateQuery - a boolean indicating whether a blast query shall be
generatedpublic java.util.Map<java.lang.String,java.lang.String> getPepNovoPtmMap()
public void setPepNovoPtmMap(java.util.Map<java.lang.String,java.lang.String> pepNovoPtmMap)
pepNovoPtmMap - the pepNovoPtmMap to setCopyright © 2014. All Rights Reserved.