icarus Namespace Reference

Cluster finding and building. More...

Namespaces
	calo
	crt
	details
	geo
	ns
	opdet
	simfilter
	testing
	Namespace including ICARUS-specific testing.
	TPCGeoUtil
	trigger
	waveform_operations
	Functions to manipulate waveform sample values.

Classes
class	PMTsorterStandard
	Sorter sorting PMT to follow the same order as TPC (standard). More...
class	GeoObjectSorterPMTasTPC
	Geometry sorter having PMT channels follow the same order as TPC. More...
class	ICARUSChannelMapAlg
	Channel mapping for ICARUS detector with split wires. More...
class	IntegerRanges
	A sequence of contiguous ranges of integral numbers. More...
class	WeakCurrentType
	Represents a type of weak current. More...
class	AnalysisTreeDataStruct
class	AnalysisTree
	Creates a simple ROOT tree with tracking and calorimetry information. More...
class	ICARUSPurityDQM
struct	CathodeDesc_t
	Simple description for the cathode. More...
struct	CathodeCrossing_t
	Information about the cathode crossing of a path. More...
class	CRTT0Matching
class	CRTT0MatchingAna
class	CRTTPCMatchingAna
class	CRTTzeroProducer
struct	matchCand
class	CRTT0MatchAlg
class	FlashResAna
class	PhotBackground
class	DaqDecoderICARUSPMT
	Produces raw::OpDetWaveform from V1730 artDAQ data fragments. More...
struct	dumpChannel
struct	TriggerConfiguration
class	KeyValuesData
	Collection of items with key/values structure. More...
class	PMTconfigurationExtractorBase
class	PMTconfigurationExtractor
	Class to extract PMT readout board configuration. More...
class	TriggerConfigurationExtractorBase
class	TriggerConfigurationExtractor
	Class to extract PMT readout board configuration. More...
class	PMTconfigurationExtraction
	Writes PMT configuration from FHiCL into a data product. More...
class	TriggerConfigurationExtraction
	Writes trigger configuration from FHiCL into a data product. More...
class	IcarusGeometryHelper
	Implementation of geo::ExptGeoHelperInterface for ICARUS. More...
class	ICARUSsplitInductionChannelMapSetupTool
	Interface for a tool creating the standard ICARUS channel mapper. More...
struct	SimEnergyDepositSummary
	Data structure containing summary information about deposited energy. More...
struct	ParsingToolkit
	Utilities for text parsing. More...
struct	WaveformRMS
	Class containing a waveform baseline RMS value. More...
class	PMTcoordinates
class	PMTStartCalibTime
class	PMTWaveformBaselines
	Extracts the baseline of PMT waveforms. More...
class	PMTWaveformBaselinesFromChannelData
	Extracts a baseline from PMT waveforms. More...
class	PMTWaveformBaselinesFromReadoutConfiguration
	Extracts PMT baseline settings from PMT readout configuration. More...
class	TrigInfo
struct	WaveformBaseline
	Class containing a waveform baseline value. More...

Functions
void	SortAuxDetsStandard (std::vector< geo::AuxDetGeo > &adgeo)
	Sorts ICARUS CRT modules in standard configuration. More...
void	SortAuxDetSensitiveStandard (std::vector< geo::AuxDetSensitiveGeo > &adsgeo)
	Sorts ICARUS CRT submodules in standard configuration. More...
template<bool CheckGrowing = true, typename Coll >
IntegerRanges< typename Coll::value_type, CheckGrowing >	makeIntegerRanges (Coll const &coll)
template<typename T , bool CheckGrowing>
std::ostream &	operator<< (std::ostream &out, IntegerRanges< T, CheckGrowing > const &ranges)
template<typename T , bool CheckGrowing>
std::ostream &	operator<< (std::ostream &out, typename IntegerRanges< T, CheckGrowing >::Range_t const &r)
CathodeDesc_t	findTPCcathode (geo::Point_t const &point, geo::GeometryCore const &geom)
	Returns cathode information for cryostat at the specified point. More...
double	distance (geo::Point_t const &point, CathodeDesc_t const &cathode)
	Returns the distance of a point from the cathode. More...
