ped_estimator Class Reference
[PulseRecoPulseReco]

A class that calculates pedestal mean & standard deviation (here and elsewhere called as "RMS"). More...

#include <ped_estimator.hh>

Inheritance diagram for ped_estimator:

decoder_base List of all members.

Public Member Functions

 ped_estimator ()
 Default constructor.
virtual ~ped_estimator ()
 Default destructor.
void compute_pedestal (const std::vector< UShort_t > *wf, size_t start, size_t nsample)
 Method to compute a pedestal of the input waveform using "nsample" ADC samples from "start" index.
double mean ()
 Getter of the pedestal mean value.
double sigma ()
 Getter of the pedestal standard deviation.
void set_verbosity (MSG::Level level)
 Setter for the verbosity level.
MSG::Level get_verbosity () const
 Getter for the verbosity level.
const std::string class_name () const
 Getter for the class name.

Protected Attributes

double _mean
 A variable holder for pedestal mean value.
double _sigma
 A variable holder for pedestal standard deviation.
char _buf [200]
 char buffer for message manipulation
bool _verbosity [MSG::MSG_TYPE_MAX]
 holder for enabled message levels
MSG::Level _verbosity_level
 holder for specified verbosity level
std::string _name
 class name holder

Detailed Description

A class that calculates pedestal mean & standard deviation (here and elsewhere called as "RMS").

Definition at line 27 of file ped_estimator.hh.


Constructor & Destructor Documentation

ped_estimator::ped_estimator (  ) 

Default constructor.

Definition at line 7 of file ped_estimator.cc.

References _mean, and _sigma.

00007                             {
00008 //***************************************************************
00009 
00010   _mean  = -1;
00011 
00012   _sigma = -1;
00013 
00014 }

virtual ped_estimator::~ped_estimator (  )  [inline, virtual]

Default destructor.

Definition at line 35 of file ped_estimator.hh.

00035 {};


Member Function Documentation

const std::string decoder_base::class_name (  )  const [inline, inherited]

Getter for the class name.

Definition at line 46 of file decoder_base.hh.

References decoder_base::_name.

00046 {return _name;};

void ped_estimator::compute_pedestal ( const std::vector< UShort_t > *  wf,
size_t  start,
size_t  nsample 
)

Method to compute a pedestal of the input waveform using "nsample" ADC samples from "start" index.

Definition at line 17 of file ped_estimator.cc.

References _mean, _sigma, Message::send(), and MSG::WARNING.

Referenced by pulse_reco::analyze().

00017                                                                                                {
00018 //***************************************************************
00019   
00020   _mean  = -1;
00021   _sigma = -1;
00022   
00023   if( (start + nsample) > wf->size() ){
00024     Message::send(MSG::WARNING,__FUNCTION__,
00025           Form("Wavelength too short (%zu ADC samples) to compute pedestal! (minimum %zu)",
00026                wf->size(),(start + nsample))
00027           );
00028     return;
00029   }
00030 
00031   for(size_t index=start; index < (start + nsample); ++index)
00032 
00033     _mean += wf->at(index);
00034 
00035   _mean = _mean / ((double)nsample);
00036 
00037   for(size_t index=0; index < (start+nsample); ++index)
00038     
00039     _sigma += pow( (wf->at(index) - _mean), 2 );
00040 
00041   _sigma = sqrt(_sigma/((double)(nsample)));
00042 
00043   return;
00044 
00045 }

MSG::Level decoder_base::get_verbosity (  )  const [inline, inherited]

Getter for the verbosity level.

Definition at line 43 of file decoder_base.hh.

References decoder_base::_verbosity_level.

00043 {return _verbosity_level;};

double ped_estimator::mean (  )  [inline]

Getter of the pedestal mean value.

Definition at line 41 of file ped_estimator.hh.

References _mean.

Referenced by pulse_reco::analyze().

00041 {return _mean;};

void decoder_base::set_verbosity ( MSG::Level  level  )  [inherited]

Setter for the verbosity level.

Reimplemented in ana_processor.

Definition at line 11 of file decoder_base.cc.

References decoder_base::_verbosity, decoder_base::_verbosity_level, MSG::DEBUG, MSG::ERROR, MSG::INFO, MSG::MSG_TYPE_MAX, MSG::NORMAL, and MSG::WARNING.

Referenced by algo_slow_readout_decoder::algo_slow_readout_decoder(), compare_content(), decoder_base::decoder_base(), decoder_manager::decoder_manager(), decoder_manager::initialize(), main(), xmit_event_search::run(), bin_word_search::run(), and ana_processor::set_verbosity().

00011                                               {
00012 
00013   _verbosity_level=level;
00014 
00015   for(size_t i=(size_t)(MSG::DEBUG); i<(size_t)(MSG::MSG_TYPE_MAX); ++i)
00016     _verbosity[i]=false;
00017 
00018   switch(level){
00019   case MSG::DEBUG:
00020     _verbosity[MSG::DEBUG]=true;
00021   case MSG::INFO:
00022     _verbosity[MSG::INFO]=true;
00023   case MSG::NORMAL:
00024     _verbosity[MSG::NORMAL]=true;
00025   case MSG::WARNING:
00026     _verbosity[MSG::WARNING]=true;
00027   case MSG::ERROR:
00028     _verbosity[MSG::ERROR]=true;
00029   case MSG::MSG_TYPE_MAX:
00030     break;
00031   }
00032 
00033 }

