transformed spectrum class More...

#include <TransformedChromatogram.h>

Inheritance diagram for kome::operation::TransformedChromatogram:

Collaboration diagram for kome::operation::TransformedChromatogram:

Public Member Functions
	TransformedChromatogram (kome::objects::Chromatogram &org, const bool op=false)
	constructor More...

virtual	~TransformedChromatogram ()
	destructor

void	setXScale (const double sc)
	sets x scale More...

double	getXScale ()
	gets x scale More...

void	setXTranslation (const double tr)
	sets x translation More...

double	getXTranslation ()
	gets x translation More...

void	setYScale (const double sc)
	sets y scale More...

double	getYScale ()
	gets y scale More...

void	setYTranslation (const double tr)
	sets y translation More...

double	getYTranslation ()
	gets y translation More...

Public Member Functions inherited from kome::objects::Chromatogram
	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...

Protected Member Functions
virtual void	onGetXYData (kome::core::XYData *const xyData)
	This method is called by getXYData method (override method) More...

virtual void	onGetSpectra (kome::objects::DataSet &spectra, const double startRt, const double endRt, const kome::objects::SearchType startSearch, const kome::objects::SearchType endSearch)
	This method is called by searchSpectrum or getDataSet method (overriede method) More...

virtual double	onGetMass (const unsigned int index)
	This method is called by getMass method (override method) More...

virtual int	onGetMsStage (const unsigned int index)
	This method is called by getMsStage method (override method) More...

virtual double	onGetPrecursor (const unsigned int index)
	This method is called by getPrecursor method (override method) More...

Protected Attributes
kome::objects::Chromatogram &	m_org

double	m_scX

double	m_trX

double	m_scY

double	m_trY

Protected Attributes inherited from kome::objects::Chromatogram
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

Additional Inherited Members
Static Public Member Functions inherited from kome::objects::Chromatogram
static bool	isCommonProperty (const char *key)
	check whther the specified property key is common property or not More...

Static Protected Attributes inherited from kome::objects::Chromatogram
static std::vector< std::string >	m_commonProps

Detailed Description

transformed spectrum class

Definition at line 23 of file TransformedChromatogram.h.

Constructor & Destructor Documentation

kome::operation::TransformedChromatogram::TransformedChromatogram	(	kome::objects::Chromatogram &	org,
		const bool	op = `false`
	)

constructor

Parameters

[in]	org	original spectrum
[in]	op	If true, processed data is gotten when getting data points.

Definition at line 28 of file TransformedChromatogram.cpp.

         : kome::objects::Chromatogram( org.getSample() ), m_org( org ) {
     m_scX = 1.0;
     m_trX = 0.0;
     m_scY = 1.0;
     m_trY = 0.0;
     m_op = op;
 
     setName( org.getName() );
     setMz( org.getMz() );
     setGroup( org.getGroup() );
     setIcon( org.getIcon() );
     setTitle( org.getTitle() );
     setAutoCreated( org.isAutoCreated() );
     setOrgChromatogram( org.getOrgChromatogram() );
     setQ1( org.getQ1() );
     setQ3( org.getQ3() );
 }

Here is the call graph for this function:

Member Function Documentation

double kome::operation::TransformedChromatogram::getXScale ( )

gets x scale

Returns: x scale

Definition at line 57 of file TransformedChromatogram.cpp.

                                           {
     return m_scX;
 }

double kome::operation::TransformedChromatogram::getXTranslation ( )

gets x translation

Returns: x translation

Definition at line 67 of file TransformedChromatogram.cpp.

                                                 {
     return m_trX;
 }

double kome::operation::TransformedChromatogram::getYScale ( )

gets y scale

Returns: y scale

Definition at line 77 of file TransformedChromatogram.cpp.

                                           {
     return m_scY;
 }

double kome::operation::TransformedChromatogram::getYTranslation ( )

gets y translation

Returns: y translation

Definition at line 87 of file TransformedChromatogram.cpp.

                                                 {
     return m_trY;
 }

double kome::operation::TransformedChromatogram::onGetMass ( const unsigned int index )

protectedvirtual

This method is called by getMass method (override method)

Parameters

[in] index data index

Returns: mass

Implements kome::objects::Chromatogram.

Definition at line 124 of file TransformedChromatogram.cpp.

                                                                     {
     return m_org.getMass( index );
 }

Here is the call graph for this function:

