SiTotalCharge Class Reference

#include <SiTotalCharge.h>

Collaboration diagram for SiTotalCharge:

Public Types
typedef std::vector< SiCharge >	list_t

Public Member Functions
	SiTotalCharge ()
	SiTotalCharge (const SiTotalCharge &totalCharge)
	~SiTotalCharge ()
SiTotalCharge &	operator= (const SiTotalCharge &totalCharge)
double	charge () const
const list_t &	chargeComposition () const
bool	complexCharge () const
bool	fromTrack () const
bool	extraNoise () const
int	trackBarcode () const
const HepMcParticleLink &	particleLink () const
double	time () const
void	add (const SiCharge &charge)
void	add (const SiTotalCharge &totalCharge)
void	removeTimeInformation ()
void	removeSmallCharges (const double minimumCharge)

Private Member Functions
void	addSiCharge (const SiCharge &charge)
const SiCharge &	mainCharge () const

Private Attributes
double	m_charge
list_t	m_chargeComposition

Static Private Attributes
static const HepMcParticleLink	m_emptyLink = HepMcParticleLink()

Detailed Description

Definition at line 24 of file SiTotalCharge.h.

Member Typedef Documentation

list_t

typedef std::vector<SiCharge> SiTotalCharge::list_t

Definition at line 31 of file SiTotalCharge.h.

Constructor & Destructor Documentation

SiTotalCharge() [1/2]

SiTotalCharge::SiTotalCharge

(

)

Definition at line 18 of file SiTotalCharge.cxx.

                             :
  m_charge(0),
  m_chargeComposition()
{}

SiTotalCharge() [2/2]

SiTotalCharge::SiTotalCharge

(

const SiTotalCharge &

totalCharge

)

Definition at line 24 of file SiTotalCharge.cxx.

                                                             :
  m_charge(totalCharge.m_charge),
  m_chargeComposition(totalCharge.m_chargeComposition)
{}

~SiTotalCharge()

SiTotalCharge::~SiTotalCharge ( )

inline

Definition at line 114 of file SiTotalCharge.h.

{
}

Member Function Documentation

add() [1/2]

void SiTotalCharge::add

(

const SiCharge &

charge

)

Definition at line 62 of file SiTotalCharge.cxx.

{
  // increase the total deposited charge
  m_charge+=charge.charge();
  // add the SiCharge to the list of charges
  addSiCharge(charge);
}

add() [2/2]

void SiTotalCharge::add

(

const SiTotalCharge &

totalCharge

)

Definition at line 71 of file SiTotalCharge.cxx.

{
  // increase the total deposited charge
  m_charge+=totalCharge.charge();
 
  std::for_each(totalCharge.chargeComposition().begin(),
                totalCharge.chargeComposition().end(),
                [this](const SiCharge & c) { addSiCharge(c); }
               );
}

addSiCharge()

void SiTotalCharge::addSiCharge ( const SiCharge & charge )

private

Definition at line 108 of file SiTotalCharge.cxx.

{
  auto element = std::find_if(m_chargeComposition.begin(), m_chargeComposition.end(),
             [&charge](const SiCharge & other) {
                       return (charge.time() == other.time()) &&
                      (charge.processType() == other.processType()) &&
                  (charge.particleLink() == other.particleLink());
             } );
  if(element != m_chargeComposition.end()) element->add(charge);
  // add the charge to the list if not merged in existing one
  else m_chargeComposition.push_back(charge);
}

charge()

double SiTotalCharge::charge ( ) const

inline

Definition at line 118 of file SiTotalCharge.h.

{
  return m_charge;
}

chargeComposition()

const SiTotalCharge::list_t & SiTotalCharge::chargeComposition ( ) const

inline

Definition at line 123 of file SiTotalCharge.h.

{
  return m_chargeComposition;
}

complexCharge()

bool SiTotalCharge::complexCharge ( ) const

inline

Definition at line 128 of file SiTotalCharge.h.

