com.compomics.util.experiment.identification
Class PeptideAssumption

java.lang.Object
  extended by com.compomics.util.experiment.personalization.ExperimentObject
      extended by com.compomics.util.experiment.identification.PeptideAssumption
All Implemented Interfaces:
Serializable, Cloneable

public class PeptideAssumption
extends ExperimentObject

This object will models the assumption made by an advocate.

Author:
Marc Vaudel, Harald Barsnes
See Also:
Serialized Form

Constructor Summary
PeptideAssumption(Peptide aPeptide, int rank, int advocate, Charge identificationCharge, double eValue, String identificationFile)
          Constructor for a peptide assumption
 
Method Summary
 int getAdvocate()
          get the used advocate
 int getC13(double precursorMZ)
          Returns the distance in Da between the experimental mass and theoretic mass, image of the error between the precursor mass and the peptide monoisotopic mass (typically for the C13 option)
 double getDeltaMass(double precursorMZ, boolean ppm)
          Returns the precursor mass error (in ppm or Da).
 double getEValue()
          returns the e-value assigned by the advocate
 String getFile()
          returns the file
 Peptide getPeptide()
          get the theoretic peptide
 int getRank()
          Get the identification rank
 boolean isDecoy()
          is the identification decoy?
 
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, toString, wait, wait, wait
 

Constructor Detail

PeptideAssumption

public PeptideAssumption(Peptide aPeptide,
                         int rank,
                         int advocate,
                         Charge identificationCharge,
                         double eValue,
                         String identificationFile)
Constructor for a peptide assumption

Parameters:
aPeptide - the theoretic peptide
rank - the identification rank
advocate - the advocate used
identificationCharge - the charge used by the search engine for identification
eValue - the e-value
identificationFile - the identification file
Method Detail

getRank

public int getRank()
Get the identification rank

Returns:
the identification rank

getPeptide

public Peptide getPeptide()
get the theoretic peptide

Returns:
the peptide

getAdvocate

public int getAdvocate()
get the used advocate

Returns:
the advocate index

getC13

public int getC13(double precursorMZ)
Returns the distance in Da between the experimental mass and theoretic mass, image of the error between the precursor mass and the peptide monoisotopic mass (typically for the C13 option)

Parameters:
precursorMZ - the precursor m/z
Returns:
the distance in Da between the experimental mass and theoretic mass

getDeltaMass

public double getDeltaMass(double precursorMZ,
                           boolean ppm)
Returns the precursor mass error (in ppm or Da). Note that the value is returns as (experimental mass - theoretical mass) and that negative values thus can occur. If an error of more than 1 Da it will be substracted from the error. The C13 error can be retrieved by the function getC13().

Parameters:
precursorMZ - the precursor m/z
ppm - if true the error is returns in ppm, false returns the error in Da
Returns:
the precursor mass error (in ppm or Da)

getEValue

public double getEValue()
returns the e-value assigned by the advocate

Returns:
the e-value

getFile

public String getFile()
returns the file

Returns:
the idenitfication file

isDecoy

public boolean isDecoy()
is the identification decoy?

Returns:
a boolean indicating if the identification is a decoy one


Copyright © 2011. All Rights Reserved.