sim::SimPhotonsLite Class Reference

Compact representation of photons on a channel. More...

#include <SimPhotons.h>

Public Member Functions
	SimPhotonsLite ()=default
	Default constructor (do not use! it's for ROOT only). More...
	SimPhotonsLite (int chan)
	Constructor: associated to optical detector channel chan, and empty. More...
SimPhotonsLite &	operator+= (const SimPhotonsLite &rhs)
	Add all photons from rhs to this ones, at their original time. More...
SimPhotonsLite	operator+ (const SimPhotonsLite &rhs) const
bool	operator== (const SimPhotonsLite &other) const
	Returns whether other is on the same channel (OpChannel) as this. More...

Public Attributes
int	OpChannel
	Optical detector channel associated to this data. More...
std::map< int, int >	DetectedPhotons
	Number of photons detected at each given time: time tick -> photons. More...

Detailed Description

Compact representation of photons on a channel.

See also

sim::SimPhotons

Compared to sim::SimPhotons, this object contains only the total count of photon arriving at a certain time on the channel. The time is discretized in ticks.

Definition at line 103 of file SimPhotons.h.

Constructor & Destructor Documentation

sim::SimPhotonsLite::SimPhotonsLite ( )

default

Default constructor (do not use! it's for ROOT only).

sim::SimPhotonsLite::SimPhotonsLite ( int  chan )

inline

Constructor: associated to optical detector channel chan, and empty.

Definition at line 110 of file SimPhotons.h.

    : OpChannel(chan)
    {}

Member Function Documentation

sim::SimPhotonsLite sim::SimPhotonsLite::operator+

(

const SimPhotonsLite &

rhs

)

const

Creates a new sim::SimPhotonsLite with all photons from rhs and this object.

Definition at line 45 of file SimPhotons.cxx.

  { return sim::SimPhotonsLite(*this) += rhs; }

sim::SimPhotonsLite & sim::SimPhotonsLite::operator+=

(

const SimPhotonsLite &

rhs

)

Add all photons from rhs to this ones, at their original time.

Definition at line 33 of file SimPhotons.cxx.

{

  for(auto const& phot: rhs.DetectedPhotons)
    DetectedPhotons[phot.first] += phot.second;

  return *this;
} // sim::SimPhotonsLite::operator+=()

bool sim::SimPhotonsLite::operator== ( const SimPhotonsLite &  other ) const

inline

Returns whether other is on the same channel (OpChannel) as this.

Definition at line 247 of file SimPhotons.h.

  { return OpChannel == other.OpChannel; }

Member Data Documentation

std::map<int, int> sim::SimPhotonsLite::DetectedPhotons

Number of photons detected at each given time: time tick -> photons.

Definition at line 117 of file SimPhotons.h.

int sim::SimPhotonsLite::OpChannel

Optical detector channel associated to this data.

Definition at line 114 of file SimPhotons.h.

---

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

• lardataobj/lardataobj/Simulation/SimPhotons.h
• lardataobj/lardataobj/Simulation/SimPhotons.cxx