CrossingFrame< T > Class Template Reference

#include <CrossingFrame.h>

Public Member Functions
void	addPileups (std::vector< T > const &vec)
void	addPileups (T const &product)
void	addSignals (const std::vector< T > *vec, edm::EventID id)
void	addSignals (const T *vec, edm::EventID id)
	CrossingFrame ()
	CrossingFrame (int minb, int maxb, int bunchsp, std::string subdet, unsigned int maxNbSources)
int	getBunchCrossing (unsigned int ip) const
std::pair< int, int >	getBunchRange () const
int	getBunchSpace () const
edm::EventID	getEventID () const
edm::EventID	getIdFirstPileup () const
unsigned int	getMaxNbSources () const
unsigned int	getNrPileups () const
unsigned int	getNrPileups (int bcr) const
unsigned int	getNrSignals () const
const T &	getObject (unsigned int ip) const
unsigned int	getPileupFileNr () const
std::vector< unsigned int >	getPileupOffsetsBcr () const
std::vector< std::vector < unsigned int > >	getPileupOffsetsSource () const
std::vector< const T * >	getPileups () const
void	getPileups (typename std::vector< const T * >::const_iterator &first, typename std::vector< const T * >::const_iterator &last) const
std::vector< const T * >	getSignal () const
void	getSignal (typename std::vector< const T * >::const_iterator &first, typename std::vector< const T * >::const_iterator &last) const
int	getSourceType (unsigned int ip) const
std::string	getSubDet () const
CrossingFrame &	operator= (CrossingFrame const &rhs)
void	print (int level=0) const
void	setBcrOffset ()
void	setBunchRange (std::pair< int, int > bunchRange)
void	setBunchSpace (int bSpace)
void	setEventID (edm::EventID evId)
void	setIdFirstPileup (edm::EventID idFP)
void	setMaxNbSources (unsigned int mNbS)
void	setPileupFileNr (unsigned int pFileNr)
void	setPileupOffsetsBcr (const std::vector< unsigned int > &pOffsetsBcr)
void	setPileupOffsetsSource (const std::vector< std::vector< unsigned int > > &pOffsetsS)
void	setPileupPtr (boost::shared_ptr< edm::Wrapper< std::vector< T > > const > shPtr)
void	setPileupPtr (boost::shared_ptr< edm::Wrapper< T > const > shPtr)
void	setPileupPtr (boost::shared_ptr< edm::Wrapper< PCrossingFrame< T > > const > shPtr)
void	setPileups (const std::vector< const T * > &p)
void	setSourceOffset (const unsigned int s)
void	setSubDet (std::string det)
void	setTof ()
void	swap (CrossingFrame &other)
	~CrossingFrame ()

Private Attributes
int	bunchSpace_
int	firstCrossing_
edm::EventID	id_
edm::EventID	idFirstPileup_
int	lastCrossing_
unsigned int	maxNbSources_
unsigned int	pileupFileNr_
std::vector< unsigned int >	pileupOffsetsBcr_
std::vector< std::vector < unsigned int > >	pileupOffsetsSource_
std::vector< const T * >	pileups_
std::vector< boost::shared_ptr < edm::Wrapper< T > const > >	shPtrPileups2_
std::vector< boost::shared_ptr < edm::Wrapper< std::vector< T > > const > >	shPtrPileups_
boost::shared_ptr < edm::Wrapper< PCrossingFrame < T > > const >	shPtrPileupsPCF_
std::vector< const T * >	signals_
std::string	subdet_

Detailed Description

template<class T>
class CrossingFrame< T >

CrossingFrame is the result of the Sim Mixing Module

Author

Ursula Berthon, Claude Charlot, LLR Palaiseau

Version

1st Version July 2005

2nd Version Sep 2005

3rd Version Nov 2007

Definition at line 39 of file CrossingFrame.h.

Constructor & Destructor Documentation

template<class T>

CrossingFrame< T >::CrossingFrame ( )

inline

Definition at line 45 of file CrossingFrame.h.

                 :  firstCrossing_(0), lastCrossing_(0), bunchSpace_(75),subdet_(""),maxNbSources_(0) {
}

template<class T >

CrossingFrame< T >::CrossingFrame	(	int	minb,
		int	maxb,
		int	bunchsp,
		std::string	subdet,
		unsigned int	maxNbSources
	)

Definition at line 181 of file CrossingFrame.h.

References CrossingFrame< T >::firstCrossing_, i, CrossingFrame< T >::lastCrossing_, CrossingFrame< T >::maxNbSources_, CrossingFrame< T >::pileupOffsetsBcr_, and CrossingFrame< T >::pileupOffsetsSource_.

             :firstCrossing_(minb), lastCrossing_(maxb),
