anab::MVAReader< T, N > Class Template Reference

#include "MVAReader.h"

Inheritance diagram for anab::MVAReader< T, N >:

Public Member Functions
	MVAReader (const art::Event &evt, const art::InputTag &tag)
std::vector< FeatureVector< N > > const &	outputs () const
	Access the vector of the feature vectors. More...
std::array< float, N >	getOutput (size_t key) const
	Get copy of the MVA output vector at index "key". More...
std::array< float, N >	getOutput (art::Ptr< T > const &item) const
	Get copy of the MVA output vector idicated with art::Ptr::key(). More...
std::array< float, N >	getOutput (std::vector< art::Ptr< T >> const &items) const
	Get MVA results accumulated over the vector of items (eg. over hits associated to a cluster). More...
std::array< float, N >	getOutput (std::vector< art::Ptr< T >> const &items, std::vector< float > const &weights) const
std::array< float, N >	getOutput (std::vector< art::Ptr< T >> const &items, std::function< float(T const &)> fweight) const
const std::string &	outputName (size_t index) const
	Meaning/name of the index'th column in the collection of MVA output vectors. More...
T const &	item (size_t key) const
	Access data product at index "key". More...
std::vector< T > const &	items () const
std::vector< FeatureVector< N > > const &	vectors () const
	Access the vector of the feature vectors. More...
std::array< float, N >	getVector (size_t key) const
	Get copy of the feature vector at index "key". More...
std::array< float, N >	getVector (art::Ptr< T > const &item) const
	Get copy of the feature vector idicated with art::Ptr::key(). More...
size_t	size () const
	Get the number of contained items (no. of data product objects equal to no. of feature vectors). More...
size_t	length () const
	Get the length of a single feature vector. More...
const std::string &	dataTag () const
	Get the input tag (string representation) of data product used to calculate feature vectors. More...
const art::Handle< std::vector< T > > &	dataHandle () const
	Access the data product handle. More...
const std::string &	columnName (size_t index) const
	Meaning/name of the index'th column in the collection of feature vectors. More...
int	getIndex (const std::string &name) const
	Index of column with given name, or -1 if name not found. More...

Static Public Member Functions
static std::unique_ptr< MVAReader >	create (const art::Event &evt, const art::InputTag &tag)

Protected Member Functions
std::string	getProductName (std::type_info const &ti) const
size_t	getProductHash (std::type_info const &ti) const
template<class T , size_t N>
std::array< float, N >	pAccumulate (std::vector< art::Ptr< T >> const &items, std::vector< FeatureVector< N >> const &outs) const
template<class T , size_t N>
std::array< float, N >	pAccumulate (std::vector< art::Ptr< T >> const &items, std::vector< float > const &weights, std::vector< FeatureVector< N >> const &outs) const
template<class T , size_t N>
std::array< float, N >	pAccumulate (std::vector< art::Ptr< T >> const &items, std::function< float(T const &)> fweight, std::vector< FeatureVector< N >> const &outs) const
template<class T , size_t N>
std::array< float, N >	pAccumulate (std::vector< art::Ptr< T >> const &items, std::function< float(art::Ptr< T > const &)> fweight, std::vector< FeatureVector< N >> const &outs) const
template<class T , size_t N>
std::array< float, N >	pAccumulate (std::vector< art::Ptr< T >> const &items, std::vector< FeatureVector< N >> const &outs, std::array< char, N > const &mask) const

Private Member Functions
	MVAReader (const art::Event &evt, const art::InputTag &tag, bool &success)
	Not-throwing constructor. More...

Detailed Description

template<class T, size_t N>
class anab::MVAReader< T, N >

Helper for reading the reconstructed objects of type T together with associated N-outputs MVA results with their metadata (this class is not a data product).

Definition at line 103 of file MVAReader.h.

Constructor & Destructor Documentation

template<class T, size_t N>

anab::MVAReader< T, N >::MVAReader ( const art::Event &  evt, const art::InputTag &  tag  )

inline

Create the wrapper for MVA data stored in the event evt with the provided input tag (the same tag which was used to save MVA results with MVAWriter class). Throws exception if data products not found in the event.

Definition at line 121 of file MVAReader.h.

: FVectorReader<T, N>(evt, tag) {}

template<class T, size_t N>

anab::MVAReader< T, N >::MVAReader ( const art::Event &  evt, const art::InputTag &  tag, bool &  success  )

inlineprivate

Not-throwing constructor.

