pulse_reco Class Reference
[PulseReco, PulseReco]

A manager class of pulse reconstruction which acts as an analysis unit (inherits from ana_base). More...

#include <pulse_reco.hh>

Inheritance diagram for pulse_reco:

List of all members.

Public Types
	kHEAD = 0
	Use first N samples.
	kTAIL
	Use last N samples.
	kBOTH
	Calculate both and use the one with smaller RMS.
enum	PED_METHOD { kHEAD = 0, kTAIL, kBOTH }
	enum to define ped_estimator algorithm options More...
Public Member Functions
	pulse_reco ()
	Default constructor.
	~pulse_reco ()
	Default destructor.
virtual bool	initialize ()
	Implementation of ana_base::initialize method.
virtual bool	analyze (storage_manager *storage)
	Implementation of ana_base::analyze method.
virtual bool	finalize ()
	Implementation of ana_base::finalize method.
void	add_reco_algo (preco_algo_base *algo)
	A method to set pulse reconstruction algorithm.
void	set_ped_algo (PED_METHOD type)
	A method to set a choice of pedestal estimation method.
void	set_ped_nsample_cosmic (size_t n)
	A method to set # of ADC samples to be used for a cosmic readout.
void	set_ped_nsample_beam (size_t n)
	A method to set # of ADC samples to be used for a beam readout.
void	set_output_file (TFile *fout)
	A setter for analysis output file poitner.
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
TFile *	_fout
	Analysis output file pointer.
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
Private Member Functions
bool	is_beam (const pmt_waveform *wf)
	A method to judge whether the subject waveform corresponds to a beam readout or not.
Private Attributes
std::vector< preco_algo_base * >	_reco_algo_v
	pulse reconstruction algorithm pointer
ped_estimator	_ped_algo
	ped_estimator object
size_t	_ped_nsample_cosmic
	# samples to be used for pedestal estimation of cosmic readout
size_t	_ped_nsample_beam
	# samples to be used for pedestal estimation of beam readout
PED_METHOD	_ped_method
	Enum value to be set by a user for the pedestal estimation method.

---

Detailed Description

A manager class of pulse reconstruction which acts as an analysis unit (inherits from ana_base).

This class executes various pulse reconstruction algorithm which inherits from preco_algo_base. Refer to analyze() function implementation to check how a pulse reconstruction algorithm is called.

Definition at line 31 of file pulse_reco.hh.

---

Member Enumeration Documentation

enum pulse_reco::PED_METHOD

enum to define ped_estimator algorithm options

Enumerator:

kHEAD	Use first N samples.
kTAIL	Use last N samples.
kBOTH	Calculate both and use the one with smaller RMS.

Definition at line 36 of file pulse_reco.hh.

                 {
    kHEAD = 0, 
    kTAIL,     
    kBOTH      
  };

---

Constructor & Destructor Documentation

pulse_reco::pulse_reco

(

)

Default constructor.

Definition at line 7 of file pulse_reco.cc.

References decoder_base::_name, _ped_method, _ped_nsample_beam, _ped_nsample_cosmic, _reco_algo_v, and kHEAD.

                       : ana_base(),  _reco_algo_v(), _ped_algo(){
//***************************************************************

  _reco_algo_v.clear();

  _ped_nsample_cosmic = 1;

  _ped_nsample_beam   = 8;

  _ped_method = kHEAD;

  _name="pulse_reco";

};

pulse_reco::~pulse_reco

(

)

[inline]

Default destructor.

Definition at line 48 of file pulse_reco.hh.

{};

---

Member Function Documentation

void pulse_reco::add_reco_algo

(

preco_algo_base *

algo

)

[inline]

A method to set pulse reconstruction algorithm.

Definition at line 60 of file pulse_reco.hh.

References _reco_algo_v.

Referenced by main().

{ _reco_algo_v.push_back(algo); };

bool pulse_reco::analyze

(

storage_manager *

storage

)

[virtual]

Implementation of ana_base::analyze method.

Implements ana_base.

Definition at line 38 of file pulse_reco.cc.

