cmf::Parameter Class Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-05-06/CovarianceMatrixFit/dataProducts/Parameter.h"

Public Member Functions
	Parameter ()
	Parameter (std::string const &name, cmf::DetType_t const &det, double const &val, bool const &fixed, float const &sigmaSize, float const &cv, float const &variance, bool const &nuisance, bool const &constrained, float const &lowerBound, float const &upperBound)
std::string const	Name () const
cmf::ParType_t const	ParType () const
double const &	Value () const
uint8_t const &	Key () const
cmf::DetType_t const	Detector () const
float const &	CentralValue () const
float const &	Sigma () const
float const &	Variance () const
bool const &	IsFixed () const
bool	IsOscPar () const
bool const &	IsConstrained () const
bool const &	IsNuisance () const
float const &	LowerBound () const
float const &	UpperBound () const
void	SetValue (double const &val)
bool	operator< (cmf::Parameter const &other) const
bool	operator== (cmf::Parameter const &other) const

Private Attributes
uint8_t	fKey
	key for this parameter More...
uint8_t	fDetector
	which detector is this parameter for? More...
double	fVal
	current value for the parameter in the fit More...
float	fCentralVal
	central value for the parameter More...
float	fSigmaSize
	size of 1 sigma More...
float	fVariance
	amount parameter can vary when making random universes More...
bool	fIsFixed
	is this parameter fixed during fits? More...
bool	fIsNuisance
	is this parameter treated as a nuisance parameter? More...
bool	fIsConstrained
	is this parameter constrained in allowed values? More...
float	fLowerBound
	lower bound for the constrained parameter More...
float	fUpperBound
	upper bound for the constrained parameter More...
uint8_t	fParType
	type of paramter this is More...

Friends
std::ostream &	operator<< (std::ostream &o, cmf::Parameter const &par)

Detailed Description

Definition at line 115 of file Parameter.h.

Constructor & Destructor Documentation

cmf::Parameter::Parameter

(

)

Definition at line 97 of file Parameter.cxx.

  : fDetector     (cmf::kFARDET       )
  , fVal          (cmf::kGarbageDouble)
  , fCentralVal   (cmf::kGarbageFloat )
  , fSigmaSize    (1.e-5              )
  , fVariance     (1.e-5              )
  , fIsFixed      (false              )
  , fIsNuisance   (false              )
  , fIsConstrained(false              )
  , fLowerBound   (cmf::kGarbageFloat )
  , fUpperBound   (cmf::kGarbageFloat )
  , fParType      (cmf::kUnknownPar   )
  {
  }

cmf::Parameter::Parameter	(	std::string const &	name,
		cmf::DetType_t const &	det,
		double const &	val,
		bool const &	fixed,
		float const &	sigmaSize,
		float const &	cv,
		float const &	variance,
		bool const &	nuisance,
		bool const &	constrained,
		float const &	lowerBound,
		float const &	upperBound
	)

Definition at line 113 of file Parameter.cxx.

