WireCell::Gen::TruthTraceID Class Reference

#include <TruthTraceID.h>

Inheritance diagram for WireCell::Gen::TruthTraceID:

Public Member Functions
	TruthTraceID ()
virtual void	reset ()
virtual bool	operator() (const input_pointer &depo, output_queue &frames)
	The calling signature: More...
virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
Public Member Functions inherited from WireCell::IDuctor
virtual	~IDuctor ()
virtual std::string	signature ()
Public Member Functions inherited from WireCell::IQueuedoutNode< IDepo, IFrame >
virtual	~IQueuedoutNode ()
virtual bool	operator() (const boost::any &anyin, queuedany &outanyq)
	The calling signature: More...
virtual std::vector< std::string >	input_types ()
virtual std::vector< std::string >	output_types ()
Public Member Functions inherited from WireCell::IQueuedoutNodeBase
virtual	~IQueuedoutNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	By default assume all subclasses maintain state. More...
Public Member Functions inherited from WireCell::INode
virtual	~INode ()
Public Member Functions inherited from WireCell::IComponent< INode >
virtual	~IComponent ()
Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()
Public Member Functions inherited from WireCell::IConfigurable
virtual	~IConfigurable ()
Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual	~IComponent ()

Private Member Functions
void	process (output_queue &frame)

Private Attributes
std::string	m_anode_tn
std::string	m_rng_tn
IAnodePlane::pointer	m_anode
IRandom::pointer	m_rng
IDepo::vector	m_depos
double	m_start_time
double	m_readout_time
double	m_tick
double	m_pitch_range
double	m_drift_speed
double	m_nsigma
double	m_truth_gain
bool	m_fluctuate
int	m_frame_count
bool	m_eos
std::string	m_truth_type
double	m_num_ind_wire
double	m_num_col_wire
double	m_ind_sigma
double	m_col_sigma
double	m_time_sigma
double	m_wire_power
double	m_time_power
double	m_max_wire_freq
double	m_max_time_freq
bool	m_wire_flag
bool	m_time_flag

Additional Inherited Members
Public Types inherited from WireCell::IDuctor
typedef std::shared_ptr< IDuctor >	pointer
Public Types inherited from WireCell::IQueuedoutNode< IDepo, IFrame >
typedef std::shared_ptr< IQueuedoutNodeBase >	pointer
typedef IDepo	input_type
typedef IFrame	output_type
typedef std::shared_ptr< const IDepo >	input_pointer
typedef std::shared_ptr< const IFrame >	output_pointer
typedef std::deque< output_pointer >	output_queue
Public Types inherited from WireCell::IQueuedoutNodeBase
typedef std::shared_ptr< IQueuedoutNodeBase >	pointer
typedef std::deque< boost::any >	queuedany
Public Types inherited from WireCell::INode
enum	NodeCategory {   unknown, sourceNode, sinkNode, functionNode,   queuedoutNode, joinNode, splitNode, faninNode,   fanoutNode, multioutNode, hydraNode }
Public Types inherited from WireCell::IComponent< INode >
typedef std::shared_ptr< INode >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...
Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer
Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Detailed Description

Definition at line 16 of file TruthTraceID.h.

Constructor & Destructor Documentation

Gen::TruthTraceID::TruthTraceID

(

)

Definition at line 17 of file TruthTraceID.cxx.

  : m_anode_tn("AnodePlane")
  , m_rng_tn("Random")
  , m_start_time(0.0*units::ns)
  , m_readout_time(5.0*units::ms)
  , m_tick(0.5*units::us)
  , m_pitch_range(20*3*units::mm) // +/- 10 wires
  , m_drift_speed(1.0*units::mm/units::us)
  , m_nsigma(3.0)
  , m_truth_gain(-1.0)
  , m_fluctuate(true)
  , m_frame_count(0)
  , m_eos(false)
  , m_truth_type("Bare")
  , m_num_ind_wire(2400.0)
  , m_num_col_wire(3456.0)
  , m_ind_sigma(1./std::sqrt(3.1415926)*1.4)
  , m_col_sigma(1./std::sqrt(3.1415926)*3.0)
  , m_time_sigma(0.14*units::megahertz)
  , m_wire_power(2.0)
  , m_time_power(2.0)
  , m_max_wire_freq(1.0)
  , m_max_time_freq(1.0*units::megahertz)
  , m_wire_flag(false)
  , m_time_flag(true)
{
}

