LDMX Software
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ldmx::BeamElectronTruth Class Reference

Represents the truth information on beam electrons at the target. More...

#include <BeamElectronTruth.h>

Public Member Functions

 BeamElectronTruth ()=default
 Class constructor.
 
virtual ~BeamElectronTruth ()
 Class destructor.
 
void Print () const
 Print a description of this object.
 
void Clear ()
 Clear the data in the object.
 
void setX (double x)
 Set x coordinate of the found beam electron.
 
void setY (double y)
 Set y coordinate of the found beam electron.
 
void setZ (double z)
 Set z coordinate of the found beam electron.
 
void setXYZ (double x, double y, double z)
 Set all three spatial coordinates at once.
 
double getX ()
 Get x coordinate of the beam electron.
 
double getY ()
 Get y coordinate of the beam electron.
 
double getZ ()
 Get z coordinate of the beam electron.
 
void setBinnedX (double x)
 SetBinned x coordinate of the found beam electron.
 
void setBinnedY (double y)
 SetBinned y coordinate of the found beam electron.
 
void setBinnedXY (double x, double y)
 Set all three binned spatial coordinates at once.
 
double getBinnedX ()
 Get binned x coordinate of the beam electron.
 
double getBinnedY ()
 GetBinned y coordinate of the beam electron.
 
void setBarX (double x)
 Set x bar number of the found beam electron.
 
void setBarY (double y)
 Set y bar number of the found beam electron.
 
void setBarXY (double x, double y)
 Set both bar number coordinates at once.
 
double getBarX ()
 Get x bar number of the found beam electron.
 
double getBarY ()
 Get y bar number of the found beam electron.
 
void setThreeMomentum (double px, double py, double pz)
 Set the entire three-momentum at once.
 
double getPx ()
 Get px component of the beam electron momentum.
 
double getPy ()
 Get py component of the beam electron momentum.
 
double getPz ()
 Get pz component of the beam electron momentum.
 
bool operator< (BeamElectronTruth &rhs)
 some sorting operator is mandatory sort on hit Z coordinate
 

Private Member Functions

 ClassDef (BeamElectronTruth, 1)
 

Private Attributes

double x_ {-999}
 x coordinate ("truth" resolution, but within merging tolerance)
 
double y_ {-999}
 y coordinate ("truth" resolution, but within merging tolerance)
 
