GENIE Interface for limiting vertex selection in the rock to a volume that depends (in part) on the neutrino p4. Uses GeomVolSelectorFiducial to possibly exclude an inner region. More...

#include <GeomVolSelectorRockBox.h>

Inheritance diagram for genie::geometry::GeomVolSelectorRockBox:

[legend]

Collaboration diagram for genie::geometry::GeomVolSelectorRockBox:

[legend]

Public Member Functions
	GeomVolSelectorRockBox ()
virtual	~GeomVolSelectorRockBox ()
void	TrimSegment (PathSegment &segment) const
void	BeginPSList (const PathSegmentList *untrimmed) const
void	EndPSList () const
void	SetRockBoxMinimal (Double_t xyzmin, Double_t xyzmax)
void	SetRockBoxInclusion (Double_t xyzmin, Double_t xyzmax)
void	SetMinimumWall (Double_t w)
void	SetDeDx (Double_t dedx)
void	SetExpandFromInclusion (bool how=false)
virtual void	ConvertShapeMaster2Top (const ROOTGeomAnalyzer *rgeom)
Public Member Functions inherited from genie::geometry::GeomVolSelectorFiducial
	GeomVolSelectorFiducial ()
virtual	~GeomVolSelectorFiducial ()
void	SetReverseFiducial (Bool_t reverse=true)
void	AdoptFidShape (FidShape *shape)
void	MakeSphere (Double_t x0, Double_t y0, Double_t z0, Double_t radius)
void	MakeXCylinder (Double_t y0, Double_t z0, Double_t radius, Double_t xmin, Double_t xmax)
void	MakeYCylinder (Double_t x0, Double_t z0, Double_t radius, Double_t ymin, Double_t ymax)
void	MakeZCylinder (Double_t x0, Double_t y0, Double_t radius, Double_t zmin, Double_t zmax)
void	MakeCylinder (Double_t base, Double_t axis, Double_t radius, Double_t cap1, Double_t cap2)
void	MakeBox (Double_t xyzmin, Double_t xyzmax)
void	MakeZPolygon (Int_t n, Double_t x0, Double_t y0, Double_t inradius, Double_t phi0deg, Double_t zmin, Double_t zmax)
Public Member Functions inherited from genie::geometry::GeomVolSelectorBasic
	GeomVolSelectorBasic ()
virtual	~GeomVolSelectorBasic ()
void	SetVolumeSelection (string volstr)
void	SetMediumSelection (string medstr)
void	SetMaterialSelection (string matstr)
void	SetPathSelection (string pathstr)
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
void	SetSI2Local (double scale)
	set scale factor for SI to "raydist" units of PathSegmentList
void	SetRemoveEntries (bool rmset)
bool	GetRemoveEntries ()
void	SetNeedPath ()
bool	GetNeedPath () const
	allow toggle on only
std::string	GetName () const

Protected Member Functions
void	MakeRockBox () const
Protected Member Functions inherited from genie::geometry::GeomVolSelectorBasic
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
Double_t	fMinimalXYZMin [3]
Double_t	fMinimalXYZMax [3]
	interior box lower corner
Double_t	fMinimumWall
	interior box upper corner
Double_t	fInclusionXYZMin [3]
	minimum distance around (XYZmin,XYZmax)
Double_t	fInclusionXYZMax [3]
	box within which events are always
Double_t	fDeDx
	accepted
Bool_t	fExpandInclusion
	how to scale from energy to distance
FidShape *	fRockBoxShape
	expand from minimal or inclusion box?
const ROOTGeomAnalyzer *	fROOTGeom
	shape changes for every nu ray
RayIntercept	fInterceptRock
Protected Attributes inherited from genie::geometry::GeomVolSelectorFiducial
Bool_t	fSelectReverse
FidShape *	fShape
	select for "outside" fiducial?
const PathSegmentList *	fCurrPathSegmentList
	shape
RayIntercept	fIntercept
Protected Attributes inherited from genie::geometry::GeomVolSelectorBasic
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)
TLorentzVector	fP4
	current neutrino ray's momentum (global)
double	fScale
	SI->raydist scale factor.
bool	fRemoveEntries
	whether selector should remove entries or set hi=lo
bool	fNeedPath
	selector needs PathSegment "path" string
std::string	fName
	volume selector name

