ms_ms1quant_match_component Class Reference [Quantitation analysis for Mascot Server and Distiller]

A component within a match. More...

#include <ms_ms1quant_match_component.hpp>

Inherits matrix_science::ms_handle.

List of all members.

Public Member Functions
	ms_ms1quant_match_component ()
	Default constructor.
	ms_ms1quant_match_component (const ms_ms1quant_match_component_body &body)
	Populated constructor.
double	getAbsoluteValue () const
	Get the summed intensity values for this component across the XIC peak. Required for normalisation.
std::string	getComponent () const
	Get the component.
double	getMoverz () const
	Get the m/z value.
int	getNumPeptides () const
	Get the number of related peptides.
int	getNumRanges () const
	Get the number of ranges.
void	getPeptideKey (int index, int &q, int &p) const
	Get a related peptide's feature key by its index (1..n).
ms_ms1quant_match_range	getRange (int index) const
	Get a range value by its index (1..n).
double	getRelativeMass () const
	Get the relative mass value.
std::string	getSummedModsStr () const
	Returns the string for any 'summed' modifications for this particular match.
std::string	getVarModsStr () const
	Returns the string for any 'variable' modifications for this particular match.
ms_xic	getXic () const
	Get the extracted ion chromatogram (XIC).
bool	hasAbsoluteValue () const
	Check if the absolute value is available.
bool	isComponentIdentified () const
	Check if the component has been identified.

---

Detailed Description

A component within a match.

This is stored in XML in "partner" and "absoluteValue" entities.

---

Constructor & Destructor Documentation

ms_ms1quant_match_component

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_ms1quant_match_component

(

const ms_ms1quant_match_component_body &

body )

Populated constructor.

Parameters:

body	The data loaded from the result file.

---

Member Function Documentation

double getAbsoluteValue

(

)

const

Get the summed intensity values for this component across the XIC peak. Required for normalisation.

If ratio values not are absolute use total intensity as absolute value

Returns:

The absolute ratio value.

std::string getComponent

(

)

const

Get the component.

Returns:

The name of the component (e.g. "Heavy").

double getMoverz

(

)

const

Get the m/z value.

Returns:

The m/z value.

int getNumPeptides

(

)

const

Get the number of related peptides.

Returns:

The number of related peptides.

int getNumRanges

(

)

const

Get the number of ranges.

Returns:

The number of ranges.

void getPeptideKey	(	int	index,
		int &	q,
		int &	p
	)		const

Get a related peptide's feature key by its index (1..n).

See Multiple return values in Perl, Java, Python and C#.

The returned keys can be used to get the ms_peptide using ms_mascotresults::getPeptide().

Parameters:

index	The index of the required peptide (1..getNumPeptides()).
q	The query number.
p	The rank.

matrix_science::ms_ms1quant_match_range getRange

(

int

index )

const

Get a range value by its index (1..n).

Parameters:

index

The index of the required range (1..getNumRanges()).

Returns:

The ms_ms1quant_match_range.

double getRelativeMass

(

)

const

Get the relative mass value.

Returns:

The relative mass value.

std::string getSummedModsStr

(

)

const

Returns the string for any 'summed' modifications for this particular match.

See ms_peptide::getSummedModsStr for details of the format

Returns:

the encoded summed mods string

std::string getVarModsStr

(

)

const

Returns the string for any 'variable' modifications for this particular match.

See ms_peptide::getVarModsStr for details of the format

Returns:

the encoded variable mods string

matrix_science::ms_xic getXic

(

)

const

Get the extracted ion chromatogram (XIC).

Returns:

The ms_xic.

bool hasAbsoluteValue

(

)

const

Check if the absolute value is available.

Returns:

True if the absolute value is available (some older datasets may not hold the value).

bool isComponentIdentified

(

)

const

Check if the component has been identified.

Returns:

True if the component has been identified.

---

The documentation for this class was generated from the following files:

• ms_ms1quant_match_component.hpp
• ms_ms1quant_match_component.cpp