Definition at line 167 of file MVAReader.h.

      : FVectorReader<T, N>(evt, tag, success)
    {}

Member Function Documentation

template<class T , size_t N>

const std::string& anab::FVectorReader< T, N >::columnName ( size_t  index ) const

inlineinherited

Meaning/name of the index'th column in the collection of feature vectors.

Definition at line 79 of file MVAReader.h.

References anab::FVectorReader< T, N >::fDescription.

Referenced by anab::MVAReader< T, N >::outputName().

{ return fDescription->outputName(index); }

template<class T, size_t N>

static std::unique_ptr<MVAReader> anab::MVAReader< T, N >::create ( const art::Event &  evt, const art::InputTag &  tag  )

inlinestatic

Create the wrapper for MVA data stored in the event evt with the provided input tag (the same tag which was used to save MVA results with MVAWriter class). Returns nullptr if data products not found in the event.

Definition at line 108 of file MVAReader.h.

Referenced by nnet::PointIdEffTest::analyze(), DUNE::NeutrinoShowerEff::checkCNNtrkshw(), trkf::PMAlgTrackMaker::getPdgFromCnnOnHits(), trkf::PMAlgTrackMaker::init(), and shower::EMShower::produce().

    {
      bool success;
      std::unique_ptr<MVAReader> ptr(new MVAReader(evt, tag, success));
      if (success) { return ptr; }
      else {
        return nullptr;
      }
    }

template<class T , size_t N>

const art::Handle<std::vector<T> >& anab::FVectorReader< T, N >::dataHandle ( ) const

inlineinherited

Access the data product handle.

Definition at line 76 of file MVAReader.h.

References anab::FVectorReader< T, N >::fDataHandle.

{ return fDataHandle; }

template<class T , size_t N>

const std::string& anab::FVectorReader< T, N >::dataTag ( ) const

inlineinherited

Get the input tag (string representation) of data product used to calculate feature vectors.

Definition at line 73 of file MVAReader.h.

References anab::FVectorReader< T, N >::fDescription.

{ return fDescription->dataTag(); }

template<class T , size_t N>

int anab::FVectorReader< T, N >::getIndex ( const std::string &  name ) const

inlineinherited

Index of column with given name, or -1 if name not found.

Definition at line 82 of file MVAReader.h.

References anab::FVectorReader< T, N >::fDescription.

Referenced by pdsp::CheckCNNScore::analyze(), and nnet::PointIdEffTest::analyze().

{ return fDescription->getIndex(name); }

template<class T, size_t N>

std::array<float, N> anab::MVAReader< T, N >::getOutput ( size_t  key ) const

inline

Get copy of the MVA output vector at index "key".

Definition at line 127 of file MVAReader.h.

References anab::FVectorReader< T, N >::getVector().

Referenced by pdsp::CheckCNNScore::analyze().

{ return FVectorReader<T, N>::getVector(key); }

template<class T, size_t N>

std::array<float, N> anab::MVAReader< T, N >::getOutput ( art::Ptr< T > const &  item ) const

inline

Get copy of the MVA output vector idicated with art::Ptr::key().

Definition at line 130 of file MVAReader.h.

References anab::FVectorReader< T, N >::getVector(), and art::Ptr< T >::key().

    {
      return FVectorReader<T, N>::getVector(item.key());
    }

template<class T, size_t N>

std::array<float, N> anab::MVAReader< T, N >::getOutput ( std::vector< art::Ptr< T >> const &  items ) const

inline

Get MVA results accumulated over the vector of items (eg. over hits associated to a cluster).

Definition at line 136 of file MVAReader.h.

References anab::FVectorReader< T, N >::items().

    {
      return pAccumulate(items, FVectorReader<T, N>::vectors());
    }

template<class T, size_t N>

std::array<float, N> anab::MVAReader< T, N >::getOutput ( std::vector< art::Ptr< T >> const &  items, std::vector< float > const &  weights  ) const

inline

Get MVA results accumulated with provided weights over the vector of items (eg. over clusters associated to a track, weighted by the cluster size; or over hits associated to a cluster, weighted by the hit area).

Definition at line 144 of file MVAReader.h.

References anab::FVectorReader< T, N >::items().

    {
      return pAccumulate(items, weights, FVectorReader<T, N>::vectors());
    }

template<class T, size_t N>

std::array<float, N> anab::MVAReader< T, N >::getOutput ( std::vector< art::Ptr< T >> const &  items, std::function< float(T const &)>  fweight  ) const

inline

