GENIE Interface for user-defined volume selector functors This basic version allows configurations that depend on PathSegment elements' material/media/volume and/or "path". More...

#include <GeomVolSelectorBasic.h>

Inheritance diagram for genie::geometry::GeomVolSelectorBasic:

[legend]

Collaboration diagram for genie::geometry::GeomVolSelectorBasic:

[legend]

Public Member Functions
	GeomVolSelectorBasic ()

virtual	~GeomVolSelectorBasic ()

void	SetVolumeSelection (string volstr)

void	SetMediumSelection (string medstr)

void	SetMaterialSelection (string matstr)

void	SetPathSelection (string pathstr)

void	TrimSegment (PathSegment &segment) const

void	BeginPSList (const PathSegmentList *untrimmed) const

void	EndPSList () const

Public Member Functions inherited from genie::geometry::GeomVolSelectorI
virtual	~GeomVolSelectorI ()

virtual PathSegmentList *	GenerateTrimmedList (const PathSegmentList *untrimmed) const

void	SetCurrentRay (const TLorentzVector &x4, const TLorentzVector &p4)
	configure for individual neutrino ray More...

void	SetSI2Local (double scale)
	set scale factor for SI to "raydist" units of PathSegmentList More...

void	SetRemoveEntries (bool rmset)

bool	GetRemoveEntries ()

void	SetNeedPath ()

bool	GetNeedPath () const
	allow toggle on only More...

std::string	GetName () const

Protected Member Functions
void	ParseSelection (const string &str, vector< string > &required, vector< string > &forbidden)

bool	RejectString (const string &str, const vector< string > &required, const vector< string > &forbidden) const

Protected Member Functions inherited from genie::geometry::GeomVolSelectorI
	GeomVolSelectorI ()

	GeomVolSelectorI (std::string name)

Protected Attributes
vector< string >	fRequiredVol

vector< string >	fRequiredMed

vector< string >	fRequiredMat

vector< string >	fRequiredPath

vector< string >	fForbiddenVol

vector< string >	fForbiddenMed

vector< string >	fForbiddenMat

vector< string >	fForbiddenPath

Protected Attributes inherited from genie::geometry::GeomVolSelectorI
TLorentzVector	fX4
	current neutrino ray's start position (global) More...

TLorentzVector	fP4
	current neutrino ray's momentum (global) More...

double	fScale
	SI->raydist scale factor. More...

bool	fRemoveEntries
	whether selector should remove entries or set hi=lo More...

bool	fNeedPath
	selector needs PathSegment "path" string More...

std::string	fName
	volume selector name More...

Detailed Description

GENIE Interface for user-defined volume selector functors This basic version allows configurations that depend on PathSegment elements' material/media/volume and/or "path".

Author: Robert Hatcher rhatc.nosp@m.her@.nosp@m.fnal..nosp@m.gov FNAL

Created:: December 3, 2008

License:: Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 35 of file GeomVolSelectorBasic.h.

Constructor & Destructor Documentation

GeomVolSelectorBasic::GeomVolSelectorBasic ( )

Definition at line 23 of file GeomVolSelectorBasic.cxx.

   : GeomVolSelectorI("Basic")
 {
 
 }

GeomVolSelectorBasic::~GeomVolSelectorBasic ( )

virtual

Definition at line 30 of file GeomVolSelectorBasic.cxx.

 {
 
 }

Member Function Documentation

void GeomVolSelectorBasic::BeginPSList ( const PathSegmentList * untrimmed ) const

virtual

Every derived version must also respond to a signal that starts a new path segment list processing and ends it. In general they can simply ignore the signal. If the derived class needs to cache something, make it mutable

Implements genie::geometry::GeomVolSelectorI.

Reimplemented in genie::geometry::GeomVolSelectorFiducial, and genie::geometry::GeomVolSelectorRockBox.

Definition at line 63 of file GeomVolSelectorBasic.cxx.

Referenced by genie::geometry::GeomVolSelectorFiducial::BeginPSList().

64 { ; }

void GeomVolSelectorBasic::EndPSList ( ) const

virtual

Implements genie::geometry::GeomVolSelectorI.

Reimplemented in genie::geometry::GeomVolSelectorFiducial, and genie::geometry::GeomVolSelectorRockBox.

Definition at line 66 of file GeomVolSelectorBasic.cxx.

Referenced by genie::geometry::GeomVolSelectorFiducial::EndPSList().

67 { ; }

void GeomVolSelectorBasic::ParseSelection	(	const string &	str,
		vector< string > &	required,
		vector< string > &	forbidden
	)

protected

Definition at line 109 of file GeomVolSelectorBasic.cxx.

References genie::utils::str::Split().

Referenced by SetMaterialSelection(), SetMediumSelection(), SetPathSelection(), and SetVolumeSelection().

 {
   required.clear();
   forbidden.clear();
   vector<string> pieces = genie::utils::str::Split(strall,":;,");
   size_t n = pieces.size();
   for ( size_t i = 0; i < n; ++i ) {
     string& strone = pieces[i];
     if ( strone == "" ) continue;  // reject null strings
     if      ( strone.find("-") == 0 ) forbidden.push_back(strone.substr(1,std::string::npos));
     else if ( strone.find("+") == 0 ) required.push_back(strone.substr(1,std::string::npos));
     else                              required.push_back(strone);
   }
 }

