pulse_collection Class Reference
[DataFormatDataFormat]

PMT-wise data member class to hold a collection of ADC samples. More...

#include <pulse_info.hh>

Inheritance diagram for pulse_collection:

data_base List of all members.

Public Member Functions

 pulse_collection ()
 Default constructor.
 pulse_collection (const pulse_collection &original)
 Default copy constructor.
void calculate_sum ()
 Method to calculate summed variables This iterates over stored pulse_info and sum charge, peark height, and # pulses.
double sum_charge () const
 Getter for charge sum.
double sum_peak () const
 Getter for summed peak.
double npulse () const
 Getter for summed # of pulses.
void set_sum_charge (double v)
 Setter for charge sum.
void set_sum_peak (double v)
 Setter for summed peak.
void set_npulse (UInt_t v)
 Setter for number of pulses.
virtual void clear_data ()
 Method to clear currently held data contents in the buffer.
 ~pulse_collection ()
 Default destructor.

Private Member Functions

void init_vars ()
 Internal function to reset variables.

Private Attributes

double _sum_charge
 summed charge from each pulse
double _sum_peak
 summed peak from each pulse
UInt_t _npulse
 summed number of pulses stored

Detailed Description

PMT-wise data member class to hold a collection of ADC samples.

Definition at line 155 of file pulse_info.hh.


Constructor & Destructor Documentation

pulse_collection::pulse_collection (  )  [inline]

Default constructor.

Definition at line 161 of file pulse_info.hh.

References clear_data().

00161 : data_base() {clear_data();};

pulse_collection::pulse_collection ( const pulse_collection original  )  [inline]

Default copy constructor.

Definition at line 164 of file pulse_info.hh.

00165     : std::vector<pulse_info>(original),
00166       data_base(original),
00167       _sum_charge(original._sum_charge),
00168       _sum_peak(original._sum_peak),
00169       _npulse(original._npulse)
00170   {};

pulse_collection::~pulse_collection (  )  [inline]

Default destructor.

Definition at line 203 of file pulse_info.hh.

00203 {};


Member Function Documentation

void pulse_collection::calculate_sum (  ) 

Method to calculate summed variables This iterates over stored pulse_info and sum charge, peark height, and # pulses.

Note that, if a user is responsible for storing all pulses, it is faster if a user calculate this sum as (s)he stores pulses, then use setter functions for each parameters to set a value. This method is useful in case a user looses a track OR a user wish to re-calculate the sum on stored pulse for some reasons.

Definition at line 30 of file pulse_info.cc.

References _npulse, _sum_charge, and _sum_peak.

00030                                     {
00031 
00032   std::vector<pulse_info>::const_iterator iter(this->begin());
00033   _sum_charge=0;
00034   _sum_peak=0;
00035   _npulse=0;
00036   while(iter!=this->end()){
00037 
00038     _sum_charge+=(*iter).charge();
00039     _sum_peak+=(*iter).pulse_peak();
00040     _npulse++;
00041   }
00042 
00043 }

void pulse_collection::clear_data (  )  [virtual]

Method to clear currently held data contents in the buffer.

Reimplemented from data_base.

Definition at line 21 of file pulse_info.cc.

References _npulse, _sum_charge, and _sum_peak.

Referenced by pulse_collection().

00021                                  {
00022 
00023   clear();
00024   _sum_charge=-1;
00025   _sum_peak=-1;
00026   _npulse=0;
00027 
00028 }

void pulse_collection::init_vars (  )  [private]

Internal function to reset variables.

double pulse_collection::npulse (  )  const [inline]

Getter for summed # of pulses.

Definition at line 188 of file pulse_info.hh.

References _npulse.

Referenced by pulse_viewer::analyze(), pulse_reco::analyze(), and pmtbaseline_ana::analyze().

00188 {return _npulse;};

void pulse_collection::set_npulse ( UInt_t  v  )  [inline]

Setter for number of pulses.

Definition at line 197 of file pulse_info.hh.

References _npulse.

Referenced by pulse_reco::analyze(), and pmtbaseline::analyze().

00197 {_npulse=v;};

void pulse_collection::set_sum_charge ( double  v  )  [inline]

Setter for charge sum.

Definition at line 191 of file pulse_info.hh.

References _sum_charge.

Referenced by pulse_reco::analyze(), and pmtbaseline::analyze().

00191 {_sum_charge=v;};

void pulse_collection::set_sum_peak ( double  v  )  [inline]

Setter for summed peak.

Definition at line 194 of file pulse_info.hh.

References _sum_peak.

Referenced by pulse_reco::analyze(), and pmtbaseline::analyze().

00194 {_sum_peak=v;};

double pulse_collection::sum_charge (  )  const [inline]

Getter for charge sum.

Definition at line 182 of file pulse_info.hh.

References _sum_charge.

Referenced by pulse_viewer::analyze(), pulse_reco::analyze(), and pmtbaseline_ana::analyze().

00182 {return _sum_charge;};

double pulse_collection::sum_peak (  )  const [inline]

Getter for summed peak.

Definition at line 185 of file pulse_info.hh.

References _sum_peak.

Referenced by pulse_viewer::analyze(), pulse_reco::analyze(), and pmtbaseline_ana::analyze().

00185 {return _sum_peak;};


Member Data Documentation

UInt_t pulse_collection::_npulse [private]

summed number of pulses stored

Definition at line 213 of file pulse_info.hh.

Referenced by calculate_sum(), clear_data(), npulse(), and set_npulse().

double pulse_collection::_sum_charge [private]

summed charge from each pulse

Definition at line 211 of file pulse_info.hh.

Referenced by calculate_sum(), clear_data(), set_sum_charge(), and sum_charge().

double pulse_collection::_sum_peak [private]

summed peak from each pulse

Definition at line 212 of file pulse_info.hh.

Referenced by calculate_sum(), clear_data(), set_sum_peak(), and sum_peak().


The documentation for this class was generated from the following files:
Generated on Mon Apr 7 15:35:13 2014 for MyProject by  doxygen 1.4.7