geo::Point_t	findCathodeCenter (geo::CryostatGeo const &cryo)
	Returns the center of the cathode in the specified cryostat. More...
template<typename Iter >
CathodeCrossing_t	detectCrossing (Iter begin, Iter end, CathodeDesc_t const &cathode)
	Returns the crossing point of a trajectory on the cathode. More...
void	vmanip (std::vector< double > v, double *ave, double *rms)
void	set_def (sbn::crt::CRTTzero tz)
matchCand	makeNULLmc ()
daq::details::BoardSetup_t	convert (DaqDecoderICARUSPMT::BoardSetupConfig const &config)
	Special function fhicl::TableAs uses to convert BoardSetupConfig. More...
std::ostream &	operator<< (std::ostream &out, dumpChannel const &d)
std::ostream &	operator<< (std::ostream &out, DaqDecoderICARUSPMT::SplitTimestamp_t const &time)
std::ostream &	operator<< (std::ostream &out, icarus::TriggerConfiguration const &config)
	Prints the configuration into a stream with default verbosity. More...
std::ostream &	operator<< (std::ostream &out, KeyValuesData const &data)
std::ostream &	operator<< (std::ostream &out, KeyValuesData::Item const &data)
sbn::PMTconfiguration	extractPMTreadoutConfiguration (std::string const &srcFileName, icarus::PMTconfigurationExtractor extractor)
sbn::PMTconfiguration	extractPMTreadoutConfiguration (TFile &srcFile, icarus::PMTconfigurationExtractor extractor)
template<typename Principal >
sbn::PMTconfiguration	extractPMTreadoutConfiguration (Principal const &data, icarus::PMTconfigurationExtractor extractor)
icarus::TriggerConfiguration	extractTriggerReadoutConfiguration (std::string const &srcFileName, icarus::TriggerConfigurationExtractor extractor)
icarus::TriggerConfiguration	extractTriggerReadoutConfiguration (TFile &srcFile, icarus::TriggerConfigurationExtractor extractor)
template<typename Principal >
icarus::TriggerConfiguration	extractTriggerReadoutConfiguration (Principal const &data, icarus::TriggerConfigurationExtractor extractor)
std::ostream &	operator<< (std::ostream &out, icarus::WaveformRMS const &baseline)
	Prints the value of the RMS into a stream. More...
opdet::SharedWaveformBaseline::Params_t	convert (icarus::PMTWaveformBaselinesFromChannelData::Config::AlgoConfig const &config)
std::ostream &	operator<< (std::ostream &out, icarus::WaveformBaseline const &baseline)
	Prints the value of the baseline into a stream. More...

Variables
constexpr WeakCurrentType	NeutralCurrentType { WeakCurrentType::NC }
	Constant value for a weak neutral current type. More...
constexpr WeakCurrentType	ChargedCurrentType { WeakCurrentType::CC }
	Constant value for a weak charged current type. More...
constexpr WeakCurrentType	AnyWeakCurrentType { WeakCurrentType::any }
	Constant value for any weak current type. More...

Detailed Description

Cluster finding and building.

Class: CRTT0Matching Module Type: producer File: CRTT0Matching_module.cc

Author: Thomas Brooks E-mail address: tbroo.nosp@m.ks@f.nosp@m.nal.g.nosp@m.ov

Modified from CRTT0Matching by Thomas Warburton.

Function Documentation

opdet::SharedWaveformBaseline::Params_t icarus::convert

(

icarus::PMTWaveformBaselinesFromChannelData::Config::AlgoConfig const &

config

)

Definition at line 412 of file PMTWaveformBaselinesFromChannelData_module.cc.

  {
    return {
        0U                               // nSample (to be changed run by run)
      , config.AcceptedSampleRangeRMS()  // nRMS
      , config.ExcessSampleLimit()       // nExcessSamples
      };
  } // convert(icarus::PMTWaveformBaselinesFromChannelData::Config::AlgoConfig)

daq::details::BoardSetup_t icarus::convert

(

DaqDecoderICARUSPMT::BoardSetupConfig const &

config

)

Special function fhicl::TableAs uses to convert BoardSetupConfig.