Member Function Documentation

void Gen::TruthTraceID::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 73 of file TruthTraceID.cxx.

                                                               {
  m_anode_tn = get<string>(cfg, "anode", m_anode_tn);
  m_anode = Factory::find_tn<IAnodePlane>(m_anode_tn);
  if(!m_anode){
    cerr << "Gen::Truth: failed to get anode: \"" << m_anode_tn << "\"\n";
    return;
  }

  m_nsigma = get<double>(cfg, "nsigma", m_nsigma);
  m_fluctuate = get<bool>(cfg, "fluctuate", m_fluctuate);
  m_rng = nullptr;
  if(m_fluctuate){
    m_rng_tn = get(cfg, "rng", m_rng_tn);
    m_rng = Factory::find_tn<IRandom>(m_rng_tn);
  }

  m_readout_time = get<double>(cfg, "readout_time", m_readout_time);
  m_tick = get<double>(cfg, "tick", m_tick);
  m_start_time = get<double>(cfg, "start_time", m_start_time);
  m_drift_speed = get<double>(cfg, "drift_speed", m_drift_speed);
  m_frame_count = get<int>(cfg, "first_frame_number", m_frame_count);
  m_truth_gain = get<double>(cfg, "truth_gain", m_truth_gain);

  m_truth_type = get<string>(cfg, "truth_type", m_truth_type);
  m_num_ind_wire = get<double>(cfg, "number_induction_wire", m_num_ind_wire);
  m_num_col_wire = get<double>(cfg, "number_collection_wire", m_num_col_wire);
  m_ind_sigma = get<double>(cfg, "induction_sigma", m_ind_sigma);
  m_col_sigma = get<double>(cfg, "collection_sigma", m_col_sigma);
  m_time_sigma = get<double>(cfg, "time_sigma", m_time_sigma);
  m_wire_power = get<double>(cfg, "wire_power", m_wire_power);
  m_time_power = get<double>(cfg, "time_power", m_time_power);
  m_max_wire_freq = get<double>(cfg, "max_wire_frequency", m_max_wire_freq);
  m_max_time_freq = get<double>(cfg, "max_time_frequency", m_max_time_freq);
  m_wire_flag = get<bool>(cfg, "wire_filter_flag", m_wire_flag);
  m_time_flag = get<bool>(cfg, "time_filter_flag", m_time_flag);
}

WireCell::Configuration Gen::TruthTraceID::default_configuration ( ) const

virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 45 of file TruthTraceID.cxx.

                                                                  {
  Configuration cfg;
  put(cfg, "nsigma", m_nsigma);
  put(cfg, "fluctuate", m_fluctuate);
  put(cfg, "start_time", m_start_time);
  put(cfg, "readout_time", m_readout_time);
  put(cfg, "tick", m_tick);
  put(cfg, "pitch_range", m_pitch_range);
  put(cfg, "drift_speed", m_drift_speed);
  put(cfg, "first_frame_number", m_frame_count);
  put(cfg, "anode", m_anode_tn);
  put(cfg, "rng", m_rng_tn);
  put(cfg, "truth_type", m_truth_type);
  put(cfg, "number_induction_wire", m_num_ind_wire);
  put(cfg, "number_collection_wire", m_num_col_wire);
  put(cfg, "induction_sigma", m_ind_sigma);
  put(cfg, "collection_sigma", m_col_sigma);
  put(cfg, "time_sigma", m_time_sigma);
  put(cfg, "wire_power", m_wire_power);
  put(cfg, "time_power", m_time_power);
  put(cfg, "max_wire_frequency", m_max_wire_freq);
  put(cfg, "max_time_frequency", m_max_time_freq);
  put(cfg, "wire_filter_flag", m_wire_flag);
  put(cfg, "time_filter_flag", m_time_flag);
  put(cfg, "truth_gain", m_truth_gain);
  return cfg;
}

bool Gen::TruthTraceID::operator() ( const input_pointer &  in, output_queue &  outq  )

virtual

The calling signature:

Implements WireCell::IQueuedoutNode< IDepo, IFrame >.

Definition at line 225 of file TruthTraceID.cxx.

                                                                               {
  if(m_eos){
    return false;
  }

  double target_time = m_start_time + m_readout_time;
  if(!depo || depo->time() > target_time){
    process(frames);
  }

  if(depo){
    m_depos.push_back(depo);
  }
  else{
    m_eos = true;
  }

  return true;  
}

void Gen::TruthTraceID::process ( output_queue &  frame )

private

Definition at line 110 of file TruthTraceID.cxx.

                                                 {
  ITrace::vector traces;
  double tick = -1;

  // ### construct wire filters ###
  Binning indBins(m_num_ind_wire,0.0,m_max_wire_freq);
  Response::HfFilter hf_ind(m_ind_sigma,m_wire_power,m_wire_flag);
  auto indTruth = hf_ind.generate(indBins);

  Binning colBins(m_num_col_wire,0.0,m_max_wire_freq);
  Response::HfFilter hf_col(m_col_sigma,m_wire_power,m_wire_flag);
  auto colTruth = hf_col.generate(colBins);

  const int nbins = m_readout_time / m_tick;

  for(auto face : m_anode->faces()){
    for(auto plane : face->planes()){
      const Pimpos* pimpos = plane->pimpos();
      
      Binning tbins(nbins, m_start_time, m_start_time+m_readout_time);
      if(tick < 0){
        tick = tbins.binsize();
      }

      // ### construct time filter ###
      Binning timeBins(tbins.nbins(),0.0,m_max_time_freq);
      Response::HfFilter hf_time(m_time_sigma,m_time_power,m_time_flag);
      auto timeTruth = hf_time.generate(timeBins);


      // ### apply diffusion at wire plane ###
      Gen::BinnedDiffusion bindiff(*pimpos, tbins, m_nsigma, m_rng);
      for(auto depo : m_depos){
        bindiff.add(depo, depo->extent_long() / m_drift_speed, depo->extent_tran());

        auto& wires = plane->wires();
        const int numwires = pimpos->region_binning().nbins();
        for(int iwire=0; iwire<numwires; iwire++){
          const auto rbins = pimpos->region_binning();
          const auto ibins = pimpos->impact_binning();
          const double wire_pos = rbins.center(iwire);
          // fixme (?) this under-calculates the min/max impact position by 1/2 wire region (bv).
          const int min_impact = ibins.edge_index(wire_pos - 0.5*m_pitch_range);
          const int max_impact = ibins.edge_index(wire_pos + 0.5*m_pitch_range);
          const int nsamples = tbins.nbins();
          Waveform::compseq_t total_spectrum(nsamples, Waveform::complex_t(0.0,0.0));

          for(int imp = min_impact; imp<=max_impact; imp++){
            auto id = bindiff.impact_data(imp);
            if(!id){
              continue;
            }

        //debugging
        std::cout<<"Truth: charge spectrum extracted." << imp << std::endl;

            if(m_truth_type == "Bare"){
              const Waveform::compseq_t& charge_spectrum = id->spectrum();
              if(charge_spectrum.empty()){
                continue;
              }
              Waveform::increase(total_spectrum, charge_spectrum);
            }
            else{ // ### convolve with charge w/ hf filters ###
              const Waveform::compseq_t& charge_spectrum = id->spectrum();
              if(charge_spectrum.empty()){
                continue;
              }
              Waveform::compseq_t conv_spectrum(nsamples, Waveform::complex_t(0.0,0.0));
          std::complex<float> charge_gain = m_truth_gain; 
              for(int ind=0; ind<nsamples; ind++){
                if(wires[iwire]->channel()<4800){
                  conv_spectrum[ind] = charge_gain*charge_spectrum[ind]*timeTruth[ind]*indTruth[iwire];
                }
                else{
                  conv_spectrum[ind] = charge_gain*charge_spectrum[ind]*timeTruth[ind]*colTruth[iwire];
                }
              }
              Waveform::increase(total_spectrum, conv_spectrum);
            }
          }
          bindiff.erase(0,min_impact);

          Waveform::realseq_t wave(nsamples,0.0);
          wave = Waveform::idft(total_spectrum);
          auto mm = Waveform::edge(wave);
          if(mm.first == (int)wave.size()){
            continue;
          }

          // ### push to trace ###
          int chid = wires[iwire]->channel();
          ITrace::ChargeSequence charge(wave.begin()+mm.first,
                                        wave.begin()+mm.second);
          auto trace = make_shared<SimpleTrace>(chid, mm.first, charge);
          traces.push_back(trace);
        }
      }
    }
  }

  // ### push to frame ###
  auto frame = make_shared<SimpleFrame>(m_frame_count, m_start_time, traces, tick);
  frames.push_back(frame);

  m_depos.clear();
  m_start_time += m_readout_time;
  ++m_frame_count;
}

void Gen::TruthTraceID::reset ( void  )

virtual

Optional hook to be implemented in order to reset after an end of stream is encountered. Fixme: this should be removed.

Reimplemented from WireCell::INode.

Definition at line 220 of file TruthTraceID.cxx.

                           {
  m_depos.clear();
  m_eos = false;
}

Member Data Documentation

IAnodePlane::pointer WireCell::Gen::TruthTraceID::m_anode

private

Definition at line 29 of file TruthTraceID.h.

std::string WireCell::Gen::TruthTraceID::m_anode_tn

private

Definition at line 26 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_col_sigma

private

Definition at line 49 of file TruthTraceID.h.

IDepo::vector WireCell::Gen::TruthTraceID::m_depos

private

Definition at line 31 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_drift_speed

private

Definition at line 36 of file TruthTraceID.h.

bool WireCell::Gen::TruthTraceID::m_eos

private

Definition at line 43 of file TruthTraceID.h.

bool WireCell::Gen::TruthTraceID::m_fluctuate

private

Definition at line 39 of file TruthTraceID.h.

int WireCell::Gen::TruthTraceID::m_frame_count

private

Definition at line 42 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_ind_sigma

private

Definition at line 48 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_max_time_freq

private

Definition at line 54 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_max_wire_freq

private

Definition at line 53 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_nsigma

private

Definition at line 37 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_num_col_wire

private

Definition at line 47 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_num_ind_wire

private

Definition at line 46 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_pitch_range

private

Definition at line 35 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_readout_time

private

Definition at line 34 of file TruthTraceID.h.

IRandom::pointer WireCell::Gen::TruthTraceID::m_rng

private

Definition at line 30 of file TruthTraceID.h.

std::string WireCell::Gen::TruthTraceID::m_rng_tn

private

Definition at line 27 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_start_time

private

Definition at line 33 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_tick

private

Definition at line 35 of file TruthTraceID.h.

bool WireCell::Gen::TruthTraceID::m_time_flag

private

Definition at line 56 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_time_power

private

Definition at line 52 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_time_sigma

private

Definition at line 50 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_truth_gain

private

Definition at line 38 of file TruthTraceID.h.

std::string WireCell::Gen::TruthTraceID::m_truth_type

private

Definition at line 45 of file TruthTraceID.h.

bool WireCell::Gen::TruthTraceID::m_wire_flag

private

Definition at line 55 of file TruthTraceID.h.

double WireCell::Gen::TruthTraceID::m_wire_power

private

Definition at line 51 of file TruthTraceID.h.

---

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

• wire-cell-build/gen/inc/WireCellGen/TruthTraceID.h
• wire-cell-build/gen/src/TruthTraceID.cxx