int kome::operation::TransformedChromatogram::onGetMsStage ( const unsigned int index )

protectedvirtual

This method is called by getMsStage method (override method)

Parameters

[in] index data index

Returns: MS stage.

Implements kome::objects::Chromatogram.

Definition at line 129 of file TransformedChromatogram.cpp.

                                                                     {
     return m_org.getMsStage( index );
 }  

Here is the call graph for this function:

double kome::operation::TransformedChromatogram::onGetPrecursor ( const unsigned int index )

protectedvirtual

This method is called by getPrecursor method (override method)

Parameters

[in] index data index

Returns: precursor mass

Implements kome::objects::Chromatogram.

Definition at line 134 of file TransformedChromatogram.cpp.

                                                                          {
     return m_org.getPrecursor( index );
 }

Here is the call graph for this function:

void kome::operation::TransformedChromatogram::onGetSpectra	(	kome::objects::DataSet &	spectra,
		const double	startRt,
		const double	endRt,
		const kome::objects::SearchType	startSearch,
		const kome::objects::SearchType	endSearch
	)

protectedvirtual

This method is called by searchSpectrum or getDataSet method (overriede method)

Parameters

[out]	spectra	spectra object to store spectra
[in]	startRt	start RT
[in]	endRt	end RT
[in]	startSearch	start search type
[in]	endSearch	end search type

Implements kome::objects::Chromatogram.

Definition at line 108 of file TransformedChromatogram.cpp.

   {
     // rt range
     double orgStartRt = ( startRt - m_trX ) / m_scX;
     double orgEndRt = ( endRt - m_trX ) / m_scX;
 
     // get spectra
     m_org.getSpectra( spectra, orgStartRt, orgEndRt, startSearch, endSearch );
 }

Here is the call graph for this function:

void kome::operation::TransformedChromatogram::onGetXYData ( kome::core::XYData *const xyData )

protectedvirtual

This method is called by getXYData method (override method)

Parameters

[out] xyData object to store data points

Implements kome::objects::Chromatogram.

Definition at line 92 of file TransformedChromatogram.cpp.

                                                                         {
     // get original data
     kome::core::DataPoints dps;
     m_org.getXYData( &dps, m_op );
 
     // add to data
     xyData->reserve( dps.getLength() );
     for( unsigned int i = 0; i < dps.getLength(); i++ ) {
         double x = m_scX * dps.getX( i ) + m_trX;
         double y = m_scY * dps.getY( i ) + m_trY;
 
         xyData->addPoint( x, y );
     }
 }

Here is the call graph for this function:

void kome::operation::TransformedChromatogram::setXScale ( const double sc )

sets x scale

Parameters

[in] sc x scale

Definition at line 52 of file TransformedChromatogram.cpp.

                                                          {
     m_scX = std::max( sc,  1.0e-10 );
 }

void kome::operation::TransformedChromatogram::setXTranslation ( const double tr )

sets x translation

Parameters

[in] tr x translation

Definition at line 62 of file TransformedChromatogram.cpp.

                                                                {
     m_trX = tr;
 }

void kome::operation::TransformedChromatogram::setYScale ( const double sc )

sets y scale

Parameters

[in] sc y scale

Definition at line 72 of file TransformedChromatogram.cpp.

                                                          {
     m_scY = std::max( sc,  1.0e-10 );
 }

void kome::operation::TransformedChromatogram::setYTranslation ( const double tr )

sets y translation

Parameters

[in] tr y translation

Definition at line 82 of file TransformedChromatogram.cpp.

                                                                {
     m_trY = tr;
 }

Member Data Documentation

kome::objects::Chromatogram& kome::operation::TransformedChromatogram::m_org

protected

original chromatogram

Definition at line 41 of file TransformedChromatogram.h.

double kome::operation::TransformedChromatogram::m_scX

protected

x scale

Definition at line 45 of file TransformedChromatogram.h.

double kome::operation::TransformedChromatogram::m_scY

protected

y scale

Definition at line 51 of file TransformedChromatogram.h.

double kome::operation::TransformedChromatogram::m_trX

protected

x translation

Definition at line 48 of file TransformedChromatogram.h.

double kome::operation::TransformedChromatogram::m_trY

protected

y translation

Definition at line 54 of file TransformedChromatogram.h.

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

DataOperation/TransformedChromatogram.h
DataOperation/TransformedChromatogram.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation