filter class More...

#include <Filter.h>

Inheritance diagram for kome::operation::Filter:

Collaboration diagram for kome::operation::Filter:

Public Member Functions
	Filter ()
	constructor

virtual	~Filter ()
	destructor

void	setFilterInfo (kome::plugin::PluginCall func, kome::objects::SettingParameterValues settings)
	sets filter information More...

Public Member Functions inherited from kome::objects::XYDataOperation
	XYDataOperation ()
	constructor

virtual	~XYDataOperation ()
	destructor

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

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

void	setIndex (int index)
	set index More...

int	getIndex ()
	get index More...

void	update (kome::core::XYData &src, kome::core::XYData &dst, Chromatogram &chrom)
	updates xy data More...

void	update (kome::core::XYData &src, kome::core::XYData &dst, Spectrum &spec)
	updates xy data More...

void	update (kome::core::XYData &src, kome::core::XYData &dst, Sample &sample)
	updates xy data More...

Protected Member Functions
void	init ()
	initializes

virtual void	getUpdatedData (kome::core::XYData &src, kome::core::XYData &dst)
	gets updated data points More...

virtual void	onUpdate (kome::core::XYData &src, kome::core::XYData &dst, kome::objects::Chromatogram &chrom)
	This method is called by update method. (override method) More...

virtual void	onUpdate (kome::core::XYData &src, kome::core::XYData &dst, kome::objects::Spectrum &spec)
	This method is called by update method. (override method) More...

virtual void	onUpdate (kome::core::XYData &src, kome::core::XYData &dst, kome::objects::Sample &sample)
	This method is called by update method. (override method) More...

Protected Attributes
kome::plugin::PluginCall *	m_fun

kome::objects::SettingParameterValues	m_settings

Protected Attributes inherited from kome::objects::XYDataOperation
std::string	m_name

int	m_index

Detailed Description

filter class

Definition at line 32 of file Filter.h.

Member Function Documentation

void kome::operation::Filter::getUpdatedData	(	kome::core::XYData &	src,
		kome::core::XYData &	dst
	)

protectedvirtual

gets updated data points

Parameters

[in]	src	source xy data
[out]	dst	the object to store updated xy data

Definition at line 91 of file Filter.cpp.

   {
     // check the member
     if( m_fun == NULL ) {
         LOG_WARN( FMT( "The filter function is not assigned." ) );
         return;
     }
 
     // check the parameter
     if( src.getLength() == 0 ) {
         return;
     }
 
     // parameters
     kome::objects::Parameters params;
 
     kome::plugin::PluginCallTool::setXYData( params, src );
     kome::plugin::PluginCallTool::setUpdatedXYData( params, dst );
     kome::plugin::PluginCallTool::setSettingValues( params, m_settings );
 
     try {
         m_fun->invoke( &params );
     }
     catch( ... ) {
     }
 }

Here is the call graph for this function:

void kome::operation::Filter::onUpdate	(	kome::core::XYData &	src,
		kome::core::XYData &	dst,
		kome::objects::Chromatogram &	chrom
	)

protectedvirtual

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

Parameters

[in]	src	source xy data
[out]	dst	the object to store updated xy data
[in]	chrom	chromatogram

Implements kome::objects::XYDataOperation.

Definition at line 121 of file Filter.cpp.

   {
     getUpdatedData( src, dst );
 }

Here is the call graph for this function:

void kome::operation::Filter::onUpdate	(	kome::core::XYData &	src,
		kome::core::XYData &	dst,
		kome::objects::Spectrum &	spec
	)

protectedvirtual

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

Parameters

[in]	src	source xy data
[out]	dst	the object to store updated xy data
[in]	spec	spectrum

Implements kome::objects::XYDataOperation.

Definition at line 130 of file Filter.cpp.

   {
     getUpdatedData( src, dst );
 }

Here is the call graph for this function:

void kome::operation::Filter::onUpdate	(	kome::core::XYData &	src,
		kome::core::XYData &	dst,
		kome::objects::Sample &	sample
	)

protectedvirtual

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

Parameters

[in]	src	source xy data
[out]	dst	the object to store updated xy data
[in]	sample	sample

Implements kome::objects::XYDataOperation.

Definition at line 139 of file Filter.cpp.

   {
     getUpdatedData( src, dst );
 }

Here is the call graph for this function:

void kome::operation::Filter::setFilterInfo	(	kome::plugin::PluginCall *	func,
		kome::objects::SettingParameterValues *	settings
	)

sets filter information

Parameters

[in]	func	filter function
[in]	settings	setting parameter values

Definition at line 48 of file Filter.cpp.

                                                                                                     {
     // initialize
     init();
     if( func == NULL ) {
         return;
     }
 
     // set information
     m_fun = func;
     if( settings != NULL ) {
         m_settings = *settings;
     }
 
     // item
     kome::plugin::PluginFunctionItem item;
     item.setInfo( func );
 
     // set name
     std::string name = FMT( "Filter [%s", item.getLongName() );
     std::string paramStr;
     for( unsigned int i = 0; i < m_settings.getNumberOfParameters(); i++ ) {
         // add parameter name
         if( !paramStr.empty() ) {
             paramStr.append( ", " );
         }
 
         std::string name = m_settings.getParameterName( i );
         std::string value = m_settings.getParameterValue( i );
 
         paramStr.append( FMT( "%s=%s", name.c_str(), value.c_str() ) );
     }
 
     if( paramStr.empty() ) {
         name.append( "]" );
     }
     else {
         name.append( FMT( "(%s)]", paramStr.c_str() ) );
     }
 
     setName( name.c_str() );
 }