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

#include <MVAReader.h>

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

Public Member Functions
	FVectorReader (const art::Event &evt, const art::InputTag &tag)
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 < FVectorReader >	create (const art::Event &evt, const art::InputTag &tag)

Protected Member Functions
	FVectorReader (const art::Event &evt, const art::InputTag &tag, bool &success)
	Not-throwing constructor. More...
Protected Member Functions inherited from anab::FVectorWrapperBase
std::string	getProductName (std::type_info const &ti) const
size_t	getProductHash (std::type_info const &ti) const

Private Attributes
FVecDescription< N > const *	fDescription
std::vector< FeatureVector< N > > const *	fVectors
art::Handle< std::vector< T > >	fDataHandle

Friends
std::ostream &	operator<< (std::ostream &o, FVectorReader const &a)

Detailed Description

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

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

Definition at line 23 of file MVAReader.h.

Constructor & Destructor Documentation

template<class T , size_t N>

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

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

Definition at line 170 of file MVAReader.h.

                                                                                    :
    fDescription(0)
{
    if (!N) { throw cet::exception("FVectorReader") << "Vector size should be > 0." << std::endl; }

    auto descriptionHandle = evt.getValidHandle< std::vector< anab::FVecDescription<N> > >(tag);

    // search for FVecDescription<N> produced for the type T, with the instance name from the tag
    std::string outputInstanceName = tag.instance() + getProductName(typeid(T));
    for (auto const & dscr : *descriptionHandle)
    {
        if (dscr.outputInstance() == outputInstanceName)
        {
            fDescription = &dscr; break;
        }
    }
    if (!fDescription) { throw cet::exception("FVectorReader") << "Vectors description not found for " << outputInstanceName << std::endl; }

    fVectors = &*(evt.getValidHandle< std::vector< FeatureVector<N> > >( art::InputTag(tag.label(), fDescription->outputInstance(), tag.process()) ));

    if (!evt.getByLabel( fDescription->dataTag(), fDataHandle ))
    {
        throw cet::exception("FVectorReader") << "Associated data product handle failed: " << *(fDataHandle.whyFailed()) << std::endl;
    }

    if (fVectors->size() != fDataHandle->size())
    {
        throw cet::exception("FVectorReader") << "Feature vectors and data products sizes inconsistent: " << fVectors->size() << "!=" << fDataHandle->size() << std::endl;
    }
}

template<class T , size_t N>

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

protected

Not-throwing constructor.

Definition at line 203 of file MVAReader.h.

                                                                                                    :
    fDescription(0)
{
    success = false; // until all is done correctly

    if (!N) { std::cout << "FVectorReader: Vector size should be > 0." << std::endl; return; }

    art::Handle< std::vector< anab::FVecDescription<N> > > descriptionHandle;
    if (!evt.getByLabel( tag, descriptionHandle )) { return; }

    // search for FVecDescription<N> produced for the type T, with the instance name from the tag
    std::string outputInstanceName = tag.instance() + getProductName(typeid(T));
    for (auto const & dscr : *descriptionHandle)
    {
        if (dscr.outputInstance() == outputInstanceName)
        {
            fDescription = &dscr; break;
        }
    }
    if (!fDescription) { std::cout << "FVectorReader: Vectors description not found for " << outputInstanceName << std::endl; return; }

    fVectors = &*(evt.getValidHandle< std::vector< FeatureVector<N> > >( art::InputTag(tag.label(), fDescription->outputInstance(), tag.process()) ));

    if (!evt.getByLabel( fDescription->dataTag(), fDataHandle ))
    {
        std::cout << "FVectorReader: Associated data product handle failed: " << *(fDataHandle.whyFailed()) << std::endl; return;
    }

    if (fVectors->size() != fDataHandle->size())
    {
        std::cout << "FVectorReader: Feature vectors and data products sizes inconsistent: " << fVectors->size() << "!=" << fDataHandle->size() << std::endl; return;
    }

    success = true; // ok, all data found in the event
}

Member Function Documentation

template<class T , size_t N>

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

inline

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

Definition at line 79 of file MVAReader.h.

{ return fDescription->outputName(index); }

template<class T , size_t N>

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

inlinestatic

Create the helper for feature vectors stored in the event evt with the provided input tag (the same tag which was used to save vectors with FVectorWriter class). Returns nullptr if data products not found in the event.

Definition at line 29 of file MVAReader.h.

    {
        bool success;
        std::unique_ptr<FVectorReader> ptr(new FVectorReader(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

inline

Access the data product handle.

Definition at line 76 of file MVAReader.h.

{ return fDataHandle; }

template<class T , size_t N>

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

inline

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

Definition at line 73 of file MVAReader.h.

{ return fDescription->dataTag(); }

template<class T , size_t N>

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

inline

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

Definition at line 82 of file MVAReader.h.

{ return fDescription->getIndex(name); }

template<class T , size_t N>

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

inline

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 54 of file MVAReader.h.

    {
        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

inline

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

Definition at line 62 of file MVAReader.h.

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

template<class T , size_t N>

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

inline

Access data product at index "key".

Definition at line 43 of file MVAReader.h.

{ return (*fDataHandle)[key]; }

template<class T , size_t N>

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

inline

Definition at line 44 of file MVAReader.h.

{ return *fDataHandle; }

template<class T , size_t N>

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

inline

Get the length of a single feature vector.

Definition at line 70 of file MVAReader.h.

{ return N; }

template<class T , size_t N>

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

inline

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.

{ return fVectors->size(); }

template<class T , size_t N>

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

inline

Access the vector of the feature vectors.

Definition at line 47 of file MVAReader.h.

{ return *fVectors; }

Friends And Related Function Documentation

template<class T , size_t N>

std::ostream& operator<< ( std::ostream &  o, FVectorReader< T, N > const &  a  )

friend

Definition at line 84 of file MVAReader.h.

    {
        o << "FVectorReader:" << std::endl << *(a.fDescription) << std::endl;
        return o;
    }

Member Data Documentation

template<class T , size_t N>

art::Handle< std::vector<T> > anab::FVectorReader< T, N >::fDataHandle

private

Definition at line 97 of file MVAReader.h.

template<class T , size_t N>

FVecDescription<N> const* anab::FVectorReader< T, N >::fDescription

private

Definition at line 95 of file MVAReader.h.

template<class T , size_t N>

std::vector< FeatureVector<N> > const* anab::FVectorReader< T, N >::fVectors

private

Definition at line 96 of file MVAReader.h.

---

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

• MVAReader.h