#include <OpalFilter.h>

Inheritance diagram for OpalFilter:

[legend]

Collaboration diagram for OpalFilter:

[legend]

Public Member Functions
	OpalFilter ()
	Exemplar constructor. More...

virtual	~OpalFilter ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual OpalFilter *	clone (const std::string &name)
	Make clone. More...

virtual void	execute ()
	Check the OpalFilter data. More...

virtual void	update ()
	Update the OpalFilter data. More...

void	print (std::ostream &os) const
	Print the object. More...

void	initOpalFilter ()

void	apply (std::vector< double > &histogram)

void	calc_derivative (std::vector< double > &histogram, const double &hz)

Public Member Functions inherited from Definition
virtual	~Definition ()

virtual const std::string	getCategory () const
	Return the object category as a string. More...

virtual bool	shouldTrace () const
	Trace flag. More...

virtual bool	shouldUpdate () const
	Update flag. More...

Public Member Functions inherited from Object
virtual	~Object ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual Object *	clone (const std::string &name)=0
	Return a clone. More...

void	copyAttributes (const Object &)
	Copy attributes from another object. More...

virtual void	execute ()
	Execute the command. More...

virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name. More...

virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name. More...

virtual const std::string	getCategory () const =0
	Return the object category as a string. More...

virtual bool	shouldTrace () const =0
	Trace flag. More...

virtual bool	shouldUpdate () const =0
	Update flag. More...

virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function. More...

virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function. More...

virtual void	parse (Statement &)
	Parse the object. More...

virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands. More...

virtual void	print (std::ostream &) const
	Print the object. More...

virtual void	printValue (std::ostream &) const

virtual void	printHelp (std::ostream &) const
	Print help. More...

virtual void	replace (Object oldObject, Object newObject)
	Replace references. More...

virtual void	update ()
	Update this object. More...

bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object. More...

virtual bool	isShared () const
	Shared flag. More...

virtual void	setShared (bool)
	Set/reset shared flag. More...

void	setDirty (bool)
	Set/reset the [b]modified[/b] flag. More...

bool	isDirty () const
	True, if the [b]modified[/b] flag is set. More...

void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for. More...

bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true). More...

const Object *	getBaseObject () const
	Return the object's base type object. More...

const std::string &	getOpalName () const
	Return object name. More...

Object *	getParent () const
	Return parent pointer. More...

bool	isTreeMember (const Object *subTree) const
	Test for tree membership. More...

void	setOpalName (const std::string &name)
	Set object name. More...

void	setParent (Object *)
	Set parent object. More...

void	clear ()
	Clear the occurrence counter. More...

int	increment ()
	Increment and return the occurrence counter. More...

int	occurrenceCount ()
	Return the occurrence counter. More...

void	registerReference (Invalidator *a)
	Register a reference to this object. More...

void	unregisterReference (Invalidator *a)
	Unegister a reference to this object. More...

void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

Static Public Member Functions
static OpalFilter *	find (const std::string &name)
	Find named FILTER. More...

Public Attributes
Filter *	filter_m

Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes. More...

Private Types
enum class	FilterType : unsigned short { SAVITZKYGOLAY , FIXEDFFTLOWPASS , RELATIVEFFTLOWPASS , STENCIL }

Private Member Functions
	OpalFilter (const OpalFilter &)

void	operator= (const OpalFilter &)

	OpalFilter (const std::string &name, OpalFilter *parent)

Additional Inherited Members
Protected Member Functions inherited from Definition
	Definition (int size, const char name, const char help)
	Constructor for exemplars. More...

	Definition (const std::string &name, Definition *parent)
	Constructor for clones. More...

Protected Member Functions inherited from Object
	Object (int size, const char name, const char help)
	Constructor for exemplars. More...

	Object (const std::string &name, Object *parent)
	Constructor for clones. More...

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Protected Attributes inherited from Object
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Detailed Description

Definition at line 30 of file OpalFilter.h.

Member Enumeration Documentation

◆ FilterType

enum class OpalFilter::FilterType : unsigned short

strongprivate

Enumerator
SAVITZKYGOLAY
FIXEDFFTLOWPASS
RELATIVEFFTLOWPASS
STENCIL

Definition at line 64 of file OpalFilter.h.

Constructor & Destructor Documentation

◆ OpalFilter() [1/3]

OpalFilter::OpalFilter ( )

Exemplar constructor.

Definition at line 55 of file OpalFilter.cpp.