{
  return (m_chargeComposition.size()>1);
}

extraNoise()

bool SiTotalCharge::extraNoise ( ) const

inline

Definition at line 133 of file SiTotalCharge.h.

{
  if(m_chargeComposition.empty())
    {
      return false;
    }
  return (mainCharge().processType()==SiCharge::extraNoise);
}

fromTrack()

bool SiTotalCharge::fromTrack

(

)

const

Definition at line 49 of file SiTotalCharge.cxx.

{
  if(m_chargeComposition.empty())
    {
      return false;
    }
  SiCharge::Process process=mainCharge().processType();
  return (process==SiCharge::track || 
      process==SiCharge::cut_track || 
      process==SiCharge::diodeX_Talk);
}

mainCharge()

const SiCharge & SiTotalCharge::mainCharge ( ) const

private

Definition at line 40 of file SiTotalCharge.cxx.

{
  auto max_element = std::max_element(m_chargeComposition.cbegin(), m_chargeComposition.cend(),
                              [](SiCharge const & lhs, SiCharge const & rhs)
                                      { return lhs.charge() < rhs.charge(); }
                     );
  return *max_element;
}

operator=()

SiTotalCharge & SiTotalCharge::operator=

(

const SiTotalCharge &

totalCharge

)

Definition at line 30 of file SiTotalCharge.cxx.

{
  if (this!=&totalCharge) {
    m_charge=totalCharge.m_charge;
    m_chargeComposition=totalCharge.m_chargeComposition;
  } else {}
  return *this;
}

particleLink()

const HepMcParticleLink & SiTotalCharge::particleLink ( ) const

inline

Definition at line 160 of file SiTotalCharge.h.

{
  if(m_chargeComposition.empty())
    {
      return SiTotalCharge::m_emptyLink;
    }
  return mainCharge().particleLink();
}

removeSmallCharges()

void SiTotalCharge::removeSmallCharges

(

const double

minimumCharge

)

Definition at line 98 of file SiTotalCharge.cxx.

{
  //erase-remove idiom to remove small charges
  auto new_end = std::remove_if(m_chargeComposition.begin(), m_chargeComposition.end(),
          [&minimumCharge](const SiCharge& c){ return (c.charge() > -minimumCharge) && 
                                                      (c.charge() < minimumCharge); });
  m_chargeComposition.erase(new_end, m_chargeComposition.end());
}

removeTimeInformation()

void SiTotalCharge::removeTimeInformation

(

)

Definition at line 83 of file SiTotalCharge.cxx.

{
  // save the old charge composition
  list_t oldComposition;
  m_chargeComposition.swap(oldComposition);
 
  // loop on all old charges
  for(const auto & p_charge : oldComposition) {
    // add the old charge (without time) to the list
    addSiCharge(SiCharge(p_charge.charge(),0,
             p_charge.processType(),p_charge.particleLink()));
  }
}

time()

double SiTotalCharge::time ( ) const

inline

Definition at line 151 of file SiTotalCharge.h.

{
  if(m_chargeComposition.empty())
    {
      return 0.0;
    }
  return mainCharge().time();
}

trackBarcode()

int SiTotalCharge::trackBarcode ( ) const

inline

Definition at line 142 of file SiTotalCharge.h.

{
  if(m_chargeComposition.empty())
    {
      return 0;
    }
  return mainCharge().trackBarcode();
}

Member Data Documentation

m_charge

double SiTotalCharge::m_charge

private

Definition at line 106 of file SiTotalCharge.h.

m_chargeComposition

list_t SiTotalCharge::m_chargeComposition

private

Definition at line 107 of file SiTotalCharge.h.

m_emptyLink

const HepMcParticleLink SiTotalCharge::m_emptyLink = HepMcParticleLink()

staticprivate

Definition at line 108 of file SiTotalCharge.h.

---

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

• SiTotalCharge.h
• SiTotalCharge.cxx