transformed spectrum class More...

#include <TransformedSpectrum.h>

Inheritance diagram for kome::operation::TransformedSpectrum:

Collaboration diagram for kome::operation::TransformedSpectrum:

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

virtual	~TransformedSpectrum ()
	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::Spectrum
	Spectrum (Sample sample, const char name)
	constructor More...

virtual	~Spectrum ()
	destructor

void	setId (int id)
	sets spectrum id More...

int	getId ()
	gets spectrum id More...

void	setOperationFlag (const bool op)
	sets the operation flag value More...

bool	getOperationFlag ()
	gets the operation flag value More...

Sample *	getSample ()
	gets the sample that has this spectrum More...

void	setName (const char *name)
	sets spectrum name More...

const char *	getName ()
	gets spectrum name More...

void	setRt (const double rt)
	sets retention time More...

void	setRt (const double startRt, const double endRt)
	gets retention time More...

void	setStartRt (const double rt)
	sets start retention time More...

void	setEndRt (const double rt)
	sets end retention time More...

double	getRt ()
	gets retention time More...

double	getStartRt ()
	gets the start of retention time More...

double	getEndRt ()
	gets the end of retention time More...

void	setSpecType (const char *type)
	sets spectrum type More...

const char *	getSpecType ()
	gets spectrum type More...

void	setTitle (const char *title)
	sets spectrum title More...

const char *	getTitle ()
	gets spectrum title More...

void	setIcon (const char *icon)
	sets icon name More...

const char *	getIcon ()
	gets icon name 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 data points More...

void	getXYData (kome::core::XYData *const xyData, const double minX, const double maxX, const bool zero)
	gets data points that spectrum has More...

void	setXRange (const double minX, const double maxX)
	sets x range More...

void	setMinX (const double minX)
	sets min x More...

double	getMinX ()
	gets min x More...

void	setMaxX (const double maxX)
	sets max x More...

double	getMaxX ()
	gets max x More...

void	setTotalIntensity (const double intensity)
	sets total intensity of spectrum More...

double	getTotalIntensity (const double minX=-1.0, const double maxX=-1.0)
	gets total intensity in specified range More...

void	setMaxIntensity (const double intensity)
	sets max intensity of spectrum More...

double	getMaxIntensity (const double minX=-1.0, const double maxX=-1.0)
	gets max intensity in specified range More...

void	setBasePeakMass (const double mass)
	sets base peak mass More...

double	getBasePeakMass ()
	gets base peak mass More...

void	setMsStage (const int stage)
	sets ms stage More...

int	getMsStage ()
	gets ms stage More...

void	setPrecursor (const int stage, const double precursor)
	sets precursor More...

void	setPrecursor (const double precursor)
	sets precursor More...

double	getPrecursor (const int stage)
	gets precursor More...

double	getPrecursor ()
	gets the precursor mass of precursor ion spectrum. More...

void	setPrecursorIntensity (const int stage, const double intensity)
	sets precursor intensity More...

void	setPrecursorIntensity (const double intensity)
	sets precursor intensity More...

double	getPrecursorIntensity (const int stage)
	gets the precursor intensity More...

double	getPrecursorIntensity ()
	gets the precursor intensity of the precursor ion spectrum. More...

void	setPrecursorCharge (const int charge)
	sets the precursor charge More...

int	getPrecursorCharge ()
	gets the precursor charge More...

void	setParentSpectrum (Spectrum *const parent)
	sets parent spectrum More...

Spectrum *	getParentSpectrum ()
	gets parent spectrum More...

void	getChildSpectra (std::vector< Spectrum * > &children)
	gets child spectra More...

void	setHasChromatogram (const bool chromatogram)
	sets wheher this spectrum has chromatogram More...

bool	hasChromatogram ()
	judges whether this spectrum has chromatogram More...

void	setGroup (DataGroupNode *group)
	sets spectrum group More...

DataGroupNode *	getGroup ()
	gets spectrum group More...

void	setScanNumber (const int scan)
	sets scan number More...

int	getScanNumber ()
	gets scan number More...

void	setPolarity (Polarity polarity)
	sets polarity More...

Polarity	getPolarity ()
	gets polarity More...