References Object::builtin, clone(), OpalData::define(), OpalData::getInstance(), Object::itsAttr, Attributes::makePredefinedString(), Attributes::makeReal(), NLEFT_DEFAULT, NPOINTS_DEFAULT, NRIGHT_DEFAULT, POLYORDER_DEFAULT, Object::registerOwnership(), AttributeHandler::STATEMENT, Attrib::Distribution::TYPE, and update().

Referenced by clone().

Here is the call graph for this function:

◆ ~OpalFilter()

OpalFilter::~OpalFilter ( )

virtual

Definition at line 102 of file OpalFilter.cpp.

References filter_m.

◆ OpalFilter() [2/3]

OpalFilter::OpalFilter ( const OpalFilter & )

private

◆ OpalFilter() [3/3]

OpalFilter::OpalFilter	(	const std::string &	name,
		OpalFilter *	parent
	)

private

Definition at line 96 of file OpalFilter.cpp.

Member Function Documentation

◆ apply()

void OpalFilter::apply ( std::vector< double > & histogram )

inline

Definition at line 79 of file OpalFilter.h.

References Filter::apply(), and filter_m.

Here is the call graph for this function:

◆ calc_derivative()

void OpalFilter::calc_derivative	(	std::vector< double > &	histogram,
		const double &	hz
	)

inline

Definition at line 84 of file OpalFilter.h.

References Filter::calc_derivative(), and filter_m.

Here is the call graph for this function:

◆ canReplaceBy()

bool OpalFilter::canReplaceBy ( Object * object )

virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 108 of file OpalFilter.cpp.

◆ clone()

OpalFilter * OpalFilter::clone ( const std::string & name )

virtual

Make clone.

Implements Object.

Definition at line 114 of file OpalFilter.cpp.

References name, and OpalFilter().

Referenced by OpalFilter().

Here is the call graph for this function:

◆ execute()

void OpalFilter::execute ( )

virtual

Check the OpalFilter data.

Reimplemented from Object.

Definition at line 119 of file OpalFilter.cpp.

References update().

Here is the call graph for this function:

◆ find()

OpalFilter * OpalFilter::find ( const std::string & name )

static

Find named FILTER.

Definition at line 124 of file OpalFilter.cpp.

References OpalData::find(), OpalData::getInstance(), and name.

Referenced by OpalWake::initWakefunction().

Here is the call graph for this function:

◆ initOpalFilter()

void OpalFilter::initOpalFilter ( )

Definition at line 141 of file OpalFilter.cpp.

References abs(), endl(), filter_m, FIXEDFFTLOWPASS, Attributes::getReal(), Attributes::getString(), gmsg, INFOMSG, Object::itsAttr, NLEFT_DEFAULT, NRIGHT_DEFAULT, RELATIVEFFTLOWPASS, SAVITZKYGOLAY, STENCIL, and Attrib::Distribution::TYPE.

Referenced by OpalWake::initWakefunction().

Here is the call graph for this function:

◆ operator=()

void OpalFilter::operator= ( const OpalFilter & )

private

◆ print()

void OpalFilter::print ( std::ostream & msg ) const

virtual

Print the object.

Reimplemented from Object.

Definition at line 204 of file OpalFilter.cpp.

References endl(), Object::getOpalName(), Attributes::getReal(), Attributes::getString(), Object::itsAttr, and Attrib::Distribution::TYPE.

Referenced by operator<<().

Here is the call graph for this function:

◆ update()

void OpalFilter::update ( )

virtual

Update the OpalFilter data.

Reimplemented from Object.

Definition at line 135 of file OpalFilter.cpp.

References Object::getOpalName(), and Object::setOpalName().

Referenced by execute(), and OpalFilter().

Here is the call graph for this function:

Member Data Documentation

◆ filter_m

Filter* OpalFilter::filter_m

Definition at line 61 of file OpalFilter.h.

Referenced by apply(), calc_derivative(), initOpalFilter(), OpalWake::initWakefunction(), and ~OpalFilter().

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

/Users/gsell/src/OPAL/src/src/Utilities/OpalFilter.h
/Users/gsell/src/OPAL/src/src/Utilities/OpalFilter.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FilterType

Constructor & Destructor Documentation

◆ OpalFilter() [1/3]

◆ ~OpalFilter()

◆ OpalFilter() [2/3]

◆ OpalFilter() [3/3]

Member Function Documentation

◆ apply()

◆ calc_derivative()

◆ canReplaceBy()

◆ clone()

◆ execute()

◆ find()

◆ initOpalFilter()

◆ operator=()

◆ print()

◆ update()

Member Data Documentation

◆ filter_m