Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
pandora::ClusterFitResult Class Reference

ClusterFitResult class. More...

#include "ClusterFitHelper.h"

Collaboration diagram for pandora::ClusterFitResult:

Public Member Functions

 ClusterFitResult ()
 Default constructor.
 
bool IsFitSuccessful () const
 Query whether fit was successful.
 
const CartesianVectorGetDirection () const
 Get the fit direction.
 
const CartesianVectorGetIntercept () const
 Get the fit intercept.
 
float GetChi2 () const
 Get the fit ch2.
 
float GetRms () const
 Get the fit rms.
 
float GetRadialDirectionCosine () const
 Get the fit direction cosine w.r.t. the radial direction.
 
void SetSuccessFlag (const bool successFlag)
 Set the fit success flag.
 
void SetDirection (const CartesianVector &direction)
 Set the fit direction.
 
void SetIntercept (const CartesianVector &intercept)
 Set the fit intercept.
 
void SetChi2 (const float chi2)
 Set the fit chi2.
 
void SetRms (const float rms)
 Set the fit rms.
 
void SetRadialDirectionCosine (const float radialDirectionCosine)
 Set the fit direction cosine w.r.t. the radial direction.
 
void Reset ()
 Reset the cluster fit result.
 

Private Attributes

bool m_isFitSuccessful
 Whether the fit was successful.
 
CartesianVector m_direction
 The best fit direction.
 
CartesianVector m_intercept
 The best fit intercept.
 
InputFloat m_chi2
 The chi2 value for the fit.
 
InputFloat m_rms
 The rms of the fit.
 
InputFloat m_dirCosR
 The direction cosine wrt to the radial direction.
 

Detailed Description

ClusterFitResult class.

Definition at line 101 of file ClusterFitHelper.h.

Constructor & Destructor Documentation

◆ ClusterFitResult()

pandora::ClusterFitResult::ClusterFitResult ( )
inline

Default constructor.

Definition at line 325 of file ClusterFitHelper.h.

Member Function Documentation

◆ GetChi2()

float pandora::ClusterFitResult::GetChi2 ( ) const
inline

Get the fit ch2.

Returns
the fit chi2

Definition at line 361 of file ClusterFitHelper.h.

Here is the call graph for this function:

◆ GetDirection()

const CartesianVector & pandora::ClusterFitResult::GetDirection ( ) const
inline

Get the fit direction.

Returns
the fit direction

Definition at line 341 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ GetIntercept()

const CartesianVector & pandora::ClusterFitResult::GetIntercept ( ) const
inline

Get the fit intercept.

Returns
the fit intercept

Definition at line 351 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ GetRadialDirectionCosine()

float pandora::ClusterFitResult::GetRadialDirectionCosine ( ) const
inline

Get the fit direction cosine w.r.t. the radial direction.

Returns
the fit direction cosine w.r.t. the radial direction

Definition at line 381 of file ClusterFitHelper.h.

Here is the call graph for this function:

◆ GetRms()

float pandora::ClusterFitResult::GetRms ( ) const
inline

Get the fit rms.

Returns
the fit rms

Definition at line 371 of file ClusterFitHelper.h.

Here is the call graph for this function:

◆ IsFitSuccessful()

bool pandora::ClusterFitResult::IsFitSuccessful ( ) const
inline

Query whether fit was successful.

Returns
boolean

Definition at line 334 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ Reset()

void pandora::ClusterFitResult::Reset ( )
inline

Reset the cluster fit result.

Definition at line 436 of file ClusterFitHelper.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetChi2()

void pandora::ClusterFitResult::SetChi2 ( const float  chi2)
inline

Set the fit chi2.

Parameters
chi2the fit chi2

Definition at line 412 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ SetDirection()

void pandora::ClusterFitResult::SetDirection ( const CartesianVector direction)
inline

Set the fit direction.

Parameters
directionthe fit direction

Definition at line 398 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ SetIntercept()

void pandora::ClusterFitResult::SetIntercept ( const CartesianVector intercept)
inline

Set the fit intercept.

Parameters
interceptthe fit intercept

Definition at line 405 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ SetRadialDirectionCosine()

void pandora::ClusterFitResult::SetRadialDirectionCosine ( const float  radialDirectionCosine)
inline

Set the fit direction cosine w.r.t. the radial direction.

Parameters
radialDirectionCosinethe fit direction cosine w.r.t. the radial direction

Definition at line 428 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ SetRms()

void pandora::ClusterFitResult::SetRms ( const float  rms)
inline

Set the fit rms.

Parameters
rmsthe fit rms

Definition at line 420 of file ClusterFitHelper.h.

Here is the caller graph for this function:

◆ SetSuccessFlag()

void pandora::ClusterFitResult::SetSuccessFlag ( const bool  successFlag)
inline

Set the fit success flag.

Parameters
successFlagthe fit success flag

Definition at line 391 of file ClusterFitHelper.h.

Here is the caller graph for this function:

Member Data Documentation

◆ m_chi2

InputFloat pandora::ClusterFitResult::m_chi2
private

The chi2 value for the fit.

Definition at line 202 of file ClusterFitHelper.h.

◆ m_dirCosR

InputFloat pandora::ClusterFitResult::m_dirCosR
private

The direction cosine wrt to the radial direction.

Definition at line 204 of file ClusterFitHelper.h.

◆ m_direction

CartesianVector pandora::ClusterFitResult::m_direction
private

The best fit direction.

Definition at line 200 of file ClusterFitHelper.h.

◆ m_intercept

CartesianVector pandora::ClusterFitResult::m_intercept
private

The best fit intercept.

Definition at line 201 of file ClusterFitHelper.h.

◆ m_isFitSuccessful

bool pandora::ClusterFitResult::m_isFitSuccessful
private

Whether the fit was successful.

Definition at line 199 of file ClusterFitHelper.h.

◆ m_rms

InputFloat pandora::ClusterFitResult::m_rms
private

The rms of the fit.

Definition at line 203 of file ClusterFitHelper.h.


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