References e, fIsFixed, fIsNuisance, fKey, fParType, fVariance, cmf::IsOscillationParameter(), cmf::kCalibSystPar, cmf::kCMFNormSystPar, cmf::kCMFSystPar, cmf::kCMFWeightPar, cmf::kEShiftSystPar, cmf::kFirstCalibrationVar, cmf::kFirstEShiftVar, cmf::kFirstNormalizationVar, cmf::kFirstSigmaVar, cmf::kLastCalibrationVar, cmf::kLastEShiftVar, cmf::kLastNormalizationVar, cmf::kLastSigmaVar, cmf::kOscPar, cmf::kOtherSystPar, cmf::kPPFXFluxCVWgt, cmf::kRPARES_Weight, cmf::kXSecCV2020Wgt, cmf::kXSecCVPPFX_Weight, MF_LOG_WARNING, cmf::StringToOscParmType(), and cmf::VarNameToKey().

  : fDetector     (det             )
  , fVal          (val             )
  , fCentralVal   (cv              )
  , fSigmaSize    (sigmaSize       )
  , fVariance     (variance        )
  , fIsFixed      (fixed           )
  , fIsNuisance   (nuisance        )
  , fIsConstrained(constrained     )
  , fLowerBound   (lowerBound      )
  , fUpperBound   (upperBound      )
  , fParType      (cmf::kUnknownPar)
  {
    if(fVariance < 1.e-5) fVariance = 1.e-5;

    if(cmf::IsOscillationParameter(name)){
      fParType = cmf::kOscPar;
      fKey     = cmf::StringToOscParmType(name);
    }
    else{
      fKey = cmf::VarNameToKey(name);
      if(fKey >= cmf::kFirstSigmaVar && fKey <= cmf::kLastSigmaVar) 
        fParType = cmf::kCMFSystPar;
      else if (fKey >= kFirstNormalizationVar && fKey <= cmf::kLastNormalizationVar)
        fParType = cmf::kCMFNormSystPar;
      else if (fKey >= kFirstCalibrationVar && fKey <= cmf::kLastCalibrationVar) 
        fParType = cmf::kCalibSystPar;
      else if (fKey >= kFirstEShiftVar && fKey <= cmf::kLastEShiftVar)
        fParType = cmf::kEShiftSystPar;
      else if (fKey == kXSecCV2020Wgt || fKey == kXSecCVPPFX_Weight || fKey == kPPFXFluxCVWgt || fKey == kRPARES_Weight)
        fParType = cmf::kCMFWeightPar;
      else
        fParType = cmf::kOtherSystPar;
    }
      

    // sanity check warning - if the parameter is fixed and labeled as nuisance,
    // tell the user that the fixed part wins
    if(fIsFixed && fIsNuisance){
      MF_LOG_WARNING("Parameter")
          << name
          << " is set to be fixed but is also set to be a nuisance parameter, "
          << "assume that leaving it fixed is correct and set IsNuisance to "
          << " false";

      fIsNuisance = false;
    }

  }

Member Function Documentation

float const& cmf::Parameter::CentralValue ( ) const

inline

Definition at line 137 of file Parameter.h.

{ return fCentralVal;                }

cmf::DetType_t const cmf::Parameter::Detector ( ) const

inline

Definition at line 136 of file Parameter.h.

References cmf::ParameterSpaceLoc::fDetector.

Referenced by cmf::ParameterSpaceLoc::InsertParameter(), and cmf::Location::InsertParameter().

{ return (cmf::DetType_t)fDetector;  }

bool const& cmf::Parameter::IsConstrained ( ) const

inline

Definition at line 142 of file Parameter.h.

Referenced by cmf::CovarianceFitHelper::InitializeMinimizer(), and cmf::operator<<().

{ return fIsConstrained;             }

bool const& cmf::Parameter::IsFixed ( ) const

inline

Definition at line 140 of file Parameter.h.

Referenced by cmf::operator<<().

{ return fIsFixed;                   }

bool const& cmf::Parameter::IsNuisance ( ) const

inline

Definition at line 143 of file Parameter.h.

Referenced by cmf::ChiSqrCalculator::ChiSqrNuisance(), and cmf::operator<<().

{ return fIsNuisance;                }

bool cmf::Parameter::IsOscPar ( ) const

inline

Definition at line 141 of file Parameter.h.

References cmf::kOscPar.

Referenced by cmf::operator<<().

{ return (fParType == cmf::kOscPar); }

uint8_t const& cmf::Parameter::Key ( ) const

inline

Definition at line 135 of file Parameter.h.

Referenced by operator<(), and operator==().

{ return fKey;                       }

float const& cmf::Parameter::LowerBound ( ) const

inline

Definition at line 144 of file Parameter.h.

Referenced by cmf::operator<<().

{ return fLowerBound;                }

std::string const cmf::Parameter::Name ( ) const

inline

Definition at line 132 of file Parameter.h.

References cmf::cOscParams_Strings(), cmf::KeyToVarName(), and cmf::kOscPar.

Referenced by cmf::ParameterSpaceLoc::InsertParameter(), cmf::Location::InsertParameter(), and cmf::operator<<().

{ return (fParType == cmf::kOscPar) ? cmf::cOscParams_Strings[fKey] : cmf::KeyToVarName(fKey);  }

bool cmf::Parameter::operator<