bool GeomVolSelectorBasic::RejectString	(	const string &	str,
		const vector< string > &	required,
		const vector< string > &	forbidden
	)		const

protected

Definition at line 126 of file GeomVolSelectorBasic.cxx.

Referenced by TrimSegment().

 {
   bool reject = false;
 
   // must have at least one of the required elements (if there are any)
   size_t nrequired = required.size();
   if ( nrequired > 0 ) {
     bool found = false;
     for (size_t jr = 0; jr < nrequired; ++jr) {
       if ( str.find(required[jr]) != std::string::npos ) {
         found = true;
         break; // found at least one case, so we're good
       }
     }
     if ( ! found ) reject = true;
   }
 
   // can not have any of the forbidden elements
   size_t nforbidden = forbidden.size();
   if ( nforbidden > 0 ) {
     for (size_t jf = 0; jf < nforbidden; ++jf) {
       if ( str.find(forbidden[jf]) != std::string::npos ) {
         reject = true;
         break; // found at least one case, so we can reject
       }
     }
   }
 
   return reject;
 }

void GeomVolSelectorBasic::SetMaterialSelection ( string matstr )

Definition at line 44 of file GeomVolSelectorBasic.cxx.

References fForbiddenMat, fRequiredMat, and ParseSelection().

 {
   ParseSelection(matstr,fRequiredMat,fForbiddenMat);
 }

void GeomVolSelectorBasic::SetMediumSelection ( string medstr )

Definition at line 40 of file GeomVolSelectorBasic.cxx.

References fForbiddenMed, fRequiredMed, and ParseSelection().

 {
   ParseSelection(medstr,fRequiredMed,fForbiddenMed);
 }

void GeomVolSelectorBasic::SetPathSelection ( string pathstr )

Definition at line 48 of file GeomVolSelectorBasic.cxx.

References fForbiddenPath, fRequiredPath, LOG, ParseSelection(), pFATAL, and genie::geometry::GeomVolSelectorI::SetNeedPath().

 {
   ParseSelection(pathstr,fRequiredPath,fForbiddenPath);
   if ( fRequiredPath.size()  > 0 || fForbiddenPath.size() > 0 ) {
 #ifdef PATHSEG_KEEP_PATH
     SetNeedPath();
 #else
     LOG("GeomVolSelectorBasic", pFATAL)
       << "PathSegment is not defined to hold fPathString -- selectors can not cut on it";
 #endif
   }
 }

void GeomVolSelectorBasic::SetVolumeSelection ( string volstr )

Selections are string based, elements are specified as a list of items separated by comma, semicolon or colons. Elements that start with "-" are rejections; elements that start with "+" (or nothing) are required, e.g. "+N276B,-air0"

Definition at line 36 of file GeomVolSelectorBasic.cxx.

References fForbiddenVol, fRequiredVol, and ParseSelection().

 {
   ParseSelection(volstr,fRequiredVol,fForbiddenVol);
 }

void GeomVolSelectorBasic::TrimSegment ( PathSegment & segment ) const

virtual

This is the method every derived version must implement To reject a segment outright: segment.fStepRangeSet.clear()

Implements genie::geometry::GeomVolSelectorI.

Reimplemented in genie::geometry::GeomVolSelectorFiducial, and genie::geometry::GeomVolSelectorRockBox.

Definition at line 70 of file GeomVolSelectorBasic.cxx.

References fForbiddenMat, fForbiddenMed, fForbiddenPath, fForbiddenVol, genie::geometry::PathSegment::fMaterial, genie::geometry::PathSegment::fMedium, genie::geometry::PathSegment::fPathString, fRequiredMat, fRequiredMed, fRequiredPath, fRequiredVol, genie::geometry::PathSegment::fStepRangeSet, genie::geometry::PathSegment::fVolume, and RejectString().

Referenced by genie::geometry::GeomVolSelectorFiducial::TrimSegment().

 {
   bool reject = false;
 
   // not splitting PathSegment into 2 or more PathSegment elements
   // so either
   //    - keep "as is"
   //    - adjust the low/high endpoints
   //    - not copy to output list (
   // be careful about steps outside all the geometry that might not
   // have an associated volume/media/material
 
 
   if ( ! reject ) {
     std::string volname = ( ps.fVolume) ? ps.fVolume->GetName() : "no-volume";
     reject = RejectString(volname,fRequiredVol,fForbiddenVol);
   }
 
   if ( ! reject ) {
     std::string medname = ( ps.fMedium) ? ps.fMedium->GetName() : "no-medium";
     reject = RejectString(medname,fRequiredMed,fForbiddenMed);
   }
 
   if ( ! reject ) {
     std::string matname = ( ps.fMaterial) ? ps.fMaterial->GetName() : "no-material";
     reject = RejectString(matname,fRequiredMat,fForbiddenMat);
   }
 
 #ifdef PATHSEG_KEEP_PATH
   if ( ! reject ) {
     reject = RejectString(ps.fPathString,fRequiredPath,fForbiddenPath);
   }
 #endif
 
   if ( reject ) ps.fStepRangeSet.clear();
 
 }