unstick::UnstickADCCodes Class Reference

Inheritance diagram for unstick::UnstickADCCodes:

Public Member Functions
	UnstickADCCodes (fhicl::ParameterSet const &pset)
virtual	~UnstickADCCodes ()
void	produce (art::Event &evt)
void	beginJob ()
void	endJob ()
void	reconfigure (fhicl::ParameterSet const &p)
Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDProducer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept
	Producer (fhicl::ParameterSet const &)
	Producer (Producer const &)=delete
	Producer (Producer &&)=delete
Producer &	operator= (Producer const &)=delete
Producer &	operator= (Producer &&)=delete
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Modifier
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Attributes
std::string	fDigitModuleLabel
	constants More...
std::string	fSpillName
raw::Compress_t	fCompression
	compression type to use More...
const unsigned int	onemask = 0x003f
	Unsigned int ending in 111111 used to select 6 LSBs with bitwise AND. More...
unsigned int	fStickyADCCodesLimit
	Number of ADC codes to check for stickiness at 0x00 or 0x3f before stopping. More...

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Definition at line 43 of file UnstickADCCodes_module.cc.

Constructor & Destructor Documentation

unstick::UnstickADCCodes::UnstickADCCodes ( fhicl::ParameterSet const &  pset )

explicit

Definition at line 77 of file UnstickADCCodes_module.cc.

                                                                : EDProducer{pset}
  {
    this->reconfigure(pset);
    produces< std::vector<raw::RawDigit>   >(fSpillName);

  }

unstick::UnstickADCCodes::~UnstickADCCodes ( )

virtual

Definition at line 85 of file UnstickADCCodes_module.cc.

  {
  }

Member Function Documentation

void unstick::UnstickADCCodes::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 106 of file UnstickADCCodes_module.cc.

  {  
  }

void unstick::UnstickADCCodes::endJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 111 of file UnstickADCCodes_module.cc.

  {  
  }

void unstick::UnstickADCCodes::produce ( art::Event &  evt )

virtual

Implements art::EDProducer.

Definition at line 116 of file UnstickADCCodes_module.cc.

  {      

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

    // Read in the digit List object(s). 
    art::InputTag itag1(fDigitModuleLabel, fSpillName);
    auto digitVecHandle = evt.getHandle< std::vector<raw::RawDigit> >(itag1);

    if (!digitVecHandle->size())  return;
    mf::LogInfo("UnstickADCCodes") << "UnstickADCCodes:: digitVecHandle size is " << digitVecHandle->size();

    // Use the handle to get a particular (0th) element of collection.
    art::Ptr<raw::RawDigit> digitVec0(digitVecHandle, 0);

    unsigned int dataSize = digitVec0->Samples(); //size of raw data vectors

  
    raw::ChannelID_t channel = raw::InvalidChannelID; // channel number

    std::vector<short> rawadc(dataSize);  // vector holding uncompressed adc values
    
    short *rawadc_a=0;

    // loop over all raw digits  
    digcol->reserve(digitVecHandle->size());
    for(size_t rdIter = 0; rdIter < digitVecHandle->size(); ++rdIter){ // ++ move
      
      // get the reference to the current raw::RawDigit
      art::Ptr<raw::RawDigit> digitVec(digitVecHandle, rdIter);
      channel = digitVec->Channel();
      fCompression = digitVec->Compression();
      float pedestal = digitVec->GetPedestal();
      // uncompress the data

      int pedestal_value = (int) digitVec->GetPedestal();
      raw::Uncompress(digitVec->ADCs(), rawadc, pedestal_value, fCompression);
      dataSize = rawadc.size();
      rawadc_a = rawadc.data();

      // loop over raw ADC vector and interpolate over stuck values
      for(size_t i = 0; i < dataSize; ++i){

        unsigned int sixlsbs = rawadc_a[i] & onemask;

        if(sixlsbs==onemask || sixlsbs==0){ //ADC code is stuck at 0x3f or 0x00
          

          if(i==0){ //if first ADC code is stuck, set it equal to pedestal value
            rawadc_a[i] = (short) pedestal;
            continue;
          }

          //find nearest preceding unstuck ADC code
          //which should be immediately preceding ADC code since all earlier ADC codes have been interpolated to non-stuck values
          size_t last_unstuck = i > 0 ? i - 1 : 0;
          

          //find nearest following unstuck ADC code
          size_t next_unstuck = i;
          unsigned short next_unstuck_sixlsbs;
          unsigned short sixlsbs_stuck_in_a_row = 0;

          do{

            if(next_unstuck < dataSize - 1 && sixlsbs_stuck_in_a_row < fStickyADCCodesLimit)
              ++next_unstuck;
            else{ 
              rawadc_a[next_unstuck] = (short) pedestal;
              break;
            }
            next_unstuck_sixlsbs = rawadc_a[next_unstuck] & onemask;
            if(next_unstuck_sixlsbs==0 || next_unstuck_sixlsbs==onemask)
              ++sixlsbs_stuck_in_a_row;
            else
              sixlsbs_stuck_in_a_row = 0;

          }
          while(next_unstuck_sixlsbs==onemask || next_unstuck_sixlsbs==0);

          // With last and next unstuck ADC codes found, interpolate linearly and replace stuck ADC code


          float interpolated_unstuck_value = 1.0*(rawadc_a[next_unstuck] - rawadc_a[last_unstuck])/(next_unstuck-last_unstuck)*(i-last_unstuck)+rawadc_a[last_unstuck];
          rawadc_a[i] = (short) interpolated_unstuck_value;

        }

        
      }

      raw::RawDigit rd(channel, dataSize, rawadc, raw::kNone );
      rd.SetPedestal( digitVec->GetPedestal(), digitVec->GetSigma() );
      digcol->push_back(rd);
 
    }

    evt.put(std::move(digcol), fSpillName);
 
    return;
  }

void unstick::UnstickADCCodes::reconfigure

(

fhicl::ParameterSet const &

p

)

Definition at line 90 of file UnstickADCCodes_module.cc.

  {
 
    fDigitModuleLabel = p.get< std::string >("DigitModuleLabel", "daq");
    fStickyADCCodesLimit = p.get< unsigned int    >("StickyADCCodesLimit");
    fSpillName.clear();
    
    size_t pos = fDigitModuleLabel.find(":");
    if( pos!=std::string::npos ) {
      fSpillName = fDigitModuleLabel.substr( pos+1 );
      fDigitModuleLabel = fDigitModuleLabel.substr( 0, pos );
    }
    
  }

Member Data Documentation

raw::Compress_t unstick::UnstickADCCodes::fCompression

private

compression type to use

Definition at line 65 of file UnstickADCCodes_module.cc.

std::string unstick::UnstickADCCodes::fDigitModuleLabel

private

constants

module that made digits

Definition at line 59 of file UnstickADCCodes_module.cc.

std::string unstick::UnstickADCCodes::fSpillName

private

nominal spill is an empty string it is set by the DigitModuleLabel ex.: "daq:preSpill" for prespill data

Definition at line 61 of file UnstickADCCodes_module.cc.

unsigned int unstick::UnstickADCCodes::fStickyADCCodesLimit

private

Number of ADC codes to check for stickiness at 0x00 or 0x3f before stopping.

Definition at line 68 of file UnstickADCCodes_module.cc.

const unsigned int unstick::UnstickADCCodes::onemask = 0x003f

private

Unsigned int ending in 111111 used to select 6 LSBs with bitwise AND.

Definition at line 67 of file UnstickADCCodes_module.cc.

---

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

• dunedataprep/dunedataprep/CalData/UnstickADCCodes_module.cc