The status resulting ratio for a peptide found in a match. More...
#include <ms_ms1quant_match_ratio.hpp>
Inherits matrix_science::ms_handle.
Public Types | |
enum | ratioStatusCode { RS_EMPTY = 0, RS_OK = 1, RS_ISOLATEDPRECURSORFAILED = 2, RS_INTEFERENCEFAILED = 4, RS_NODATA = 8, RS_FITEXYSIGMA = 16, RS_NEGATIVERATIO = 32, RS_INFINITERATIO = 64, RS_ZERORATIO = 128, RS_DO_NOT_USE = 256, RS_TOTALINTENSITYFAILED = 512 } |
Status codes from fitting ratios. More... | |
Public Member Functions | |
ms_ms1quant_match_ratio () | |
Default constructor. | |
ms_ms1quant_match_ratio (const ms_ms1quant_match_ratio_body &body) | |
Populated constructor, linked to loaded data. | |
bool | getFitexy (ms_fitexy_result &value) const |
Get the fitexy value. Returns true if a fitexy value is set. | |
double | getQuality () const |
Get the quality of the match. | |
std::string | getRatioName () const |
Returns the ratio name. | |
int | getStatus () const |
Get the status composite value. | |
std::vector< ratioStatusCode > | getStatusList () const |
Get the status values. Each status in the list is a single bit. | |
double | getValue () const |
Return the numerical value of the ratio. | |
bool | isIncluded () const |
Returns true if the item should be included in calculations. | |
bool | isSet () const |
Returns true if the item has a value set. | |
bool | isUsedForAverage () const |
Returns true if the item is used in the average protocol for quantitation. | |
bool | isValid () const |
Returns true if the item has a valid value. | |
Static Public Member Functions | |
static ratioStatusCode | getCodeFromXml (std::string text) |
Get the status code for an XML attribute value. | |
static bool | getCodeInfo (ratioStatusCode code, const ms_quant_method &method, double &info) |
Return true if the status is associated with further information. | |
static std::string | getXmlCode (ratioStatusCode code) |
Get the XML attribute value for a status code. |
The status resulting ratio for a peptide found in a match.
This is stored in XML in a "originalRatio" entity.
enum ratioStatusCode |
Status codes from fitting ratios.
See Using enumerated values and static const ints in Perl, Java, Python and C#.
Note that RS_FITEXYSIGMA maps to "StdErrAboveTreshold" which has always been misspelt.
The "XML text" is returned by matrix_science::ms_ms1quant_match_ratio::getXmlCode
The statuses get set by matrix_science::ms_ms1quant_match::applyThresholds()
Default constructor.
Assigns reasonable default values to all internal members.
ms_ms1quant_match_ratio | ( | const ms_ms1quant_match_ratio_body & | body ) |
Populated constructor, linked to loaded data.
body | The data loaded from the result file. |
matrix_science::ms_ms1quant_match_ratio::ratioStatusCode getCodeFromXml | ( | std::string | text ) | [static] |
Get the status code for an XML attribute value.
text | The string used to encode the ratio status in the XML file. |
bool getCodeInfo | ( | ratioStatusCode | code, |
const ms_quant_method & | method, | ||
double & | info | ||
) | [static] |
Return true if the status is associated with further information.
Four status codes have further information associated with them:
code | The ratio status for which extra information is wanted. |
method | The quantitation method. |
info | Filled in with the value of the extra information. |
bool getFitexy | ( | matrix_science::ms_fitexy_result & | value ) | const |
Get the fitexy value. Returns true if a fitexy value is set.
value | Filled in with the ms_fitexy_result, if any. |
double getQuality | ( | ) | const |
Get the quality of the match.
Std. Err. = sigb / abs(b) from fitexy. Perfect fit is 0.0.
std::string getRatioName | ( | ) | const |
Returns the ratio name.
int getStatus | ( | ) | const |
Get the status composite value.
Whether a peptide ratio is included or rejected when calculating a protein ratio.
These can be retrieved as a collection of separate values with getStatusList().
std::vector< ms_ms1quant_match_ratio::ratioStatusCode > getStatusList | ( | ) | const |
Get the status values. Each status in the list is a single bit.
These can be retrieved as a single composite value with getStatus().
double getValue | ( | ) | const |
Return the numerical value of the ratio.
std::string getXmlCode | ( | ratioStatusCode | code ) | [static] |
Get the XML attribute value for a status code.
code | The ratio status to get the XML excoding string for. |
bool isIncluded | ( | ) | const |
Returns true if the item should be included in calculations.
bool isSet | ( | ) | const |
Returns true if the item has a value set.
bool isUsedForAverage | ( | ) | const |
Returns true if the item is used in the average protocol for quantitation.
The Average protocol only uses a number of the the most intense peptides.
bool isValid | ( | ) | const |
Returns true if the item has a valid value.
Copyright © 2022 Matrix Science Ltd. All Rights Reserved. Generated on Thu Mar 31 2022 01:12:34 |