Definition at line 1179 of file DaqDecoderICARUSPMT_module.cc.

  {
    
    daq::details::BoardSetup_t bs {
        config.Name()                                          // name
      , config.FragmentID()
          .value_or(daq::details::BoardSetup_t::NoFragmentID)  // fragmentID
      , config.TriggerDelay()                                  // triggerDelay
      , config.TTTresetDelay()                                 // TTTresetDelay
      };
    
    // set the special configuration for the board channels that have one;
    // the others will stay with the default one (which implies that a channel
    // is saved in the standard data product, and only if it has a channel ID
    // entry from the database)
    for (
      DaqDecoderICARUSPMT::BoardSetupConfig::ChannelSetupConfig const& chConfig
      : config.SpecialChannels().value_or(
        std::vector<DaqDecoderICARUSPMT::BoardSetupConfig::ChannelSetupConfig>{}
        )
    ) {
      try {
        bs.channelSettings.at(chConfig.ChannelIndex()) = {
            chConfig.Channel()              // channelID
          , chConfig.Skip()                 // forcedSkip
          , chConfig.OnlyOnGlobalTrigger()  // onGlobalOnly
          , chConfig.MinSpan()              // minSpan
          , chConfig.InstanceName()         // category
          };
      }
      catch (std::out_of_range const&) {
        throw art::Exception(art::errors::Configuration)
          << "Configuration requested for invalid channel index "
          << chConfig.ChannelIndex() << " of the board '"
          << config.Name() << "'\n";
      }
    } // for
    
    return bs;
  } // convert(BoardSetupConfig)

template<typename Iter >

CathodeCrossing_t icarus::detectCrossing	(	Iter	begin,
		Iter	end,
		CathodeDesc_t const &	cathode
	)

Returns the crossing point of a trajectory on the cathode.

Template Parameters

Iter	type of iterator to a point in space

Parameters

begin	iterator to the first point of the trajectory
end	iterator past the last point of the trajectory
cathode	description of the cathode plane

Returns

the crossing information

This algorithm intersects a path on a infinite plane in 3D space, and returns the intersection point.

The path is a sequence of segments. For simple trajectories, there is only one crossing, and then the returned point lies on both the path and the plane (it is, indeed, the path/cathode intersection point). For trajectories which cross the plane multiple times, the details of the part of the trajectory between the first and the last crossing are ignored and the two chunks of end paths that lie entirely on one side of the cathode are joint by a segment, shortcutting the details of the path in between.

The function also returns the length of the paths at the two sides of the cathode. Again, in case of multiple crossings, the details of the crossing are ignored and a single segment is used to connect the two sides, and the two lengths reflect that approximation. If no intersection point is found, the two partial lengths are both 0.

double icarus::distance	(	geo::Point_t const &	point,
		CathodeDesc_t const &	cathode
	)

Returns the distance of a point from the cathode.

Definition at line 35 of file CathodeCrossingUtils.cxx.

  { return (point - cathode.center).Dot(cathode.normal); }

sbn::PMTconfiguration icarus::extractPMTreadoutConfiguration	(	std::string const &	srcFileName,
		icarus::PMTconfigurationExtractor	extractor
	)

Definition at line 219 of file PMTconfigurationExtractor.cxx.

{
  //
  // TFile::Open() call is needed to support non-local URL
  // (e.g. XRootD URL are not supported by TFile constructor).
  //
  return extractPMTreadoutConfiguration(*(
    std::unique_ptr<TFile>{ TFile::Open(srcFileName.c_str(), "READ") }
    ),
    std::move(extractor)
    );
} // icarus::extractPMTreadoutConfiguration(string)

sbn::PMTconfiguration icarus::extractPMTreadoutConfiguration	(	TFile &	srcFile,
		icarus::PMTconfigurationExtractor	extractor
	)

Definition at line 235 of file PMTconfigurationExtractor.cxx.

{
  
  return details::extractPMTreadoutConfigurationImpl
    (util::readConfigurationFromArtFile(srcFile), std::move(extractor));
  
} // icarus::extractPMTreadoutConfiguration(TFile)

template<typename Principal >

sbn::PMTconfiguration icarus::extractPMTreadoutConfiguration	(	Principal const &	data,
		icarus::PMTconfigurationExtractor	extractor
	)

