Rivet::MultiplexedAO Class Reference

Multiplexer base class. More...

#include <RivetYODA.hh>

Inheritance diagram for Rivet::MultiplexedAO:

Public Types
using	Inner = YODA::AnalysisObject
	The type being represented is a generic AO.

Public Member Functions
virtual void	newSubEvent ()=0
	Add a new layer of subevent fill staging.
virtual void	collapseEventGroup (const vector< std::valarray< double > > &weight, const double nlowfrac=0.0)=0
	Sync the fill proxies to the persistent histogram.
virtual void	pushToFinal ()=0
	Sync the persistent histograms to the final collection.
virtual YODA::AnalysisObjectPtr	activeAO () const =0
	A shared pointer to the active YODA AO.
virtual string	basePath () const =0
	The histogram path, without a variation suffix.
virtual YODA::AnalysisObject *	operator-> ()=0
	Access the active analysis object for function calls.
virtual YODA::AnalysisObject *	operator-> () const =0
	Access the active analysis object for const function calls.
virtual const YODA::AnalysisObject &	operator* () const =0
	Access the active analysis object as a reference.
virtual void	setActiveWeightIdx (size_t iWeight)=0
	Set active object for analyze.
virtual void	setActiveFinalWeightIdx (size_t iWeight)=0
	Set active object for finalize.
virtual void	unsetActiveWeight ()=0
	Unset the active-object pointer.
virtual void	initBootstrap ()=0
	Set the size of the bootstrap vectors.
bool	operator== (const MultiplexedAO &p)
	Test for equality.
bool	operator!= (const MultiplexedAO &p)
	Test for inequality.
const vector< bool > &	fillOutcomes () const
const vector< double > &	fillFractions () const

Detailed Description

Multiplexer base class.

Abstract interface to a set of YODA AOs corresponding to multiple weight-streams, with subevent handling.

Note

This abstraction is useful for looping over generic multiplexed AOs e.g. in the AnalysisHandler.

Member Function Documentation

activeAO()

virtual YODA::AnalysisObjectPtr Rivet::MultiplexedAO::activeAO ( ) const

pure virtual

A shared pointer to the active YODA AO.

Implemented in Rivet::Multiplexer< T >.

basePath()

virtual string Rivet::MultiplexedAO::basePath ( ) const

pure virtual

The histogram path, without a variation suffix.

Implemented in Rivet::Multiplexer< T >.

collapseEventGroup()

virtual void Rivet::MultiplexedAO::collapseEventGroup ( const vector< std::valarray< double > > &  weight, const double  nlowfrac = 0.0  )

pure virtual

Sync the fill proxies to the persistent histogram.

Implemented in Rivet::Multiplexer< T >.

initBootstrap()

virtual void Rivet::MultiplexedAO::initBootstrap ( )

pure virtual

Set the size of the bootstrap vectors.

Implemented in Rivet::Multiplexer< T >.

newSubEvent()

virtual void Rivet::MultiplexedAO::newSubEvent ( )

pure virtual

Add a new layer of subevent fill staging.

Implemented in Rivet::Multiplexer< T >.

operator*()

virtual const YODA::AnalysisObject & Rivet::MultiplexedAO::operator* ( ) const

pure virtual

Access the active analysis object as a reference.

Implemented in Rivet::Multiplexer< T >.

operator->() [1/2]

virtual YODA::AnalysisObject * Rivet::MultiplexedAO::operator-> ( ) const

pure virtual

Access the active analysis object for const function calls.

Implemented in Rivet::Multiplexer< T >.

operator->() [2/2]

virtual YODA::AnalysisObject * Rivet::MultiplexedAO::operator-> ( )

pure virtual

Access the active analysis object for function calls.

Implemented in Rivet::Multiplexer< T >.

pushToFinal()

virtual void Rivet::MultiplexedAO::pushToFinal ( )

pure virtual

Sync the persistent histograms to the final collection.

Implemented in Rivet::Multiplexer< T >.

setActiveFinalWeightIdx()

virtual void Rivet::MultiplexedAO::setActiveFinalWeightIdx ( size_t  iWeight )

pure virtual

Set active object for finalize.

Implemented in Rivet::Multiplexer< T >.

setActiveWeightIdx()

virtual void Rivet::MultiplexedAO::setActiveWeightIdx ( size_t  iWeight )

pure virtual

Set active object for analyze.

Implemented in Rivet::Multiplexer< T >.

unsetActiveWeight()

virtual void Rivet::MultiplexedAO::unsetActiveWeight ( )

pure virtual

Unset the active-object pointer.

Implemented in Rivet::Multiplexer< T >.

---

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

• /Users/chrisg/software/rivet/include/Rivet/Tools/RivetYODA.hh