bunchSpace_(bunchsp),subdet_(subdet),maxNbSources_(maxNbSources) {
 pileupOffsetsSource_.resize(maxNbSources_);
 for (unsigned int i=0;i<maxNbSources_;++i)
   pileupOffsetsSource_[i].reserve(-firstCrossing_+lastCrossing_+1);

//FIXME: should we force around 0 or so??
  pileupOffsetsBcr_.reserve(-firstCrossing_+lastCrossing_+1);
}

template<class T>

CrossingFrame< T >::~CrossingFrame ( )

inline

Definition at line 49 of file CrossingFrame.h.

{;}

Member Function Documentation

template<class T>

void CrossingFrame< T >::addPileups

(

std::vector< T > const &

vec

)

Definition at line 292 of file CrossingFrame.h.

                                                            {
  for (auto const& item : product) {
    pileups_.push_back(&item);
  }
}

template<class T>

void CrossingFrame< T >::addPileups

(

T const &

product

)

Definition at line 285 of file CrossingFrame.h.

                                                  {
  // default, valid for HepMCProduct
  pileups_.push_back(&product);
}

template<class T>

void CrossingFrame< T >::addSignals	(	const std::vector< T > *	vec,
		edm::EventID	id
	)

Definition at line 300 of file CrossingFrame.h.

References i.

                                                                       {
  // valid (called) for all except HepMCProduct
  id_=id;
  for (unsigned int i=0;i<vec->size();++i) {
    signals_.push_back(&((*vec)[i]));
  }
}

template<class T>

void CrossingFrame< T >::addSignals	(	const T *	vec,
		edm::EventID	id
	)

Definition at line 309 of file CrossingFrame.h.

                                                                {
  // valid (called) for all except HepMCProduct
  id_=id;
  signals_.push_back(product);
}

template<class T >

int CrossingFrame< T >::getBunchCrossing

(

unsigned int

ip

)

const

Definition at line 249 of file CrossingFrame.h.

References cuy::ii.

                                                            {
  // return the bcr for a certain position in the pileup vector
    for (unsigned int ii=1;ii<pileupOffsetsBcr_.size();ii++){
      if (ip>=pileupOffsetsBcr_[ii-1] && ip<pileupOffsetsBcr_[ii]) return ii+firstCrossing_-1;
    }
    if (ip<pileups_.size()) return lastCrossing_;
    else return 999;
}

template<class T>

std::pair<int,int> CrossingFrame< T >::getBunchRange ( ) const

inline

Definition at line 88 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return std::pair<int,int>(firstCrossing_,lastCrossing_);}

template<class T>

int CrossingFrame< T >::getBunchSpace ( ) const

inline

Definition at line 89 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return bunchSpace_;}

template<class T>

edm::EventID CrossingFrame< T >::getEventID ( ) const

inline

Definition at line 87 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return id_;}

template<class T>

edm::EventID CrossingFrame< T >::getIdFirstPileup ( ) const

inline

Definition at line 93 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return idFirstPileup_;}

template<class T>

unsigned int CrossingFrame< T >::getMaxNbSources ( ) const

inline

Definition at line 90 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return maxNbSources_; }

template<class T>

unsigned int CrossingFrame< T >::getNrPileups ( ) const

inline

Definition at line 106 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getObject().

{return pileups_.size();} 

template<class T>

unsigned int CrossingFrame< T >::getNrPileups ( int  bcr ) const

inline

Definition at line 107 of file CrossingFrame.h.

                                           {
    return bcr==lastCrossing_ ? pileups_.size()-pileupOffsetsBcr_[lastCrossing_-firstCrossing_] :pileupOffsetsBcr_[bcr-firstCrossing_+1]- pileupOffsetsBcr_[bcr-firstCrossing_];} 

template<class T>

unsigned int CrossingFrame< T >::getNrSignals ( ) const

inline

Definition at line 105 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getObject().

{return signals_.size();} 

template<class T>

const T& CrossingFrame< T >::getObject ( unsigned int  ip ) const

inline

Definition at line 117 of file CrossingFrame.h.

                                             { 
    //ip is position in the MixCollection (i.e. signal + pileup)
    if (ip>getNrSignals()+getNrPileups()) throw cms::Exception("BadIndex")<<"CrossingFrame::getObject called with an invalid index- index was "<<ip<<"!"; // ip >=0, since ip is unsigned
    if (ip<getNrSignals()) {
      return *(signals_[ip]);
    }
    else  {
      return *(pileups_[ip-getNrSignals()]);
    }
  }  