void	setCentroidMode (const bool centroidMode)
	sets centroid mode or not More...

bool	isCentroidMode ()
	judget wheter this spectrum is centroid mode More...

void	setResolution (const double resolution)
	sets resolution More...

double	getResolution ()
	gets resolution More...

void	setCollisionEnergy (const char *collisionEnergy)
	sets the collision energy More...

const char *	getCollisionEnergy ()
	gets the collision energy More...

void	setVisible (const bool visible)
	sets the visible flag More...

bool	isVisible ()
	gets the visible flag value More...

void	setAutoZeroPoints (const bool autoZero)
	sets auto zero points flag value More...

bool	isAutoZeroPoints ()
	gets auto zero points flag value More...

kome::core::Properties &	getProperties ()
	gets properties More...

kome::core::Properties &	getUserProperties ()
	gets user properties More...

void	setOrgSpectrum (Spectrum *spec)
	sets original spectrum More...

Spectrum *	getOrgSpectrum ()
	gets original spectrum More...

void	getProperties (kome::core::Properties &properties)
	gets spectrum and spectrum group properties More...

void	getUserProperties (kome::core::Properties &userProperties)
	gets spectrum and spectrum group user properties More...

void	setSpotId (const char *pcSpotId)
	set spot id param[in] pcSpotId SpotId information

const char *	getSpotId (void)
	get spot id More...

void	setRequestLoadData (void)
	set the flag of request load data More...

void	resetRequestLoadData (void)

bool	isRequestLoadData (void)
	check the flag of request load data More...

void	setFirstAccess (void)
	set the flag of first access

void	resetFirstAccess (void)
	reset the flag of first access

bool	isFirstAccess (void)
	check the flag of first access More...

bool	loadData (void)
	load data More...

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

virtual void	onGetXRange (double minX, double maxX)
	This method is called by getMinX or getMaxX method. (override method) More...

virtual double	onGetTotalIntensity (const double minX, const double maxX)
	This method is called by getTotalIntensity method. (override method) More...

virtual double	onGetMaxIntensity (const double minX, const double maxX)
	This method is called by getMaxIntensity method. (override method) More...

virtual void	onSetRequestLoadData (void)
	This method is called by setRequestLoadData method. (abstract method)

virtual void	onResetRequestLoadData (void)
	This method is called by resetRequestLoadData method. (abstract method)

virtual bool	onIsRequestLoadData (void)
	This method is called by isRequestLoadData method. (abstract method) More...

virtual void	onSetFirstAccess (void)
	This method is called by setFirstAccess method. (abstract method)

virtual void	onResetFirstAccess (void)
	This method is called by resetFirstAccess method. (abstract method)

virtual bool	onIsFirstAccess (void)
	This method is called by isFirstAccess method. (abstract method) More...

virtual bool	onLoadData (void)
	This method is called by loadData method. (abstract method) More...

Protected Member Functions inherited from kome::objects::Spectrum
bool	firstAccessProcess (void)
	method for processing when accessing the first item of this class More...

Protected Attributes
kome::objects::Spectrum &	m_org

double	m_scX

double	m_trX

double	m_scY

double	m_trY

Protected Attributes inherited from kome::objects::Spectrum
Spectrum *	m_orgSpec

bool	m_op

int	m_specId

Additional Inherited Members
Public Types inherited from kome::objects::Spectrum
enum	Polarity { POLARITY_UNKNOWN = 0, POLARITY_POSITIVE = 1, POLARITY_NEGATIVE = 2 }
	polarity definition

Static Public Member Functions inherited from kome::objects::Spectrum
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::Spectrum
static std::vector< std::string >	m_commonProps

Detailed Description

transformed spectrum class

Definition at line 23 of file TransformedSpectrum.h.

Constructor & Destructor Documentation

