ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::TruthParticle_v1::Polarization Struct Reference

Single container for full polarization information. More...

#include <TruthParticle_v1.h>

Collaboration diagram for xAOD::TruthParticle_v1::Polarization:

Public Member Functions

 Polarization ()
 Constructor to set (invalid) defaults.
bool valid () const
 Check if the stored values are valid.

Public Attributes

float phi
 Polarization in ( \(\phi\))
float theta
 Polarization in ( \(\theta\))

Detailed Description

Single container for full polarization information.

It can be used as a convenient way for accessing the polarization of the particle with a single call.

Definition at line 366 of file TruthParticle_v1.h.

Constructor & Destructor Documentation

◆ Polarization()

xAOD::TruthParticle_v1::Polarization::Polarization ( )
inline

Constructor to set (invalid) defaults.

Todo
Use C++11 inline member init when allowed

Definition at line 370 of file TruthParticle_v1.h.

371 : phi( -1.0 ), theta( -1.0 ) {}

Member Function Documentation

◆ valid()

bool xAOD::TruthParticle_v1::Polarization::valid ( ) const
inline

Check if the stored values are valid.

Definition at line 374 of file TruthParticle_v1.h.

374 {
375 return ( ( phi > 0.0 ) && ( theta > 0.0 ) );
376 }

Member Data Documentation

◆ phi

float xAOD::TruthParticle_v1::Polarization::phi

Polarization in ( \(\phi\))

Definition at line 378 of file TruthParticle_v1.h.

◆ theta

float xAOD::TruthParticle_v1::Polarization::theta

Polarization in ( \(\theta\))

Definition at line 379 of file TruthParticle_v1.h.


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