FilterOperation Class Reference

#include <FilterOperation.h>

Public Member Functions
virtual const char *	tag () const =0
virtual const char *	description () const =0
virtual void	process (FilteredAnitaEvent *event)=0
virtual void	processOne (AnalysisWaveform *awf, const RawAnitaHeader *header=0, int ant=0, int pol=0)=0
virtual unsigned	nOutputs () const
virtual const char *	outputName (unsigned i) const
virtual unsigned	outputLength (unsigned i) const
virtual void	fillOutput (unsigned i, double *v) const
virtual	~FilterOperation ()

Protected Member Functions
AnalysisWaveform *	getWf (FilteredAnitaEvent *ev, int i)
AnalysisWaveform *	getWf (FilteredAnitaEvent *ev, int ant, AnitaPol::AnitaPol_t pol)

Detailed Description

A FilteredOperation does things to the waveforms inside a FilteredAnitaEvent

See anitaGround/cozzyd/UCorrelator for some example implementing filters.

Definition at line 15 of file FilterOperation.h.

Inheritance diagram for FilterOperation:

Constructor & Destructor Documentation

~FilterOperation()

FilterOperation::~FilterOperation ( )

virtual

Destructor

Definition at line 8 of file FilterOperation.cc.

Member Function Documentation

description()

virtual const char* FilterOperation::description ( ) const

pure virtual

human readable description, should provide sufficient information to understand what was done

Implemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveBrickWallFilter, UCorrelator::AdaptiveBrickWallFilter, AnitaResponse::DeconvolveFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, DeglitchFilter, Acclaim::Filters::UniformMagnitude, ALFAButterworthFilter, Acclaim::Filters::SpectrumMagnitude, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, ALFALanczosFilter, Acclaim::Filters::RayleighFilter, DigitalFilterOperation, UCorrelator::ComplicatedNotchFilter, UCorrelator::ComplicatedNotchFilter, SumDifferenceFilter, HybridFilter, Acclaim::Filters::RayleighMonitor, ALFASincFilter, ConditionalFilterOperation, UCorrelator::A3toA4ConversionFilter, UCorrelator::A3toA4ConversionFilter, Acclaim::Filters::Notch, SimpleNotchFilter, UCorrelator::timePadFilter, UCorrelator::timePadFilter, UCorrelator::AntiBH13Filter, UCorrelator::AntiBH13Filter, GeometricFilter, SimplePassBandFilter, UCorrelator::BH13Filter, UCorrelator::BH13Filter, DiodeFilter, and GaussianTaper.

fillOutput()

virtual void FilterOperation::fillOutput ( unsigned  i, double *  v  ) const

inlinevirtual

Fill the ith output

Reimplemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, Acclaim::Filters::RayleighMonitor, and Acclaim::Filters::Notch.

Definition at line 43 of file FilterOperation.h.

getWf() [1/2]

AnalysisWaveform * FilterOperation::getWf ( FilteredAnitaEvent *  ev, int  i  )

protected

Accessor for waveform

Definition at line 34 of file FilterOperation.cc.

getWf() [2/2]

AnalysisWaveform * FilterOperation::getWf ( FilteredAnitaEvent *  ev, int  ant, AnitaPol::AnitaPol_t  pol  )

protected

Accessor for waveform

Definition at line 39 of file FilterOperation.cc.

nOutputs()

virtual unsigned FilterOperation::nOutputs ( ) const

inlinevirtual

The number of output variables (doubles or double arrays) defined by this operation

Reimplemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, Acclaim::Filters::RayleighMonitor, and Acclaim::Filters::Notch.

Definition at line 34 of file FilterOperation.h.

outputLength()

virtual unsigned FilterOperation::outputLength ( unsigned  i ) const

inlinevirtual