kome::operation::TransformedSpectrum::TransformedSpectrum	(	kome::objects::Spectrum &	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 TransformedSpectrum.cpp.

         : kome::objects::Spectrum( org.getSample(), org.getName() ), 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() );
     setRt( org.getRt() );
     setStartRt( org.getStartRt() );
     setEndRt( org.getEndRt() );
     setSpecType( org.getSpecType() );
     setTitle( org.getTitle() );
     setIcon( org.getIcon() );
     setMinX( org.getMinX() );
     setMaxX( org.getMaxX() );
     setTotalIntensity( org.getTotalIntensity() );
     setBasePeakMass( org.getBasePeakMass() );
     setMsStage( org.getMsStage() );
     setPrecursor( org.getPrecursor() );
     setPrecursorIntensity( org.getPrecursorIntensity() );
     setParentSpectrum( org.getParentSpectrum() );
     setHasChromatogram( org.hasChromatogram() );
     setGroup( org.getGroup() );
     setScanNumber( org.getScanNumber() );
     setPolarity( org.getPolarity() );
     setCentroidMode( org.isCentroidMode() );
     setResolution( org.getResolution() );
     setOrgSpectrum( org.getOrgSpectrum() );
 }

Here is the call graph for this function:

Member Function Documentation

double kome::operation::TransformedSpectrum::getXScale ( )

gets x scale

Returns: x scale

Definition at line 70 of file TransformedSpectrum.cpp.

                                       {
     return m_scX;
 }

double kome::operation::TransformedSpectrum::getXTranslation ( )

gets x translation

Returns: x translation

Definition at line 80 of file TransformedSpectrum.cpp.

                                             {
     return m_trX;
 }

double kome::operation::TransformedSpectrum::getYScale ( )

gets y scale

Returns: y scale

Definition at line 90 of file TransformedSpectrum.cpp.

                                       {
     return m_scY;
 }

double kome::operation::TransformedSpectrum::getYTranslation ( )

gets y translation

Returns: y translation

Definition at line 100 of file TransformedSpectrum.cpp.

                                             {
     return m_trY;
 }

double kome::operation::TransformedSpectrum::onGetMaxIntensity	(	const double	minX,
		const double	maxX
	)

protectedvirtual

This method is called by getMaxIntensity method. (override method)

Parameters

[in]	minX	minimum x of range (If minX is negative number, minimum x value is unbounded.)
[in]	maxX	maximum x of range (If maxX is negative number, maximum x value is unbounded.)

Returns: max intensity

Implements kome::objects::Spectrum.

Definition at line 161 of file TransformedSpectrum.cpp.

                                                                                     {
     // x range
     double orgMinX = minX;
     if( orgMinX >= 0.0 ) {
         orgMinX = std::max( ( minX - m_trX ) / m_scX, 0.0 );
     }
 
     double orgMaxX = maxX;
     if( orgMaxX >= 0.0 ) {
         orgMaxX = std::max( ( maxX - m_trX ) / m_scX, 0.0 );
     }
 
     // max intensity
     double intensity = m_org.getMaxIntensity( orgMinX, orgMaxX );
     intensity = m_scY * intensity + m_trY;
 
     return intensity;
 }

Here is the call graph for this function:

double kome::operation::TransformedSpectrum::onGetTotalIntensity	(	const double	minX,
		const double	maxX
	)

protectedvirtual

This method is called by getTotalIntensity method. (override method)

Parameters

[in]	minX	minimum x of range (If minX is negative number, minimum x value is unbounded.)
[in]	maxX	maximum x of range (If maxX is negative number, maximum x value is unbounded.)

Returns: total intensity

Implements kome::objects::Spectrum.

Definition at line 141 of file TransformedSpectrum.cpp.

                                                                                       {
     // x range
     double orgMinX = minX;
     if( orgMinX >= 0.0 ) {
         orgMinX = std::max( ( minX - m_trX ) / m_scX, 0.0 );
     }
 
     double orgMaxX = maxX;
     if( orgMaxX >= 0.0 ) {
         orgMaxX = std::max( ( maxX - m_trX ) / m_scX, 0.0 );
     }
 
     // total intensity
     double intensity = m_org.getTotalIntensity( orgMinX, orgMaxX );
     intensity = m_scY * intensity + m_trY;
 
     return intensity;
 }

Here is the call graph for this function:

void kome::operation::TransformedSpectrum::onGetXRange	(	double *	minX,
		double *	maxX
	)

protectedvirtual

This method is called by getMinX or getMaxX method. (override method)

Parameters

[out]	minX	the pointer to store minimum x value
[out]	maxX	the pointer to store maximum x value

