ATTPCROOT  0.3.0-alpha
A ROOT-based framework for analyzing data from active target detectors
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
AtSpaceChargeModel Class Referenceabstract

#include <AtSpaceChargeModel.h>

Inheritance diagram for AtSpaceChargeModel:
Inheritance graph
[legend]

Public Member Functions

virtual ~AtSpaceChargeModel ()=default
 
virtual XYZPoint CorrectSpaceCharge (const XYZPoint &position)=0
 Using model correct for space charge. More...
 
virtual XYZPoint ApplySpaceCharge (const XYZPoint &position)=0
 Using model add space charge effect. More...
 
virtual void LoadParameters (const AtDigiPar *par)=0
 Load common parameters from AtDigiPar. More...
 
void SetBeamLocation (XYZPoint window, XYZPoint padPlane)
 

Protected Types

using XYZPoint = ROOT::Math::XYZPoint
 

Protected Member Functions

XYZPoint OffsetForBeam (XYZPoint point)
 
XYZPoint UndoOffsetForBeam (XYZPoint point)
 

Protected Attributes

XYZPoint fWindow {0, 0, 0}
 
XYZPoint fPadPlane {0, 0, 1000}
 

Detailed Description

Definition at line 9 of file AtSpaceChargeModel.h.

Member Typedef Documentation

◆ XYZPoint

using AtSpaceChargeModel::XYZPoint = ROOT::Math::XYZPoint
protected

Definition at line 11 of file AtSpaceChargeModel.h.

Constructor & Destructor Documentation

◆ ~AtSpaceChargeModel()

virtual AtSpaceChargeModel::~AtSpaceChargeModel ( )
virtualdefault

Member Function Documentation

◆ ApplySpaceCharge()

virtual XYZPoint AtSpaceChargeModel::ApplySpaceCharge ( const XYZPoint &  position)
pure virtual

Using model add space charge effect.

Used to simulate the effect of this space charge model.

Parameters
[in]posPosition charge was deposited in detector [mm].
Returns
Position charge hits the pad plane [mm].

Implemented in AtEDistortionModel, AtRadialChargeModel, and AtLineChargeModel.

◆ CorrectSpaceCharge()

virtual XYZPoint AtSpaceChargeModel::CorrectSpaceCharge ( const XYZPoint &  position)
pure virtual

Using model correct for space charge.

Used correct for space charge in data.

Parameters
[in]posPosition charge hits the pad plane [mm].
Returns
Position charge was deposited in the detector [mm].

Implemented in AtEDistortionModel, AtRadialChargeModel, and AtLineChargeModel.

◆ LoadParameters()

virtual void AtSpaceChargeModel::LoadParameters ( const AtDigiPar *  par)
pure virtual

Load common parameters from AtDigiPar.

Will load any parameters used by the model from the parameter file attached to the run.

Implemented in AtEDistortionModel, AtRadialChargeModel, and AtLineChargeModel.

◆ OffsetForBeam()

XYZPoint AtSpaceChargeModel::OffsetForBeam ( XYZPoint  point)
protected

Definition at line 8 of file AtSpaceChargeModel.cxx.

◆ SetBeamLocation()

void AtSpaceChargeModel::SetBeamLocation ( XYZPoint  window,
XYZPoint  padPlane 
)
inline

Definition at line 44 of file AtSpaceChargeModel.h.

◆ UndoOffsetForBeam()

XYZPoint AtSpaceChargeModel::UndoOffsetForBeam ( XYZPoint  point)
protected

Definition at line 14 of file AtSpaceChargeModel.cxx.

Member Data Documentation

◆ fPadPlane

XYZPoint AtSpaceChargeModel::fPadPlane {0, 0, 1000}
protected

Definition at line 14 of file AtSpaceChargeModel.h.

◆ fWindow

XYZPoint AtSpaceChargeModel::fWindow {0, 0, 0}
protected

Definition at line 13 of file AtSpaceChargeModel.h.


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