AdcChannelMetric::MetricSummary Class Reference

Public Member Functions
void	add (double val, double weight)
double	neff () const
double	mean () const
double	dmean () const
double	meansq () const
double	rms () const
double	drms () const
double	sdev () const
double	center () const
double	range () const
double	getValue (Name vnam) const

Static Public Member Functions
static bool	isValueName (Name vnam)

Public Attributes
Index	weightFlag = 0
Index	eventCount = 0
Index	weightedEventCount = 0
double	weightSum
double	sum = 0.0
double	sumsq = 0.0
double	minval = 0.0
double	maxval = 0.0

Detailed Description

Definition at line 223 of file AdcChannelMetric.h.

Member Function Documentation

void AdcChannelMetric::MetricSummary::add ( double  val, double  weight  )

inline

Definition at line 234 of file AdcChannelMetric.h.

                                        {
      ++eventCount;
      if ( weight <= 0.0 ) return;
      ++weightedEventCount;
      if ( weightSum == 0 || val < minval ) minval = val;
      if ( weightSum == 0 || val > maxval ) maxval = val;
      weightSum += weight;
      sum += weight*val;
      sumsq += weight*val*val;
    }

double AdcChannelMetric::MetricSummary::center ( ) const

inline

Definition at line 262 of file AdcChannelMetric.h.

{ return 0.5*(minval + maxval); }

double AdcChannelMetric::MetricSummary::dmean ( ) const

inline

Definition at line 246 of file AdcChannelMetric.h.

{ return weightSum > 0.0 ? sdev()/sqrt(neff()) : 0.0; }

double AdcChannelMetric::MetricSummary::drms ( ) const

inline

Definition at line 251 of file AdcChannelMetric.h.

                        {
      if ( weightSum <= 0.0 ) return 0.0;
      double rmsVal = rms();
      double rmsVar = meansq() + rmsVal*(rmsVal - 2.0*mean());
      return rmsVar > 0.0 ? sqrt(rmsVar/neff()) : 0.0;
    }

double AdcChannelMetric::MetricSummary::getValue ( Name  vnam ) const

inline

Definition at line 273 of file AdcChannelMetric.h.

                                     {
      if ( vnam == "weightFlag" ) return weightFlag;
      if ( vnam == "weightedEventCount" ) return weightedEventCount;
      if ( vnam == "eventCount" ) return eventCount;
      if ( vnam == "weightSum" ) return weightSum;
      if ( vnam == "mean" ) return mean();
      if ( vnam == "rms" ) return rms();
      if ( vnam == "sdev" ) return sdev();
      if ( vnam == "min" ) return minval;
      if ( vnam == "max" ) return maxval;
      if ( vnam == "center" ) return center();
      if ( vnam == "range" ) return range();
      if ( vnam == "halfRange" ) return 0.5*range();
      if ( vnam == "dmean" ) return dmean();
      if ( vnam == "drms" ) return drms();
      return 0.0;
    }

static bool AdcChannelMetric::MetricSummary::isValueName ( Name  vnam )

inlinestatic

Definition at line 265 of file AdcChannelMetric.h.

                                       {
      const std::set<Name> sumVals =
        {"weightFlag", "eventCount", "weightedEventCount", "weightSum",
         "mean", "rms", "sdev", "min", "max", "dmean", "drms",
         "center", "range", "halfRange"};
      return sumVals.find(vnam) != sumVals.end();
    }

double AdcChannelMetric::MetricSummary::mean ( ) const

inline

Definition at line 245 of file AdcChannelMetric.h.

{ return weightSum ? sum/weightSum : 0.0; }

double AdcChannelMetric::MetricSummary::meansq ( ) const

inline

Definition at line 247 of file AdcChannelMetric.h.

{ return weightSum ? sumsq/weightSum : 0.0; }

double AdcChannelMetric::MetricSummary::neff ( ) const

inline

Definition at line 244 of file AdcChannelMetric.h.

{ return weightFlag ? weightSum : weightedEventCount; }

double AdcChannelMetric::MetricSummary::range ( ) const

inline

Definition at line 263 of file AdcChannelMetric.h.

{ return  maxval - minval; }

double AdcChannelMetric::MetricSummary::rms ( ) const

inline

Definition at line 248 of file AdcChannelMetric.h.

                       {
      return sqrt(meansq());
    }

double AdcChannelMetric::MetricSummary::sdev ( ) const

inline

Definition at line 257 of file AdcChannelMetric.h.

                        {
      double valm = mean();
      double arg = meansq() - valm*valm;
      return arg > 0 ? sqrt(arg) : 0.0;
    }

Member Data Documentation

Index AdcChannelMetric::MetricSummary::eventCount = 0

Definition at line 226 of file AdcChannelMetric.h.

double AdcChannelMetric::MetricSummary::maxval = 0.0

Definition at line 232 of file AdcChannelMetric.h.

double AdcChannelMetric::MetricSummary::minval = 0.0

Definition at line 231 of file AdcChannelMetric.h.

double AdcChannelMetric::MetricSummary::sum = 0.0

Definition at line 229 of file AdcChannelMetric.h.

double AdcChannelMetric::MetricSummary::sumsq = 0.0

Definition at line 230 of file AdcChannelMetric.h.

Index AdcChannelMetric::MetricSummary::weightedEventCount = 0

Definition at line 227 of file AdcChannelMetric.h.

Index AdcChannelMetric::MetricSummary::weightFlag = 0

Definition at line 225 of file AdcChannelMetric.h.

double AdcChannelMetric::MetricSummary::weightSum

Definition at line 228 of file AdcChannelMetric.h.

---

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

• dunedataprep/dunedataprep/DataPrep/Tool/AdcChannelMetric.h