Get MVA results accumulated with provided weighting function over the vector of items (eg. over clusters associated to a track, weighted by the cluster size; or over hits associated to a cluster, weighted by the hit area).

Definition at line 153 of file MVAReader.h.

References anab::FVectorReader< T, N >::items().

    {
      return pAccumulate(items, fweight, FVectorReader<T, N>::vectors());
    }

size_t anab::FVectorWrapperBase::getProductHash ( std::type_info const &  ti ) const

inlineprotectedinherited

Definition at line 29 of file MVAWrapperBase.h.

Referenced by anab::FVectorWriter< N >::getProductID(), and anab::FVectorWriter< N >::initOutputs().

{ return ti.hash_code(); }

std::string anab::FVectorWrapperBase::getProductName ( std::type_info const &  ti ) const

protectedinherited

Definition at line 17 of file MVAWrapperBase.cxx.

Referenced by anab::FVectorReader< T, N >::FVectorReader(), anab::FVectorWriter< N >::getProductID(), anab::FVectorWriter< N >::initOutputs(), and anab::FVectorWriter< N >::produces_using().

  {
    char* realname;
    int status;

    realname = abi::__cxa_demangle(ti.name(), 0, 0, &status);
    std::string pname(realname);
    free(realname);

    pname.erase(std::remove(pname.begin(), pname.end(), ' '), pname.end());
    pname.erase(std::remove(pname.begin(), pname.end(), ':'), pname.end());

    return pname;
  }

template<class T , size_t N>

std::array<float, N> anab::FVectorReader< T, N >::getVector ( size_t  key ) const

inlineinherited

Get copy of the feature vector at index "key".

Access feature vector data at index "key". *** WOULD LIKE TO CHANGE TYPE OF FVEC DATA MEMBER TO std::array AND THEN ENABLE THIS FUNCTION ***

Definition at line 55 of file MVAReader.h.

References anab::FVectorReader< T, N >::fVectors.

Referenced by anab::MVAReader< T, N >::getOutput().

    {
      std::array<float, N> vout;
      for (size_t i = 0; i < N; ++i)
        vout[i] = (*fVectors)[key][i];
      return vout;
    }

template<class T , size_t N>

std::array<float, N> anab::FVectorReader< T, N >::getVector ( art::Ptr< T > const &  item ) const

inlineinherited

Get copy of the feature vector idicated with art::Ptr::key().

Definition at line 64 of file MVAReader.h.

References anab::FVectorReader< T, N >::getVector(), and art::Ptr< T >::key().

Referenced by anab::FVectorReader< T, N >::getVector().

{ return getVector(item.key()); }

template<class T , size_t N>

T const& anab::FVectorReader< T, N >::item ( size_t  key ) const

inlineinherited

Access data product at index "key".

Definition at line 44 of file MVAReader.h.

References anab::FVectorReader< T, N >::fDataHandle.

{ return (*fDataHandle)[key]; }

template<class T , size_t N>

std::vector<T> const& anab::FVectorReader< T, N >::items ( ) const

inlineinherited

Definition at line 45 of file MVAReader.h.

References anab::FVectorReader< T, N >::fDataHandle.

Referenced by anab::MVAReader< T, N >::getOutput().

{ return *fDataHandle; }

template<class T , size_t N>

size_t anab::FVectorReader< T, N >::length ( ) const

inlineinherited

Get the length of a single feature vector.

Definition at line 70 of file MVAReader.h.

{ return N; }

template<class T, size_t N>

const std::string& anab::MVAReader< T, N >::outputName ( size_t  index ) const

inline

Meaning/name of the index'th column in the collection of MVA output vectors.

Definition at line 160 of file MVAReader.h.

References anab::FVectorReader< T, N >::columnName().

    {
      return FVectorReader<T, N>::columnName(index);
    }

template<class T, size_t N>

std::vector<FeatureVector<N> > const& anab::MVAReader< T, N >::outputs ( ) const

inline

Access the vector of the feature vectors.

Definition at line 124 of file MVAReader.h.

References anab::FVectorReader< T, N >::vectors().

Referenced by nnet::PointIdEffTest::analyze().

{ return FVectorReader<T, N>::vectors(); }

template<class T , size_t N>

std::array< float, N > anab::MVAWrapperBase::pAccumulate ( std::vector< art::Ptr< T >> const &  items, std::vector< FeatureVector< N >> const &  outs  ) const

protectedinherited

Definition at line 73 of file MVAWrapperBase.h.

References trkf::fill().

