Inheritance diagram for detsim::SimWire:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	SimWire (fhicl::ParameterSet const &pset)

virtual	~SimWire ()

void	produce (art::Event &evt)

void	beginJob ()

void	endJob ()

void	reconfigure (fhicl::ParameterSet const &p)

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

bool	modifiesEvent () const

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Member Functions
void	ConvoluteResponseFunctions ()
	convolute electronics and field response More...

void	SetFieldResponse ()
	response of wires to field More...

void	SetElectResponse ()
	response of electronics More...

void	GenNoise (std::vector< float > &array)

Private Attributes
bool	fResponseSet
	flag of whether to set the response functions or not More...

std::string	fDriftEModuleLabel
	module making the ionization electrons More...

std::string	fResponseFile
	response file for induction planes More...

raw::Compress_t	fCompression
	compression type to use More...

double	fNoiseFact
	noise scale factor More...

double	fNoiseWidth
	exponential noise width (kHz) More...

double	fLowCutoff
	low frequency filter cutoff (kHz) More...

int	fNTicks
	number of ticks of the clock More...

int	fNFieldBins
	number of bins for field response More...

double	fSampleRate
	sampling rate in ns More...

unsigned int	fNSamplesReadout
	number of ADC readout samples in 1 readout frame More...

double	fCol3DCorrection

double	fInd3DCorrection

double	fColFieldRespAmp
	amplitude of response to field More...

double	fIndFieldRespAmp
	amplitude of response to field More...

std::vector< double >	fShapeTimeConst
	time constants for exponential shaping More...

int	fTriggerOffset
	(units of ticks) time of expected neutrino event More...

unsigned int	fNElectResp
	number of entries from response to use More...

std::vector< double >	fColFieldResponse
	response function for the field @ collection plane More...

std::vector< double >	fIndFieldResponse
	response function for the field @ induction plane More...

std::vector< TComplex >	fColShape
	response function for the field @ collection plane More...

std::vector< TComplex >	fIndShape
	response function for the field @ induction plane More...

std::vector< double >	fChargeWork

std::vector< double >	fElectResponse
	response function for the electronics More...

std::vector< std::vector< float > >	fNoise
	noise on each channel for each time More...

TH1D *	fIndFieldResp
	response function for the field @ induction plane More...

TH1D *	fColFieldResp
	response function for the field @ collection plane More...

TH1D *	fElectResp
	response function for the electronics More...

TH1D *	fColTimeShape
	convoluted shape for field x electronics @ col plane More...

TH1D *	fIndTimeShape
	convoluted shape for field x electronics @ ind plane More...

TH1D *	fNoiseDist
	distribution of noise counts More...

Detailed Description

Definition at line 77 of file SimWire_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

detsim::SimWire::SimWire ( fhicl::ParameterSet const & pset )

explicit

Definition at line 143 of file SimWire_module.cc.

References fhicl::ParameterSet::get(), raw::kHuffman, and raw::kNone.

   {
     this->reconfigure(pset);
 
     produces< std::vector<raw::RawDigit>   >();
  
     fCompression = raw::kNone;
     std::string compression(pset.get< std::string >("CompressionType"));
     if(compression.compare("Huffman") == 0) fCompression = raw::kHuffman;
 
     // create a default random engine; obtain the random seed from NuRandomService,
     // unless overridden in configuration with key "Seed"
     art::ServiceHandle<rndm::NuRandomService>()
       ->createEngine(*this, pset, "Seed");
   }

detsim::SimWire::~SimWire ( )

virtual

Definition at line 160 of file SimWire_module.cc.

References clear(), and LOG_WARNING.

   {
     fColFieldResponse.clear();
     fIndFieldResponse.clear();
     fColShape.clear();
     fIndShape.clear();
     fChargeWork.clear();
     fElectResponse.clear();
  
     for(unsigned int i = 0; i < fNoise.size(); ++i) fNoise[i].clear();
     fNoise.clear();
 
     LOG_WARNING("SimWire") << "SimWire is an example module that works for the "
                            << "MicroBooNE detector.  Each experiment should implement "
                            << "its own version of this module to simulate electronics "
                            << "response.";
 
   }

Member Function Documentation

void detsim::SimWire::beginJob ( )

virtual

