GENIE Interface for user-defined volume selector functors Trim path segments based on the intersection with a cylinder, box or sphere as well as everything the Basic selector can do. More...

#include <GeomVolSelectorFiducial.h>

Inheritance diagram for genie::geometry::GeomVolSelectorFiducial:

[legend]

Collaboration diagram for genie::geometry::GeomVolSelectorFiducial:

[legend]

Public Member Functions
	GeomVolSelectorFiducial ()

virtual	~GeomVolSelectorFiducial ()

void	TrimSegment (PathSegment &segment) const

void	BeginPSList (const PathSegmentList *untrimmed) const

void	EndPSList () const

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)

virtual void	ConvertShapeMaster2Top (const ROOTGeomAnalyzer *rgeom)

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 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

Static Protected Member Functions
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)

Protected Attributes
Bool_t	fSelectReverse

FidShape *	fShape
	select for "outside" fiducial? More...

const PathSegmentList *	fCurrPathSegmentList
	shape More...

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) 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...

Additional Inherited Members
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)

Detailed Description

GENIE Interface for user-defined volume selector functors Trim path segments based on the intersection with a cylinder, box or sphere as well as everything the Basic selector can do.

      Assumes that the fiducial volume is defined in the same coords
      and units as the PathSegmentList ("top vol") and that the ray
      always starts outside the defined volume.  (If not user should
      cap the fid volume just down from the flux window or use the
      SetUpstreamZ() in the flux driver to push the ray back to make it so).

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

Created:: July 14, 2010

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

Definition at line 43 of file GeomVolSelectorFiducial.h.

Constructor & Destructor Documentation

GeomVolSelectorFiducial::GeomVolSelectorFiducial ( )

Definition at line 22 of file GeomVolSelectorFiducial.cxx.

References genie::geometry::GeomVolSelectorI::fName.

   : GeomVolSelectorBasic(), fSelectReverse(false)
   , fShape(0), fCurrPathSegmentList(0)
 {
   fName = "Fiducial";
 }

GeomVolSelectorFiducial::~GeomVolSelectorFiducial ( )

virtual

Definition at line 30 of file GeomVolSelectorFiducial.cxx.

References fCurrPathSegmentList, and fShape.

 {
   if ( fShape ) delete fShape;
   fShape = 0;
   fCurrPathSegmentList = 0;  // was reference only
 }

Member Function Documentation

void GeomVolSelectorFiducial::AdoptFidShape ( FidShape * shape )

Definition at line 177 of file GeomVolSelectorFiducial.cxx.

References fShape.

Referenced by MakeBox(), MakeCylinder(), MakeSphere(), and MakeZPolygon().

 {
   if ( fShape ) delete fShape;
   fShape = shape;
 }

void GeomVolSelectorFiducial::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::GeomVolSelectorBasic.

Reimplemented in genie::geometry::GeomVolSelectorRockBox.

Definition at line 150 of file GeomVolSelectorFiducial.cxx.

References genie::geometry::GeomVolSelectorBasic::BeginPSList(), fCurrPathSegmentList, fIntercept, fShape, genie::geometry::PathSegmentList::GetDirection(), genie::geometry::PathSegmentList::GetStartPos(), genie::geometry::FidShape::Intercept(), LOG, and pFATAL.

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

 {
   // A new neutrino ray has been set, calculate the entrance/exit distances.
 
   GeomVolSelectorBasic::BeginPSList(untrimmed);  // initialize base class in case it is needed
 
   fCurrPathSegmentList = untrimmed;
 
   if ( ! fShape ) {
     LOG("GeomVolSel", pFATAL) << "no shape defined";
     fIntercept = RayIntercept();
   } else {
     fIntercept = fShape->Intercept(fCurrPathSegmentList->GetStartPos(),
                                    fCurrPathSegmentList->GetDirection());
   }
 
 }

void GeomVolSelectorFiducial::ConvertShapeMaster2Top ( const ROOTGeomAnalyzer * rgeom )

virtual

