AtFilter Class Reference

#include <AtFilter.h>

Inheritance diagram for AtFilter:

Public Member Functions
virtual	~AtFilter ()=default
virtual void	Init ()=0
	Called at the init stage of the AtFilterTask. More...
virtual AtRawEvent *	ConstructOutputEvent (TClonesArray *outputEventArray, AtRawEvent *inputEvent)
	Construct output event from input event array. More...
virtual void	InitEvent (AtRawEvent *inputEvent)=0
	Called once for each event at the start of the Exec phase. More...
virtual void	Filter (AtPad *pad, AtPadReference *padReference=nullptr)=0
	Called to filter each pad. More...
virtual bool	IsGoodEvent ()=0
	Called at the end of an event. Returns if filtering was successful. More...

Detailed Description

Definition at line 13 of file AtFilter.h.

Constructor & Destructor Documentation

~AtFilter()

virtual AtFilter::~AtFilter ( )

virtualdefault

Member Function Documentation

ConstructOutputEvent()

AtRawEvent * AtFilter::ConstructOutputEvent ( TClonesArray *  outputEventArray, AtRawEvent *  inputEvent  )

virtual

Construct output event from input event array.

Called to construct and return the output event in the array from the input event This only needs to be overriden if you are doing something unusual and cannot just copy the input event

Definition at line 7 of file AtFilter.cxx.

Filter()

virtual void AtFilter::Filter ( AtPad *  pad, AtPadReference *  padReference = nullptr  )

pure virtual

Called to filter each pad.

Optional padRef currently only used by SCA filter (10/20/22).

Parameters

[in]	pad	Pad to filter.
	[in[	padRefernece optional parameter only needed when when filtering FPN channels.

Implemented in AtFilterFFT, AtFilterSubtraction, AtSCACorrect, AtTrapezoidFilter, AtFilterCalibrate, AtFilterZero, AtFilterDivide, and AtRemovePulser.

Init()

virtual void AtFilter::Init ( )

pure virtual

Called at the init stage of the AtFilterTask.

Implemented in AtFilterFFT, AtFilterSubtraction, AtSCACorrect, AtTrapezoidFilter, AtFilterCalibrate, AtFilterZero, AtFilterDivide, and AtRemovePulser.

InitEvent()

virtual void AtFilter::InitEvent ( AtRawEvent *  inputEvent )

pure virtual

Called once for each event at the start of the Exec phase.

Implemented in AtFilterFFT, AtFilterSubtraction, AtTrapezoidFilter, AtFilterCalibrate, AtFilterDivide, AtFilterFPN, AtSCACorrect, AtFilterZero, and AtRemovePulser.

IsGoodEvent()

virtual bool AtFilter::IsGoodEvent ( )

pure virtual

Called at the end of an event. Returns if filtering was successful.

Implemented in AtFilterFFT, AtFilterSubtraction, AtSCACorrect, AtTrapezoidFilter, AtFilterCalibrate, AtFilterZero, AtFilterDivide, and AtRemovePulser.

---

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

• /github/workspace/AtReconstruction/AtFilter/AtFilter.h
• /github/workspace/AtReconstruction/AtFilter/AtFilter.cxx