(

cmf::Parameter const &

other

)

const

Definition at line 174 of file Parameter.cxx.

References fKey, and Key().

                                                           {
    return fKey < other.Key();
  }

bool cmf::Parameter::operator==

(

cmf::Parameter const &

other

)

const

Definition at line 179 of file Parameter.cxx.

References fKey, and Key().

                                                            {
    return fKey == other.Key();
  }

cmf::ParType_t const cmf::Parameter::ParType ( ) const

inline

Definition at line 133 of file Parameter.h.

{ return (cmf::ParType_t)fParType;   }

void cmf::Parameter::SetValue ( double const &  val )

inline

Definition at line 147 of file Parameter.h.

References msf_helper::o, ana::operator<(), cmf::operator<<(), operator==(), fhicl::other, par, and febshutoff_auto::val.

{ fVal = val; }

float const& cmf::Parameter::Sigma ( ) const

inline

Definition at line 138 of file Parameter.h.

Referenced by cmf::ShifterAndWeighter::ShiftForParameter().

{ return fSigmaSize;                 }

float const& cmf::Parameter::UpperBound ( ) const

inline

Definition at line 145 of file Parameter.h.

Referenced by cmf::operator<<().

{ return fUpperBound;                }

double const& cmf::Parameter::Value ( ) const

inline

Definition at line 134 of file Parameter.h.

Referenced by cmf::ShifterAndWeighter::CurrentParameterValue(), cmf::Location::InsertParameter(), cmf::operator<<(), and cmf::CovarianceMatrixMaker::SetSystematicParameter().

{ return fVal;                       }

float const& cmf::Parameter::Variance ( ) const

inline

Definition at line 139 of file Parameter.h.

{ return fVariance;                  }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, cmf::Parameter const &  par  )

friend

Definition at line 184 of file Parameter.cxx.

                                                                 {

    o  << "-- parameter: "
       << std::setw(30)     << par.Name()  << std::setw(10)
       << " val: "          << par.Value()
       << " fixed: "        << par.IsFixed()
       << " oscillation "   << par.IsOscPar()
       << " nuisance "      << par.IsNuisance()
       << " constrained "   << par.IsConstrained()
       << " lower: "        << par.LowerBound()
       << " upper: "        << par.UpperBound()
       << std::endl;

    return o;
  }

Member Data Documentation

float cmf::Parameter::fCentralVal

private

central value for the parameter

Definition at line 158 of file Parameter.h.

uint8_t cmf::Parameter::fDetector

private

which detector is this parameter for?

Definition at line 156 of file Parameter.h.

bool cmf::Parameter::fIsConstrained

private

is this parameter constrained in allowed values?

Definition at line 163 of file Parameter.h.

bool cmf::Parameter::fIsFixed

private

is this parameter fixed during fits?

Definition at line 161 of file Parameter.h.

Referenced by Parameter().

bool cmf::Parameter::fIsNuisance

private

is this parameter treated as a nuisance parameter?

Definition at line 162 of file Parameter.h.

Referenced by Parameter().

uint8_t cmf::Parameter::fKey

private

key for this parameter

Definition at line 155 of file Parameter.h.

Referenced by operator<(), operator==(), and Parameter().

float cmf::Parameter::fLowerBound

private

lower bound for the constrained parameter

Definition at line 164 of file Parameter.h.

uint8_t cmf::Parameter::fParType

private

type of paramter this is

Definition at line 166 of file Parameter.h.

Referenced by Parameter().

float cmf::Parameter::fSigmaSize

private

size of 1 sigma

Definition at line 159 of file Parameter.h.

float cmf::Parameter::fUpperBound

private

upper bound for the constrained parameter

Definition at line 165 of file Parameter.h.

double cmf::Parameter::fVal

private

current value for the parameter in the fit

Definition at line 157 of file Parameter.h.

float cmf::Parameter::fVariance

private

amount parameter can vary when making random universes

Definition at line 160 of file Parameter.h.

Referenced by Parameter().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-05-06/CovarianceMatrixFit/dataProducts/Parameter.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-05-06/CovarianceMatrixFit/dataProducts/Parameter.cxx