ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::EventShape_v1 Class Reference

Data class for event shapes. More...

#include <EventShape_v1.h>

Inheritance diagram for xAOD::EventShape_v1:
Collaboration diagram for xAOD::EventShape_v1:

Public Types

enum  EventShapeID {
  UnknownShape = -1 , Thrust , ThrustEta , ThrustPhi ,
  ThrustMinor , Sphericity , FoxWolfram
}
 Event shape variable types. More...
enum  EventDensityID { UnknownDensity = -1 , Density , DensitySigma , DensityArea }
 Event density variable types. More...

Public Member Functions

 EventShape_v1 ()
 Default constructor.
bool getShape (EventShapeID id, double &v) const
 Get a shape variable from the object.
double getShape (EventShapeID id) const
 Get a shape variable in a PyROOT friendly way (can throw exception!).
bool setShape (EventShapeID id, double v)
 Set a shape variable on the object.
bool getDensity (EventDensityID id, double &v) const
 Get a density variable from the object.
double getDensity (EventDensityID id) const
 Get a density variable in a PyROOT friendly way (can throw exception!).
bool setDensity (EventDensityID id, double v)
 Set a density variable on the object.

Detailed Description

Data class for event shapes.

This class is used to save event-level quantities such as event shapes or event density. One instance holds the shapes/densities corresponding to a given input source. An input source is typically the set of CaloClusters or of TrackParticles or TruthParticles.

Author
P-A Delsart
Revision
629489
Date
2014-11-19 15:37:55 +0100 (Wed, 19 Nov 2014)

Definition at line 28 of file EventShape_v1.h.

Member Enumeration Documentation

◆ EventDensityID

Event density variable types.

Enumerator
UnknownDensity 
Density 
DensitySigma 
DensityArea 

Definition at line 45 of file EventShape_v1.h.

◆ EventShapeID

Event shape variable types.

Enumerator
UnknownShape 
Thrust 
ThrustEta 
ThrustPhi 
ThrustMinor 
Sphericity 
FoxWolfram 

Definition at line 35 of file EventShape_v1.h.

Constructor & Destructor Documentation

◆ EventShape_v1()

xAOD::EventShape_v1::EventShape_v1 ( )

Default constructor.

Definition at line 104 of file EventShape_v1.cxx.

105 : SG::AuxElement() {
106
107 }
AuxElement(SG::AuxVectorData *container, size_t index)
Base class for elements of a container that can have aux data.

Member Function Documentation

◆ getDensity() [1/2]

double xAOD::EventShape_v1::getDensity ( EventDensityID id) const

Get a density variable in a PyROOT friendly way (can throw exception!).

Definition at line 140 of file EventShape_v1.cxx.

140 {
141
142 return getAttribute( eventDensityAccessor( id ), *this );
143 }

◆ getDensity() [2/2]

bool xAOD::EventShape_v1::getDensity ( EventDensityID id,
double & v ) const

Get a density variable from the object.

Definition at line 135 of file EventShape_v1.cxx.

135 {
136
137 return getAttribute( eventDensityAccessor( id ), *this, v );
138 }

◆ getShape() [1/2]

double xAOD::EventShape_v1::getShape ( EventShapeID id) const

Get a shape variable in a PyROOT friendly way (can throw exception!).

Definition at line 118 of file EventShape_v1.cxx.

118 {
119
120 return getAttribute( eventShapeAccessor( id ), *this );
121 }

◆ getShape() [2/2]

bool xAOD::EventShape_v1::getShape ( EventShapeID id,
double & v ) const

Get a shape variable from the object.

Definition at line 113 of file EventShape_v1.cxx.

113 {
114
115 return getAttribute( eventShapeAccessor( id ), *this, v );
116 }

◆ setDensity()

bool xAOD::EventShape_v1::setDensity ( EventDensityID id,
double v )

Set a density variable on the object.

Definition at line 145 of file EventShape_v1.cxx.

145 {
146
147 return setAttribute( eventDensityAccessor( id ), *this, v );
148 }

◆ setShape()

bool xAOD::EventShape_v1::setShape ( EventShapeID id,
double v )

Set a shape variable on the object.

Definition at line 123 of file EventShape_v1.cxx.

123 {
124
125 return setAttribute( eventShapeAccessor( id ), *this, v );
126 }

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