AtSCACorrect Class Reference

#include <AtSCACorrect.h>

Inheritance diagram for AtSCACorrect:

Collaboration diagram for AtSCACorrect:

Public Member Functions
	AtSCACorrect (AtMapPtr map, TString filename, TString eventName, TString baselineAug, TString phaseAug)
	AtSCACorrect (AtMapPtr map, RawEventPtr rawEvent, TString baselineAug, TString phaseAug)
virtual void	Init () override
	Called at the init stage of the AtFilterTask. More...
virtual void	InitEvent (AtRawEvent *) override
	Called once for each event at the start of the Exec phase. More...
virtual bool	IsGoodEvent () override
	Called at the end of an event. Returns if filtering was successful. More...
virtual void	Filter (AtPad *pad, AtPadReference *padReference) override
	Called to filter each pad. More...
void	DoBaseline (Bool_t val)
void	DoPhase (Bool_t val)
void	UseChannelZero ()
Public Member Functions inherited from AtFilter
virtual	~AtFilter ()=default
virtual AtRawEvent *	ConstructOutputEvent (TClonesArray *outputEventArray, AtRawEvent *inputEvent)
	Construct output event from input event array. More...

Detailed Description

A filter to perform baseline subtraction using the average baseline and average phase effect stored as AtRawEvent objects in a separate file or files.

Definition at line 20 of file AtSCACorrect.h.

Constructor & Destructor Documentation

AtSCACorrect() [1/2]

AtSCACorrect::AtSCACorrect	(	AtMapPtr	map,
		TString	filename,
		TString	eventName,
		TString	baselineAug,
		TString	phaseAug
	)

Baseline and phase effects can be stored in a AtRawEvent object in a file.

filename: Name of the file eventName: Name of the AtRawEvent object baselineAug: The string used to identify the AtPad augment the baseline is stored in phaseAug: The string used to identify the AtPad augment the phase effect is stored in

Definition at line 18 of file AtSCACorrect.cxx.

AtSCACorrect() [2/2]

AtSCACorrect::AtSCACorrect	(	AtMapPtr	map,
		RawEventPtr	rawEvent,
		TString	baselineAug,
		TString	phaseAug
	)

Baseline and phase effects can be stored in a AtRawEvent object with a unique pointer supplied to the constructor

baselineAug: The string used to identify the AtPad augment the baseline is stored in phaseAug: The string used to identify the AtPad augment the phase effect is stored in

Definition at line 31 of file AtSCACorrect.cxx.

Member Function Documentation

DoBaseline()

void AtSCACorrect::DoBaseline ( Bool_t  val )

inline

Turns on and off the baseline correction. Defaults to true. Set false to disable baseline correction.

Definition at line 64 of file AtSCACorrect.h.

DoPhase()

void AtSCACorrect::DoPhase ( Bool_t  val )

inline

Turns on and off the phase effect correction. Defaults to true. Set false to disable phase effect correction.

Definition at line 69 of file AtSCACorrect.h.

Filter()

void AtSCACorrect::Filter ( AtPad *  pad, AtPadReference *  padReference  )

overridevirtual

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.

Implements AtFilter.

Definition at line 37 of file AtSCACorrect.cxx.

Init()

virtual void AtSCACorrect::Init ( )

inlineoverridevirtual

Called at the init stage of the AtFilterTask.

Implements AtFilter.

Definition at line 54 of file AtSCACorrect.h.

InitEvent()

virtual void AtSCACorrect::InitEvent ( AtRawEvent *  inputEvent )

inlineoverridevirtual

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

Implements AtFilter.

Definition at line 55 of file AtSCACorrect.h.

IsGoodEvent()

virtual bool AtSCACorrect::IsGoodEvent ( )

inlineoverridevirtual

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

Implements AtFilter.

Definition at line 56 of file AtSCACorrect.h.

UseChannelZero()

void AtSCACorrect::UseChannelZero ( )

inline

Sets the use of channel zero for the given AGET chip for the baseline and phase effect insted of the actual channel being corrected.

Definition at line 75 of file AtSCACorrect.h.

---

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

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