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

Inheritance diagram for TICFilter:

Collaboration diagram for TICFilter:

Public Member Functions
	TICFilter ()
	standard constructor More...

	TICFilter (const TICFilter &source)
	copy constructor More...

	~TICFilter () override
	destructor More...

TICFilter &	operator= (const TICFilter &source)
	assignment operator More...

template<typename SpectrumType >
double	apply (SpectrumType &spectrum)

Public Member Functions inherited from FilterFunctor
	FilterFunctor ()
	default constructor More...

	FilterFunctor (const FilterFunctor &source)
	copy constructor More...

	~FilterFunctor () override
	destructor More...

FilterFunctor &	operator= (const FilterFunctor &source)
	assignment operator More...

template<typename SpectrumType >
double	apply (SpectrumType &)
	function call operator 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...

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...

Static Public Member Functions
static FilterFunctor *	create ()

static const String	getProductName ()

Static Public Member Functions inherited from FilterFunctor
static void	registerChildren ()

Static Public Member Functions inherited from DefaultParamHandler
static void	writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="")
	Writes all parameters to meta values. More...

Additional Inherited Members
Protected Member Functions inherited from DefaultParamHandler
virtual void	updateMembers_ ()
	This method is used to update extra member variables at the end of the setParameters() method. More...

void	defaultsToParam_ ()
	Updates the parameters after the defaults have been set in the constructor. 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...

Detailed Description

TICFilter calculates TIC.

Parameters of this class are:

Name	Type	Default	Restrictions	Description
window	int	5		Windowing parameter which defines the windows size

Note:

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

Constructor & Destructor Documentation

◆ TICFilter() [1/2]

TICFilter ( )

standard constructor

◆ TICFilter() [2/2]

TICFilter ( const TICFilter & source )

copy constructor

◆ ~TICFilter()

~TICFilter ( )

override

destructor

Member Function Documentation

◆ apply()

double apply ( SpectrumType & spectrum )

inline

◆ create()

static FilterFunctor* create ( )

inlinestatic

◆ getProductName()

static const String getProductName ( )

inlinestatic

◆ operator=()

TICFilter& operator= ( const TICFilter & source )

assignment operator

Public Member Functions

Static Public Member Functions

Additional Inherited Members