double ped_estimator::sigma (  )  [inline]

Getter of the pedestal standard deviation.

Definition at line 44 of file ped_estimator.hh.

References _sigma.

Referenced by pulse_reco::analyze().

00044 {return _sigma;};


Member Data Documentation

char decoder_base::_buf[200] [protected, inherited]

char buffer for message manipulation

Definition at line 46 of file decoder_base.hh.

Referenced by reco_wf::analyze(), pulse_viewer::analyze(), algo_slow_readout_decoder::check_event_quality(), storage_manager::close(), bin_io_handler::close(), decoder_manager::decode(), algo_slow_readout_decoder::decode_ch_word(), algo_pmt_xmit::decode_ch_word(), algo_slow_readout_decoder::decode_event_header(), pulse_viewer::get_waveform(), ana_processor::initialize(), pulse_viewer::next_pulse(), storage_manager::open(), bin_io_handler::open(), storage_manager::prepare_tree(), pulse_viewer::previous_pulse(), algo_slow_readout_decoder::print_adc_values(), algo_tpc_xmit::process_ch_word(), algo_slow_readout_decoder::process_ch_word(), algo_pmt_xmit::process_ch_word(), algo_fem_decoder_base::process_fem_header(), algo_xmit_decoder::process_header(), algo_slow_readout_decoder::process_header(), algo_slow_readout_decoder::process_word(), bin_io_handler::read_multi_word(), bin_io_handler::read_word(), and ana_processor::run().

double ped_estimator::_mean [protected]

A variable holder for pedestal mean value.

Definition at line 44 of file ped_estimator.hh.

Referenced by compute_pedestal(), mean(), and ped_estimator().

std::string decoder_base::_name [protected, inherited]

class name holder

Definition at line 53 of file decoder_base.hh.

Referenced by algo_base::algo_base(), algo_fem_decoder_base::algo_fem_decoder_base(), algo_fixed_window::algo_fixed_window(), algo_slow_readout_decoder::algo_slow_readout_decoder(), algo_threshold::algo_threshold(), algo_tpc_huffman::algo_tpc_huffman(), algo_trig_decoder::algo_trig_decoder(), ana_base::ana_base(), ana_processor::ana_processor(), beamgate_debugger::beamgate_debugger(), bin_io_handler::bin_io_handler(), decoder_base::class_name(), led_pulse_analyzer::led_pulse_analyzer(), led_pulse_selector::led_pulse_selector(), pmt_slow_encoder::pmt_slow_encoder(), pmtbaseline::pmtbaseline(), pmtbaseline_ana::pmtbaseline_ana(), preco_algo_base::preco_algo_base(), pulse_analyzer::pulse_analyzer(), pulse_reco::pulse_reco(), pulse_selector_base::pulse_selector_base(), pulse_selector_simple::pulse_selector_simple(), pulse_viewer::pulse_viewer(), reco_wf::reco_wf(), storage_manager::storage_manager(), and waveform_sampler::waveform_sampler().

double ped_estimator::_sigma [protected]

A variable holder for pedestal standard deviation.

Definition at line 52 of file ped_estimator.hh.

Referenced by compute_pedestal(), ped_estimator(), and sigma().

bool decoder_base::_verbosity[MSG::MSG_TYPE_MAX] [protected, inherited]

holder for enabled message levels

Definition at line 51 of file decoder_base.hh.

Referenced by reco_wf::analyze(), algo_slow_readout_decoder::check_event_quality(), storage_manager::close(), decoder_manager::decode(), algo_slow_readout_decoder::decode_ch_word(), algo_pmt_xmit::decode_ch_word(), algo_slow_readout_decoder::decode_event_header(), algo_fem_decoder_base::decode_fem_header(), algo_trig_decoder::decode_trigger_words(), decoder_manager::finalize(), beamgate_debugger::finalize(), ana_processor::finalize(), decoder_manager::initialize(), beamgate_debugger::initialize(), ana_processor::initialize(), storage_manager::open(), beamgate_debugger::prepare_histo(), storage_manager::prepare_tree(), algo_tpc_xmit::process_ch_word(), algo_tpc_huffman::process_ch_word(), algo_slow_readout_decoder::process_ch_word(), algo_pmt_xmit::process_ch_word(), algo_tpc_xmit::process_event_last_word(), algo_pmt_xmit::process_event_last_word(), algo_fem_decoder_base::process_fem_header(), algo_pmt_xmit::process_fem_last_word(), algo_xmit_decoder::process_header(), algo_slow_readout_decoder::process_header(), algo_fem_decoder_base::process_word(), bin_io_handler::read_multi_word(), storage_manager::reset(), beamgate_debugger::reset(), ana_processor::reset(), decoder_manager::run(), ana_processor::run(), decoder_base::set_verbosity(), algo_tpc_xmit::store_event(), and algo_pmt_xmit::store_event().

MSG::Level decoder_base::_verbosity_level [protected, inherited]

holder for specified verbosity level

Definition at line 52 of file decoder_base.hh.

Referenced by pulse_viewer::analyze(), decoder_base::get_verbosity(), pulse_viewer::initialize(), decoder_manager::initialize(), ana_processor::initialize(), bin_io_handler::read_multi_word(), bin_io_handler::read_word(), and decoder_base::set_verbosity().


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