References _ped_algo, _ped_method, _ped_nsample_beam, _ped_nsample_cosmic, _reco_algo_v, ped_estimator::compute_pedestal(), pmt_wf_collection::event_id(), storage_manager::get_data(), is_beam(), kBOTH, kHEAD, kTAIL, ped_estimator::mean(), pulse_collection::npulse(), DATA_STRUCT::PMT_WF_COLLECTION, Message::send(), pulse_info::set_channel_frame_id(), pulse_info::set_channel_number(), pulse_info::set_charge(), pulse_info::set_disc_id(), pulse_info::set_end_time(), pulse_info::set_max_time(), pulse_collection::set_npulse(), pulse_info::set_ped_mean(), pulse_info::set_ped_rms(), pulse_info::set_pulse_peak(), pulse_info::set_start_time(), pulse_collection::set_sum_charge(), pulse_collection::set_sum_peak(), ped_estimator::sigma(), pulse_collection::sum_charge(), pulse_collection::sum_peak(), and MSG::WARNING.

                                                {
//***************************************************************

  pmt_wf_collection *waveforms = (pmt_wf_collection*)(storage->get_data(DATA_STRUCT::PMT_WF_COLLECTION));

  bool status = true;
  
  for(pmt_wf_collection::iterator iter(waveforms->begin());
      iter!=waveforms->end();
      ++iter){
    
    //
    // Step 0: skipe 0-length waveform with a warning message
    //    
    if((*iter).size()<1){
      
      Message::send(MSG::WARNING,__PRETTY_FUNCTION__,
            Form("Found 0-length waveform vector! Skipping Event = %d, Ch. = %d ...",
             waveforms->event_id(), (*iter).channel_number()));
      continue;
    }
    
    //
    // Step 1: apply pedestal estimation
    //  
    double ped_mean = 0;
    double sigma  = 0;
    // Figure out whether this is a beam readout or not
    size_t ped_nsample = ( is_beam(&(*iter)) ? _ped_nsample_beam : _ped_nsample_cosmic);

    switch(_ped_method){

    case kHEAD:

      _ped_algo.compute_pedestal(&(*iter), 0, ped_nsample);

      ped_mean = _ped_algo.mean();

      sigma  = _ped_algo.sigma();

      break;

    case kTAIL:

      _ped_algo.compute_pedestal(&(*iter), ((*iter).size()-ped_nsample), ped_nsample);
      
      ped_mean = _ped_algo.mean();

      sigma  = _ped_algo.sigma();

      break;

    case kBOTH:

      _ped_algo.compute_pedestal(&(*iter), 0, ped_nsample);

      ped_mean = _ped_algo.mean();

      sigma  = _ped_algo.sigma();

      _ped_algo.compute_pedestal(&(*iter), ((*iter).size()-ped_nsample), ped_nsample);
      
      if( sigma > _ped_algo.sigma() ) {

    ped_mean = _ped_algo.mean();
    
    sigma  = _ped_algo.sigma();

      }
      
      break;
    }

    //
    // Step 2: apply reco algos
    //
    for(auto reco_algo : _reco_algo_v){

      reco_algo->set_ped_mean(ped_mean);
      
      reco_algo->set_ped_rms (sigma);
    
      status = status && reco_algo->reco(&(*iter));

      //
      // Step 3: loop over reconstructed pulse ane store.
      //
      pulse_collection *pulses = (pulse_collection*)(storage->get_data(reco_algo->storage_type()));

      for(size_t i=0; i < reco_algo->get_npulse(); ++i) {
    
    // Fill output data product for waveform-wise info
    pulse_info pulse;
    
    pulse.set_timeslice        ( (*iter).timeslice()        );
    pulse.set_channel_number   ( (*iter).channel_number()   );
    pulse.set_channel_frame_id ( (*iter).channel_frame_id() );
    pulse.set_disc_id          ( (*iter).disc_id()          );
    
    pulse.set_ped_mean   ( reco_algo->ped_mean()            );
    pulse.set_ped_rms    ( reco_algo->ped_rms()             );
    pulse.set_charge     ( reco_algo->get_pulse(i)->area    );
    pulse.set_pulse_peak ( reco_algo->get_pulse(i)->peak    );
    pulse.set_start_time ( reco_algo->get_pulse(i)->t_start );
    pulse.set_max_time   ( reco_algo->get_pulse(i)->t_max   );
    pulse.set_end_time   ( reco_algo->get_pulse(i)->t_end   );
    
    pulses->push_back(pulse);

    // Accumulate event-wise charge/amplitude sum
    pulses->set_sum_charge ( pulses->sum_charge() + reco_algo->get_pulse(i)->area);
    pulses->set_sum_peak   ( pulses->sum_peak()   + reco_algo->get_pulse(i)->peak);
    pulses->set_npulse     ( pulses->npulse()     + 1                            );

      } // end of reco-ed pulse loop
    } // end of reco algorithm loop
  } // end of PMT waveform loop

  return status;
  
  }

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.

{return _name;};

bool pulse_reco::finalize

(

)

[virtual]

Implementation of ana_base::finalize method.

Implements ana_base.

Definition at line 161 of file pulse_reco.cc.

References ana_base::_fout.

                          {
//***************************************************************

  _fout->cd();
  
  return true;

}

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.

