VLAFrequencyFilter Class Reference

#include <VLAFrequencyFilter.h>

Inheritance diagram for VLAFrequencyFilter:

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

Private Attributes
casacore::Double	itsTopEdge
casacore::Double	itsBottomEdge

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

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 90 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 casacore::MVFrequency &	centreFrequency,
		const casacore::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 casacore::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 casacore::Bool VLAFrequencyFilter::ok ( ) const

virtual

casacore::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 casacore::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 casacore::MVFrequency &

refFrequency

)

set the reference frequency.

Member Data Documentation

casacore::Double VLAFrequencyFilter::itsBottomEdge

private

Definition at line 135 of file VLAFrequencyFilter.h.

casacore::Double VLAFrequencyFilter::itsTopEdge

private

Definition at line 134 of file VLAFrequencyFilter.h.

---

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

• casa/code/nrao/VLA/VLAFrequencyFilter.h