double z_ {-9999}
 z coordinate ("truth" resolution, in practice, set to taget z = 0
 
double binnedX_ {-999}
 x coordinate (with TS resolution)
 
double binnedY_ {-999}
 y coordinate (with TS resolution)
 
double barX_ {-1}
 TS vertical bar number overlapping with x coordinate.
 
double barY_ {-1}
 TS horizontal bar number overlapping with y coordinate.
 
double px_ {-999}
 x momentum component
 
double py_ {-999}
 y momentum component
 
double pz_ {-999}
 z momentum component
 

Detailed Description

Represents the truth information on beam electrons at the target.

Definition at line 24 of file BeamElectronTruth.h.

Constructor & Destructor Documentation

◆ ~BeamElectronTruth()

virtual ldmx::BeamElectronTruth::~BeamElectronTruth ( )
inlinevirtual

Class destructor.

Definition at line 34 of file BeamElectronTruth.h.

34{};

Member Function Documentation

◆ getBarX()

double ldmx::BeamElectronTruth::getBarX ( )
inline

Get x bar number of the found beam electron.

Returns
x The x (vertical) bar number of the found beam electron.

Definition at line 159 of file BeamElectronTruth.h.

159{ return barX_; }
double barX_
TS vertical bar number overlapping with x coordinate.

References barX_.

Referenced by recon::BeamElectronLocator::produce().

◆ getBarY()

double ldmx::BeamElectronTruth::getBarY ( )
inline

Get y bar number of the found beam electron.

Returns
y The y (horizontal) bar number of the found beam electron.

Definition at line 165 of file BeamElectronTruth.h.

165{ return barY_; }
double barY_
TS horizontal bar number overlapping with y coordinate.

References barY_.

Referenced by recon::BeamElectronLocator::produce().

◆ getBinnedX()

double ldmx::BeamElectronTruth::getBinnedX ( )
inline

Get binned x coordinate of the beam electron.

Returns
x The x coordinate of the found beam electron.

Definition at line 123 of file BeamElectronTruth.h.

123{ return binnedX_; }
double binnedX_
x coordinate (with TS resolution)

References binnedX_.

◆ getBinnedY()

double ldmx::BeamElectronTruth::getBinnedY ( )
inline

GetBinned y coordinate of the beam electron.

Returns
y The y coordinate of the found beam electron.

Definition at line 129 of file BeamElectronTruth.h.

129{ return binnedY_; }
double binnedY_
y coordinate (with TS resolution)

References binnedY_.

◆ getPx()

double ldmx::BeamElectronTruth::getPx ( )
inline

Get px component of the beam electron momentum.

Returns
px The px component of the beam electron momentum.

Definition at line 181 of file BeamElectronTruth.h.

181{ return px_; }
double px_
x momentum component

References px_.

◆ getPy()

double ldmx::BeamElectronTruth::getPy ( )
inline

Get py component of the beam electron momentum.

Returns
py The py component of the beam electron momentum.

Definition at line 187 of file BeamElectronTruth.h.

187{ return py_; }
double py_
y momentum component

References py_.

◆ getPz()

double ldmx::BeamElectronTruth::getPz ( )
inline

Get pz component of the beam electron momentum.

Returns
pz The pz component of the beam electron momentum.

Definition at line 193 of file BeamElectronTruth.h.

193{ return pz_; }
double pz_
z momentum component

References pz_.

◆ getX()

double ldmx::BeamElectronTruth::getX ( )
inline

Get x coordinate of the beam electron.

Returns
x The x coordinate of the found beam electron.

Definition at line 81 of file BeamElectronTruth.h.

81{ return x_; }
double x_
x coordinate ("truth" resolution, but within merging tolerance)

References x_.

◆ getY()

double ldmx::BeamElectronTruth::getY ( )
inline

Get y coordinate of the beam electron.

Returns
y The y coordinate of the found beam electron.

Definition at line 87 of file BeamElectronTruth.h.

87{ return y_; }
double y_
y coordinate ("truth" resolution, but within merging tolerance)

References y_.

◆ getZ()

double ldmx::BeamElectronTruth::getZ ( )
inline

Get z coordinate of the beam electron.

Returns
z The z coordinate of the found beam electron.

Definition at line 93 of file BeamElectronTruth.h.

93{ return z_; }
double z_
z coordinate ("truth" resolution, in practice, set to taget z = 0

References z_.

Referenced by operator<().

◆ operator<()

bool ldmx::BeamElectronTruth::operator< ( BeamElectronTruth rhs)
inline

some sorting operator is mandatory sort on hit Z coordinate

Definition at line 199 of file BeamElectronTruth.h.

199{ return this->getZ() < rhs.getZ(); }
double getZ()
Get z coordinate of the beam electron.

References getZ().

◆ setBarX()

void ldmx::BeamElectronTruth::setBarX ( double  x)
inline

Set x bar number of the found beam electron.

Parameters
xThe x (vertical) bar number of the found beam electron.

Definition at line 137 of file BeamElectronTruth.h.

137{ barX_ = x; }

References barX_.

Referenced by recon::BeamElectronLocator::produce().

◆ setBarXY()

void ldmx::BeamElectronTruth::setBarXY ( double  x,
double  y 
)
inline

Set both bar number coordinates at once.

Parameters
xThe x (vertical) bar number of the found beam electron.
yThe y (horizontal) bar number of the found beam electron.

Definition at line 150 of file BeamElectronTruth.h.

150 {
151 barX_ = x;
152 barY_ = y;
153 }

References barX_, and barY_.

◆ setBarY()

void ldmx::BeamElectronTruth::setBarY ( double  y)
inline

Set y bar number of the found beam electron.

Parameters
yThe y (horizontal) bar number of the found beam electron.

Definition at line 143 of file BeamElectronTruth.h.

143{ barY_ = y; }

References barY_.

Referenced by recon::BeamElectronLocator::produce().

◆ setBinnedX()

void ldmx::BeamElectronTruth::setBinnedX ( double  x)
inline

SetBinned x coordinate of the found beam electron.

Parameters
xThe x coordinate of the found beam electron.

Definition at line 101 of file BeamElectronTruth.h.

101{ binnedX_ = x; }

References binnedX_.

Referenced by recon::BeamElectronLocator::produce().

◆ setBinnedXY()

void ldmx::BeamElectronTruth::setBinnedXY ( double  x,
double  y 
)
inline

Set all three binned spatial coordinates at once.

Parameters
xThe binned x coordinate of the found beam electron.
yThe binned y coordinate of the found beam electron.

Definition at line 114 of file BeamElectronTruth.h.

114 {
115 binnedX_ = x;
116 binnedY_ = y;
117 }

References binnedX_, and binnedY_.

◆ setBinnedY()

void ldmx::BeamElectronTruth::setBinnedY ( double  y)
inline

SetBinned y coordinate of the found beam electron.

Parameters
yThe y coordinate of the found beam electron.

Definition at line 107 of file BeamElectronTruth.h.

107{ binnedY_ = y; }

References binnedY_.

Referenced by recon::BeamElectronLocator::produce().

◆ setThreeMomentum()

void ldmx::BeamElectronTruth::setThreeMomentum ( double  px,
double  py,
double  pz 
)

Set the entire three-momentum at once.

Parameters
pxThe x component of the three-momentum
pyThe y component of the three-momentum
pzThe z component of the three-momentum

◆ setX()

void ldmx::BeamElectronTruth::setX ( double  x)
inline

Set x coordinate of the found beam electron.

Parameters
xThe x coordinate of the found beam electron.

Definition at line 50 of file BeamElectronTruth.h.

50{ x_ = x; }

References x_.

◆ setXYZ()

void ldmx::BeamElectronTruth::setXYZ ( double  x,
double  y,
double  z 
)
inline

Set all three spatial coordinates at once.

Parameters
xThe x coordinate of the found beam electron.
yThe y coordinate of the found beam electron.
zThe z coordinate of the found beam electron.

Definition at line 71 of file BeamElectronTruth.h.

71 {
72 x_ = x;
73 y_ = y;
74 z_ = z;
75 }

References x_, y_, and z_.

Referenced by recon::BeamElectronLocator::produce().

◆ setY()

void ldmx::BeamElectronTruth::setY ( double  y)
inline

Set y coordinate of the found beam electron.

Parameters
yThe y coordinate of the found beam electron.

Definition at line 56 of file BeamElectronTruth.h.

56{ y_ = y; }

References y_.

◆ setZ()

void ldmx::BeamElectronTruth::setZ ( double  z)
inline

Set z coordinate of the found beam electron.

Parameters
zThe z coordinate of the found beam electron.

Definition at line 62 of file BeamElectronTruth.h.

62{ z_ = z; }

References z_.

Member Data Documentation

◆ barX_

double ldmx::BeamElectronTruth::barX_ {-1}
private

TS vertical bar number overlapping with x coordinate.

Definition at line 220 of file BeamElectronTruth.h.

220{-1};

Referenced by getBarX(), setBarX(), and setBarXY().

◆ barY_

double ldmx::BeamElectronTruth::barY_ {-1}
private

TS horizontal bar number overlapping with y coordinate.

Definition at line 223 of file BeamElectronTruth.h.

223{-1};

Referenced by getBarY(), setBarXY(), and setBarY().

◆ binnedX_

double ldmx::BeamElectronTruth::binnedX_ {-999}
private

x coordinate (with TS resolution)

Definition at line 214 of file BeamElectronTruth.h.

214{-999};

Referenced by getBinnedX(), setBinnedX(), and setBinnedXY().

◆ binnedY_

double ldmx::BeamElectronTruth::binnedY_ {-999}
private

y coordinate (with TS resolution)

Definition at line 217 of file BeamElectronTruth.h.

217{-999};

Referenced by getBinnedY(), setBinnedXY(), and setBinnedY().

◆ px_

double ldmx::BeamElectronTruth::px_ {-999}
private

x momentum component

Definition at line 226 of file BeamElectronTruth.h.

226{-999};

Referenced by getPx().

◆ py_

double ldmx::BeamElectronTruth::py_ {-999}
private

y momentum component

Definition at line 228 of file BeamElectronTruth.h.

228{-999};

Referenced by getPy().

◆ pz_

double ldmx::BeamElectronTruth::pz_ {-999}
private

z momentum component

Definition at line 230 of file BeamElectronTruth.h.

230{-999};

Referenced by getPz().

◆ x_

double ldmx::BeamElectronTruth::x_ {-999}
private

x coordinate ("truth" resolution, but within merging tolerance)

Definition at line 205 of file BeamElectronTruth.h.

205{-999};

Referenced by getX(), setX(), and setXYZ().

◆ y_

double ldmx::BeamElectronTruth::y_ {-999}
private

y coordinate ("truth" resolution, but within merging tolerance)

Definition at line 208 of file BeamElectronTruth.h.

208{-999};

Referenced by getY(), setXYZ(), and setY().

◆ z_

double ldmx::BeamElectronTruth::z_ {-9999}
private

z coordinate ("truth" resolution, in practice, set to taget z = 0

Definition at line 211 of file BeamElectronTruth.h.

211{-9999};

Referenced by getZ(), setXYZ(), and setZ().


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