template<class T>

unsigned int CrossingFrame< T >::getPileupFileNr ( ) const

inline

Definition at line 92 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return pileupFileNr_;}

template<class T>

std::vector<unsigned int> CrossingFrame< T >::getPileupOffsetsBcr ( ) const

inline

Definition at line 94 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return pileupOffsetsBcr_;}   

template<class T>

std::vector< std::vector<unsigned int> > CrossingFrame< T >::getPileupOffsetsSource ( ) const

inline

Definition at line 95 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return pileupOffsetsSource_;} //one per source

template<class T>

std::vector<const T *> CrossingFrame< T >::getPileups ( ) const

inline

Definition at line 96 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return pileups_;}

template<class T>

void CrossingFrame< T >::getPileups	(	typename std::vector< const T * >::const_iterator &	first,
		typename std::vector< const T * >::const_iterator &	last
	)		const

Definition at line 227 of file CrossingFrame.h.

                                                                                                                                             {
  first=pileups_.begin();
  last=pileups_.end();
}

template<class T>

std::vector<const T *> CrossingFrame< T >::getSignal ( ) const

inline

Definition at line 97 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{return signals_;}

template<class T>

void CrossingFrame< T >::getSignal ( typename std::vector< const T * >::const_iterator &  first, typename std::vector< const T * >::const_iterator &  last  ) const

inline

Definition at line 100 of file CrossingFrame.h.

                                                                                                                            {
    first=signals_.begin();
    last=signals_.end();
  }

template<class T >

int CrossingFrame< T >::getSourceType

(

unsigned int

ip

)

const

Definition at line 237 of file CrossingFrame.h.

References i.

                                                          {
  // ip is position in the pileup vector
  // decide to which source belongs object with index ip in the pileup vector
  // pileup=0, cosmics=1, beam halo+ =2, beam halo- =3 forward =4
  unsigned int bcr= getBunchCrossing(ip)-firstCrossing_; //starts at 0
  for (unsigned int i=0;i<pileupOffsetsSource_.size()-1;++i) {
    if (ip>=(pileupOffsetsSource_[i])[bcr] && ip <(pileupOffsetsSource_[i+1])[bcr]) return i;
  }
  return pileupOffsetsSource_.size()-1;
}

template<class T>

std::string CrossingFrame< T >::getSubDet ( ) const

inline

Definition at line 91 of file CrossingFrame.h.

Referenced by PCrossingFrame< T >::PCrossingFrame().

{ return subdet_;}

template<class T>

CrossingFrame< T > & CrossingFrame< T >::operator= ( CrossingFrame< T > const &  rhs )

inline

Definition at line 219 of file CrossingFrame.h.

References swap(), and groupFilesInBlocks::temp.

                                                       {
  CrossingFrame<T> temp(rhs);
  this->swap(temp);
  return *this;
}

template<class T >

void CrossingFrame< T >::print

(

int

level = 0

)

const

Definition at line 233 of file CrossingFrame.h.

                                            {
}

template<class T>

void CrossingFrame< T >::setBcrOffset ( )

inline

Definition at line 78 of file CrossingFrame.h.

                      {
    pileupOffsetsBcr_.push_back(pileups_.size());
  }

template<class T>

void CrossingFrame< T >::setBunchRange ( std::pair< int, int >  bunchRange )

inline

Definition at line 139 of file CrossingFrame.h.

                                                  { firstCrossing_ = bunchRange.first;
                              lastCrossing_ = bunchRange.second;} 

template<class T>

void CrossingFrame< T >::setBunchSpace ( int  bSpace )

inline

Definition at line 132 of file CrossingFrame.h.

{ bunchSpace_ = bSpace; } 

template<class T>

void CrossingFrame< T >::setEventID ( edm::EventID  evId )

inline

Definition at line 130 of file CrossingFrame.h.

{ id_ = evId; }

template<class T>

void CrossingFrame< T >::setIdFirstPileup ( edm::EventID  idFP )

inline

Definition at line 136 of file CrossingFrame.h.

{idFirstPileup_ = idFP;}

template<class T>

void CrossingFrame< T >::setMaxNbSources ( unsigned int  mNbS )

inline

Definition at line 133 of file CrossingFrame.h.

{ maxNbSources_ = mNbS; } 

template<class T>

void CrossingFrame< T >::setPileupFileNr ( unsigned int  pFileNr )

inline

Definition at line 135 of file CrossingFrame.h.

