detsim::SimWireSBND Class Reference

Inheritance diagram for detsim::SimWireSBND:

Public Member Functions
	SimWireSBND (fhicl::ParameterSet const &pset)
virtual	~SimWireSBND ()
void	produce (art::Event &evt)
void	beginJob ()
void	endJob ()
void	reconfigure (fhicl::ParameterSet const &p)

Private Attributes
std::string	fDriftEModuleLabel
	module making the ionization electrons More...
raw::Compress_t	fCompression
	compression type to use More...
size_t	fNTicks
	number of ticks of the clock More...
unsigned int	fNTimeSamples
	number of ADC readout samples in all readout frames (per event) More...
float	fCollectionPed
	ADC value of baseline for collection plane. More...
float	fInductionPed
	ADC value of baseline for induction plane. More...
float	fCollectionSat
	ADC value of pre-amp saturation for collection plane. More...
float	fInductionSat
	ADC value of pre-amp saturation for induction plane. More...
float	fBaselineRMS
	ADC value of baseline RMS within each channel. More...
TH1D *	fNoiseDist
	distribution of noise counts More...
bool	fGenNoise
	if True -> Gen Noise. if False -> Skip noise generation entierly More...
art::ServiceHandle < ChannelNoiseService >	noiseserv
std::string	fTrigModName
	Trigger data product producer name. More...
CLHEP::HepRandomEngine &	fPedestalEngine

Static Private Attributes
static constexpr float	adcsaturation {4095}

Detailed Description

Definition at line 69 of file SimWireSBND_module.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 112 of file SimWireSBND_module.cc.

  : EDProducer{pset}
  // create a default random engine; obtain the random seed from NuRandomService,
  // unless overridden in configuration with key "Seed" and "SeedPedestal"
  //  , fNoiseEngine(art::ServiceHandle<rndm::NuRandomService>{}->createEngine(*this, "HepJamesRandom", "noise", pset, "Seed"))
  , fPedestalEngine(art::ServiceHandle<rndm::NuRandomService>{}->createEngine(*this, "HepJamesRandom", "pedestal", pset, "SeedPedestal"))

detsim::SimWireSBND::~SimWireSBND ( )

virtual

Definition at line 129 of file SimWireSBND_module.cc.

{
}

Member Function Documentation

void detsim::SimWireSBND::beginJob

(

)

Definition at line 185 of file SimWireSBND_module.cc.

{

  // 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();

  if ( fNTicks % 2 != 0 )
    MF_LOG_DEBUG("SimWireSBND") << "Warning: FFTSize not a power of 2. "
                              << "May cause issues in (de)convolution.\n";

  if ( fNTimeSamples > fNTicks )
    mf::LogError("SimWireSBND") << "Cannot have number of readout samples "
                                 << "greater than FFTSize!";

  return;

}

void detsim::SimWireSBND::endJob

(

)

Definition at line 209 of file SimWireSBND_module.cc.

{}

void detsim::SimWireSBND::produce

(

art::Event &

evt

)

Definition at line 212 of file SimWireSBND_module.cc.