{return _verbosity_level;};

bool pulse_reco::initialize

(

)

[virtual]

Implementation of ana_base::initialize method.

Implements ana_base.

Definition at line 23 of file pulse_reco.cc.

References _reco_algo_v, MSG::ERROR, and Message::send().

                           {
//***************************************************************
  
  if(!(_reco_algo_v.size())) {

    Message::send(MSG::ERROR,__PRETTY_FUNCTION__,"Pulse reconstruction algorithm not set!");
          
    return false;
  }

  return true;

}

bool pulse_reco::is_beam

(

const pmt_waveform *

wf

)

[inline, private]

A method to judge whether the subject waveform corresponds to a beam readout or not.

Definition at line 89 of file pulse_reco.hh.

Referenced by analyze().

{return (wf->size() > 1000);};

void ana_base::set_output_file

(

TFile *

fout

)

[inline, inherited]

A setter for analysis output file poitner.

Definition at line 46 of file ana_base.hh.

References ana_base::_fout.

{_fout=fout;};

void pulse_reco::set_ped_algo

(

PED_METHOD

type

)

[inline]

A method to set a choice of pedestal estimation method.

Definition at line 63 of file pulse_reco.hh.

References _ped_method.

Referenced by main().

{ _ped_method = type;           };

void pulse_reco::set_ped_nsample_beam

(

size_t

n

)

[inline]

A method to set # of ADC samples to be used for a beam readout.

Definition at line 69 of file pulse_reco.hh.

References _ped_nsample_beam.

{ _ped_nsample_beam   = n;      };

void pulse_reco::set_ped_nsample_cosmic

(

size_t

n

)

[inline]

A method to set # of ADC samples to be used for a cosmic readout.

Definition at line 66 of file pulse_reco.hh.

References _ped_nsample_cosmic.

Referenced by main().

{ _ped_nsample_cosmic = n;      };

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().

                                              {

  _verbosity_level=level;

  for(size_t i=(size_t)(MSG::DEBUG); i<(size_t)(MSG::MSG_TYPE_MAX); ++i)
    _verbosity[i]=false;

  switch(level){
  case MSG::DEBUG:
    _verbosity[MSG::DEBUG]=true;
  case MSG::INFO:
    _verbosity[MSG::INFO]=true;
  case MSG::NORMAL:
    _verbosity[MSG::NORMAL]=true;
  case MSG::WARNING:
    _verbosity[MSG::WARNING]=true;
  case MSG::ERROR:
    _verbosity[MSG::ERROR]=true;
  case MSG::MSG_TYPE_MAX:
    break;
  }

}

---

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().

TFile* ana_base::_fout [protected, inherited]

Analysis output file pointer.

Definition at line 46 of file ana_base.hh.

Referenced by ana_base::ana_base(), waveform_sampler::finalize(), finalize(), pulse_analyzer::finalize(), pmtbaseline_ana::finalize(), pmtbaseline::finalize(), led_pulse_analyzer::finalize(), beamgate_debugger::finalize(), pulse_analyzer::initialize(), pmt_slow_encoder::pmt_slow_encoder(), pmtbaseline::pmtbaseline(), pmtbaseline_ana::pmtbaseline_ana(), pulse_selector_base::pulse_selector_base(), pulse_selector_simple::pulse_selector_simple(), waveform_sampler::sample_waveform(), ana_base::set_output_file(), and waveform_sampler::waveform_sampler().

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_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().

ped_estimator pulse_reco::_ped_algo [private]

ped_estimator object

Definition at line 77 of file pulse_reco.hh.

Referenced by analyze().

PED_METHOD pulse_reco::_ped_method [private]

Enum value to be set by a user for the pedestal estimation method.

Definition at line 86 of file pulse_reco.hh.

Referenced by analyze(), pulse_reco(), and set_ped_algo().

size_t pulse_reco::_ped_nsample_beam [private]

# samples to be used for pedestal estimation of beam readout

Definition at line 83 of file pulse_reco.hh.

Referenced by analyze(), pulse_reco(), and set_ped_nsample_beam().

size_t pulse_reco::_ped_nsample_cosmic [private]

# samples to be used for pedestal estimation of cosmic readout

Definition at line 80 of file pulse_reco.hh.

Referenced by analyze(), pulse_reco(), and set_ped_nsample_cosmic().

std::vector<preco_algo_base*> pulse_reco::_reco_algo_v [private]

pulse reconstruction algorithm pointer

Definition at line 69 of file pulse_reco.hh.

Referenced by add_reco_algo(), analyze(), initialize(), and pulse_reco().

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:

• pulse_reco.hh
• pulse_reco.cc

---