{
  std::array<double, N> acc;
  acc.fill(0);

  float pmin = 1.0e-6, pmax = 1.0 - pmin;
  float log_pmin = std::log(pmin), log_pmax = std::log(pmax);

  for (auto const& ptr : items) {
    auto const& vout = outs[ptr.key()];
    for (size_t i = 0; i < vout.size(); ++i) {
      float v;
      if (vout[i] < pmin)
        v = log_pmin;
      else if (vout[i] > pmax)
        v = log_pmax;
      else
        v = std::log(vout[i]);

      acc[i] += v;
    }
  }

  if (!items.empty()) {
    double totp = 0.0;
    for (size_t i = 0; i < N; ++i) {
      acc[i] = exp(acc[i] / items.size());
      totp += acc[i];
    }
    for (size_t i = 0; i < N; ++i) {
      acc[i] /= totp;
    }
  }
  else
    std::fill(acc.begin(), acc.end(), 1.0 / N);

  std::array<float, N> result;
  for (size_t i = 0; i < N; ++i)
    result[i] = acc[i];
  return result;
}

template<class T , size_t N>

std::array< float, N > anab::MVAWrapperBase::pAccumulate ( std::vector< art::Ptr< T >> const &  items, std::vector< float > const &  weights, std::vector< FeatureVector< N >> const &  outs  ) const

protectedinherited

Definition at line 119 of file MVAWrapperBase.h.

References trkf::fill(), and w.

{
  std::array<double, N> acc;
  acc.fill(0);

  float pmin = 1.0e-6, pmax = 1.0 - pmin;
  float log_pmin = std::log(pmin), log_pmax = std::log(pmax);
  double totw = 0.0;

  for (size_t k = 0; k < items.size(); ++k) {
    auto const& ptr = items[k];
    float w = weights[k];

    if (w == 0) continue;

    auto const& vout = outs[ptr.key()];
    for (size_t i = 0; i < vout.size(); ++i) {
      float v;
      if (vout[i] < pmin)
        v = log_pmin;
      else if (vout[i] > pmax)
        v = log_pmax;
      else
        v = std::log(vout[i]);

      acc[i] += w * v;
    }
    totw += w;
  }

  if (!items.empty()) {
    double totp = 0.0;
    for (size_t i = 0; i < N; ++i) {
      acc[i] = exp(acc[i] / totw);
      totp += acc[i];
    }
    for (size_t i = 0; i < N; ++i) {
      acc[i] /= totp;
    }
  }
  else
    std::fill(acc.begin(), acc.end(), 1.0 / N);

  std::array<float, N> result;
  for (size_t i = 0; i < N; ++i)
    result[i] = acc[i];
  return result;
}

template<class T , size_t N>

std::array< float, N > anab::MVAWrapperBase::pAccumulate ( std::vector< art::Ptr< T >> const &  items, std::function< float(T const &)>  fweight, std::vector< FeatureVector< N >> const &  outs  ) const

protectedinherited

Definition at line 173 of file MVAWrapperBase.h.

References trkf::fill(), and w.

{
  std::array<double, N> acc;
  acc.fill(0);

  float pmin = 1.0e-6, pmax = 1.0 - pmin;
  float log_pmin = std::log(pmin), log_pmax = std::log(pmax);
  double totw = 0.0;

  for (size_t k = 0; k < items.size(); ++k) {
    auto const& ptr = items[k];
    float w = fweight(*ptr);

    if (w == 0) continue;

    auto const& vout = outs[ptr.key()];
    for (size_t i = 0; i < vout.size(); ++i) {
      float v;
      if (vout[i] < pmin)
        v = log_pmin;
      else if (vout[i] > pmax)
        v = log_pmax;
      else
        v = std::log(vout[i]);

      acc[i] += w * v;
    }
    totw += w;
  }

  if (!items.empty()) {
    double totp = 0.0;
    for (size_t i = 0; i < N; ++i) {
      acc[i] = exp(acc[i] / totw);
      totp += acc[i];
    }
    for (size_t i = 0; i < N; ++i) {
      acc[i] /= totp;
    }
  }
  else
    std::fill(acc.begin(), acc.end(), 1.0 / N);

  std::array<float, N> result;
  for (size_t i = 0; i < N; ++i)
    result[i] = acc[i];
  return result;
}

template<class T , size_t N>

std::array< float, N > anab::MVAWrapperBase::pAccumulate ( std::vector< art::Ptr< T >> const &  items, std::function< float(art::Ptr< T > const &)>  fweight, std::vector< FeatureVector< N >> const &  outs  ) const