Definition at line 494 of file PMTconfigurationExtractor.h.

{
  
  return details::extractPMTreadoutConfigurationImpl
    (util::readConfigurationFromArtPrincipal(principal), std::move(extractor));
  
} // icarus::extractPMTreadoutConfiguration(Principal)

icarus::TriggerConfiguration icarus::extractTriggerReadoutConfiguration	(	std::string const &	srcFileName,
		icarus::TriggerConfigurationExtractor	extractor
	)

Definition at line 343 of file TriggerConfigurationExtractor.cxx.

{
  //
  // TFile::Open() call is needed to support non-local URL
  // (e.g. XRootD URL are not supported by TFile constructor).
  //
  return extractTriggerReadoutConfiguration(*(
    std::unique_ptr<TFile>{ TFile::Open(srcFileName.c_str(), "READ") }
    ),
    std::move(extractor)
    );
} // icarus::extractTriggerReadoutConfiguration(string)

icarus::TriggerConfiguration icarus::extractTriggerReadoutConfiguration	(	TFile &	srcFile,
		icarus::TriggerConfigurationExtractor	extractor
	)

Definition at line 359 of file TriggerConfigurationExtractor.cxx.

{
  
  return details::extractTriggerReadoutConfigurationImpl
    (util::readConfigurationFromArtFile(srcFile), std::move(extractor));
  
} // icarus::extractTriggerReadoutConfiguration(TFile)

template<typename Principal >

icarus::TriggerConfiguration icarus::extractTriggerReadoutConfiguration	(	Principal const &	data,
		icarus::TriggerConfigurationExtractor	extractor
	)

Definition at line 466 of file TriggerConfigurationExtractor.h.

{
  
  return details::extractTriggerReadoutConfigurationImpl
    (util::readConfigurationFromArtPrincipal(principal), std::move(extractor));
  
} // icarus::extracatTriggerReadoutConfiguration(Principal)

geo::Point_t icarus::findCathodeCenter

(

geo::CryostatGeo const &

cryo

)

Returns the center of the cathode in the specified cryostat.

Definition at line 40 of file CathodeCrossingUtils.cxx.

                                                               {
  
  // cathode position: assumes one cathode plane shared by all TPC
  geo::vect::MiddlePointAccumulator cathodePos;
  
  for (geo::TPCGeo const& TPC: cryo.IterateTPCs())
      cathodePos.add(TPC.GetCathodeCenter<geo::Point_t>());
  
  return cathodePos.middlePoint();
  
} // icarus::findCathodeCenter()

icarus::CathodeDesc_t icarus::findTPCcathode	(	geo::Point_t const &	point,
		geo::GeometryCore const &	geom
	)

Returns cathode information for cryostat at the specified point.

The normal to the cathode is always the same as the normal of the first TPC in the cryostat containing point. This ensures consistency within the cryostat.

Definition at line 21 of file CathodeCrossingUtils.cxx.

{
  geo::CryostatGeo const* pCryo = geom.PositionToCryostatPtr(point);
  if (!pCryo) return {}; // all invalid, goodbye
  
  return {
      findCathodeCenter(*pCryo)                   // center
    , -(pCryo->TPC(0).DriftDir<geo::Vector_t>())  // normal
    };
  
} // icarus::findTPCcathode()

template<bool CheckGrowing = true, typename Coll >

IntegerRanges<typename Coll::value_type, CheckGrowing> icarus::makeIntegerRanges

(

Coll const &

coll

)

matchCand icarus::makeNULLmc

(

)

Definition at line 41 of file icaruscode/icaruscode/CRT/CRTUtils/CRTT0MatchAlg.cc.

                         {
    sbn::crt::CRTHit hit;
    matchCand null;
    null.thishit = hit;
    null.t0 = -99999;
    null.dca = -99999;
    null.extrapLen = -99999;
    return null;
  }

std::ostream & icarus::operator<<	(	std::ostream &	out,
		icarus::WaveformRMS const &	baseline
	)

Prints the value of the RMS into a stream.

Definition at line 18 of file WaveformRMS.cxx.

  { out << RMS.RMS(); return out; }

std::ostream & icarus::operator<<	(	std::ostream &	out,
		icarus::WaveformBaseline const &	baseline
	)