Reimplemented in genie::geometry::GeomVolSelectorRockBox.

Definition at line 183 of file GeomVolSelectorFiducial.cxx.

References genie::geometry::FidShape::ConvertMaster2Top(), and fShape.

Referenced by genie::geometry::GeomVolSelectorRockBox::ConvertShapeMaster2Top(), and CreateFidSelection().

 {
   if ( fShape ) fShape->ConvertMaster2Top(rgeom);
 }

void GeomVolSelectorFiducial::EndPSList ( ) const

virtual

Reimplemented from genie::geometry::GeomVolSelectorBasic.

Reimplemented in genie::geometry::GeomVolSelectorRockBox.

Definition at line 169 of file GeomVolSelectorFiducial.cxx.

References genie::geometry::GeomVolSelectorBasic::EndPSList(), and fCurrPathSegmentList.

 {
   // Completed current path segment list processsing
   GeomVolSelectorBasic::EndPSList();
   fCurrPathSegmentList = 0;
 }

void GeomVolSelectorFiducial::MakeBox	(	Double_t *	xyzmin,
		Double_t *	xyzmax
	)

Definition at line 239 of file GeomVolSelectorFiducial.cxx.

References AdoptFidShape(), and genie::geometry::FidPolyhedron::push_back().

Referenced by CreateFidSelection(), CreateRockBoxSelection(), and genie::geometry::GeomVolSelectorRockBox::SetRockBoxMinimal().

 {
   // This sets parameters for a box
 
   double boxXYZmin[3], boxXYZmax[3];
   for ( int j = 0; j < 3; ++j ) {
     boxXYZmin[j] = TMath::Min(xyzmin[j],xyzmax[j]);
     boxXYZmax[j] = TMath::Max(xyzmin[j],xyzmax[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);
 
   AdoptFidShape(poly);
 }

void GeomVolSelectorFiducial::MakeCylinder	(	Double_t *	base,
		Double_t *	axis,
		Double_t	radius,
		Double_t *	cap1,
		Double_t *	cap2
	)

Definition at line 230 of file GeomVolSelectorFiducial.cxx.

References AdoptFidShape().

Referenced by MakeXCylinder(), MakeYCylinder(), and MakeZCylinder().

 {
   // This sets parameters for a cylinder
   AdoptFidShape(new FidCylinder(TVector3(base),TVector3(axis),radius,
                                 PlaneParam(cap1),PlaneParam(cap2)));
 }

void GeomVolSelectorFiducial::MakeSphere	(	Double_t	x0,
		Double_t	y0,
		Double_t	z0,
		Double_t	radius
	)

Definition at line 188 of file GeomVolSelectorFiducial.cxx.

References AdoptFidShape().

Referenced by CreateFidSelection(), and CreateRockBoxSelection().

 {
   AdoptFidShape(new FidSphere(TVector3(x0,y0,z0),radius));
 }

void GeomVolSelectorFiducial::MakeXCylinder	(	Double_t	y0,
		Double_t	z0,
		Double_t	radius,
		Double_t	xmin,
		Double_t	xmax
	)

Definition at line 194 of file GeomVolSelectorFiducial.cxx.

References MakeCylinder().

 {
   // This sets parameters for a cylinder parallel to the x-axis
   Double_t base[] = {  0, y0, z0 };
   Double_t axis[] = {  1,  0,  0 };
   Double_t cap1[] = { -1,  0,  0,  xmin };
   Double_t cap2[] = { +1,  0,  0, -xmax };  // note sign change
   this->MakeCylinder(base,axis,radius,cap1,cap2);
 }

void GeomVolSelectorFiducial::MakeYCylinder	(	Double_t	x0,
		Double_t	z0,
		Double_t	radius,
		Double_t	ymin,
		Double_t	ymax
	)

Definition at line 206 of file GeomVolSelectorFiducial.cxx.

References MakeCylinder().

 {
   // This sets parameters for a cylinder parallel to the y-axis
   Double_t base[] = { x0,  0, z0 };
   Double_t axis[] = {  0,  1,  0 };
   Double_t cap1[] = {  0, -1,  0,  ymin };
   Double_t cap2[] = {  0, +1,  0, -ymax };  // note sign change
   this->MakeCylinder(base,axis,radius,cap1,cap2);
 }

void GeomVolSelectorFiducial::MakeZCylinder	(	Double_t	x0,
		Double_t	y0,
		Double_t	radius,
		Double_t	zmin,
		Double_t	zmax
	)

Definition at line 218 of file GeomVolSelectorFiducial.cxx.

References MakeCylinder().

Referenced by CreateFidSelection().

 {
   // This sets parameters for a cylinder parallel to the z-axis
   Double_t base[] = { x0, y0,  0 };
   Double_t axis[] = {  0,  0,  1 };
   Double_t cap1[] = {  0,  0, -1,  zmin };
   Double_t cap2[] = {  0,  0, +1, -zmax };  // note sign change
   this->MakeCylinder(base,axis,radius,cap1,cap2);
 }

void GeomVolSelectorFiducial::MakeZPolygon	(	Int_t	n,
		Double_t	x0,
		Double_t	y0,
		Double_t	inradius,
		Double_t	phi0deg,
		Double_t	zmin,
		Double_t	zmax
	)

Definition at line 262 of file GeomVolSelectorFiducial.cxx.

References AdoptFidShape(), and genie::geometry::FidPolyhedron::push_back().

Referenced by CreateFidSelection().

 {
   // phi=0 will put flat face towards +x
   // inscribed radius
 
   FidPolyhedron* poly = new FidPolyhedron();
 
   Double_t dphir = TMath::TwoPi()/n;
   Double_t phi0r = phi0deg * TMath::DegToRad();
   for ( int iface = 0; iface < n; ++iface ) {
     Double_t dx = TMath::Cos(dphir*iface + phi0r);
     Double_t dy = TMath::Sin(dphir*iface + phi0r);
     PlaneParam face(dx,dy,0,-inradius-dx*x0-dy*y0); poly->push_back(face);
   }
   PlaneParam plnz1(0,0,-1, zmin);  poly->push_back(plnz1);
   PlaneParam plnz2(0,0,+1,-zmax);  poly->push_back(plnz2);
 
   AdoptFidShape(poly);
 }

Bool_t GeomVolSelectorFiducial::NewStepPairs	(	Bool_t	selectReverse,
		Double_t	raydist,
		Double_t	slo,
		Double_t	shi,
		const RayIntercept &	intercept,
		Bool_t &	split,
		StepRange &	step1,
		StepRange &	step2
	)

staticprotected

Definition at line 87 of file GeomVolSelectorFiducial.cxx.

References genie::geometry::RayIntercept::fDistIn, and genie::geometry::RayIntercept::fDistOut.

Referenced by genie::geometry::GeomVolSelectorRockBox::TrimSegment(), and TrimSegment().

 {
   // modifying a step based on a range
   // there seem to be six possible cases:
   //     step: |===| {slo,shi}
   //
   //   range:   in       out
   //            #        #            normal     reverse
   // 0   |===|  #        #            {0,0}      {slo,shi}
   // 1       |==#==|     #            {in,shi}   {slo,in}
   // 2       |==#========#==|         {in,out}   {slo,in}+{out,shi}
   // 3          #  |==|  #            {slo,shi}  {0,0}
   // 4          #     |==#==|         {slo,out}  {out,shi}
   // 5          #        #  |====|    {0,0}      {slo,shi}
   //            #        #
   //
   bool ismodified = true;
   step1 = StepRange(slo,shi);
   split = false;
   // dist in/out are relative to the ray origin
   Double_t sdistin  = intercept.fDistIn  - raydist;
   Double_t sdistout = intercept.fDistOut - raydist;
   // do remaining calculations relative to steps within this segment
   if ( slo < sdistin ) {
     if ( shi < sdistin ) {
       // case 0
       if ( selectReverse ) { ismodified = false; }
       else                 { step1 = StepRange(0,0); }
     } else if ( shi < sdistout ) {
       // case 1
       if ( selectReverse ) { step1.second = sdistin; }
       else                 { step1.first  = sdistin; }
     } else {
       // case 2
       if ( selectReverse ) { split = true;
         step1 = StepRange(slo,sdistin);
         step2 = StepRange(sdistout,shi); }
       else                 { step1 = StepRange(sdistin,sdistout); }
     }
   } else if ( slo < sdistout ) {
     if ( shi < sdistout ) {
       // case 3
       if ( selectReverse ) { step1 = StepRange(0,0); }
       else                 { ismodified = false; }
     } else {
       // case 4
       if ( selectReverse ) { step1.first  = sdistout; }
       else                 { step1.second = sdistout; }
     }
   } else {
     // case 5
     if ( selectReverse ) { ismodified = false; }
     else                 { step1 = StepRange(0,0); }
   }
 
   return ismodified;
 }

void genie::geometry::GeomVolSelectorFiducial::SetReverseFiducial ( Bool_t reverse = true )

inline

Definition at line 57 of file GeomVolSelectorFiducial.h.

Referenced by CreateFidSelection(), and genie::geometry::GeomVolSelectorRockBox::GeomVolSelectorRockBox().

57 { fSelectReverse = reverse; }

genie::geometry::GeomVolSelectorFiducial::fSelectReverse

Bool_t fSelectReverse

Definition: GeomVolSelectorFiducial.h:85

void GeomVolSelectorFiducial::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::GeomVolSelectorBasic.

Reimplemented in genie::geometry::GeomVolSelectorRockBox.

Definition at line 38 of file GeomVolSelectorFiducial.cxx.

References fIntercept, genie::geometry::RayIntercept::fIsHit, genie::geometry::PathSegment::fRayDist, genie::geometry::GeomVolSelectorI::fRemoveEntries, fSelectReverse, genie::geometry::PathSegment::fStepRangeSet, NewStepPairs(), and genie::geometry::GeomVolSelectorBasic::TrimSegment().

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

 {
   // First trim the segment based on the ray vs. cylinder or box
   // Then trim futher according to the Basic parameters
 
   if ( ! fIntercept.fIsHit ) {
     // simple case when ray doesn't intersect the fiducial volume at all
     if ( fSelectReverse ) {
       // fiducial is reversed (ie. only want regions outside)
       /// so a miss means blindly accept all segments
     } else {
       // want in fiducial, ray misses => reject all segments
       ps.fStepRangeSet.clear();  //
     }
   } else {
     // ray hit fiducial 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(fSelectReverse,dist,slo,shi,
                             fIntercept,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
 
   GeomVolSelectorBasic::TrimSegment(ps);
 }

Member Data Documentation

const PathSegmentList* genie::geometry::GeomVolSelectorFiducial::fCurrPathSegmentList

mutableprotected

shape

Definition at line 90 of file GeomVolSelectorFiducial.h.

Referenced by genie::geometry::GeomVolSelectorRockBox::BeginPSList(), BeginPSList(), EndPSList(), genie::geometry::GeomVolSelectorRockBox::MakeRockBox(), and ~GeomVolSelectorFiducial().

RayIntercept genie::geometry::GeomVolSelectorFiducial::fIntercept

mutableprotected

Definition at line 91 of file GeomVolSelectorFiducial.h.

Referenced by BeginPSList(), and TrimSegment().

Bool_t genie::geometry::GeomVolSelectorFiducial::fSelectReverse

protected

Definition at line 85 of file GeomVolSelectorFiducial.h.

Referenced by TrimSegment().

FidShape* genie::geometry::GeomVolSelectorFiducial::fShape

protected

select for "outside" fiducial?

Definition at line 87 of file GeomVolSelectorFiducial.h.

Referenced by AdoptFidShape(), BeginPSList(), ConvertShapeMaster2Top(), genie::geometry::GeomVolSelectorRockBox::MakeRockBox(), and ~GeomVolSelectorFiducial().

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

Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation