npstat::StorableHistoNDFunctor< Numeric, Axis, Converter > Class Template Reference

#include <StorableHistoNDFunctor.h>

Inheritance diagram for npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >:

Public Types
typedef HistoND< Numeric, Axis >	Table

Public Member Functions
unsigned	interpolationDegree () const
unsigned	minDim () const override
double	operator() (const double *point, unsigned dim) const override
void	setConverter (const Converter &conv)
void	setInterpolationDegree (const unsigned deg)
template<class Num2 , class Conv2 >
	StorableHistoNDFunctor (const StorableHistoNDFunctor< Num2, Axis, Conv2 > &tab)
	~StorableHistoNDFunctor () override
template<class Num2 >
	StorableHistoNDFunctor (const HistoND< Num2, Axis > &table, const unsigned degree=1)
template<class Num2 >
	StorableHistoNDFunctor (const HistoND< Num2, Axis > &table, const unsigned degree, const std::string &descr)
Table &	interpolator ()
const Table &	interpolator () const
ArrayND< Numeric > &	table ()
const ArrayND< Numeric > &	table () const
gs::ClassId	classId () const override
bool	write (std::ostream &of) const override
Public Member Functions inherited from npstat::StorableMultivariateFunctor
const std::string &	description () const
void	setDescription (const std::string &newDescription)
	StorableMultivariateFunctor ()
	StorableMultivariateFunctor (const std::string &descr)
void	validateDescription (const std::string &description) const
	~StorableMultivariateFunctor () override
bool	operator== (const StorableMultivariateFunctor &r) const
bool	operator!= (const StorableMultivariateFunctor &r) const
Public Member Functions inherited from npstat::AbsMultivariateFunctor
virtual unsigned	maxDim () const
virtual	~AbsMultivariateFunctor ()

Static Public Member Functions
static const char *	classname ()
static StorableHistoNDFunctor *	read (const gs::ClassId &id, std::istream &in)
static unsigned	version ()
Static Public Member Functions inherited from npstat::StorableMultivariateFunctor
static const char *	classname ()
static StorableMultivariateFunctor *	read (const gs::ClassId &id, std::istream &in)
static unsigned	version ()

Protected Member Functions
bool	isEqual (const StorableMultivariateFunctor &other) const override

Private Member Functions
	StorableHistoNDFunctor ()=delete

Static Private Member Functions
static void	validateInterDegree (unsigned deg, bool isUniform)

Private Attributes
Converter	conv_
unsigned	deg_
Table	table_

Friends
template<typename Num2 , typename Axis2 , typename Conv2 >
class	StorableHistoNDFunctor

Detailed Description

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>
class npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >

This class adapts HistoND template together with various histogram interpolation functions to the StorableMultivariateFunctor interface

Definition at line 26 of file StorableHistoNDFunctor.h.

Member Typedef Documentation

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

typedef HistoND<Numeric, Axis> npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::Table

Definition at line 31 of file StorableHistoNDFunctor.h.

Constructor & Destructor Documentation

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

template<class Num2 >

npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor ( const HistoND< Num2, Axis > &  table, const unsigned  degree = 1  )

inline

Constructor from a pre-existing histogram. The "degree" argument specifies the interpolation degree which can be 0, 1, or 3.

Definition at line 40 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::isUniformlyBinned(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::validateInterDegree().

        : StorableMultivariateFunctor(), table_(table), deg_(degree) {
      validateInterDegree(degree, table.isUniformlyBinned());
    }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

template<class Num2 >

npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor ( const HistoND< Num2, Axis > &  table, const unsigned  degree, const std::string &  descr  )

inline

Definition at line 46 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::isUniformlyBinned(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::validateInterDegree().

        : StorableMultivariateFunctor(descr), table_(table), deg_(degree) {
      validateInterDegree(degree, table.isUniformlyBinned());
    }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

template<class Num2 , class Conv2 >

npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor ( const StorableHistoNDFunctor< Num2, Axis, Conv2 > &  tab )

inline

Converting copy constructor

Definition at line 54 of file StorableHistoNDFunctor.h.

        : StorableMultivariateFunctor(tab.description()),
          table_(tab.table_, Same<Num2>(), tab.title().c_str(), tab.accumulatedDataLabel().c_str()),
          deg_(tab.deg_) {}

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::~StorableHistoNDFunctor ( )

inlineoverride

Definition at line 59 of file StorableHistoNDFunctor.h.

{}

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor ( )

privatedelete

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::isEqual(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::read().

Member Function Documentation

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

gs::ClassId npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::classId ( ) const

inlineoverridevirtual

Method related to "geners" I/O

Implements npstat::StorableMultivariateFunctor.

Definition at line 89 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::classname(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::write().

{ return gs::ClassId(*this); }

template<class Numeric , class Axis , class Converter >

const char * npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::classname ( )

inlinestatic

Definition at line 132 of file StorableHistoNDFunctor.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::classId().

                                                                          {
    static const std::string myClass(gs::template_class_name<Numeric, Axis>("npstat::StorableHistoNDFunctor"));
    return myClass.c_str();
  }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

unsigned npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolationDegree ( ) const

inline

Retrieve interpolation degree

Definition at line 66 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::deg_, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setInterpolationDegree().

{ return deg_; }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

Table& npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolator ( )

inline

Retrieve the underlying HistoND object

Definition at line 73 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

{ return table_; }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

const Table& npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolator ( ) const

inline

Definition at line 74 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

{ return table_; }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

bool npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::isEqual ( const StorableMultivariateFunctor &  ) const

inlineoverrideprotectedvirtual

Method needed to compare objects for equality. Must be overriden by derived classes. It is left up to the derived classes to decide whether they should compare description strings in order to establish equality.

Implements npstat::StorableMultivariateFunctor.

Definition at line 99 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::deg_, npstat::StorableMultivariateFunctor::description(), trackingPlots::other, alignCSCRings::r, npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

                                                                          {
      // Note the use of static_cast rather than dynamic_cast below.
      // static_cast works faster and it is guaranteed to succeed here.
      const StorableHistoNDFunctor& r = static_cast<const StorableHistoNDFunctor&>(other);
      return table_ == r.table_ && deg_ == r.deg_ && this->description() == other.description();
    }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

unsigned npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::minDim ( ) const

inlineoverridevirtual

Minimum expected dimensionality

Implements npstat::AbsMultivariateFunctor.

Definition at line 61 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::dim(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::operator()(), point, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

{ return table_.dim(); };

template<class Numeric , class Axis , class Converter >

double npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::operator() ( const double *  point, unsigned  dim  ) const

overridevirtual

Function value

Implements npstat::AbsMultivariateFunctor.

Definition at line 127 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::conv_, npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::deg_, npstat::interpolateHistoND(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::minDim().

                                                                                                                   {
    return conv_(interpolateHistoND(table_, point, dim, deg_));
  }

template<class Numeric , class Axis , class Converter >

StorableHistoNDFunctor< Numeric, Axis, Converter > * npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::read ( const gs::ClassId &  id, std::istream &  in  )

static

Definition at line 145 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::read(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edmIntegrityCheck.PublishToFileSystem::get(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::version().

                                           {
    static const gs::ClassId current(gs::ClassId::makeId<StorableHistoNDFunctor<Numeric, Axis> >());
    current.ensureSameId(id);

    std::string descr;
    gs::read_pod(in, &descr);
    unsigned deg;
    gs::read_pod(in, &deg);
    gs::ClassId tabid(in, 1);
    if (in.fail())
      throw gs::IOReadFailure(
          "In npstat::StorableHistoNDFunctor::read: "
          "input stream failure");
    CPP11_auto_ptr<Table> tab(Table::read(tabid, in));
    return new StorableHistoNDFunctor(*tab, deg, descr);
  }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

void npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setConverter ( const Converter &  conv )

inline

Change the coordinate converter

Definition at line 85 of file StorableHistoNDFunctor.h.

References conv, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::conv_.

{ conv_ = conv; }

template<class Numeric , class Axis , class Converter >

void npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setInterpolationDegree ( const unsigned  deg )

inline

Set interpolation degree (0, 1, or 3)

Definition at line 164 of file StorableHistoNDFunctor.h.

References npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::deg_, npstat::HistoND< Numeric, Axis >::isUniformlyBinned(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::validateInterDegree().

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolationDegree().

                                                                                                         {
    validateInterDegree(deg, table_.isUniformlyBinned());
    deg_ = deg;
  }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

ArrayND<Numeric>& npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table ( )

inline

Retrieve the tabulated data

Definition at line 79 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::binContents(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

{ return const_cast<ArrayND<Numeric>&>(table_.binContents()); }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

const ArrayND<Numeric>& npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table ( ) const

inline

Definition at line 81 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::binContents(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_.

{ return table_.binContents(); }

template<class Numeric , class Axis , class Converter >

void npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::validateInterDegree ( unsigned  deg, bool  isUniform  )

inlinestaticprivate

Definition at line 170 of file StorableHistoNDFunctor.h.

References convertSQLiteXML::ok.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setInterpolationDegree(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor().

                                                                                                          {
    const bool ok = isUniform ? (deg == 0 || deg == 1 || deg == 3) : (deg == 0 || deg == 1);
    if (!ok)
      throw npstat::NpstatInvalidArgument(
          "In npstat::StorableHistoNDFunctor::validateInterDegree: "
          "unsupported interpolation degree");
  }

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

static unsigned npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::version ( )

inlinestatic

Definition at line 95 of file StorableHistoNDFunctor.h.

References recoMuon::in, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::read().

Referenced by validation.Sample::datasetpattern(), and validation.Sample::filename().

{ return 1; }

template<class Numeric , class Axis , class Converter >

bool npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::write ( std::ostream &  of ) const

overridevirtual

Implements npstat::StorableMultivariateFunctor.

Definition at line 138 of file StorableHistoNDFunctor.h.

References npstat::HistoND< Numeric, Axis >::classId(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::deg_, npstat::StorableMultivariateFunctor::description(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_, and npstat::HistoND< Numeric, Axis >::write().

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::classId().

                                                                                   {
    gs::write_pod(of, this->description());
    gs::write_pod(of, deg_);
    return table_.classId().write(of) && table_.write(of);
  }

Friends And Related Function Documentation

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

template<typename Num2 , typename Axis2 , typename Conv2 >

friend class StorableHistoNDFunctor

friend

Definition at line 28 of file StorableHistoNDFunctor.h.

Member Data Documentation

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

Converter npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::conv_

private

Definition at line 111 of file StorableHistoNDFunctor.h.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::operator()(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setConverter().

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

unsigned npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::deg_

private

Definition at line 110 of file StorableHistoNDFunctor.h.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolationDegree(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::isEqual(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::operator()(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setInterpolationDegree(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::write().

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>

Table npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table_

private

Definition at line 109 of file StorableHistoNDFunctor.h.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolator(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::isEqual(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::minDim(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::operator()(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setInterpolationDegree(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table(), and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::write().