Implements kome::objects::Spectrum.

Definition at line 126 of file TransformedSpectrum.cpp.

                                                                   {
     // get original x range
     double orgMinX = m_org.getMinX();
     double orgMaxX = m_org.getMaxX();
 
     // get range
     if( minX != NULL ) {
         *minX = m_scX * orgMinX + m_trX;
     }
     if( maxX != NULL ) {
         *maxX = m_scX * orgMaxX + m_trX;
     }
 }

Here is the call graph for this function:

void kome::operation::TransformedSpectrum::onGetXYData	(	kome::core::XYData *const	xyData,
		const double	minX,
		const double	maxX
	)

protectedvirtual

This method is called by getXYData method. (override method)

Parameters

[out]	xyData	the object to store data points
[in]	minX	minimum x value. (If minX is negative number, minimum x value is not unbounded.)
[in]	maxX	maximum x value. (If maxX is negative number, maximum x value is not unbounded.)

Implements kome::objects::Spectrum.

Definition at line 105 of file TransformedSpectrum.cpp.

   {
     // get points
     kome::core::DataPoints dps;
     m_org.getXYData( &dps, m_op );
 
     // transform
     for( unsigned int i = 0; i < dps.getLength(); i++ ) {
         const double x = m_scX * dps.getX( i ) + m_trX;
         const double y = m_scY * dps.getY( i ) + m_trY;
 
         if( ( minX < 0.0 || x >= minX ) && ( maxX < 0.0 || x <= maxX ) ) {
             xyData->addPoint( x, y );
         }
     }
 }

Here is the call graph for this function:

bool kome::operation::TransformedSpectrum::onIsFirstAccess ( void )

protectedvirtual

This method is called by isFirstAccess method. (abstract method)

Returns: If true, the first accessing.

Reimplemented from kome::objects::Spectrum.

Definition at line 213 of file TransformedSpectrum.cpp.

 {
     return  kome::objects::Spectrum::onIsFirstAccess( );
 }

Here is the call graph for this function:

bool kome::operation::TransformedSpectrum::onIsRequestLoadData ( void )

protectedvirtual

This method is called by isRequestLoadData method. (abstract method)

Returns: If true, file read request is valid.

Reimplemented from kome::objects::Spectrum.

Definition at line 195 of file TransformedSpectrum.cpp.

 {
     return  kome::objects::Spectrum::onIsRequestLoadData( );
 }

Here is the call graph for this function:

bool kome::operation::TransformedSpectrum::onLoadData ( void )

protectedvirtual

This method is called by loadData method. (abstract method)

Returns: If true, file reading success.

Reimplemented from kome::objects::Spectrum.

Definition at line 219 of file TransformedSpectrum.cpp.

 {
     return  kome::objects::Spectrum::onLoadData( );
 }

Here is the call graph for this function:

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

sets x scale

Parameters

[in] sc x scale

Definition at line 65 of file TransformedSpectrum.cpp.

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

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

sets x translation

Parameters

[in] tr x translation

Definition at line 75 of file TransformedSpectrum.cpp.

                                                            {
     m_trX = tr;
 }

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

sets y scale

Parameters

[in] sc y scale

Definition at line 85 of file TransformedSpectrum.cpp.

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

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

sets y translation

Parameters

[in] tr y translation

Definition at line 95 of file TransformedSpectrum.cpp.

                                                            {
     m_trY = tr;
 }

Member Data Documentation

kome::objects::Spectrum& kome::operation::TransformedSpectrum::m_org

protected

original spectrum

Definition at line 41 of file TransformedSpectrum.h.

double kome::operation::TransformedSpectrum::m_scX

protected

x scale

Definition at line 45 of file TransformedSpectrum.h.

double kome::operation::TransformedSpectrum::m_scY

protected

y scale

Definition at line 51 of file TransformedSpectrum.h.

double kome::operation::TransformedSpectrum::m_trX

protected

x translation

Definition at line 48 of file TransformedSpectrum.h.

double kome::operation::TransformedSpectrum::m_trY

protected

y translation

Definition at line 54 of file TransformedSpectrum.h.

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

DataOperation/TransformedSpectrum.h
DataOperation/TransformedSpectrum.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation