LinearResampler Class Reference

Linear Resampling of raw data. More...

#include <OpenMS/FILTERING/TRANSFORMERS/LinearResampler.h>

Inheritance diagram for LinearResampler:

Collaboration diagram for LinearResampler:

Public Member Functions
	LinearResampler ()
	Constructor. More...
	~LinearResampler () override
	Destructor. More...
void	raster (MSSpectrum &spectrum)
	Applies the resampling algorithm to an MSSpectrum. More...
void	rasterExperiment (PeakMap &exp)
	Resamples the data in an MSExperiment. More...
Public Member Functions inherited from DefaultParamHandler
	DefaultParamHandler (const String &name)
	Constructor with name that is displayed in error messages. More...
	DefaultParamHandler (const DefaultParamHandler &rhs)
	Copy constructor. More...
virtual	~DefaultParamHandler ()
	Destructor. More...
virtual DefaultParamHandler &	operator= (const DefaultParamHandler &rhs)
	Assignment operator. More...
virtual bool	operator== (const DefaultParamHandler &rhs) const
	Equality operator. More...
void	setParameters (const Param &param)
	Sets the parameters. More...
const Param &	getParameters () const
	Non-mutable access to the parameters. More...
const Param &	getDefaults () const
	Non-mutable access to the default parameters. More...
const String &	getName () const
	Non-mutable access to the name. More...
void	setName (const String &name)
	Mutable access to the name. More...
const std::vector< String > &	getSubsections () const
	Non-mutable access to the registered subsections. More...
Public Member Functions inherited from ProgressLogger
	ProgressLogger ()
	Constructor. More...
	~ProgressLogger ()
	Destructor. More...
	ProgressLogger (const ProgressLogger &other)
	Copy constructor. More...
ProgressLogger &	operator= (const ProgressLogger &other)
	Assignment Operator. More...
void	setLogType (LogType type) const
	Sets the progress log that should be used. The default type is NONE! More...
LogType	getLogType () const
	Returns the type of progress log being used. More...
void	startProgress (SignedSize begin, SignedSize end, const String &label) const
	Initializes the progress display. More...
void	setProgress (SignedSize value) const
	Sets the current progress. More...
void	endProgress () const
	Ends the progress display. More...
void	nextProgress () const
	increment progress by 1 (according to range begin-end) More...

Protected Member Functions
void	updateMembers_ () override
	This method is used to update extra member variables at the end of the setParameters() method. More...
Protected Member Functions inherited from DefaultParamHandler
void	defaultsToParam_ ()
	Updates the parameters after the defaults have been set in the constructor. More...

Protected Attributes
double	spacing_
	Spacing of the resampled data. More...
Protected Attributes inherited from DefaultParamHandler
Param	param_
	Container for current parameters. More...
Param	defaults_
	Container for default parameters. This member should be filled in the constructor of derived classes! More...
std::vector< String >	subsections_
	Container for registered subsections. This member should be filled in the constructor of derived classes! More...
String	error_name_
	Name that is displayed in error messages during the parameter checking. More...
bool	check_defaults_
	If this member is set to false no checking if parameters in done;. More...
bool	warn_empty_defaults_
	If this member is set to false no warning is emitted when defaults are empty;. More...
Protected Attributes inherited from ProgressLogger
LogType	type_
time_t	last_invoke_
ProgressLoggerImpl *	current_logger_

Additional Inherited Members
Public Types inherited from ProgressLogger
enum	LogType { CMD, GUI, NONE }
	Possible log types. More...
Static Public Member Functions inherited from DefaultParamHandler
static void	writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &prefix="")
	Writes all parameters to meta values. More...
Static Protected Member Functions inherited from ProgressLogger
static String	logTypeToFactoryName_ (LogType type)
	Return the name of the factory product used for this log type. More...
Static Protected Attributes inherited from ProgressLogger
static int	recursion_depth_

Detailed Description

Linear Resampling of raw data.

This class can be used to generate uniform data from non-uniform raw data (e.g. ESI-TOF or MALDI-TOF experiments). Therefore the intensity at every position x in the input raw data is spread to the two adjacent resampling points. This method preserves the area of the input signal and also the centroid position of a peak. Therefore it is recommended for quantitation as well as for ProteinIdentification experiments.

Note

Use this method only for high resolution data (< 0.1 Th between two adjacent raw data points). The resampling rate should be >= the precision.

Parameters of this class are:

Name	Type	Default	Restrictions	Description
spacing	float	0.05		Spacing of the resampled output peaks.

Note:

• If a section name is documented, the documentation is displayed as tooltip.
• Advanced parameter names are italic.

Constructor & Destructor Documentation

LinearResampler()

LinearResampler ( )

inline

Constructor.

~LinearResampler()

~LinearResampler ( )

inlineoverride

Destructor.

Member Function Documentation

raster()

void raster ( MSSpectrum &  spectrum )

inline

Applies the resampling algorithm to an MSSpectrum.

rasterExperiment()

void rasterExperiment ( PeakMap &  exp )

inline

Resamples the data in an MSExperiment.

References MSExperiment::size().

updateMembers_()

void updateMembers_ ( )

inlineoverrideprotectedvirtual

This method is used to update extra member variables at the end of the setParameters() method.

Also call it at the end of the derived classes' copy constructor and assignment operator.

The default implementation is empty.

Reimplemented from DefaultParamHandler.

Reimplemented in LinearResamplerAlign.

Member Data Documentation

spacing_

double spacing_

protected

Spacing of the resampled data.