protectedinherited

Definition at line 227 of file MVAWrapperBase.h.

References trkf::fill(), and w.

{
  std::array<double, N> acc;
  acc.fill(0);

  float pmin = 1.0e-6, pmax = 1.0 - pmin;
  float log_pmin = std::log(pmin), log_pmax = std::log(pmax);
  double totw = 0.0;

  for (size_t k = 0; k < items.size(); ++k) {
    auto const& ptr = items[k];
    float w = fweight(ptr);

    if (w == 0) continue;

    auto const& vout = outs[ptr.key()];
    for (size_t i = 0; i < vout.size(); ++i) {
      float v;
      if (vout[i] < pmin)
        v = log_pmin;
      else if (vout[i] > pmax)
        v = log_pmax;
      else
        v = std::log(vout[i]);

      acc[i] += w * v;
    }
    totw += w;
  }

  if (!items.empty()) {
    double totp = 0.0;
    for (size_t i = 0; i < N; ++i) {
      acc[i] = exp(acc[i] / totw);
      totp += acc[i];
    }
    for (size_t i = 0; i < N; ++i) {
      acc[i] /= totp;
    }
  }
  else
    std::fill(acc.begin(), acc.end(), 1.0 / N);

  std::array<float, N> result;
  for (size_t i = 0; i < N; ++i)
    result[i] = acc[i];
  return result;
}

template<class T , size_t N>

std::array< float, N > anab::MVAWrapperBase::pAccumulate ( std::vector< art::Ptr< T >> const &  items, std::vector< FeatureVector< N >> const &  outs, std::array< char, N > const &  mask  ) const

protectedinherited

Definition at line 285 of file MVAWrapperBase.h.

{
  size_t n_groups = 0;
  std::unordered_map<char, size_t> label2group;
  std::vector<size_t> nb_entries;
  std::array<int, N> groupidx;
  for (size_t i = 0; i < N; ++i) {
    int idx = -1;
    if (mask[i] >= 0) {
      auto search = label2group.find(mask[i]);
      if (search == label2group.end()) {
        idx = n_groups;
        label2group[mask[i]] = idx;
        nb_entries.push_back(0);
        ++n_groups;
      }
      else {
        idx = search->second;
        nb_entries[idx]++;
      }
    }
    groupidx[i] = idx;
  }

  std::array<double, N> acc;
  acc.fill(0);

  float pmin = 1.0e-6, pmax = 1.0 - pmin;
  float log_pmin = std::log(pmin), log_pmax = std::log(pmax);

  for (auto const& ptr : items) {
    auto const& vout = outs[ptr.key()];
    for (size_t i = 0; i < vout.size(); ++i) {
      if (groupidx[i] < 0) continue;

      float v;
      if (vout[i] < pmin)
        v = log_pmin;
      else if (vout[i] > pmax)
        v = log_pmax;
      else
        v = std::log(vout[i]);

      acc[i] += v;
    }
  }

  if (!items.empty()) {
    std::vector<double> totp(n_groups, 0.0);
    for (size_t i = 0; i < N; ++i) {
      if (groupidx[i] >= 0) {
        acc[i] = exp(acc[i] / items.size());
        totp[groupidx[i]] += acc[i];
      }
    }
    for (size_t i = 0; i < N; ++i) {
      if (groupidx[i] >= 0) { acc[i] /= totp[groupidx[i]]; }
    }
  }
  else {
    for (size_t i = 0; i < N; ++i) {
      if (groupidx[i] >= 0) { acc[i] = 1 / nb_entries[groupidx[i]]; }
    }
  }

  std::array<float, N> result;
  for (size_t i = 0; i < N; ++i)
    result[i] = acc[i];
  return result;
}

template<class T , size_t N>

size_t anab::FVectorReader< T, N >::size ( ) const

inlineinherited

Get the number of contained items (no. of data product objects equal to no. of feature vectors).

Definition at line 67 of file MVAReader.h.

References anab::FVectorReader< T, N >::fVectors.

{ return fVectors->size(); }

template<class T , size_t N>

std::vector<FeatureVector<N> > const& anab::FVectorReader< T, N >::vectors ( ) const

inlineinherited

Access the vector of the feature vectors.

Definition at line 48 of file MVAReader.h.

References anab::FVectorReader< T, N >::fVectors.

Referenced by anab::MVAReader< T, N >::outputs().

{ return *fVectors; }

---

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

• lardata/v09_16_03/source/lardata/ArtDataHelper/MVAReader.h