#include <VLAFrequencyFilter.h>

Inheritance diagram for VLAFrequencyFilter:

Public Member Functions
	VLAFrequencyFilter ()
	The default constructor creates a filter that does not filter anything.
	VLAFrequencyFilter (const MVFrequency &centreFrequency, const MVFrequency &bandwidth)
	Creates a filter that filters all records except those where any of the observed data are within the specified band.
	VLAFrequencyFilter (const VLAFrequencyFilter &other)
	The copy constructor uses copy semantics.
virtual	~VLAFrequencyFilter ()
	The destructor is trivial.
VLAFrequencyFilter &	operator= (const VLAFrequencyFilter &other)
	The assignment operator uses copy semantics.
void	refFrequency (const MVFrequency &refFrequency)
	set the reference frequency.
void	bandwidth (const MVFrequency &bandwidth)
	set the bandwidth.
virtual Bool	passThru (const VLALogicalRecord &record) const
	returns True if the supplied record contains any data that is between the specified start and end frequencies.
virtual VLAFilter *	clone () const
	Return a pointer to a copy of the VLAFrequencyFilter object upcast to a VLAFilter object.
virtual Bool	ok () const
	Function which checks the internal data of this class for correct dimensionality and consistant values.
Private Attributes
Double	itsTopEdge
Double	itsBottomEdge

Detailed Description

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd</dl>

Prerequisite

SomeClass
SomeOtherClass
some concept

Etymology

Synopsis

Note the start and stop frequencys are the values at the center if the integration.

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

add this feature
fix this bug
start discussion of this possible extension

Definition at line 86 of file VLAFrequencyFilter.h.

Constructor & Destructor Documentation

VLAFrequencyFilter::VLAFrequencyFilter ( )

The default constructor creates a filter that does not filter anything.

ie., the passThru() function always returns True;

VLAFrequencyFilter::VLAFrequencyFilter	(	const MVFrequency &	centreFrequency,
		const MVFrequency &	bandwidth
	)

Creates a filter that filters all records except those where any of the observed data are within the specified band.

The frequency frame is assumed to be topocentric.

VLAFrequencyFilter::VLAFrequencyFilter ( const VLAFrequencyFilter & other )

The copy constructor uses copy semantics.

virtual VLAFrequencyFilter::~VLAFrequencyFilter ( ) [virtual]

The destructor is trivial.

Member Function Documentation

void VLAFrequencyFilter::bandwidth ( const MVFrequency & bandwidth )

set the bandwidth.

virtual VLAFilter* VLAFrequencyFilter::clone ( ) const [virtual]

Return a pointer to a copy of the VLAFrequencyFilter object upcast to a VLAFilter object.

The class that uses this function is responsible for deleting the pointer. This is used to implement a virtual copy constructor.

Implements VLAFilter.

virtual Bool VLAFrequencyFilter::ok ( ) const [virtual]

Function which checks the internal data of this class for correct dimensionality and consistant values.

Returns True if everything is fine otherwise returns False.

Reimplemented from VLAFilter.

VLAFrequencyFilter& VLAFrequencyFilter::operator= ( const VLAFrequencyFilter & other )

The assignment operator uses copy semantics.

virtual Bool VLAFrequencyFilter::passThru ( const VLALogicalRecord & record ) const [virtual]

returns True if the supplied record contains any data that is between the specified start and end frequencies.

Implements VLAFilter.

void VLAFrequencyFilter::refFrequency ( const MVFrequency & refFrequency )

set the reference frequency.

Member Data Documentation

Double VLAFrequencyFilter::itsBottomEdge [private]

Definition at line 131 of file VLAFrequencyFilter.h.

Double VLAFrequencyFilter::itsTopEdge [private]

Definition at line 130 of file VLAFrequencyFilter.h.

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

code/nrao/VLA/VLAFrequencyFilter.h

Public Member Functions

Private Attributes