Additional Inherited Members
Static Protected Member Functions inherited from genie::geometry::GeomVolSelectorFiducial
static Bool_t	NewStepPairs (Bool_t selectReverse, Double_t raydist, Double_t slo, Double_t shi, const RayIntercept &intercept, Bool_t &split, StepRange &step1, StepRange &step2)

Detailed Description

GENIE Interface for limiting vertex selection in the rock to a volume that depends (in part) on the neutrino p4. Uses GeomVolSelectorFiducial to possibly exclude an inner region.

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

Created:\n August 5, 2010

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

Definition at line 37 of file GeomVolSelectorRockBox.h.

Constructor & Destructor Documentation

◆ GeomVolSelectorRockBox()

GeomVolSelectorRockBox::GeomVolSelectorRockBox ( )

Definition at line 22 of file GeomVolSelectorRockBox.cxx.

  : GeomVolSelectorFiducial(), fMinimumWall(0.), fDeDx(1.)
  , fExpandInclusion(false)
  , fRockBoxShape(0), fROOTGeom(0)
{
  fName = "RockBox";
  // base class' fiducial volume always treated as reverse (if even exists)
  this->SetReverseFiducial(true);
 
  for (int i=0; i<3; ++i) {
    fMinimalXYZMin[i] = 0;
    fMinimalXYZMax[i] = 0;
    fInclusionXYZMin[i] = 0;
    fInclusionXYZMax[i] = 0;
  }
}

References fDeDx, fExpandInclusion, fInclusionXYZMax, fInclusionXYZMin, fMinimalXYZMax, fMinimalXYZMin, fMinimumWall, genie::geometry::GeomVolSelectorI::fName, fRockBoxShape, fROOTGeom, genie::geometry::GeomVolSelectorFiducial::GeomVolSelectorFiducial(), and genie::geometry::GeomVolSelectorFiducial::SetReverseFiducial().

◆ ~GeomVolSelectorRockBox()

GeomVolSelectorRockBox::~GeomVolSelectorRockBox ( )

virtual

Definition at line 40 of file GeomVolSelectorRockBox.cxx.

{
  if ( fRockBoxShape ) delete fRockBoxShape;
  fRockBoxShape = 0;
  fROOTGeom = 0;  // was reference only
}

References fRockBoxShape, and fROOTGeom.

Member Function Documentation

◆ BeginPSList()

void GeomVolSelectorRockBox::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

Reimplemented from genie::geometry::GeomVolSelectorFiducial.

Definition at line 91 of file GeomVolSelectorRockBox.cxx.

{
  // A new neutrino ray has been set, calculate the entrance/exit distances.
 
  GeomVolSelectorFiducial::BeginPSList(untrimmed);
 
  fCurrPathSegmentList = untrimmed;
 
  MakeRockBox();
 
  if ( ! fRockBoxShape ) {
    LOG("GeomVolSel", pFATAL) << "no shape defined";
    fInterceptRock = RayIntercept();
  } else {
    fInterceptRock =
      fRockBoxShape->Intercept(fCurrPathSegmentList->GetStartPos(),
                               fCurrPathSegmentList->GetDirection());
  }
 
  //cout << "BeginPSList: " << endl
  //     << " fid:  " << fIntercept << endl
  //     << " rock: " << fInterceptRock << endl;
 
}

References genie::geometry::GeomVolSelectorFiducial::BeginPSList(), genie::geometry::GeomVolSelectorFiducial::fCurrPathSegmentList, fInterceptRock, fRockBoxShape, LOG, MakeRockBox(), and pFATAL.

◆ ConvertShapeMaster2Top()

void GeomVolSelectorRockBox::ConvertShapeMaster2Top ( const ROOTGeomAnalyzer * rgeom )

virtual

Reimplemented from genie::geometry::GeomVolSelectorFiducial.

Definition at line 123 of file GeomVolSelectorRockBox.cxx.

{
  GeomVolSelectorFiducial::ConvertShapeMaster2Top(rgeom);
  fROOTGeom = rgeom;   // stash away a copy
}

References genie::geometry::GeomVolSelectorFiducial::ConvertShapeMaster2Top(), and fROOTGeom.

◆ EndPSList()

void GeomVolSelectorRockBox::EndPSList ( ) const

virtual

Reimplemented from genie::geometry::GeomVolSelectorFiducial.

Definition at line 117 of file GeomVolSelectorRockBox.cxx.

{
  // Completed current path segment list processsing
}

◆ MakeRockBox()

void GeomVolSelectorRockBox::MakeRockBox ( ) const

protected

Definition at line 162 of file GeomVolSelectorRockBox.cxx.

{
  // This sets parameters for a box
 
  // expanded box
  double energy = fP4.Energy();
  double boxXYZMin[3], boxXYZMax[3];
  for ( int j = 0; j < 3; ++j ) {
    double dmin = 0, dmax = 0;
    double dircos = fCurrPathSegmentList->GetDirection()[j];
    if ( dircos > 0 ) dmin =  dircos*energy/fDeDx;  // pad upstream
    else              dmax = -dircos*energy/fDeDx;
 
//#define RWH_DEBUG
#ifdef RWH_DEBUG
    cout << "MakeRockBox [" << j << "] wall " << fMinimumWall
         << " dm " << dmin << " " << dmax   << " dircos " << dircos
         << " e " << energy << " dedx " << fDeDx << endl;
#endif
 
    if ( fExpandInclusion ) {
      boxXYZMin[j] = fInclusionXYZMin[j] - dmin;
      boxXYZMax[j] = fInclusionXYZMax[j] + dmax;
    } else {
      boxXYZMin[j] = TMath::Min(fMinimalXYZMin[j]-dmin,fInclusionXYZMin[j]);
      boxXYZMax[j] = TMath::Max(fMinimalXYZMax[j]+dmin,fInclusionXYZMax[j]);
    }
  }
 
  FidPolyhedron* poly = new FidPolyhedron();
  // careful about sign of "d" vs. direction normal
  PlaneParam pln0(-1,0,0, boxXYZMin[0]);  poly->push_back(pln0);
  PlaneParam pln1(0,-1,0, boxXYZMin[1]);  poly->push_back(pln1);
  PlaneParam pln2(0,0,-1, boxXYZMin[2]);  poly->push_back(pln2);
  PlaneParam pln3(+1,0,0,-boxXYZMax[0]);  poly->push_back(pln3);
  PlaneParam pln4(0,+1,0,-boxXYZMax[1]);  poly->push_back(pln4);
  PlaneParam pln5(0,0,+1,-boxXYZMax[2]);  poly->push_back(pln5);
 
  if ( fRockBoxShape ) delete fRockBoxShape;
  fRockBoxShape = poly;
 
#ifdef RWH_DEBUG
  static bool first = true;
  if ( first ) {
    cout << "MakeRockBox first Minimal min ["
         << fMinimalXYZMin[0] << ","
         << fMinimalXYZMin[1] << ","
         << fMinimalXYZMin[2] << "]"
         << "  max ["
         << fMinimalXYZMax[0] << ","
         << fMinimalXYZMax[1] << ","
         << fMinimalXYZMax[2] << "]" << endl;
    cout << "MakeRockBox first Inclusion min ["
         << fInclusionXYZMin[0] << ","
         << fInclusionXYZMin[1] << ","
         << fInclusionXYZMin[2] << "]"
         << "  max ["
         << fInclusionXYZMax[0] << ","
         << fInclusionXYZMax[1] << ","
         << fInclusionXYZMax[2] << "]" << endl;
    first = false;
  }
  cout << "MakeRockBox this ray using min ["
       << boxXYZMin[0] << ","
       << boxXYZMin[1] << ","
       << boxXYZMin[2] << "]"
       << "  max ["
       << boxXYZMax[0] << ","
       << boxXYZMax[1] << ","
       << boxXYZMax[2] << "]" << endl;
  cout << "rock before:" << *fRockBoxShape << endl;
#endif
 
  if ( fROOTGeom ) fRockBoxShape->ConvertMaster2Top(fROOTGeom);
 
#ifdef RWH_DEBUG
  cout << "rock after: " << *fRockBoxShape << endl;
  cout << "fid  after: " << *fShape << endl;
#endif
 
}

References genie::geometry::GeomVolSelectorFiducial::fCurrPathSegmentList, fDeDx, fExpandInclusion, fInclusionXYZMax, fInclusionXYZMin, fMinimalXYZMax, fMinimalXYZMin, fMinimumWall, genie::geometry::GeomVolSelectorI::fP4, fRockBoxShape, fROOTGeom, genie::geometry::GeomVolSelectorFiducial::fShape, and genie::geometry::FidPolyhedron::push_back().

Referenced by BeginPSList().

◆ SetDeDx()

void genie::geometry::GeomVolSelectorRockBox::SetDeDx ( Double_t dedx )

inline

Definition at line 59 of file GeomVolSelectorRockBox.h.

59{ fDeDx = dedx; }

References fDeDx.

Referenced by CreateRockBoxSelection().

◆ SetExpandFromInclusion()

void genie::geometry::GeomVolSelectorRockBox::SetExpandFromInclusion ( bool how = false )

inline

Definition at line 60 of file GeomVolSelectorRockBox.h.

60{ fExpandInclusion = how; }

References fExpandInclusion.

Referenced by CreateRockBoxSelection().

◆ SetMinimumWall()

void GeomVolSelectorRockBox::SetMinimumWall ( Double_t w )

Definition at line 153 of file GeomVolSelectorRockBox.cxx.

{
  fMinimumWall = w;
  for ( int j = 0; j < 3; ++j ) {
    fInclusionXYZMin[j] = fMinimalXYZMin[j] - fMinimumWall;
    fInclusionXYZMax[j] = fMinimalXYZMax[j] + fMinimumWall;
  }
}

References fInclusionXYZMax, fInclusionXYZMin, fMinimalXYZMax, fMinimalXYZMin, and fMinimumWall.

Referenced by CreateRockBoxSelection().

◆ SetRockBoxInclusion()

void GeomVolSelectorRockBox::SetRockBoxInclusion	(	Double_t *	xyzmin,
		Double_t *	xyzmax )

Definition at line 142 of file GeomVolSelectorRockBox.cxx.

{
  // This sets parameters for the inclusion (outer) box
 
  for ( int j = 0; j < 3; ++j ) {
    fInclusionXYZMin[j] = TMath::Min(xyzmin[j],xyzmax[j]);
    fInclusionXYZMax[j] = TMath::Max(xyzmax[j],xyzmax[j]);
  }
}

References fInclusionXYZMax, and fInclusionXYZMin.

◆ SetRockBoxMinimal()

void GeomVolSelectorRockBox::SetRockBoxMinimal	(	Double_t *	xyzmin,
		Double_t *	xyzmax )

Definition at line 129 of file GeomVolSelectorRockBox.cxx.

{
  // This sets parameters for a minimal box
 
  for ( int j = 0; j < 3; ++j ) {
    fMinimalXYZMin[j] = TMath::Min(xyzmin[j],xyzmax[j]);
    fMinimalXYZMax[j] = TMath::Max(xyzmax[j],xyzmax[j]);
  }
  // create the default inner (exclusion) box
  this->MakeBox(fMinimalXYZMin,fMinimalXYZMax);
}

References fMinimalXYZMax, fMinimalXYZMin, and genie::geometry::GeomVolSelectorFiducial::MakeBox().

Referenced by CreateRockBoxSelection().

◆ TrimSegment()

void GeomVolSelectorRockBox::TrimSegment ( PathSegment & segment ) const

virtual

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

so a miss means blindly accept all segments

Reimplemented from genie::geometry::GeomVolSelectorFiducial.

Definition at line 48 of file GeomVolSelectorRockBox.cxx.

{
  // First trim the segment based on the ray vs. cylinder or box
  // Then trim futher according to the Basic parameters
 
  if ( ! fInterceptRock.fIsHit ) {
      // want in rock box, ray misses => reject all segments
      ps.fStepRangeSet.clear();  //
  } else {
    // ray hit rock box volume, some segments steps need rejection, some need splitting...
    // check the steps in this segment
    Double_t dist = ps.fRayDist;
    StepRangeSet::iterator srs_itr = ps.fStepRangeSet.begin();
    StepRangeSet::iterator srs_end = ps.fStepRangeSet.end();
    StepRangeSet modifiedStepRangeSet;
    Bool_t ismod = false;
 
    // loop over steps within this segement
    for ( ; srs_itr != srs_end; ++srs_itr ) {
      Double_t slo = srs_itr->first;
      Double_t shi = srs_itr->second;
      Bool_t split = false;
      StepRange step1, step2;
      // determine new trimmed or split steps
      ismod |= NewStepPairs(false,dist,slo,shi,
                            fInterceptRock,split,step1,step2);
      // build up new step list
      bool nonzerostep = ( step1.first != step1.second );
      if ( nonzerostep || ! fRemoveEntries ) {
        modifiedStepRangeSet.push_back(step1);
        if (split) {
          modifiedStepRangeSet.push_back(step2);
        }
      }
    } // loop over step range set elements
    if ( ismod ) ps.fStepRangeSet = modifiedStepRangeSet;
 
  } // fIsHit
 
  GeomVolSelectorFiducial::TrimSegment(ps);
}

