YODA::YStatsMixin< Derived > Struct Template Reference

CRTP mixin introducing convenience aliases to access statistics along Y axis. More...

#include <BinnedUtils.h>

Public Member Functions
Whole histo data
double	yMean (const bool includeOverflows=true) const noexcept
	Calculate the mean on Y axis.
double	yVariance (const bool includeOverflows=true) const noexcept
	Calculate the variance on Y axis.
double	yStdDev (const bool includeOverflows=true) const noexcept
	Calculate the standard deviation on Y axis.
double	yStdErr (const bool includeOverflows=true) const noexcept
	Calculate the standard error on Y axis.
double	yRMS (const bool includeOverflows=true) const noexcept
	Calculate the RMS on Y axis.

Detailed Description

template<class Derived>
struct YODA::YStatsMixin< Derived >

CRTP mixin introducing convenience aliases to access statistics along Y axis.

Definition at line 163 of file BinnedUtils.h.

Member Function Documentation

yMean()

template<class Derived >

double YODA::YStatsMixin< Derived >::yMean ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the mean on Y axis.

Definition at line 169 of file BinnedUtils.h.

                                                                  {
      return static_cast<const Derived*>(this)->mean(1, includeOverflows);
    }

References YODA::mean().

yRMS()

template<class Derived >

double YODA::YStatsMixin< Derived >::yRMS ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the RMS on Y axis.

Definition at line 189 of file BinnedUtils.h.

                                                                 {
      return static_cast<const Derived*>(this)->rms(1, includeOverflows);
    }

yStdDev()

template<class Derived >

double YODA::YStatsMixin< Derived >::yStdDev ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the standard deviation on Y axis.

Definition at line 179 of file BinnedUtils.h.

                                                                    {
      return static_cast<const Derived*>(this)->stdDev(1, includeOverflows);
    }

References YODA::stdDev().

yStdErr()

template<class Derived >

double YODA::YStatsMixin< Derived >::yStdErr ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the standard error on Y axis.

Definition at line 184 of file BinnedUtils.h.

                                                                    {
      return static_cast<const Derived*>(this)->stdErr(1, includeOverflows);
    }

References YODA::stdErr().

yVariance()

template<class Derived >

double YODA::YStatsMixin< Derived >::yVariance ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the variance on Y axis.

Definition at line 174 of file BinnedUtils.h.

                                                                      {
      return static_cast<const Derived*>(this)->variance(1, includeOverflows);
    }

References YODA::variance().

---

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

• include/YODA/Utils/BinnedUtils.h