{ pileupFileNr_ = pFileNr;} 

template<class T>

void CrossingFrame< T >::setPileupOffsetsBcr ( const std::vector< unsigned int > &  pOffsetsBcr )

inline

Definition at line 137 of file CrossingFrame.h.

{ pileupOffsetsBcr_ = pOffsetsBcr;}  

template<class T>

void CrossingFrame< T >::setPileupOffsetsSource ( const std::vector< std::vector< unsigned int > > &  pOffsetsS )

inline

Definition at line 138 of file CrossingFrame.h.

{ pileupOffsetsSource_ = pOffsetsS;}  //one per source

template<class T>

void CrossingFrame< T >::setPileupPtr ( boost::shared_ptr< edm::Wrapper< std::vector< T > > const >  shPtr )

inline

Definition at line 71 of file CrossingFrame.h.

{shPtrPileups_.push_back( shPtr );}

template<class T>

void CrossingFrame< T >::setPileupPtr ( boost::shared_ptr< edm::Wrapper< T > const >  shPtr )

inline

Definition at line 72 of file CrossingFrame.h.

{shPtrPileups2_.push_back( shPtr );}

template<class T>

void CrossingFrame< T >::setPileupPtr

(

boost::shared_ptr< edm::Wrapper< PCrossingFrame< T > > const >

shPtr

)

Definition at line 281 of file CrossingFrame.h.

{shPtrPileupsPCF_=shPtr;}

template<class T>

void CrossingFrame< T >::setPileups ( const std::vector< const T * > &  p )

inline

Definition at line 131 of file CrossingFrame.h.

{ pileups_ = p; } 

template<class T>

void CrossingFrame< T >::setSourceOffset ( const unsigned int  s )

inline

Definition at line 82 of file CrossingFrame.h.

                                             {
    pileupOffsetsSource_[s].push_back(pileups_.size());
  }

template<class T>

void CrossingFrame< T >::setSubDet ( std::string  det )

inline

Definition at line 134 of file CrossingFrame.h.

{ subdet_ = det; } 

template<class T >

void CrossingFrame< T >::setTof

(

)

Definition at line 316 of file CrossingFrame.h.

{;}

template<class T>

void CrossingFrame< T >::swap ( CrossingFrame< T > &  other )

inline

Definition at line 195 of file CrossingFrame.h.

References CrossingFrame< T >::bunchSpace_, CrossingFrame< T >::firstCrossing_, i, CrossingFrame< T >::id_, CrossingFrame< T >::idFirstPileup_, CrossingFrame< T >::lastCrossing_, CrossingFrame< T >::maxNbSources_, CrossingFrame< T >::pileupFileNr_, CrossingFrame< T >::pileupOffsetsBcr_, CrossingFrame< T >::pileupOffsetsSource_, CrossingFrame< T >::pileups_, CrossingFrame< T >::shPtrPileups2_, CrossingFrame< T >::shPtrPileups_, CrossingFrame< T >::shPtrPileupsPCF_, CrossingFrame< T >::signals_, CrossingFrame< T >::subdet_, and std::swap().

Referenced by swap().

                                              {
  std::swap(firstCrossing_, other.firstCrossing_);
  std::swap(lastCrossing_, other.lastCrossing_);
  std::swap(bunchSpace_, other.bunchSpace_);
  subdet_.swap(other.subdet_);
  std::swap(id_, other.id_);
  std::swap(idFirstPileup_, other.idFirstPileup_);
  std::swap(pileupFileNr_, other.pileupFileNr_);
  std::swap(maxNbSources_, other.maxNbSources_);
  signals_.swap(other.signals_);
  pileups_.swap(other.pileups_);
  shPtrPileups_.swap(other.shPtrPileups_);
  shPtrPileups2_.swap(other.shPtrPileups2_);
  shPtrPileupsPCF_.swap(other.shPtrPileupsPCF_);
  pileupOffsetsBcr_.swap(other.pileupOffsetsBcr_);
  pileupOffsetsSource_.resize(maxNbSources_);
  for (unsigned int i=0;i<pileupOffsetsSource_.size();++i) { 
    pileupOffsetsSource_[i].swap(other.pileupOffsetsSource_[i]);
  }
}

Member Data Documentation

template<class T>

int CrossingFrame< T >::bunchSpace_

private

Definition at line 147 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getBunchSpace(), CrossingFrame< PCaloHit >::setBunchSpace(), and CrossingFrame< T >::swap().

template<class T>

int CrossingFrame< T >::firstCrossing_

private

Definition at line 145 of file CrossingFrame.h.

Referenced by CrossingFrame< T >::CrossingFrame(), CrossingFrame< PCaloHit >::getBunchRange(), CrossingFrame< PCaloHit >::getNrPileups(), CrossingFrame< PCaloHit >::setBunchRange(), and CrossingFrame< T >::swap().

template<class T>

edm::EventID CrossingFrame< T >::id_

private

Definition at line 149 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getEventID(), CrossingFrame< PCaloHit >::setEventID(), and CrossingFrame< T >::swap().

template<class T>

edm::EventID CrossingFrame< T >::idFirstPileup_

private

Definition at line 152 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getIdFirstPileup(), CrossingFrame< PCaloHit >::setIdFirstPileup(), and CrossingFrame< T >::swap().

template<class T>

int CrossingFrame< T >::lastCrossing_

private

Definition at line 146 of file CrossingFrame.h.

Referenced by CrossingFrame< T >::CrossingFrame(), CrossingFrame< PCaloHit >::getBunchRange(), CrossingFrame< PCaloHit >::getNrPileups(), CrossingFrame< PCaloHit >::setBunchRange(), and CrossingFrame< T >::swap().

template<class T>

unsigned int CrossingFrame< T >::maxNbSources_

private

Definition at line 155 of file CrossingFrame.h.

Referenced by CrossingFrame< T >::CrossingFrame(), CrossingFrame< PCaloHit >::getMaxNbSources(), CrossingFrame< PCaloHit >::setMaxNbSources(), and CrossingFrame< T >::swap().

template<class T>

unsigned int CrossingFrame< T >::pileupFileNr_

private

Definition at line 153 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getPileupFileNr(), CrossingFrame< PCaloHit >::setPileupFileNr(), and CrossingFrame< T >::swap().

template<class T>

std::vector<unsigned int> CrossingFrame< T >::pileupOffsetsBcr_

private

Definition at line 171 of file CrossingFrame.h.

Referenced by CrossingFrame< T >::CrossingFrame(), CrossingFrame< PCaloHit >::getNrPileups(), CrossingFrame< PCaloHit >::getPileupOffsetsBcr(), CrossingFrame< PCaloHit >::setBcrOffset(), CrossingFrame< PCaloHit >::setPileupOffsetsBcr(), and CrossingFrame< T >::swap().

template<class T>

std::vector< std::vector<unsigned int> > CrossingFrame< T >::pileupOffsetsSource_

private

Definition at line 172 of file CrossingFrame.h.

Referenced by CrossingFrame< T >::CrossingFrame(), CrossingFrame< PCaloHit >::getPileupOffsetsSource(), CrossingFrame< PCaloHit >::setPileupOffsetsSource(), CrossingFrame< PCaloHit >::setSourceOffset(), and CrossingFrame< T >::swap().

template<class T>

std::vector<const T *> CrossingFrame< T >::pileups_

private

Definition at line 161 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getNrPileups(), CrossingFrame< PCaloHit >::getObject(), CrossingFrame< PCaloHit >::getPileups(), CrossingFrame< PCaloHit >::setBcrOffset(), CrossingFrame< PCaloHit >::setPileups(), CrossingFrame< PCaloHit >::setSourceOffset(), and CrossingFrame< T >::swap().

template<class T>

std::vector< boost::shared_ptr<edm::Wrapper<T> const> > CrossingFrame< T >::shPtrPileups2_

private

Definition at line 163 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::setPileupPtr(), and CrossingFrame< T >::swap().

template<class T>

std::vector< boost::shared_ptr<edm::Wrapper<std::vector<T> > const> > CrossingFrame< T >::shPtrPileups_

private

Definition at line 162 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::setPileupPtr(), and CrossingFrame< T >::swap().

template<class T>

boost::shared_ptr<edm::Wrapper<PCrossingFrame<T> > const> CrossingFrame< T >::shPtrPileupsPCF_

private

Definition at line 166 of file CrossingFrame.h.

Referenced by CrossingFrame< T >::swap().

template<class T>

std::vector<const T * > CrossingFrame< T >::signals_

private

Definition at line 158 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getNrSignals(), CrossingFrame< PCaloHit >::getObject(), CrossingFrame< PCaloHit >::getSignal(), and CrossingFrame< T >::swap().

template<class T>

std::string CrossingFrame< T >::subdet_

private

Definition at line 148 of file CrossingFrame.h.

Referenced by CrossingFrame< PCaloHit >::getSubDet(), CrossingFrame< PCaloHit >::setSubDet(), and CrossingFrame< T >::swap().