#include <FilterOperation.h>

Inheritance diagram for FilterOperation:

[legend]

Public Member Functions
virtual const char *	description () const =0

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

virtual unsigned	nOutputs () const

virtual unsigned	outputLength (unsigned i) const

virtual const char *	outputName (unsigned i) const

virtual void	process (FilteredAnitaEvent *event)=0

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

virtual const char *	tag () const =0

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.

Constructor & Destructor Documentation

◆ ~FilterOperation()

virtual FilterOperation::~FilterOperation ( )

virtual

Destructor

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 AnitaResponse::DeconvolveFilter, DeglitchFilter, ALFAButterworthFilter, ALFALanczosFilter, DigitalFilterOperation, SumDifferenceFilter, HybridFilter, ALFASincFilter, ConditionalFilterOperation, SimpleNotchFilter, GeometricFilter, SimplePassBandFilter, DiodeFilter, and GaussianTaper.

◆ fillOutput()

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

inlinevirtual

Fill the ith output

Definition at line 43 of file FilterOperation.h.

◆ getWf() [1/2]

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

protected

Accessor for waveform

◆ getWf() [2/2]

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

protected

Accessor for waveform

◆ nOutputs()

virtual unsigned FilterOperation::nOutputs ( ) const

inlinevirtual

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

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)

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

Definition at line 37 of file FilterOperation.h.

◆ process()

virtual void FilterOperation::process ( FilteredAnitaEvent * event )

pure virtual

operate on the FilteredAnitaEvent

Implemented in AnitaResponse::DeconvolveFilter, ALFAButterworthFilter, ALFALanczosFilter, SumDifferenceFilter, HybridFilter, ConditionalFilterOperation, ALFASincFilter, UniformFilterOperation, and GeometricFilter.

◆ 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 AnitaResponse::DeconvolveFilter, DeglitchFilter, ALFAButterworthFilter, ALFALanczosFilter, DigitalFilterOperation, HybridFilter, ConditionalFilterOperation, ALFASincFilter, SimpleNotchFilter, UniformFilterOperation, SimplePassBandFilter, GeometricFilter, GaussianTaper, and DiodeFilter.