Pipe

In file FilterBase/Pipe.hh:

class Pipe : public FilterBase

Pipe API

Inheritance:

Public Methods
Protected Methods

Inherited from FilterBase:

Public Methods
virtual bool rootGetStartTime(Time& t) const throw()
virtual bool rootGetCurrentTime(Time& t) const throw()

Documentation

Abstract base class for Pipes: filters that act on and return a single TSeries.

virtual ~Pipe()

Filter destructor

virtual Pipe* clone(void) const

Create an identical filter and return the pointer to the cloned object or zero if the object is unclonable..

Returns:: Pointer to the cloned object,

virtual TSeries operator)(const TSeries& in)

Process the input, returning result in an output container. Synonym for apply() method.

Parameters:: in - TSeries being acted on.

FilterIO& operator)(const FilterIO& in)

Process the input, returning result in an output container. Synonym for apply() method.

Parameters:: in - TSeries being acted on.

virtual TSeries apply(const TSeries& in)

Process the input returning the output in an output container. Synonymous with operator() method.

Parameters:: in - The TSeries being acted on.

FilterIO& apply(const FilterIO& in)

Process the input returning the output in an output container. Synonymous with operator() method.

Parameters:: in - The TSeries being acted on.

virtual void dataCheck(const TSeries& in) const

Validate filter input. The input container is checked for completeness, continuity, consistency and other criteria specific to a given instance. Throws an appropriate exception on invalid input. For an exception-less version, see isDataValid().

Parameters:: in - TSeries to validate

void dataCheck(const FilterIO& in) const

Validate filter input. The input container is checked for completeness, continuity, consistency and other criteria specific to a given instance. Throws an appropriate exception on invalid input. For an exception-less version, see isDataValid().

Parameters:: in - TSeries to validate

virtual bool isDataValid(const TSeries& in) const

Validate filter input without throwing exceptions. The input container is checked for completeness, continuity, consistency and other criteria specific to a given instance. Does not throw an exception, so safe for use in root.

Parameters:: in - TSeries to validate

virtual void reset(void)

Reset the filter history.

virtual bool inUse(void) const

Test whether the filter is being used. A filter is defined as being in use if the filter has been applied to one or more time series since the filter was constructed or reset. The filter state generally reflects the application of the filters but need not.

Returns:: true if the filter is in use.

KeyChain& getInputKeys(void) const

Return a KeyChain for input TSeries. Use these keys to fill a FilterIO container with TSeries, optionally validates the container and contents with dataCheck(), and act on the input with apply().

KeyChain& getOutputKeys(void) const

Return a KeyChain for output TSeries. Use the keys on this chain to retrieve output TSeries from output FilterIO container.

virtual Time getStartTime(void) const

Get the time of the first sample processed after the most recent reset.

virtual Time getCurrentTime(void) const

Get the time of the expected next sample to be processed.

Returns:: Time of next expected sample.

virtual Interval getTimeDelay(void) const

Get the time delay imposed by the Filter. The time delay is only non-zero for filters that have a well defined delay i.e. FIR filters. A positive value indicates that the filter delays a signal by the specified time.

Returns:: Signal time delay.

virtual bool Xfer(fComplex& coeff, double f) const

The transfer coefficient of the filter at the specified frequency is calculated and returned as a complex number. Filters that support a fast way to compute a transfer coefficient should override xfer rather than this method.

Returns:: true if successful
Parameters:: coeff - a complex number representing the Filter response at the specified frequency (return)
f - Frequency at which to sample the transfer function.

virtual bool Xfer(fComplex* tf, const float* freqs, int points) const

The transfer function of the filter at the specified frequency points is calculated and returned as a complex array. The frequency points are user supplied. The return array must be at least of length points. Filters that support a fast way to compute a transfer coefficient should override xfer rather than this method.

Returns:: true if successful
Parameters:: tf - Transfer function (return)
freqs - Frequency points
points - Number of points.

virtual bool Xfer(FSeries& Fs, float Fmin = 0.0, float Fmax = 1000.0, float dF = 1.0) const

The transfer function of the filter in the specified frequency interval is calculated and returned as a complex frequency series. Filters that support a fast way to compute a transfer coefficient should override xfer rather than this method.

Returns:: true if successful
Parameters:: Fs - a complex FSeries containing the Filter response at each frequency step.
Fmin - Minimum frequency at which to sample the transfer function.
Fmax - Maximum frequency at which to sample the transfer function.
dF - Frequency step.

virtual bool xfer(fComplex& coeff, double f) const

The transfer coefficient of the filter at the specified frequency is calculated and returned as a complex number. Filters that support a fast way to compute a transfer coefficient should implement this method and return true.

Returns:: true if successful
Parameters:: coeff - a complex number representing the Filter response at the specified frequency (return)
f - Frequency at which to sample the transfer function.

Direct child classes:: Window
LineFilter
Limiter
IIRFilter
FIRFilter
BaseLine
MultiRate
Mixer
DecimateBy2
MultiPipe

Author:: Lee Samuel Finn <LSF5@PSU.Edu>
Version:

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++