xAOD::MissingETComponent_v1::Weight Class Reference

Kinematic weight descriptor. More...

#include <MissingETComponent_v1.h>

List of all members.

Public Member Functions

 Weight ()
 Default constructor.
 Weight (double wpx, double wpy, double wet)
 Constructor with parameters.
 ~Weight ()
 Data class destructor.
Accessors



double wpx () const
 Returns $ w_{x} $.
double wpy () const
 Returns $ w_{y} $.
double wet () const
 Returns $ w_{\rm T} $.
Setters



void setWpx (double wpx)
 Set $ w_{x} $.
void setWpy (double wpy)
 Set $ w_{y} $.
void setWet (double wet)
 Set $ w_{\rm T} $.
Modifiers for kinematic weights



double & wpx ()
 Returns reference to modifiable dataword storing $ w_{x} $.
double & wpy ()
 Returns reference to modifiable data word storing $ w_{y} $.
double & wet ()
 Returns reference to modifiable data word storing $ w_{\rm T} $.
Weight & operator+= (const Weight &wght)
 Add another weight.
Weight & operator-= (const Weight &wght)
 Subtract another weight.
Weight & operator*= (const Weight &wght)
 Multiply two weights.
Weight & operator*= (double scale)
 Scale weight by multiplication.
Weight & operator/= (const Weight &wght)
 Divide two weights.
Weight & operator/= (double scale)
 Scale weight by division.
Comparators



bool operator== (const Weight &wght) const
 Equality comparator.
bool operator!= (const Weight &wght) const
 Inequality operator.

Detailed Description

Kinematic weight descriptor.

This object is purely transient. It allows a compact extraction and setting of kinematic weights for component descriptions for MET. In addition, it helps to implement a clean and well defined algebra for these weights. This structure is not used in the auxiliary data store holding the data for a MissingETComponent_v1 object.

Constructor & Destructor Documentation

xAOD::MissingETComponent_v1::Weight::Weight (  )  [inline]

Default constructor.

Constructs a kinematic weight object with settings $ (w_{x} = 1, w_{y} = 1, w_{\rm T} = 1) $.

xAOD::MissingETComponent_v1::Weight::Weight ( double  wpx,
double  wpy,
double  wet 
) [inline]

Constructor with parameters.

Construct a kinematic weight object with client provided weights. All numerical values are accepted, there is no consistency or numerical range check on the weights.

Parameters:
[in] wpx $ w_{x} $
[in] wpy $ w_{y} $
[in] wet $ w_{\rm T} $

Member Function Documentation

xAOD::MissingETComponent_v1::Weight & xAOD::MissingETComponent_v1::Weight::operator*= ( double  scale  ) 

Scale weight by multiplication.

This operation updates the internal store of this object and yields

\[ s \times \mathcal{W} = \left( \begin{array}{c} s \times w_{x} \\ s \times w_{y} \\ s \times w_{\rm T} \end{array} \right) \]

for weight $ \mathcal{W} $ multiplied by a scale factor $ s $. The internal data content of $ \mathcal{W} $ is modified.

Returns:
Reference to self.
Parameters:
[in] scale scale factor $ s $.
xAOD::MissingETComponent_v1::Weight & xAOD::MissingETComponent_v1::Weight::operator*= ( const Weight &  wght  ) 

Multiply two weights.

This operation updates the internal store of this object and yields

\[ s \times \mathcal{W} = \left( \begin{array}{c} w_{x} \times w_{x}^{\prime} \\ w_{y} \times w_{y}^{\prime} \\ w_{\rm T} \times = w_{\rm T}^{\prime} \end{array} \right) \]

for weight $ \mathcal{W} $ multiplied by another weight $ \mathcal{W}^{\prime} = (w_{x}^{\prime},w_{y}^{\prime},w_{\rm T}^{\prime}) $. The internal data content of $ \mathcal{W} $ is modified.

Returns:
Reference to self.
Parameters:
[in] wght weight $ \mathcal{W}*{\prime} $
xAOD::MissingETComponent_v1::Weight::operator+= ( const Weight &  wght  ) 

Add another weight.

This operation updates the internal store of this object and yields

\[ \mathcal{W} + \mathcal{W}^{\prime} = \left(\begin{array}{c} w_{x} + w_{x}^{\prime} \\ w_{y} + w_{y}^{\prime} \\ w_{\rm T} + w_{\rm T}^{\prime} \end{array} \right) \]

for two weights $ \mathcal{W}, \mathcal{W}^{\prime} $ added. The result replaces the data content of $ \mathcal{W} $.

Returns:
Reference to self.
Parameters:
[in] wght reference to non-modifiable Weight object to be added.
xAOD::MissingETComponent_v1::Weight & xAOD::MissingETComponent_v1::Weight::operator-= ( const Weight &  wght  ) 

Subtract another weight.

This operation updates the internal store of this object and yields

\[ \mathcal{W} - \mathcal{W}^{\prime} = \left(\begin{array}{c} w_{x} - w_{x}^{\prime} \\ w_{y} - w_{y}^{\prime} \\ w_{\rm T} - w_{\rm T}^{\prime} \end{array} \right) \]

for weight $ \mathcal{W}^{\prime} $ subtracted from $ \mathcal{W}^{\prime} $. The result replaces the data content of $ \mathcal{W} $.

Returns:
Reference to self.
Parameters:
[in] wght reference to non-modifiable Weight object to be subtracted.
xAOD::MissingETComponent_v1::Weight & xAOD::MissingETComponent_v1::Weight::operator/= ( double  scale  ) 

Scale weight by division.

This operation updates the internal store of this object and yields

\[ \mathcal{W} / s = \left( \begin{array}{c} w_{x} / s \\ w_{y} / s \\ w_{\rm T} / s \end{array} \right) \]

for weight $ \mathcal{W} $ divided by a scale factor $ s $. The internal data content of $ \mathcal{W} $ is modified.

Note:
In case an invalid scale factor ( $ s = 0 $ ) is provided, the original weight $ \mathcal{W} $ is set to (0,0,0).
Returns:
Reference to self.
Parameters:
[in] scale scale factor $ s $.
The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1