References fInterceptRock, genie::geometry::PathSegment::fRayDist, genie::geometry::GeomVolSelectorI::fRemoveEntries, genie::geometry::PathSegment::fStepRangeSet, genie::geometry::GeomVolSelectorFiducial::NewStepPairs(), and genie::geometry::GeomVolSelectorFiducial::TrimSegment().

Member Data Documentation

◆ fDeDx

Double_t genie::geometry::GeomVolSelectorRockBox::fDeDx

protected

accepted

Definition at line 77 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), and SetDeDx().

◆ fExpandInclusion

Bool_t genie::geometry::GeomVolSelectorRockBox::fExpandInclusion

protected

how to scale from energy to distance

Definition at line 78 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), and SetExpandFromInclusion().

◆ fInclusionXYZMax

Double_t genie::geometry::GeomVolSelectorRockBox::fInclusionXYZMax[3]

protected

box within which events are always

Definition at line 76 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), SetMinimumWall(), and SetRockBoxInclusion().

◆ fInclusionXYZMin

Double_t genie::geometry::GeomVolSelectorRockBox::fInclusionXYZMin[3]

protected

minimum distance around (XYZmin,XYZmax)

Definition at line 75 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), SetMinimumWall(), and SetRockBoxInclusion().

◆ fInterceptRock

RayIntercept genie::geometry::GeomVolSelectorRockBox::fInterceptRock

mutableprotected

Definition at line 85 of file GeomVolSelectorRockBox.h.

Referenced by BeginPSList(), and TrimSegment().

◆ fMinimalXYZMax

Double_t genie::geometry::GeomVolSelectorRockBox::fMinimalXYZMax[3]

protected

interior box lower corner

Definition at line 73 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), SetMinimumWall(), and SetRockBoxMinimal().

◆ fMinimalXYZMin

Double_t genie::geometry::GeomVolSelectorRockBox::fMinimalXYZMin[3]

protected

Definition at line 72 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), SetMinimumWall(), and SetRockBoxMinimal().

◆ fMinimumWall

Double_t genie::geometry::GeomVolSelectorRockBox::fMinimumWall

protected

interior box upper corner

Definition at line 74 of file GeomVolSelectorRockBox.h.

Referenced by GeomVolSelectorRockBox(), MakeRockBox(), and SetMinimumWall().

◆ fRockBoxShape

FidShape* genie::geometry::GeomVolSelectorRockBox::fRockBoxShape

mutableprotected

expand from minimal or inclusion box?

Definition at line 80 of file GeomVolSelectorRockBox.h.

Referenced by BeginPSList(), GeomVolSelectorRockBox(), MakeRockBox(), and ~GeomVolSelectorRockBox().

◆ fROOTGeom

const ROOTGeomAnalyzer* genie::geometry::GeomVolSelectorRockBox::fROOTGeom

protected

shape changes for every nu ray

Definition at line 82 of file GeomVolSelectorRockBox.h.

Referenced by ConvertShapeMaster2Top(), GeomVolSelectorRockBox(), MakeRockBox(), and ~GeomVolSelectorRockBox().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GeomVolSelectorRockBox()

◆ ~GeomVolSelectorRockBox()

Member Function Documentation

◆ BeginPSList()

◆ ConvertShapeMaster2Top()

◆ EndPSList()

◆ MakeRockBox()

◆ SetDeDx()

◆ SetExpandFromInclusion()

◆ SetMinimumWall()

◆ SetRockBoxInclusion()

◆ SetRockBoxMinimal()

◆ TrimSegment()

Member Data Documentation

◆ fDeDx

◆ fExpandInclusion

◆ fInclusionXYZMax

◆ fInclusionXYZMin

◆ fInterceptRock

◆ fMinimalXYZMax

◆ fMinimalXYZMin

◆ fMinimumWall

◆ fRockBoxShape

◆ fROOTGeom