ANITA Analysis Framework
Public Types | Public Member Functions | List of all members
DeglitchFilter Class Reference

#include <BasicFilters.h>

Inheritance diagram for DeglitchFilter:
Inheritance graph
[legend]
Collaboration diagram for DeglitchFilter:
Collaboration graph
[legend]

Public Types

enum  RemoveAction { DELETE, AVERAGE }
 

Public Member Functions

 DeglitchFilter (double threshold_above_neighbors=100, int n_neighbors=9, RemoveAction action=DELETE, int max_remove=10)
 
const char * description () const
 
virtual void processOne (AnalysisWaveform *wf, const RawAnitaHeader *=0, int ant=0, int pol=0)
 
const char * tag () const
 
- Public Member Functions inherited from UniformFilterOperation
virtual void process (FilteredAnitaEvent *event)
 
- Public Member Functions inherited from FilterOperation
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 ~FilterOperation ()
 

Additional Inherited Members

- Protected Member Functions inherited from FilterOperation
AnalysisWaveformgetWf (FilteredAnitaEvent *ev, int i)
 
AnalysisWaveformgetWf (FilteredAnitaEvent *ev, int ant, AnitaPol::AnitaPol_t pol)
 

Detailed Description

Removes glitches

Definition at line 194 of file BasicFilters.h.

Constructor & Destructor Documentation

◆ DeglitchFilter()

DeglitchFilter::DeglitchFilter ( double  threshold_above_neighbors = 100,
int  n_neighbors = 9,
RemoveAction  action = DELETE,
int  max_remove = 10 
)

Construct the filter.

Parameters
threshold_above_neighborsthe minimum abs(v) threshold above neigbhors to be considered a glitch
n_neighborsnumber of neighbors (on both sides, so up to 2 * n_neighbors + 1 are considered
actionWhat to do when removing a point. If DELETE is used, will function on uneven waveform. AVERAGE will function on even waveform.
max_removeThe maximum number of points to remove. If more than this are attempted, None are removed (since probably something silly is going on)

Member Function Documentation

◆ description()

const char* DeglitchFilter::description ( ) const
inlinevirtual

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

Implements FilterOperation.

Definition at line 211 of file BasicFilters.h.

◆ processOne()

virtual void DeglitchFilter::processOne ( AnalysisWaveform awf,
const RawAnitaHeader *  header = 0,
int  ant = 0,
int  pol = 0 
)
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)

Implements UniformFilterOperation.

◆ tag()

const char* DeglitchFilter::tag ( ) const
inlinevirtual

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

Implements FilterOperation.

Definition at line 210 of file BasicFilters.h.


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