com.compomics.util.experiment.identification.spectrum_assumptions

Class TagAssumption

java.lang.Object

com.compomics.util.experiment.personalization.ExperimentObject

com.compomics.util.experiment.identification.SpectrumIdentificationAssumption

com.compomics.util.experiment.identification.spectrum_assumptions.TagAssumption

All Implemented Interfaces:

UrParameter, Serializable, Cloneable

public class TagAssumption
extends SpectrumIdentificationAssumption
implements UrParameter

This class represent a tag assumption made by an identification algorithm based on a sequence tag.

Author:

Marc Vaudel

See Also:

Serialized Form

Field Summary

Fields inherited from class com.compomics.util.experiment.identification.SpectrumIdentificationAssumption

advocate, aminoAcidScores, identificationCharge, identificationFile, rank, rawScore, score

Constructor Summary

Constructors

Constructor and Description
TagAssumption() Constructor for en empty assumption.
TagAssumption(int advocate, int rank, Tag tag, Charge identificationCharge, double score) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getFamilyName() This method returns the family name of the parameter.
int	getIndex() This method returns the index of the parameter.
ArrayList<TagAssumption>	getPossibleTags(boolean forwardIon, int minCharge, int maxCharge, int maxIsotope) Computes the possible tag assumptions which can be obtained from this one by accounting for other charges and isotopes.
Tag	getTag() Returns the tag of this assumption.
Double	getTheoreticMass() Returns the theoretic mass of the given assumption.
double	getTheoreticMass(boolean includeCTermGap, boolean includeNTermGap) Returns the theoretic mass of the tag, eventually without terminal gaps.
double	getTheoreticMz(boolean includeCTermGap, boolean includeNTermGap) Returns the theoretic mass of the tag, eventually without terminal gaps.
TagAssumption	reverse(boolean yIon) Retunrs a new TagAssumption instance where the tag is a reversed version of this tag.
String	toString()

Methods inherited from class com.compomics.util.experiment.identification.SpectrumIdentificationAssumption

getAdvocate, getAminoAcidScores, getDeltaMass, getIdentificationCharge, getIdentificationFile, getIsotopeNumber, getPrecursorMatch, getRank, getRawScore, getScore, getTheoreticMz, setAminoAcidScores, setIdentificationCharge, setRank, setRawScore, setScore

Methods inherited from class com.compomics.util.experiment.personalization.ExperimentObject

addUrParam, getParameterKey, getUrParam

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TagAssumption

public TagAssumption()

Constructor for en empty assumption.

TagAssumption

public TagAssumption(int advocate,
                     int rank,
                     Tag tag,
                     Charge identificationCharge,
                     double score)

Constructor. Note: if PsmScores.scoreRoundingDecimal is not null the scored will be floored accordingly.

Parameters:

advocate - the advocate supporting this assumption

rank - the rank of the assumption

tag - the identified tag

identificationCharge - the identified charge

score - the score

Method Detail

getTag

public Tag getTag()

Returns the tag of this assumption.

Returns:

the tag of this assumption

getTheoreticMass

public Double getTheoreticMass()

Description copied from class: SpectrumIdentificationAssumption

Returns the theoretic mass of the given assumption.

Specified by:

getTheoreticMass in class SpectrumIdentificationAssumption

Returns:

the theoretic mass of the given assumption

getTheoreticMass

public double getTheoreticMass(boolean includeCTermGap,
                               boolean includeNTermGap)

Returns the theoretic mass of the tag, eventually without terminal gaps.

Parameters:

includeCTermGap - if true the C-terminal gap will be added if present

includeNTermGap - if true the N-terminal gap will be added if present

Returns:

the theoretic mass of the tag

getTheoreticMz

public double getTheoreticMz(boolean includeCTermGap,
                             boolean includeNTermGap)

Returns the theoretic mass of the tag, eventually without terminal gaps.

Parameters:

includeCTermGap - if true the C-terminal gap will be added if present

includeNTermGap - if true the N-terminal gap will be added if present

Returns:

the theoretic mass of the tag

getPossibleTags

public ArrayList<TagAssumption> getPossibleTags(boolean forwardIon,
                                                int minCharge,
                                                int maxCharge,
                                                int maxIsotope)

Computes the possible tag assumptions which can be obtained from this one by accounting for other charges and isotopes.

Parameters:

forwardIon - indicates whether the tag is based on forward ions (a, b, or c)

minCharge - the minimal precursor charge to consider

maxCharge - the maximal precursor charge to consider

maxIsotope - the maximal isotope number to consider

Returns:

the possible tag assumptions which can be obtained from this one by accounting for other charges and isotopes

reverse

public TagAssumption reverse(boolean yIon)

Retunrs a new TagAssumption instance where the tag is a reversed version of this tag.

Parameters:

yIon - indicates whether the tag is based on y ions

Returns:

a new TagAssumption instance where the tag is a reversed version of this tag

getFamilyName

public String getFamilyName()

Description copied from interface: UrParameter

This method returns the family name of the parameter. Shall not contain '|'.

Specified by:

getFamilyName in interface UrParameter

Returns:

family name

getIndex

public int getIndex()

Description copied from interface: UrParameter

This method returns the index of the parameter. Shall not contain '|'.

Specified by:

getIndex in interface UrParameter

Returns:

the index of the parameter

toString

public String toString()

Overrides:

toString in class Object