The length of the ith output variable (it's a double array of this size)

Reimplemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, Acclaim::Filters::RayleighMonitor, and Acclaim::Filters::Notch.

Definition at line 40 of file FilterOperation.h.

outputName()

virtual const char* FilterOperation::outputName ( unsigned  i ) const

inlinevirtual

The name of the ith output variable

Reimplemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, Acclaim::Filters::RayleighMonitor, and Acclaim::Filters::Notch.

Definition at line 37 of file FilterOperation.h.

process()

virtual void FilterOperation::process ( FilteredAnitaEvent *  event )

pure virtual

operate on the FilteredAnitaEvent

Implemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveBrickWallFilter, UCorrelator::AdaptiveBrickWallFilter, AnitaResponse::DeconvolveFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, ALFAButterworthFilter, Acclaim::Filters::SpectrumMagnitude, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, ALFALanczosFilter, Acclaim::Filters::RayleighFilter, SumDifferenceFilter, Acclaim::Filters::RayleighMonitor, HybridFilter, ConditionalFilterOperation, Acclaim::Filters::Notch, ALFASincFilter, UCorrelator::A3toA4ConversionFilter, UCorrelator::A3toA4ConversionFilter, UCorrelator::timePadFilter, UCorrelator::timePadFilter, UniformFilterOperation, UCorrelator::AntiBH13Filter, UCorrelator::AntiBH13Filter, GeometricFilter, UCorrelator::BH13Filter, and UCorrelator::BH13Filter.

processOne()

virtual void FilterOperation::processOne ( AnalysisWaveform *  awf, const RawAnitaHeader *  header = 0, int  ant = 0, int  pol = 0  )

pure virtual

operate on one waveform (ABL added moved this from UniformFitlerOperation so that FilterStrategy could call its this on single waveforms, and the weird argument structure is just so it matches ad sinsub)

Implemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveBrickWallFilter, UCorrelator::AdaptiveBrickWallFilter, AnitaResponse::DeconvolveFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, DeglitchFilter, Acclaim::Filters::UniformMagnitude, ALFAButterworthFilter, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, ALFALanczosFilter, DigitalFilterOperation, UCorrelator::ComplicatedNotchFilter, UCorrelator::ComplicatedNotchFilter, HybridFilter, Acclaim::Filters::RayleighMonitor, ConditionalFilterOperation, ALFASincFilter, UCorrelator::A3toA4ConversionFilter, UCorrelator::A3toA4ConversionFilter, Acclaim::Filters::Notch, SimpleNotchFilter, UniformFilterOperation, UCorrelator::AntiBH13Filter, UCorrelator::AntiBH13Filter, SimplePassBandFilter, GeometricFilter, UCorrelator::BH13Filter, UCorrelator::BH13Filter, GaussianTaper, and DiodeFilter.

tag()

virtual const char* FilterOperation::tag ( ) const

pure virtual

short name for operation, will be used for output tree name, if there is one

Implemented in UCorrelator::CombinedSineSubtractFilter, UCorrelator::CombinedSineSubtractFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveButterworthFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveMinimumPhaseFilter, UCorrelator::AdaptiveBrickWallFilter, UCorrelator::AdaptiveBrickWallFilter, AnitaResponse::DeconvolveFilter, UCorrelator::SineSubtractFilter, UCorrelator::SineSubtractFilter, DeglitchFilter, Acclaim::Filters::UniformMagnitude, ALFAButterworthFilter, Acclaim::Filters::SpectrumMagnitude, UCorrelator::AdaptiveFilterAbby, UCorrelator::AdaptiveFilterAbby, ALFALanczosFilter, Acclaim::Filters::RayleighFilter, DigitalFilterOperation, UCorrelator::ComplicatedNotchFilter, UCorrelator::ComplicatedNotchFilter, SumDifferenceFilter, HybridFilter, Acclaim::Filters::RayleighMonitor, ALFASincFilter, ConditionalFilterOperation, UCorrelator::A3toA4ConversionFilter, UCorrelator::A3toA4ConversionFilter, Acclaim::Filters::Notch, SimpleNotchFilter, UCorrelator::timePadFilter, UCorrelator::timePadFilter, UCorrelator::AntiBH13Filter, UCorrelator::AntiBH13Filter, GeometricFilter, SimplePassBandFilter, UCorrelator::BH13Filter, UCorrelator::BH13Filter, DiodeFilter, and GaussianTaper.

---

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

• components/AnitaAnalysisFramework/include/FilterOperation.h
• components/AnitaAnalysisFramework/src/FilterOperation.cc