ATLAS Offline Software
Public Member Functions | Public Attributes | List of all members
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. More...
 
bool valid () const
 Check if the stored values are valid. More...
 

Public Attributes

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

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 371 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 375 of file TruthParticle_v1.h.

376  : 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 379 of file TruthParticle_v1.h.

379  {
380  return ( ( phi > 0.0 ) && ( theta > 0.0 ) );
381  }

Member Data Documentation

◆ phi

float xAOD::TruthParticle_v1::Polarization::phi

Polarization in ( \(\phi\))

Definition at line 383 of file TruthParticle_v1.h.

◆ theta

float xAOD::TruthParticle_v1::Polarization::theta

Polarization in ( \(\theta\))

Definition at line 384 of file TruthParticle_v1.h.


The documentation for this struct was generated from the following file:
xAOD::TruthParticle_v1::Polarization::phi
float phi
Polarization in ( )
Definition: TruthParticle_v1.h:383
xAOD::TruthParticle_v1::Polarization::theta
float theta
Polarization in ( )
Definition: TruthParticle_v1.h:384