chromatogram information management class More...
#include <Chromatogram.h>


Public Member Functions | |
| Chromatogram (Sample *sample) | |
| constructor More... | |
| virtual | ~Chromatogram () |
| destructor | |
| void | setOperationFlag (const bool op) |
| sets the operation flag value More... | |
| bool | getOperationFlag () |
| gets the operation flag value More... | |
| void | setId (int id) |
| sets chromatogram id More... | |
| int | getId () |
| gets chromatogram id More... | |
| Sample * | getSample () |
| gets sample More... | |
| void | setName (const char *name) |
| sets chromatogram name More... | |
| const char * | getName () |
| gets chromatogram name More... | |
| void | setMz (const double mz) |
| sets m/z More... | |
| double | getMz () |
| gets m/z More... | |
| void | setGroup (DataGroupNode *group) |
| sets spectrum group More... | |
| DataGroupNode * | getGroup () |
| gets spectrum group More... | |
| void | setIcon (const char *icon) |
| sets icon name More... | |
| const char * | getIcon () |
| gets icon name More... | |
| void | setTitle (const char *title) |
| sets title More... | |
| const char * | getTitle () |
| gets title More... | |
| kome::core::Properties & | getProperties () |
| gets properties More... | |
| kome::core::Properties & | getUserProperties () |
| gets user properties More... | |
| void | setAutoCreated (const bool autoCreated=true) |
| sets auto created flag More... | |
| bool | isAutoCreated () |
| gets auto created flag value More... | |
| void | setVisible (const bool visible) |
| sets the visible flag More... | |
| bool | isVisible () |
| gets the visible flag value More... | |
| void | setOrgChromatogram (Chromatogram *chrom) |
| sets original chromatogram More... | |
| Chromatogram * | getOrgChromatogram () |
| gets original chromatogram More... | |
| void | setQ1 (const double q1) |
| sets the Q1 Mass More... | |
| double | getQ1 () |
| gets the Q1 Mass More... | |
| void | setQ3 (const double q3) |
| sets the Q3 Mass More... | |
| double | getQ3 () |
| gets the Q3 Mass More... | |
| kome::core::XYData * | getXYData () |
| gets xy data from data manager More... | |
| void | deleteXYData () |
| deletes xy data of data manager | |
| void | getXYData (kome::core::XYData *const xyData, const bool op) |
| gets chromatogram data points More... | |
| Spectrum * | searchSpectrum (const double rt, const SearchType search=SEARCH_NEAR) |
| searches spectrum More... | |
| void | getSpectra (DataSet &dataSet, const double startRt, const double endRt, const SearchType startSearch=SEARCH_NEAR, const SearchType endSearch=SEARCH_NEAR) |
| get spectra in specified RT range More... | |
| double | getMass (const unsigned int index) |
| gets mass More... | |
| int | getMsStage (const unsigned int index) |
| gets MS stage More... | |
| double | getPrecursor (const unsigned int index) |
| gets precursor mass More... | |
| void | getProperties (kome::core::Properties &properties) |
| gets spectrum and spectrum group properties More... | |
| void | getUserProperties (kome::core::Properties &userProperties) |
| gets chromatogram and chromatogram group user properties More... | |
Static Public Member Functions | |
| static bool | isCommonProperty (const char *key) |
| check whther the specified property key is common property or not More... | |
Protected Member Functions | |
| virtual void | onGetXYData (kome::core::XYData *const xyData)=0 |
| This method is called by getXYData method (abstract method) More... | |
| virtual void | onGetSpectra (DataSet &dataSet, const double startRt, const double endRt, const SearchType startSearch, const SearchType endSearch)=0 |
| This method is called by searchSpectrum or getDataSet method (abstract method) More... | |
| virtual double | onGetMass (const unsigned int index)=0 |
| This method is called by getMass method (abstract method) More... | |
| virtual int | onGetMsStage (const unsigned int index)=0 |
| This method is called by getMsStage method (abstract method) More... | |
| virtual double | onGetPrecursor (const unsigned int index)=0 |
| This method is called by getPrecursor method (abstract method) More... | |
Protected Attributes | |
| Sample * | m_sample |
| DataGroupNode * | m_group |
| std::string | m_name |
| double | m_mz |
| std::string | m_icon |
| std::string | m_title |
| kome::core::Properties | m_props |
| kome::core::Properties | m_userProps |
| bool | m_autoCreated |
| bool | m_visible |
| Chromatogram * | m_orgChrom |
| bool | m_op |
| int | m_chromId |
| double | m_q1 |
| double | m_q3 |
Static Protected Attributes | |
| static std::vector< std::string > | m_commonProps |
chromatogram information management class
Definition at line 33 of file Chromatogram.h.
| kome::objects::Chromatogram::Chromatogram | ( | Sample * | sample | ) |
constructor
| [in] | sample |
Definition at line 45 of file Chromatogram.cpp.