{
  auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);

  //Generate gaussian and coherent noise if doing uBooNE noise model. For other models it does nothing.
  noiseserv->generateNoise(clockData);

  // get the geometry to be able to figure out signal types and chan -> plane mappings
  art::ServiceHandle<geo::Geometry> geo;
  //unsigned int signalSize = fNTicks;
  //
  //Get the channels status
  lariov::ChannelStatusProvider const& channelStatus(art::ServiceHandle<lariov::ChannelStatusService const>()->GetProvider());

  std::vector<const sim::SimChannel*> chanHandle;
  evt.getView(fDriftEModuleLabel, chanHandle);

  //Get fIndShape and fColShape from SignalShapingService, on the fly
  art::ServiceHandle<util::SignalShapingServiceSBND> sss;

  // 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(), nullptr);
  for (size_t c = 0; c < chanHandle.size(); ++c) {
    channels.at(chanHandle.at(c)->Channel()) = chanHandle.at(c);
  }

  const auto NChannels = geo->Nchannels();

  // vectors for working
  std::vector<short>    adcvec(fNTimeSamples, 0);
  std::vector<double>   chargeWork(fNTicks, 0.);



  // make a 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>);
  digcol->reserve(NChannels);

  unsigned int chan = 0;
  art::ServiceHandle<util::LArFFT> fFFT;
     
  //LOOP OVER ALL CHANNELS
  std::map<int, double>::iterator mapIter;
  for (chan = 0; chan < geo->Nchannels(); chan++) {

    if (channelStatus.IsBad(chan)) continue;

    // get the sim::SimChannel for this channel
    const sim::SimChannel* sc = channels.at(chan);
    std::fill(chargeWork.begin(), chargeWork.end(), 0.);
    if ( sc ) {

      // loop over the tdcs and grab the number of electrons for each
      for (int t = 0; t < (int)(chargeWork.size()); ++t) {

        int tdc = clockData.TPCTick2TDC(t);

        // continue if tdc < 0
        if ( tdc < 0 ) continue;

        chargeWork.at(t) = sc->Charge(tdc);

      }

      // Convolve charge with appropriate response function
      sss->Convolute(clockData, chan, chargeWork);

    }
    std::vector<float> noisetmp(fNTicks, 0.);

    // Add noise to channel.
    if( fGenNoise ) noiseserv->addNoise(clockData, chan,noisetmp);

    //Pedestal determination
    float ped_mean = fCollectionPed;
    float preamp_sat=fCollectionSat;
    geo::SigType_t sigtype = geo->SignalType(chan);
    if (sigtype == geo::kInduction) {
      ped_mean = fInductionPed;
      preamp_sat = fInductionSat;
    }
    //slight variation on ped on order of RMS of baseline variation
    // (skip this if BaselineRMS = 0 in fhicl)
    if( fBaselineRMS ) {
      CLHEP::RandGaussQ rGaussPed(fPedestalEngine, 0.0, fBaselineRMS);
      ped_mean += rGaussPed.fire();
    }

    for (unsigned int i = 0; i < fNTimeSamples; ++i) {

      float chargecontrib = chargeWork.at(i);
      if (chargecontrib>preamp_sat) chargecontrib=preamp_sat;

      float adcval = noisetmp.at(i) + chargecontrib + ped_mean;

      //Add Noise to NoiseDist Histogram
      if (i % 100 == 0)
        fNoiseDist->Fill(noisetmp.at(i));

      //allow for ADC saturation
      if ( adcval > adcsaturation )
        adcval = adcsaturation;
      //don't allow for "negative" saturation
      if ( adcval < 0 )
        adcval = 0;

      adcvec.at(i) = (unsigned short)(adcval+0.5);

    }// end loop over signal size

    // resize the adcvec to be the correct number of time samples,
    // just drop the extra samples
    //adcvec.resize(fNTimeSamples);

    // 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);

    // add this digit to the collection
    raw::RawDigit rd(chan, fNTimeSamples, adcvec, fCompression);
    rd.SetPedestal(ped_mean);
    digcol->push_back(rd);

  }// end loop over channels

  evt.put(std::move(digcol));

}//produce()

void detsim::SimWireSBND::reconfigure

(

fhicl::ParameterSet const &

p

)

Definition at line 134 of file SimWireSBND_module.cc.

{
  fDriftEModuleLabel = p.get< std::string         >("DriftEModuleLabel");
  fGenNoise          = p.get< bool                >("GenNoise");
  fCollectionPed     = p.get< float               >("CollectionPed",690.);
  fInductionPed      = p.get< float               >("InductionPed",2100.);
  fCollectionSat     = p.get< float               >("CollectionSat",2922.);
  fInductionSat      = p.get< float               >("InductionSat",1247.);
  fBaselineRMS       = p.get< float               >("BaselineRMS");
  fTrigModName       = p.get< std::string         >("TrigModName");

  //Map the Shaping times to the entry position for the noise ADC
  //level in fNoiseFactInd and fNoiseFactColl
  //fShapingTimeOrder = { {0.5, 0 }, {1.0, 1}, {2.0, 2}, {3.0, 3} };

  //if (fGetNoiseFromHisto)
  //{
  //  fNoiseHistoName = p.get< std::string         >("NoiseHistoName");

  //  cet::search_path sp("FW_SEARCH_PATH");
  //  sp.find_file(p.get<std::string>("NoiseFileFname"), fNoiseFileFname);

  //  TFile in(fNoiseFileFname.c_str(), "READ");
  //  if (!in.IsOpen()) {
  //    throw art::Exception(art::errors::FileOpenError)
  //      << "Could not find Root file '" << fNoiseHistoName
  //      << "' for noise histogram\n";
  //  }
  //  fNoiseHist = (TH1D*) in.Get(fNoiseHistoName.c_str());

  //  if (!fNoiseHist) {
  //    throw art::Exception(art::errors::NotFound)
  //      << "Could not find noise histogram '" << fNoiseHistoName
  //      << "' in Root file '" << in.GetPath() << "'\n";
  //  }
  //  // release the histogram from its file; now we own it
  //  fNoiseHist->SetDirectory(nullptr);
  //  in.Close();
  //}

  //detector properties information
  auto const detProp = art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataForJob();
  fNTimeSamples  = detProp.NumberTimeSamples();

  noiseserv->InitialiseProducerDeps(this, p);  


  return;
}

Member Data Documentation

constexpr float detsim::SimWireSBND::adcsaturation {4095}

staticprivate

Definition at line 102 of file SimWireSBND_module.cc.

float detsim::SimWireSBND::fBaselineRMS

private

ADC value of baseline RMS within each channel.

Definition at line 93 of file SimWireSBND_module.cc.

float detsim::SimWireSBND::fCollectionPed

private

ADC value of baseline for collection plane.

Definition at line 89 of file SimWireSBND_module.cc.

float detsim::SimWireSBND::fCollectionSat

private

ADC value of pre-amp saturation for collection plane.

Definition at line 91 of file SimWireSBND_module.cc.

raw::Compress_t detsim::SimWireSBND::fCompression

private

compression type to use

Definition at line 85 of file SimWireSBND_module.cc.

std::string detsim::SimWireSBND::fDriftEModuleLabel

private

module making the ionization electrons

Definition at line 84 of file SimWireSBND_module.cc.

bool detsim::SimWireSBND::fGenNoise

private

if True -> Gen Noise. if False -> Skip noise generation entierly

Definition at line 95 of file SimWireSBND_module.cc.

float detsim::SimWireSBND::fInductionPed

private

ADC value of baseline for induction plane.

Definition at line 90 of file SimWireSBND_module.cc.

float detsim::SimWireSBND::fInductionSat

private

ADC value of pre-amp saturation for induction plane.

Definition at line 92 of file SimWireSBND_module.cc.

TH1D* detsim::SimWireSBND::fNoiseDist

private

distribution of noise counts

Definition at line 94 of file SimWireSBND_module.cc.

size_t detsim::SimWireSBND::fNTicks

private

number of ticks of the clock

Definition at line 87 of file SimWireSBND_module.cc.

unsigned int detsim::SimWireSBND::fNTimeSamples

private

number of ADC readout samples in all readout frames (per event)

Definition at line 88 of file SimWireSBND_module.cc.

CLHEP::HepRandomEngine& detsim::SimWireSBND::fPedestalEngine

private

Definition at line 105 of file SimWireSBND_module.cc.

std::string detsim::SimWireSBND::fTrigModName

private

Trigger data product producer name.

Definition at line 99 of file SimWireSBND_module.cc.

art::ServiceHandle<ChannelNoiseService> detsim::SimWireSBND::noiseserv

private

Definition at line 97 of file SimWireSBND_module.cc.

---

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

• SimWireSBND_module.cc