set field response and electronics response, then convolute them

Reimplemented from art::EDProducer.

Definition at line 210 of file SimWire_module.cc.

References util::LArFFT::FFTSize(), and art::TFileDirectory::make().

   { 
     // get access to the TFile service
     art::ServiceHandle<art::TFileService> tfs;
 
     fNoiseDist      = tfs->make<TH1D>("Noise", ";Noise (ADC);", 1000, -10., 10.);
 
     art::ServiceHandle<util::LArFFT> fFFT;
     fNTicks = fFFT->FFTSize();
     fChargeWork.resize(fNTicks, 0.);
 
     // Note the magic 100 here. Argo and uBooNe use NChannels.
     fNoise.resize(100);
     // GenNoise() will further resize each channel's 
     // fNoise vector to fNTicks long.
 
     for(int p = 0; p < 100; ++p){
       GenNoise(fNoise[p]);
       for(int i = 0; i < fNTicks; ++i){
         fNoiseDist->Fill(fNoise[p][i]);
       }
     }//end loop over wires
 
     SetFieldResponse();
     SetElectResponse();
     ConvoluteResponseFunctions();
 
 
     return;
 
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

void detsim::SimWire::ConvoluteResponseFunctions ( )

private

convolute electronics and field response

pad out the rest of the vector with 0.

do the FFT of the shapes

check that you did the right thing

Definition at line 340 of file SimWire_module.cc.

References util::LArFFT::AlignedSum(), col, util::LArFFT::DoFFT(), and art::TFileDirectory::make().

   {
     std::vector<double> col(fNTicks, 0.);
     std::vector<double> ind(fNTicks, 0.);
 
     unsigned int mxbin = TMath::Min(fNTicks, (int)fNElectResp + fNFieldBins);
 
     double sumCol = 0.;
     double sumInd = 0.;
   
     for(unsigned int i = 1; i < mxbin; ++i){
       sumCol = 0.;
       sumInd = 0.;
       for(unsigned int j = 0; j < (unsigned int)fNFieldBins; ++j){
         unsigned int k = i - j;
         if(k == 0) break;
         sumCol += fElectResponse[k]*fColFieldResponse[j];
         sumInd += fElectResponse[k]*fIndFieldResponse[j];
       }
       col[i] = sumCol;
       ind[i] = sumInd;
     
     }//end loop over bins;
 
     ind.resize(fNTicks, 0.);  
     col.resize(fNTicks, 0.);  
 
     // write the shapes out to a file
     art::ServiceHandle<art::TFileService> tfs;
     fColTimeShape = tfs->make<TH1D>("ConvolutedCollection",";ticks; Electronics#timesCollection",fNTicks,0,fNTicks);
     fIndTimeShape = tfs->make<TH1D>("ConvolutedInduction",";ticks; Electronics#timesInduction",fNTicks,0,fNTicks);    
 
     fIndShape.resize(fNTicks/2+1);  
     fColShape.resize(fNTicks/2+1);  
 
     std::vector<double> delta(fNTicks);  
     delta[0] = 1.0;  
     delta[fNTicks-1]=1.0;  
 
     art::ServiceHandle<util::LArFFT> fFFT;
     fFFT->AlignedSum(ind,delta,false);  
     fFFT->AlignedSum(col,delta,false);  
     fFFT->DoFFT(ind, fIndShape);  
     fFFT->DoFFT(col, fColShape);
 
     for(unsigned int i = 0; i < ind.size(); ++i){    
       fColTimeShape->Fill(i, col[i]);    
       fIndTimeShape->Fill(i, ind[i]);  
     }  
 
     fColTimeShape->Write();
     fIndTimeShape->Write();
 
 
     return;
   }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

   {
     return current_context_.get();
   }

void detsim::SimWire::endJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 244 of file SimWire_module.cc.

245 {

246 }

void detsim::SimWire::GenNoise ( std::vector< float > & array )

private

<noise in frequency space

multiply each noise value by fNTicks as the InvFFT divides each bin by fNTicks assuming that a forward FFT has already been done.

Definition at line 401 of file SimWire_module.cc.

References util::LArFFT::DoInvFFT(), and art::RandomNumberGenerator::getEngine().

   {
     art::ServiceHandle<art::RandomNumberGenerator> rng;
     CLHEP::HepRandomEngine &engine = rng->getEngine();
     CLHEP::RandFlat flat(engine);
 
     noise.clear();
     noise.resize(fNTicks, 0.);
     std::vector<TComplex> noiseFrequency(fNTicks/2+1, 0.);
 
     double pval = 0.; 
     double lofilter = 0.;
     double phase = 0.;
     double rnd[2] = {0.};
 
     //width of frequencyBin in kHz
     double binWidth = 1.0/(fNTicks*fSampleRate*1.0e-6);
     for(int i=0; i< fNTicks/2+1; ++i){
       //exponential noise spectrum 
       pval = fNoiseFact*exp(-(double)i*binWidth/fNoiseWidth);
       //low frequency cutoff     
       lofilter = 1.0/(1.0+exp(-(i-fLowCutoff/binWidth)/0.5));
       //randomize 10%
       flat.fireArray(2,rnd,0,1);
       pval *= lofilter*(0.9+0.2*rnd[0]);
       //random pahse angle
       phase = rnd[1]*2.*TMath::Pi();
 
       TComplex tc(pval*cos(phase),pval*sin(phase));
       noiseFrequency[i] += tc;
     }
   
     //std::cout << "filled noise freq" << std::endl;
 
     //inverse FFT MCSignal
     art::ServiceHandle<util::LArFFT> fFFT;
     fFFT->DoInvFFT(noiseFrequency, noise);
 
     noiseFrequency.clear();
 
     for(unsigned int i = 0; i < noise.size(); ++i) noise[i] *= 1.*fNTicks;
 
     return;
   }

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

void detsim::SimWire::produce ( art::Event & evt )

virtual

Implements art::EDProducer.

Definition at line 249 of file SimWire_module.cc.

References sim::SimChannel::Charge(), raw::Compress(), util::LArFFT::Convolute(), art::RandomNumberGenerator::getEngine(), art::DataViewImpl::getView(), geo::kInduction, geo::GeometryCore::Nchannels(), art::Event::put(), and geo::GeometryCore::SignalType().

   {
 
     //std::cout << "in SimWire::produce " << std::endl;
 
     // get the geometry to be able to figure out signal types and chan -> plane mappings
     art::ServiceHandle<geo::Geometry> geo;
     unsigned int signalSize = fNTicks;
     // vectors for working
     std::vector<short>    adcvec(signalSize, 0);        
 
     std::vector<const sim::SimChannel*> chanHandle;
     evt.getView(fDriftEModuleLabel,chanHandle);
 
     // make a vector of const sim::SimChannel* that has same number
     // of entries as the number of channels in the detector
     // and set the entries for the channels that have signal on them
     // using the chanHandle
     std::vector<const sim::SimChannel*> channels(geo->Nchannels());
     for(size_t c = 0; c < chanHandle.size(); ++c){
       channels[chanHandle[c]->Channel()] = chanHandle[c];
     }
     
     // make an unique_ptr of sim::SimDigits that allows ownership of the produced
     // digits to be transferred to the art::Event after the put statement below
     std::unique_ptr< std::vector<raw::RawDigit>   >  digcol(new std::vector<raw::RawDigit>);
           
     unsigned int chan = 0; 
     fChargeWork.clear();
     fChargeWork.resize(fNTicks, 0.);
           
     art::ServiceHandle<util::LArFFT> fFFT;
 
     // Add all channels  
     art::ServiceHandle<art::RandomNumberGenerator> rng;
     CLHEP::HepRandomEngine &engine = rng->getEngine();
     CLHEP::RandFlat flat(engine);
 
     std::map<int,double>::iterator mapIter;      
     for(chan = 0; chan < geo->Nchannels(); chan++) {    
       //       std::cout << "on channel " << chan << std::endl;
       
       fChargeWork.clear();    
       fChargeWork.resize(fNTicks, 0.);    
 
       if( channels[chan] ){      
 
         // get the sim::SimChannel for this channel
         const sim::SimChannel* sc = channels[chan];
 
         // loop over the tdcs and grab the number of electrons for each
         for(size_t t = 0; t < fChargeWork.size(); ++t) 
           fChargeWork[t] = sc->Charge(t);      
 
         //Convolve charge with appropriate response function 
         if(geo->SignalType(chan) == geo::kInduction)        
           fFFT->Convolute(fChargeWork,fIndShape);      
         else fFFT->Convolute(fChargeWork,fColShape);      
       }
 
       // noise was already generated for each wire in the event
       // raw digit vec is already in channel order
       // pick a new "noise channel" for every channel  - this makes sure    
       // the noise has the right coherent characteristics to be on one channel   
       int noisechan = TMath::Nint(flat.fire()*(1.*(fNoise.size()-1)+0.1));
       for(unsigned int i = 0; i < signalSize; ++i){
         adcvec[i] = (short)TMath::Nint(fNoise[noisechan][i] + fChargeWork[i]);
       }
       adcvec.resize(fNSamplesReadout);
 
       // compress the adc vector using the desired compression scheme,
       // if raw::kNone is selected nothing happens to adcvec
       // This shrinks adcvec, if fCompression is not kNone.
 
       raw::Compress(adcvec, fCompression);
       
       raw::RawDigit rd(chan, signalSize, adcvec, fCompression);
       // Then, resize adcvec back to full length!
       adcvec.clear();
       adcvec.resize(signalSize,0.0);
 
       // add this digit to the collection
       digcol->push_back(rd);
     }//end loop over channels      
 
     evt.put(std::move(digcol));
 
     return;
   }

void detsim::SimWire::reconfigure ( fhicl::ParameterSet const & p )

Definition at line 180 of file SimWire_module.cc.

References fhicl::ParameterSet::get().

   {
     std::string fResponseFile = p.get<std::string>("ResponseFile", "");
     
     fResponseSet      = !fResponseFile.empty();
     if (fResponseSet) {
       cet::search_path sp("FW_SEARCH_PATH");
       sp.find_file(p.get<std::string>("ResponseFile"), fResponseFile);
     }
     else fResponseFile.clear();
     fDriftEModuleLabel= p.get< std::string         >("DriftEModuleLabel");
     fNoiseFact        = p.get< double              >("NoiseFact");
     fNoiseWidth       = p.get< double              >("NoiseWidth");
     fLowCutoff        = p.get< double              >("LowCutoff");
     fNFieldBins       = p.get< int                 >("FieldBins");
     fCol3DCorrection  = p.get< double              >("Col3DCorrection");
     fInd3DCorrection  = p.get< double              >("Ind3DCorrection");
     fColFieldRespAmp  = p.get< double              >("ColFieldRespAmp");
     fIndFieldRespAmp  = p.get< double              >("IndFieldRespAmp");
     fShapeTimeConst   = p.get< std::vector<double> >("ShapeTimeConst");
 
     const detinfo::DetectorProperties* detprop = lar::providerFrom<detinfo::DetectorPropertiesService>();
     fSampleRate       = detprop->SamplingRate();
     fTriggerOffset    = detprop->TriggerOffset();
     fNSamplesReadout  = detprop->NumberTimeSamples();
 
     return;
   }

void detsim::SimWire::SetElectResponse ( )

private

response of electronics

end loop over time buckets

remove all values of fElectResponse and time where fElectResponse < 0.01*peak

Definition at line 513 of file SimWire_module.cc.

References DEFINE_ART_MODULE, art::TFileDirectory::make(), and norm.

   {
 
     //     std::cerr << "SetElectResponse" << std::endl;
 
     art::ServiceHandle<geo::Geometry> geo;
   
     fElectResponse.resize(fNTicks, 0.);
     std::vector<double> time(fNTicks,0.);
 
     double norm = fShapeTimeConst[1]*TMath::Pi();
     norm /= sin(fShapeTimeConst[1]*TMath::Pi()/fShapeTimeConst[0])/fSampleRate;
     
     double peak = 0.;
     
     for(int i = 0; i < fNTicks; ++i){
       time[i] = (1.*i - 0.33333*fNTicks)*fSampleRate;
       
       // The 120000 is an arbitrary scaling to get displays for microboone
       fElectResponse[i] = 120000.0*exp(-time[i]/fShapeTimeConst[0])/(1. + exp(-time[i]/fShapeTimeConst[1]))/norm;  
       
       if(fElectResponse[i] > peak){
         peak = fElectResponse[i];
       }
     }
     
     peak *= 0.01;
     std::vector<double>::iterator eitr = fElectResponse.begin();
     std::vector<double>::iterator titr = time.begin();
     while(eitr != fElectResponse.end()){
       if(*eitr < peak){
         fElectResponse.erase(eitr);
         time.erase(titr);
         
       }
       else{
         ++eitr;
         ++titr;
       }
     }//end loop to remove low response values
     
     fNElectResp = fElectResponse.size();
 
     // write the response out to a file
     art::ServiceHandle<art::TFileService> tfs;
     fElectResp = tfs->make<TH1D>("ElectronicsResponse",";t (ns);Electronics Response",fNElectResp,0,fNElectResp);
     for(unsigned int i = 0; i < fNElectResp; ++i){
       //mf::LogInfo("SimWire") <<"checking ElectResponse: i=  "<< i << "  time[i]=  " << time[i] << "  fElectResponse[i]=  " << fElectResponse[i];
       fElectResp->Fill(i, fElectResponse[i]);
     }
 
     fElectResp->Write();
 
     return;
   }

void detsim::SimWire::SetFieldResponse ( )

private

response of wires to field

< should always have at least 2 planes

this assumes all planes are equidistant from each other, probably not a bad assumption

in cm

set the response for the collection plane first the first entry is 0

number of bins //KP

now the induction plane

Definition at line 450 of file SimWire_module.cc.

References detinfo::DetectorProperties::DriftVelocity(), geo::PlaneGeo::LocalToWorld(), art::TFileDirectory::make(), and geo::GeometryCore::Plane().

   {
 
     //     std::cerr << "SetFieldResponse" << std::endl;
 
     art::ServiceHandle<geo::Geometry> geo;
  
     double xyz1[3] = {0.};
     double xyz2[3] = {0.};
     double xyzl[3] = {0.};
     geo->Plane(0).LocalToWorld(xyzl, xyz1);
     geo->Plane(1).LocalToWorld(xyzl, xyz2);
 
     double pitch = xyz2[0] - xyz1[0]; 
 
     fColFieldResponse.resize(fNFieldBins, 0.);
     fIndFieldResponse.resize(fNFieldBins, 0.);
 
 
     // write out the response functions to the file
     // get access to the TFile service
     art::ServiceHandle<art::TFileService> tfs;
     fIndFieldResp = tfs->make<TH1D>("InductionFieldResponse",";t (ns);Induction Response",fNTicks,0,fNTicks);
     fColFieldResp = tfs->make<TH1D>("CollectionFieldResponse",";t (ns);Collection Response",fNTicks,0,fNTicks);
     const detinfo::DetectorProperties* detprop = lar::providerFrom<detinfo::DetectorPropertiesService>();
     double driftvelocity=detprop->DriftVelocity(detprop->Efield(),detprop->Temperature())/1000.;  
     int nbinc = TMath::Nint(fCol3DCorrection*(std::abs(pitch))/(driftvelocity*fSampleRate)); 
   
     double integral = 0.;
     for(int i = 1; i < nbinc; ++i){
       fColFieldResponse[i] = fColFieldResponse[i-1] + 1.0;
       integral += fColFieldResponse[i];
     }
 
     for(int i = 0; i < nbinc; ++i){
       fColFieldResponse[i] *= fColFieldRespAmp/integral;
       fColFieldResp->Fill(i, fColFieldResponse[i]);
     }
 
     
     int nbini = TMath::Nint(fInd3DCorrection*(std::abs(pitch))/(driftvelocity*fSampleRate));//KP
     for(int i = 0; i < nbini; ++i){
       fIndFieldResponse[i] = fIndFieldRespAmp/(1.*nbini);
       fIndFieldResponse[nbini+i] = -fIndFieldRespAmp/(1.*nbini);
     
       fIndFieldResp->Fill(i, fIndFieldResponse[i]);
       fIndFieldResp->Fill(nbini+i, fIndFieldResponse[nbini+i]);
     
     }
 
     fColFieldResp->Write();
     fIndFieldResp->Write();
 
     return;
   }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

Member Data Documentation

std::vector<double> detsim::SimWire::fChargeWork

private

Definition at line 125 of file SimWire_module.cc.

double detsim::SimWire::fCol3DCorrection

private

correction factor to account for 3D path of electrons thru wires

Definition at line 111 of file SimWire_module.cc.

TH1D* detsim::SimWire::fColFieldResp

private

response function for the field @ collection plane

Definition at line 130 of file SimWire_module.cc.

double detsim::SimWire::fColFieldRespAmp

private

amplitude of response to field

Definition at line 115 of file SimWire_module.cc.

std::vector<double> detsim::SimWire::fColFieldResponse

private

response function for the field @ collection plane

Definition at line 121 of file SimWire_module.cc.

std::vector<TComplex> detsim::SimWire::fColShape

private

response function for the field @ collection plane

Definition at line 123 of file SimWire_module.cc.

TH1D* detsim::SimWire::fColTimeShape

private

convoluted shape for field x electronics @ col plane

Definition at line 132 of file SimWire_module.cc.

raw::Compress_t detsim::SimWire::fCompression

private

compression type to use

Definition at line 102 of file SimWire_module.cc.

std::string detsim::SimWire::fDriftEModuleLabel

private

module making the ionization electrons

Definition at line 100 of file SimWire_module.cc.

TH1D* detsim::SimWire::fElectResp

private

response function for the electronics

Definition at line 131 of file SimWire_module.cc.

std::vector<double> detsim::SimWire::fElectResponse

private

response function for the electronics

Definition at line 126 of file SimWire_module.cc.

double detsim::SimWire::fInd3DCorrection

private

correction factor to account for 3D path of electrons thru wires

Definition at line 113 of file SimWire_module.cc.

TH1D* detsim::SimWire::fIndFieldResp

private

response function for the field @ induction plane

Definition at line 129 of file SimWire_module.cc.

double detsim::SimWire::fIndFieldRespAmp

private

amplitude of response to field

Definition at line 116 of file SimWire_module.cc.

std::vector<double> detsim::SimWire::fIndFieldResponse

private

response function for the field @ induction plane

Definition at line 122 of file SimWire_module.cc.

std::vector<TComplex> detsim::SimWire::fIndShape

private

response function for the field @ induction plane

Definition at line 124 of file SimWire_module.cc.

TH1D* detsim::SimWire::fIndTimeShape

private

convoluted shape for field x electronics @ ind plane

Definition at line 133 of file SimWire_module.cc.

double detsim::SimWire::fLowCutoff

private

low frequency filter cutoff (kHz)

Definition at line 106 of file SimWire_module.cc.

unsigned int detsim::SimWire::fNElectResp

private

number of entries from response to use

Definition at line 119 of file SimWire_module.cc.

int detsim::SimWire::fNFieldBins

private

number of bins for field response

Definition at line 108 of file SimWire_module.cc.

std::vector< std::vector<float> > detsim::SimWire::fNoise

private

noise on each channel for each time

Definition at line 127 of file SimWire_module.cc.

TH1D* detsim::SimWire::fNoiseDist

private

distribution of noise counts

Definition at line 134 of file SimWire_module.cc.

double detsim::SimWire::fNoiseFact

private

noise scale factor

Definition at line 104 of file SimWire_module.cc.

double detsim::SimWire::fNoiseWidth

private

exponential noise width (kHz)

Definition at line 105 of file SimWire_module.cc.

unsigned int detsim::SimWire::fNSamplesReadout

private

number of ADC readout samples in 1 readout frame

Definition at line 110 of file SimWire_module.cc.

int detsim::SimWire::fNTicks

private

number of ticks of the clock

Definition at line 107 of file SimWire_module.cc.

std::string detsim::SimWire::fResponseFile

private

response file for induction planes

Definition at line 101 of file SimWire_module.cc.

bool detsim::SimWire::fResponseSet

private

flag of whether to set the response functions or not

Definition at line 99 of file SimWire_module.cc.

double detsim::SimWire::fSampleRate

private

sampling rate in ns

Definition at line 109 of file SimWire_module.cc.

std::vector<double> detsim::SimWire::fShapeTimeConst

private

time constants for exponential shaping

Definition at line 117 of file SimWire_module.cc.

int detsim::SimWire::fTriggerOffset

private

(units of ticks) time of expected neutrino event

Definition at line 118 of file SimWire_module.cc.

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

larsim/v06_53_00/source/larsim/DetSim/SimWire_module.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation