casacore::MarshButterworthBandpass< T > Class Template Reference

A Butterworth function class that supports serialization. More...

#include <MarshButterworthBandpass.h>

Inheritance diagram for casacore::MarshButterworthBandpass< T >:

Public Types
enum	FieldNames { BPASS, ORDER, PEAK, NFieldNames }
	definitions of the fields stored in a serialized Record. More...
Public Member Functions
	MarshButterworthBandpass ()
	create a zero-th order (all-pass) Butterworth bandpass.
	MarshButterworthBandpass (uInt minord, uInt maxord, T mincut=T(-1), T maxcut=T(1), T center=T(0), T peak=T(1))
	create a Butterworth bandpass function.
	MarshButterworthBandpass (const Record &gr) throw (InvalidSerializationError)
	create a fully specified Butterworth polynomial from parameters stored in a Record.
	MarshButterworthBandpass (const SimButterworthBandpass< T > &other)
	create a deep copy of another Butterworth polynomial
	MarshButterworthBandpass (const MarshButterworthBandpass< T > &other)
MarshButterworthBandpass< T > &	operator= (const MarshButterworthBandpass< T > &other)
	make a (deep) copy of another Butterworth polynomial
MarshButterworthBandpass< T > &	operator= (const SimButterworthBandpass< T > &other)
virtual	~MarshButterworthBandpass ()
	Destructor.
virtual void	store (Record &gr) const
	store the state of this Function into a Record
virtual Function< T > *	clone () const
	Create a copy of this object.
Static Public Attributes
static const String	FUNCTYPE
static const String	FUNCFIELDS []

Detailed Description

template<class T>
class casacore::MarshButterworthBandpass< T >

A Butterworth function class that supports serialization.

Intended use:

Public interface

Prerequisite

Function

Etymology

"Marsh" is short for "Marshallable" which means that the class can be serialized into a form that can be transmitted to another execution context. "ButterBandpass" refers to its parent class: SimButterworthBandpass.

Synopsis

This class is a specialization of SimButterworthBandpass class that supports serialization. That is, it allows one to write the state of the SimButterworthBandpass function object into a Record. This record can then be transmitted to another execution context where it can be "reconstituted" as a new object with identical state as this one. This documentation focusses on this serialization functionality (also known as "marshalling"); for details about the general features of this Butterworth function, see the SimButterworthBandpass class.

Example

Motivation

Making SimButterworthBandpass Marshallable provides a convenient way of configuring the simulator tool from .

Thrown Exceptions

Assertion in debug mode if attempt is made to address incorrect coefficients

Definition at line 87 of file MarshButterworthBandpass.h.

Member Enumeration Documentation

template<class T>

enum casacore::MarshButterworthBandpass::FieldNames

definitions of the fields stored in a serialized Record.

The actual string names are stored in FUNCFIELDS

Enumerator:

BPASS	the minimum cutoff, center, and maximum cutoff values
ORDER	the orders of the transitions between pass and no-pass
PEAK	the peak value
NFieldNames	the number of supported fields

Definition at line 96 of file MarshButterworthBandpass.h.

Constructor & Destructor Documentation

template<class T>

casacore::MarshButterworthBandpass< T >::MarshButterworthBandpass ( ) [inline]

create a zero-th order (all-pass) Butterworth bandpass.

Definition at line 109 of file MarshButterworthBandpass.h.

template<class T>

casacore::MarshButterworthBandpass< T >::MarshButterworthBandpass	(	uInt	minord,
		uInt	maxord,
		T	mincut = `T(-1)`,
		T	maxcut = `T(1)`,
		T	center = `T(0)`,
		T	peak = `T(1)`
	)			`[inline]`