Accepts only neutrino-like events with vertices in a specified volume. More...

Inheritance diagram for icarus::simfilter::FilterNeutrinosActiveVolume:

Classes
struct	BoxCoordConfig
	Configuration of box volume geometry. More...

struct	Config
	Configuration parameter structure. More...

Public Types
using	Parameters = art::EDFilter::Table< Config >

Public Member Functions
	FilterNeutrinosActiveVolume (Parameters const &config)
	Constructor: reads configuration and extracts information from geometry. More...

virtual bool	filter (art::Event &event) override
	Framework hook: applies the filter. More...

virtual void	endJob () override
	Framework hook: prints the summary of the passed events. More...

Private Member Functions
void	addActiveVolumes ()
	Adds all active volumes of detector into the qualifying volume list. More...

void	addVolumeBoxes (fhicl::OptionalSequence< fhicl::Table< BoxCoordConfig >> const &boxConfig)
	Adds the specified volumes into the qualifying volume list. More...

unsigned	addVolumeByName (std::string const &volumeName)
	Adds all `volName` from geometry into the qualifying volume list. More...

bool	qualifying (simb::MCTruth const &truth) const
	Returns whether the interaction described in `truth` qualifies. More...

bool	qualifyingInteractionType (int const interactionType) const
	Returns whether the interaction type is qualifying. More...

bool	qualifyingWeakCurrent (int const CCNC) const
	Returns whether the weak current type is qualifying. More...

bool	qualifyingLocation (geo::Point_t const &location) const
	Returns whether the location is among the accepted ones. More...

Static Private Member Functions
template<typename Coll >
static Coll	sorted (Coll const &coll)
	Returns a sorted copy of the specified collection. More...

Private Attributes
std::vector< geo::BoxBoundedGeo >	fVolumes
	Volumes for qualifying interactions. More...

std::vector< int > const	fInteractions
	List of qualifying interaction types. More...

icarus::WeakCurrentType const	fWeakCurrentType
	Selected weak current. More...

std::string const	fLogCategory
	Category name for the output stream. More...

std::atomic< unsigned int >	fNObserved { 0U }
	Number of observed events. More...

std::atomic< unsigned int >	fNPassed { 0U }
	Number of passed events. More...

Detailed Description

Accepts only neutrino-like events with vertices in a specified volume.

The module identifies a list of volumes to filter on. The filter selects "qualifying" neutrino interactions that:

have interaction vertex in one of a selected list of volumes
optionally, has a specific interaction type (like in simb::MCNeutrino::InteractionType())
optionally, has a specific current type (see simb::MCNeutrino::CCNC())

The event is kept if there is at least one qualifying interaction. In that case, the whole event is passed (including any other interaction).

Input

Truth information from all data products in the form std::vector<simb::MCTruth> will be evaluated. It is an error for an event to have no such data product (but they can all be empty, in which case the event does not qualify).

Configuration

Parameters

The module can be operated in one of two ways: active volumes or generic. In the active volume mode, all TPC active volumes are used for filtering. In the generic mode, all the specified volumes are used for filtering.

inActive (flag, default: false): if set to true, the "active volume mode" is activated;
volumeBoxes (list of coordinate sets; default: empty): a list of selected volumes is specified as a collection of box coordinates, each one in the form of a table:
- Xmin: lower x coordinate
- Xmax: upper x coordinate
- Ymin: lower y coordinate
- Ymax: upper y coordinate
- Zmin: lower z coordinate
- Zmax: upper z coordinate each coordinate is in centimeters, and in the "world" reference frame
volumeNames (list of strings; default: empty): a list of selected volume patterns is specified as volume names; all volumes in the detector geometry with the specified names are included in the list (for example, specifying volCryostat all cryostats will be included); each pattern is a regular expression like parsed by std::regex with default flags;
interactionTypes (list of integers, optional): if specified, interactions only qualify if they belong to any of these interaction types; see simb::MCNeutrino::InteractionType(), and simb::int_type_ definition for the values and their meanings;
weakCurrent (CC or NC, optional): if specified, interactions qualify only if they are tagged as charged or neutral currents; see icarus::WeakCurrentTypes::parse();
logCategory (string, default: FilterNeutrinosActiveVolume): name of the category this module uses to send messages to the message facility.

It is required that at least one among inActive, volumeNames, volumeBoxes, weakCurrent and interactionTypes are specified.

Filtering

This is a filter module: its configuration must appear in the filters table and to be included in a path in trigger_path, and the output module must be told to include that path in SelectEvents configuration key; e.g.:

physics: {
  filters: {
    eventActive: @local::icarus_FilterNeutrinoActive
    # ...
  } # filters
  # ...
  appliedFilters: [ eventActive ]
  trigger_paths: [ appliedFilters ]
} # physics
outputs: {
  rootoutput: {
    module_type:  RootOutput
    fileName:    "%ifb_%tc-%p.root"
    SelectEvents: [ appliedFilters ]
  }
}

Definition at line 161 of file FilterNeutrinosActiveVolume_module.cc.

Member Typedef Documentation

using icarus::simfilter::FilterNeutrinosActiveVolume::Parameters = art::EDFilter::Table<Config>

Definition at line 244 of file FilterNeutrinosActiveVolume_module.cc.

Constructor & Destructor Documentation

icarus::simfilter::FilterNeutrinosActiveVolume::FilterNeutrinosActiveVolume ( Parameters const & config )

explicit

Constructor: reads configuration and extracts information from geometry.

Definition at line 317 of file FilterNeutrinosActiveVolume_module.cc.

   : art::EDFilter(config)
   , fInteractions(sorted(config().interactionTypes()))
   , fWeakCurrentType(config().weakCurrent())
   , fLogCategory(config().logCategory())
 {
   
   { // local scope
     mf::LogInfo log(fLogCategory);
     
     log << "Filter configuration:";
     
     if (!fInteractions.empty()) {
       log << "\n * required one of these " << size(fInteractions)
         << " interaction types:";
       for (int intType: fInteractions)
         log << "\n    - " << sim::TruthInteractionTypeName(intType);
     } // if
     
     log << "\n * weak current type: " << std::string(fWeakCurrentType);
     
     log << "\nConfiguration of qualifying volumes:";
     
   }
   
   //
   // load volumes from the different sources
   //
   if (config().inActive()) addActiveVolumes();
   
   addVolumeBoxes(config().volumeBoxes);
   
   for (std::string const& volName: config().volumeNames())
     addVolumeByName(volName);
   
   //
   // check that we are doing at least something
   //
   if (fVolumes.empty()
     && fInteractions.empty()
     && (fWeakCurrentType == icarus::AnyWeakCurrentType)
   ) {
     
     throw art::Exception(art::errors::Configuration)
       << "No filtering action specified (volume, current nor interaction type).\n"
       ;
     
   } // if no filter
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::FilterNeutrinosActiveVolume()

Member Function Documentation

void icarus::simfilter::FilterNeutrinosActiveVolume::addActiveVolumes ( )

private

Adds all active volumes of detector into the qualifying volume list.

Definition at line 445 of file FilterNeutrinosActiveVolume_module.cc.

                                                                   {
   
   geo::GeometryCore const& geom = *(lar::providerFrom<geo::Geometry>());
   
   for (geo::TPCGeo const& TPC: geom.IterateTPCs()) {
     
     geo::BoxBoundedGeo const& box = TPC.ActiveBoundingBox();
     
     mf::LogVerbatim(fLogCategory)
       << "[volume #" << fVolumes.size() << "] active volume from " << TPC.ID()
       << ": [ " << box.Min() << " -- " << box.Max() << " ]";
     
     fVolumes.push_back(box);
     
   } // for all TPCs
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::addActiveVolumes()

void icarus::simfilter::FilterNeutrinosActiveVolume::addVolumeBoxes ( fhicl::OptionalSequence< fhicl::Table< BoxCoordConfig >> const & boxConfig )

private

Adds the specified volumes into the qualifying volume list.

Definition at line 466 of file FilterNeutrinosActiveVolume_module.cc.

 {
   std::vector<BoxCoordConfig> boxParams;
   
   if (!boxConfig(boxParams)) return;
   
   for (auto const& [ iBox, boxParam ]: util::enumerate(boxParams)) {
     
     geo::BoxBoundedGeo box {
       boxParam.Xmin(), boxParam.Xmax(),
       boxParam.Ymin(), boxParam.Ymax(),
       boxParam.Zmin(), boxParam.Zmax()
       };
     
     mf::LogVerbatim(fLogCategory)
       << "[volume #" << fVolumes.size() << "] box coordinates #" << iBox
       << ": [ " << box.Min() << " -- " << box.Max() << " ]";
     
     fVolumes.push_back(std::move(box));
     
   } // for boxes
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::addVolumeBoxes()

unsigned int icarus::simfilter::FilterNeutrinosActiveVolume::addVolumeByName ( std::string const & volumeName )

private

Adds all volName from geometry into the qualifying volume list.

Definition at line 493 of file FilterNeutrinosActiveVolume_module.cc.

 {
   
   geo::GeometryCore const& geom = *(lar::providerFrom<geo::Geometry>());
   
   //
   // find the path of all volumes matching the given pattern
   //
   std::regex const namePattern { volumePattern };
   std::vector<geo::GeoNodePath> volumePaths;
   auto const matchMe = [&pattern=namePattern](std::string const& s)
     { std::smatch match; return (std::regex_match(s, match, pattern)); };
   auto const findVolume = [&volumePaths, &patternMatcher=matchMe](auto& path)
     {
       if (patternMatcher(path.current().GetVolume()->GetName()))
         volumePaths.push_back(path);
       return true;
     };
   
   geo::ROOTGeometryNavigator navigator { *(geom.ROOTGeoManager()) };
   
   navigator.apply(findVolume);
   
   if (volumePaths.empty()) {
     throw art::Exception(art::errors::Configuration)
       << "No volume matching '" << volumePattern
       << "' has been found in the detector '" << geom.DetectorName()
       << "'.\n";
   }
   
   //
   // convert each volume into world coordinates and add it to the list
   //
   for (auto const& [ iVolume, path ] : util::enumerate(volumePaths)) {
     
     //
     // find the coordinates of the volume in local coordinates
     //
     TGeoShape const* pShape = path.current().GetVolume()->GetShape();
     auto pBox = dynamic_cast<TGeoBBox const*>(pShape);
     if (!pBox) {
       throw cet::exception("FilterNeutrinosActiveVolume") << "Volume '"
         << path.current().GetName() << "' is a " << pShape->IsA()->GetName()
         << ", not a TGeoBBox.\n";
     }
     
     geo::Point_t const origin
       = geo::vect::makeFromCoords<geo::Point_t>(pBox->GetOrigin());
     geo::Vector_t const diag = {
       std::abs(pBox->GetDX()), std::abs(pBox->GetDY()), std::abs(pBox->GetDZ())
       };
     
     //
     // convert to world coordinates
     //
     
     auto const trans
       = path.currentTransformation<geo::TransformationMatrix>();
     
     geo::Point_t min, max;
     trans.Transform(origin - diag, min);
     trans.Transform(origin + diag, max);
     
     //
     // add to the coordinates
     //
     geo::BoxBoundedGeo box { min, max };
     
     mf::LogVerbatim(fLogCategory)
       << " c* [volume #" << fVolumes.size() << "] volume box '"
       << path.current().GetVolume()->GetName()
       << "' [(" << (iVolume + 1U) << "/" << volumePaths.size()
       << "): [ " << box.Min() << " -- " << box.Max() << " ]";
     
     fVolumes.push_back(std::move(box));
     
   } // for all volume paths
   
   return volumePaths.size();
 } // icarus::simfilter::FilterNeutrinosActiveVolume::addVolumeByName()

void icarus::simfilter::FilterNeutrinosActiveVolume::endJob ( )

overridevirtual

Framework hook: prints the summary of the passed events.

Definition at line 432 of file FilterNeutrinosActiveVolume_module.cc.

                                                         {
   
   mf::LogInfo log(fLogCategory);
   log
     << "FilterNeutrinosActiveVolume: passed " << fNPassed << " / " << fNObserved
     << " events";
   if (fNObserved > 0U)
     log << " (" << (float(fNPassed) * 100. / fNObserved) << "%)";
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::endJob()

bool icarus::simfilter::FilterNeutrinosActiveVolume::filter ( art::Event & event )

overridevirtual

Framework hook: applies the filter.

Definition at line 370 of file FilterNeutrinosActiveVolume_module.cc.

                                                                        {
   
   ++fNObserved;
   
   /*
    * Consider all truth information available in the event.
    * Any record of any truth data product will be enough to pass the event.
    */
   //std::vector<art::Handle<std::vector<simb::MCTruth>>> allTruth;
   //event.getManyByType(allTruth);
   auto allTruth = event.getMany<std::vector<simb::MCTruth>>();
   
   if (allTruth.empty()) { // is this real data?
     throw art::Exception(art::errors::ProductNotFound)
       << event.id() << " has no truth information!\n";
   } // if no truth
   
   mf::LogDebug(fLogCategory)
     << "Event " << event.id() << " (#" << fNObserved << ") has "
     << allTruth.size() << " truth data products.";
   
   for (auto const& handle: allTruth) {
     
     art::InputTag const& tag [[gnu::unused]] = handle.provenance()->inputTag();
     
     std::vector<simb::MCTruth> const& truths = *handle;
     if (truths.empty()) {
       mf::LogTrace(fLogCategory)
         << "No truth records from " << tag.encode() << ": skipped.";
       continue;
     } // if no truth
     
     for (auto const& [ iTruth, truth ]: util::enumerate(truths)) {
       
       mf::LogTrace(fLogCategory)
         << "Processing record [" << (iTruth + 1U) << "/" << truths.size()
         << "] from " << tag.encode();
       
       if (!qualifying(truth)) continue; // neeext!
       
       ++fNPassed;
       mf::LogTrace(fLogCategory) << "Event " << event.id()
         << " (#" << fNObserved << ") passes the filter in virtue of "
         << tag.encode() << " record " << (iTruth + 1U)
         << " (" << fNPassed << "/" << fNObserved << " passed so far)."
         ;
       return true;
       
     } // for truth record
     
   } // for truth data product
   
   mf::LogTrace(fLogCategory) << "Event " << event.id() << " (#" << fNObserved
     << ")  does not pass the filter (" << fNPassed << "/" << fNObserved
     << " passed so far).";
   
   return false;
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::filter()

bool icarus::simfilter::FilterNeutrinosActiveVolume::qualifying ( simb::MCTruth const & truth ) const

private

Returns whether the interaction described in truth qualifies.

Definition at line 577 of file FilterNeutrinosActiveVolume_module.cc.

 {
   /*
    * Apply all the needed cuts:
    * * interaction type
    * * current type
    * * location
    * 
    */
   
   //
   // only neutrino record types may qualify:
   //
   if (!truth.NeutrinoSet()) {
     mf::LogTrace(fLogCategory)
       << "Interaction does not qualify because it is not tagged as neutrino.";
     return false;
   }
   
   simb::MCNeutrino const& nuInfo = truth.GetNeutrino();
   simb::MCParticle const& nu = nuInfo.Nu();
   
   //
   // interaction type
   //
   if (!fInteractions.empty() && !qualifyingInteractionType(nuInfo.InteractionType()))
     return false;
   
   //
   // current type
   //
   if ((fWeakCurrentType != icarus::AnyWeakCurrentType) && !qualifyingWeakCurrent(nuInfo.CCNC()))
     return false;
   
   //
   // location
   //
   if (!fVolumes.empty() && !qualifyingLocation({ nu.Vx(), nu.Vy(), nu.Vz() }))
     return false;
   
   // success, after all
   return true;
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::qualifying()

bool icarus::simfilter::FilterNeutrinosActiveVolume::qualifyingInteractionType ( int const interactionType ) const

private

Returns whether the interaction type is qualifying.

Definition at line 625 of file FilterNeutrinosActiveVolume_module.cc.

 {
   mf::LogTrace log(fLogCategory);
   log
     << "Interaction type: " << sim::TruthInteractionTypeName(interactionType)
     << " (" << interactionType << ")";
   
   bool const pass = std::binary_search
     (begin(fInteractions), end(fInteractions), interactionType);
   log << " => :-" << (pass? ')': '(');
   return pass;
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::qualifyingInteractionType()

bool icarus::simfilter::FilterNeutrinosActiveVolume::qualifyingLocation ( geo::Point_t const & location ) const

private

Returns whether the location is among the accepted ones.

Definition at line 666 of file FilterNeutrinosActiveVolume_module.cc.

 {
   
   mf::LogTrace log(fLogCategory);
   log << "Interaction location: " << location << " cm";
   
   for (auto const& [ iBox, box ]: util::enumerate(fVolumes)) {
     if (!box.ContainsPosition(location)) continue;
     
     log << " => in volume #" << iBox
       << " [ " << box.Min() << " -- " << box.Max() << " ] => :-)";
     
     return true;
   } // for
   
   log << " => :-(";
   return false;
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::qualifyingLocation()

bool icarus::simfilter::FilterNeutrinosActiveVolume::qualifyingWeakCurrent ( int const CCNC ) const

private

Returns whether the weak current type is qualifying.

Definition at line 643 of file FilterNeutrinosActiveVolume_module.cc.

 {
   using icarus::WeakCurrentType;
   
   mf::LogTrace log(fLogCategory);
   log << "Interaction current: " << sim::TruthCCNCname(CCNC)
     << " (" << CCNC << ")";
   
   bool pass = false;
   switch (fWeakCurrentType) {
     case WeakCurrentType::CC:  pass = (CCNC == simb::kCC); break;
     case WeakCurrentType::NC:  pass = (CCNC == simb::kNC); break;
     case WeakCurrentType::any: pass = true; break;
   } // switch
   
   log << " => :-" << (pass? ')': '(');
   return pass;
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::qualifyingWeakCurrent()

template<typename Coll >

Coll icarus::simfilter::FilterNeutrinosActiveVolume::sorted ( Coll const & coll )

staticprivate

Returns a sorted copy of the specified collection.

Definition at line 689 of file FilterNeutrinosActiveVolume_module.cc.

                                                                         {
   
   // copy, sort, return
   auto sortedColl { coll };
   std::sort(util::begin(sortedColl), util::end(sortedColl));
   return sortedColl;
   
 } // icarus::simfilter::FilterNeutrinosActiveVolume::sorted()