LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_content::SupportVectorMachine::FeatureInfo Class Reference

FeatureInfo class. More...

Public Member Functions

 FeatureInfo (const double muValue, const double sigmaValue)
 FeatureInfo class. More...
 
 FeatureInfo ()
 Default constructor to allow default-construction of (uninitialized) svms. More...
 
double StandardizeParameter (const double parameter) const
 Standardize a parameter corresponding to this feature. More...
 

Public Attributes

double m_muValue
 The average value of this feature. More...
 
double m_sigmaValue
 The stddev of this feature. More...
 

Detailed Description

FeatureInfo class.

Definition at line 132 of file LArSupportVectorMachine.h.

Constructor & Destructor Documentation

lar_content::SupportVectorMachine::FeatureInfo::FeatureInfo ( const double  muValue,
const double  sigmaValue 
)
inline

FeatureInfo class.

Parameters
muValuethe average value of this feature
sigmaValuethe stddev of this feature

Definition at line 410 of file LArSupportVectorMachine.h.

410  :
411  m_muValue(muValue),
412  m_sigmaValue(sigmaValue)
413 {
414 }
double m_muValue
The average value of this feature.
lar_content::SupportVectorMachine::FeatureInfo::FeatureInfo ( )
inline

Default constructor to allow default-construction of (uninitialized) svms.

Definition at line 418 of file LArSupportVectorMachine.h.

418  :
419  m_muValue(0.),
420  m_sigmaValue(0.)
421 {
422 }
double m_muValue
The average value of this feature.

Member Function Documentation

double lar_content::SupportVectorMachine::FeatureInfo::StandardizeParameter ( const double  parameter) const
inline

Standardize a parameter corresponding to this feature.

Parameters
parameterthe parameter
Returns
the standardized parameter

Definition at line 426 of file LArSupportVectorMachine.h.

References m_muValue, and m_sigmaValue.

427 {
428  if (m_sigmaValue < std::numeric_limits<double>::epsilon())
429  throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
430 
431  return (parameter - m_muValue) / m_sigmaValue;
432 }
double m_muValue
The average value of this feature.

Member Data Documentation

double lar_content::SupportVectorMachine::FeatureInfo::m_muValue

The average value of this feature.

Definition at line 157 of file LArSupportVectorMachine.h.

Referenced by StandardizeParameter().

double lar_content::SupportVectorMachine::FeatureInfo::m_sigmaValue

The stddev of this feature.

Definition at line 158 of file LArSupportVectorMachine.h.

Referenced by StandardizeParameter().


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