Acclaim::Filters::RayleighMonitor Class Reference

Tracks the amplitudes of frequencies but doesn't do anything else, to be inherited from. More...

#include <AcclaimFilters.h>

Public Member Functions
	RayleighMonitor (int numEvents)
	Constructor for theh RayleighMonitor. More...
virtual const char *	tag () const
virtual const char *	description () const
virtual void	processOne (AnalysisWaveform *wave, const RawAnitaHeader *h=NULL, int ant=0, int pol=0)
virtual void	process (FilteredAnitaEvent *fEv)
	Wrapper for FourierBuffer::add(FilteredAnitaEvent*) More...
virtual unsigned	outputLength (unsigned i) const
	returns the number of doubles each output array More...
virtual unsigned	nOutputs () const
virtual const char *	outputName (unsigned i) const
	maps the output array index to a name More...
virtual void	fillOutput (unsigned i, double *v) const
	puts the ith output buffer into the array v. More...
const FourierBuffer *	getFourierBuffer () const
Public Member Functions inherited from FilterOperation
virtual	~FilterOperation ()

Protected Attributes
int	fNumEvents
FourierBuffer	fourierBuffer
TString	fDescription
unsigned	fNumOutputs
AnitaPol::AnitaPol_t	fOutputPol
int	fOutputAnt

Additional Inherited Members
Protected Member Functions inherited from FilterOperation
AnalysisWaveform *	getWf (FilteredAnitaEvent *ev, int i)
AnalysisWaveform *	getWf (FilteredAnitaEvent *ev, int ant, AnitaPol::AnitaPol_t pol)

Detailed Description

Tracks the amplitudes of frequencies but doesn't do anything else, to be inherited from.

RayleighMonitor (Actually all the hard work is done by the FourierBuffer class, which is a rather complicated beastie.)

Definition at line 98 of file AcclaimFilters.h.

Inheritance diagram for Acclaim::Filters::RayleighMonitor:

Collaboration diagram for Acclaim::Filters::RayleighMonitor:

Constructor & Destructor Documentation

Acclaim::Filters::RayleighMonitor::RayleighMonitor ( int  numEvents )

explicit

Constructor for theh RayleighMonitor.

This class is the mother of all filter classes which interface with the FourierBuffer.

Parameters

numEvents

is the number of events over which the FourierBuffer is to track frequency amplitudes

Definition at line 374 of file AcclaimFilters.cxx.

Member Function Documentation

virtual const char* Acclaim::Filters::RayleighMonitor::description ( ) const

inlinevirtual

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

Implements FilterOperation.

Reimplemented in Acclaim::Filters::SpectrumMagnitude, and Acclaim::Filters::RayleighFilter.

Definition at line 109 of file AcclaimFilters.h.

void Acclaim::Filters::RayleighMonitor::fillOutput ( unsigned  i, double *  v  ) const

virtual

puts the ith output buffer into the array v.

Parameters

i	us the output index
v	points to the array into which the output should be written

Reimplemented from FilterOperation.

Definition at line 455 of file AcclaimFilters.cxx.

virtual unsigned Acclaim::Filters::RayleighMonitor::nOutputs ( ) const

inlinevirtual

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

Reimplemented from FilterOperation.

Definition at line 121 of file AcclaimFilters.h.

unsigned Acclaim::Filters::RayleighMonitor::outputLength ( unsigned  i ) const

virtual

returns the number of doubles each output array

Since the FourierBuffer produces a high density of output, the standard FilterOperation i/o is not particularly useful. Therefore the associated functions are not well tested.

Parameters

i	is the element of the output array

Returns

the length of the output

Reimplemented from FilterOperation.

Definition at line 406 of file AcclaimFilters.cxx.

const char * Acclaim::Filters::RayleighMonitor::outputName ( unsigned  i ) const

virtual

maps the output array index to a name

Parameters

i	is the output index.

Returns

a pointer to a c-style string containing the name of the output, or NULL if i is invalid.

Reimplemented from FilterOperation.

Definition at line 426 of file AcclaimFilters.cxx.

void Acclaim::Filters::RayleighMonitor::process ( FilteredAnitaEvent *  fEv )

virtual

Wrapper for FourierBuffer::add(FilteredAnitaEvent*)

Parameters

fEv	is the event to pass to FourierBuffer

Reimplemented from UniformFilterOperation.

Reimplemented in Acclaim::Filters::SpectrumMagnitude, and Acclaim::Filters::RayleighFilter.

Definition at line 390 of file AcclaimFilters.cxx.

virtual void Acclaim::Filters::RayleighMonitor::processOne ( AnalysisWaveform *  awf, const RawAnitaHeader *  header = NULL, int  ant = 0, int  pol = 0  )

inlinevirtual

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)

Implements UniformFilterOperation.

Definition at line 110 of file AcclaimFilters.h.

virtual const char* Acclaim::Filters::RayleighMonitor::tag ( ) const

inlinevirtual

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

Implements FilterOperation.

Reimplemented in Acclaim::Filters::SpectrumMagnitude, and Acclaim::Filters::RayleighFilter.

Definition at line 108 of file AcclaimFilters.h.

---

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

• components/anitaAnalysisTools/include/AcclaimFilters.h
• components/anitaAnalysisTools/src/AcclaimFilters.cxx