VLAFrequencyFilter.h
Classes
- VLAFrequencyFilter -- (full description)
Interface
- Public Members
- VLAFrequencyFilter()
- VLAFrequencyFilter(const MVFrequency& centreFrequency, const MVFrequency& bandwidth)
- VLAFrequencyFilter(const VLAFrequencyFilter& other)
- virtual ~VLAFrequencyFilter()
- VLAFrequencyFilter& operator=(const VLAFrequencyFilter& other)
- void refFrequency(const MVFrequency& refFrequency)
- void bandwidth(const MVFrequency& bandwidth)
- virtual Bool passThru(const VLALogicalRecord& record) const
- virtual VLAFilter* clone() const
- virtual Bool ok() const
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
Member Description
The default constructor creates a filter that does not filter
anything. ie., the passThru() function always returns True;
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.
The copy constructor uses copy semantics.
The destructor is trivial
VLAFrequencyFilter& operator=(const VLAFrequencyFilter& other)
The assignment operator uses copy semantics.
set the reference frequency.
set the bandwidth.
returns True if the supplied record contains any data that is between the
specified start and end frequencies.
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.
virtual Bool ok() const
Function which checks the internal data of this class for correct
dimensionality and consistant values. Returns True if everything is fine
otherwise returns False.