Prints the value of the baseline into a stream.

Definition at line 18 of file WaveformBaseline.cxx.

  { out << baseline.baseline(); return out; }

std::ostream & icarus::operator<< ( std::ostream &  out, icarus::TriggerConfiguration const &  config  )

inline

Prints the configuration into a stream with default verbosity.

Definition at line 339 of file TriggerConfiguration.h.

  { config.dump(out); return out; }

std::ostream & icarus::operator<<	(	std::ostream &	out,
		KeyValuesData const &	data
	)

Definition at line 102 of file KeyValuesData.cxx.

{
  out << data.size() << " items";
  if (!data.empty()) {
    out << ':';
    for (auto const& item: data.items()) out << "\n  " << item;
  } // if has data
  return out << "\n";
} // icarus::operator<< (KeyValuesData)

template<typename T , bool CheckGrowing>

std::ostream & icarus::operator<<	(	std::ostream &	out,
		IntegerRanges< T, CheckGrowing > const &	ranges
	)

Definition at line 443 of file IntegerRanges.h.

  { r.dump(out); return out; }

template<typename T , bool CheckGrowing>

std::ostream & icarus::operator<<	(	std::ostream &	out,
		typename IntegerRanges< T, CheckGrowing >::Range_t const &	r
	)

Definition at line 436 of file IntegerRanges.h.

  { r.dump(out); return out; }

std::ostream & icarus::operator<<	(	std::ostream &	out,
		KeyValuesData::Item const &	data
	)

Definition at line 90 of file KeyValuesData.cxx.

{
  out << "'" << item.key() << "' (" << item.nValues() << ")";
  if (!item.values().empty()) {
    out << ':';
    for (auto const& value: item.values()) out << " '" << value << '\'';
  }
  return out;
} // icarus::operator<< (KeyValuesData::Item)

std::ostream& icarus::operator<<	(	std::ostream &	out,
		dumpChannel const &	d
	)

Definition at line 1226 of file DaqDecoderICARUSPMT_module.cc.

                                                                 {
    return out << (d.wf.channelSetup->category.empty()? std::dec: std::hex)
      << d.wf.waveform.ChannelNumber() << std::dec;
  }

std::ostream& icarus::operator<<	(	std::ostream &	out,
		DaqDecoderICARUSPMT::SplitTimestamp_t const &	time
	)

Definition at line 1259 of file DaqDecoderICARUSPMT_module.cc.

  {
    out << time.split.seconds << '.'
      << std::setfill('0') << std::setw(9) << time.split.nanoseconds;
    return out;
  } // operator<< (std::ostream&, PMTDecoder::SplitTimestamp_t)

void icarus::set_def

(

sbn::crt::CRTTzero

tz

)

void icarus::SortAuxDetSensitiveStandard

(

std::vector< geo::AuxDetSensitiveGeo > &

adsgeo

)

Sorts ICARUS CRT submodules in standard configuration.

Definition at line 108 of file AuxDetSorting.cxx.

{
  std::sort(adsgeo.begin(), adsgeo.end(), AuxDetSensitiveStandardSortingRule);
}

void icarus::SortAuxDetsStandard

(

std::vector< geo::AuxDetGeo > &

adgeo

)

Sorts ICARUS CRT modules in standard configuration.

Definition at line 101 of file AuxDetSorting.cxx.

                                                                {
  std::sort(adgeo.begin(), adgeo.end(), AuxDetStandardSortingRule);
}

void icarus::vmanip	(	std::vector< double >	v,
		double *	ave,
		double *	rms
	)

Variable Documentation

constexpr WeakCurrentType icarus::AnyWeakCurrentType { WeakCurrentType::any }

Constant value for any weak current type.

Definition at line 156 of file WeakCurrentType.h.

constexpr WeakCurrentType icarus::ChargedCurrentType { WeakCurrentType::CC }

Constant value for a weak charged current type.

Definition at line 153 of file WeakCurrentType.h.

constexpr WeakCurrentType icarus::NeutralCurrentType { WeakCurrentType::NC }

Constant value for a weak neutral current type.

Definition at line 150 of file WeakCurrentType.h.