| DataGroupNode * kome::objects::Chromatogram::getGroup | ( | ) |
| const char * kome::objects::Chromatogram::getIcon | ( | ) |
| int kome::objects::Chromatogram::getId | ( | ) |
| double kome::objects::Chromatogram::getMass | ( | const unsigned int | index | ) |
gets mass
| [in] | index | data index |
Definition at line 298 of file Chromatogram.cpp.

| int kome::objects::Chromatogram::getMsStage | ( | const unsigned int | index | ) |
gets MS stage
| [in] | index | data index |
Definition at line 303 of file Chromatogram.cpp.

| double kome::objects::Chromatogram::getMz | ( | ) |
| const char * kome::objects::Chromatogram::getName | ( | ) |
|
inline |
gets the operation flag value
Definition at line 111 of file Chromatogram.h.
| Chromatogram * kome::objects::Chromatogram::getOrgChromatogram | ( | ) |
gets original chromatogram
Definition at line 174 of file Chromatogram.cpp.
| double kome::objects::Chromatogram::getPrecursor | ( | const unsigned int | index | ) |
gets precursor mass
| [in] | index | data index |
Definition at line 308 of file Chromatogram.cpp.

| kome::core::Properties & kome::objects::Chromatogram::getProperties | ( | ) |
| void kome::objects::Chromatogram::getProperties | ( | kome::core::Properties & | properties | ) |
gets spectrum and spectrum group properties
| [out] | properties | properties object to store properties |
Definition at line 313 of file Chromatogram.cpp.

| double kome::objects::Chromatogram::getQ1 | ( | ) |
gets the Q1 Mass
Definition at line 195 of file Chromatogram.cpp.

| double kome::objects::Chromatogram::getQ3 | ( | ) |
gets the Q3 Mass
Definition at line 216 of file Chromatogram.cpp.

| Sample * kome::objects::Chromatogram::getSample | ( | ) |
| void kome::objects::Chromatogram::getSpectra | ( | DataSet & | dataSet, |
| const double | startRt, | ||
| const double | endRt, | ||
| const SearchType | startSearch = SEARCH_NEAR, |
||
| const SearchType | endSearch = SEARCH_NEAR |
||
| ) |
get spectra in specified RT range
| [out] | dataSet | data set object to store spectra |
| [in] | startRt | start RT |
| [in] | endRt | end RT |
| [in] | startSearch | start search type |
| [in] | endSearch | end search type |
Definition at line 287 of file Chromatogram.cpp.

| const char * kome::objects::Chromatogram::getTitle | ( | ) |
| kome::core::Properties & kome::objects::Chromatogram::getUserProperties | ( | ) |
gets user properties
Definition at line 144 of file Chromatogram.cpp.
| void kome::objects::Chromatogram::getUserProperties | ( | kome::core::Properties & | userProperties | ) |
gets chromatogram and chromatogram group user properties
| [out] | userProperties | properties object to store user properties |
Definition at line 342 of file Chromatogram.cpp.

| kome::core::XYData * kome::objects::Chromatogram::getXYData | ( | ) |
gets xy data from data manager
Definition at line 225 of file Chromatogram.cpp.

| void kome::objects::Chromatogram::getXYData | ( | kome::core::XYData *const | xyData, |
| const bool | op | ||
| ) |
gets chromatogram data points
| [out] | xyData | object to store data points |
| [in] | op | If true, getting operated data points |
Definition at line 239 of file Chromatogram.cpp.

| bool kome::objects::Chromatogram::isAutoCreated | ( | ) |
gets auto created flag value
Definition at line 154 of file Chromatogram.cpp.
|
static |
check whther the specified property key is common property or not
| [in] | key | parameter key |
Definition at line 363 of file Chromatogram.cpp.
| bool kome::objects::Chromatogram::isVisible | ( | ) |
gets the visible flag value
Definition at line 164 of file Chromatogram.cpp.
|
protectedpure virtual |
This method is called by getMass method (abstract method)
| [in] | index | data index |
Implemented in kome::objects::SpectraChromatogram, kome::operation::TransformedChromatogram, kome::objects::OverlappingChromatogram, and kome::operation::AlignedChromatogram.
|
protectedpure virtual |
This method is called by getMsStage method (abstract method)
| [in] | index | data index |
Implemented in kome::objects::SpectraChromatogram, kome::operation::TransformedChromatogram, kome::objects::OverlappingChromatogram, and kome::operation::AlignedChromatogram.
|
protectedpure virtual |
This method is called by getPrecursor method (abstract method)
| [in] | index | data index |
Implemented in kome::objects::SpectraChromatogram, kome::operation::TransformedChromatogram, kome::objects::OverlappingChromatogram, and kome::operation::AlignedChromatogram.
|
protectedpure virtual |
This method is called by searchSpectrum or getDataSet method (abstract method)
| [out] | dataSet | data set object to store spectra |
| [in] | startRt | start RT |
| [in] | endRt | end RT |
| [in] | startSearch | start search type |
| [in] | endSearch | end search type |
Implemented in kome::objects::SpectraChromatogram, kome::operation::TransformedChromatogram, kome::objects::OverlappingChromatogram, and kome::operation::AlignedChromatogram.
|
protectedpure virtual |
This method is called by getXYData method (abstract method)
| [out] | xyData | object to store data points |
Implemented in kome::objects::SpectraChromatogram, kome::operation::TransformedChromatogram, kome::objects::OverlappingChromatogram, and kome::operation::AlignedChromatogram.
| Spectrum * kome::objects::Chromatogram::searchSpectrum | ( | const double | rt, |
| const SearchType | search = SEARCH_NEAR |
||
| ) |
searches spectrum
| [in] | rt | RT |
| [in] | search | search type |
Definition at line 274 of file Chromatogram.cpp.

| void kome::objects::Chromatogram::setAutoCreated | ( | const bool | autoCreated = true | ) |
sets auto created flag
| [in] | autoCreated | auto created flag value |
Definition at line 149 of file Chromatogram.cpp.
| void kome::objects::Chromatogram::setGroup | ( | DataGroupNode * | group | ) |
sets spectrum group
Definition at line 108 of file Chromatogram.cpp.

| void kome::objects::Chromatogram::setIcon | ( | const char * | icon | ) |
| void kome::objects::Chromatogram::setId | ( | int | id | ) |
sets chromatogram id
| [in] | id | chromatogram id |
Definition at line 384 of file Chromatogram.cpp.
| void kome::objects::Chromatogram::setMz | ( | const double | mz | ) |
| void kome::objects::Chromatogram::setName | ( | const char * | name | ) |
sets chromatogram name
| [in] | name | chromatogram name |
Definition at line 88 of file Chromatogram.cpp.
|
inline |
sets the operation flag value
| [in] | op | operation flag value |
Definition at line 104 of file Chromatogram.h.
| void kome::objects::Chromatogram::setOrgChromatogram | ( | Chromatogram * | chrom | ) |
sets original chromatogram
| [in] | chrom | original chromatogram |
Definition at line 169 of file Chromatogram.cpp.
| void kome::objects::Chromatogram::setQ1 | ( | const double | q1 | ) |
sets the Q1 Mass
| [in] | q1 | Q1 Mass |
Definition at line 183 of file Chromatogram.cpp.

| void kome::objects::Chromatogram::setQ3 | ( | const double | q3 | ) |
sets the Q3 Mass
| [in] | q3 | Q3 Mass |
Definition at line 204 of file Chromatogram.cpp.

| void kome::objects::Chromatogram::setTitle | ( | const char * | title | ) |
| void kome::objects::Chromatogram::setVisible | ( | const bool | visible | ) |
sets the visible flag
| [in] | visible | visible flag value |
Definition at line 159 of file Chromatogram.cpp.
|
protected |
auto created flag
Definition at line 74 of file Chromatogram.h.
|
protected |
chromatogram id
Definition at line 86 of file Chromatogram.h.
|
staticprotected |
common properties
Definition at line 96 of file Chromatogram.h.
|
protected |
group
Definition at line 53 of file Chromatogram.h.
|
protected |
icon name
Definition at line 62 of file Chromatogram.h.
|
protected |
m/z
Definition at line 59 of file Chromatogram.h.
|
protected |
name
Definition at line 56 of file Chromatogram.h.
|
protected |
operation flag
Definition at line 83 of file Chromatogram.h.
|
protected |
original chromatogram
Definition at line 80 of file Chromatogram.h.
|
protected |
properties
Definition at line 68 of file Chromatogram.h.
|
protected |
Q1 Mass
Definition at line 89 of file Chromatogram.h.
|
protected |
Q3 Mass
Definition at line 92 of file Chromatogram.h.
|
protected |
sample
Definition at line 50 of file Chromatogram.h.
|
protected |
title
Definition at line 65 of file Chromatogram.h.
|
protected |
user properties
Definition at line 71 of file Chromatogram.h.
|
protected |
visible
Definition at line 77 of file Chromatogram.h.
1.8.6