geo::BoxBoundedGeo Class Reference

A base class aware of world box coordinatesAn object describing a simple shape can inherit from this one to gain access to a common boundary checking interface. More...

#include "BoxBoundedGeo.h"

Inheritance diagram for geo::BoxBoundedGeo:

Public Types
using	Coords_t = geo::Point_t
	Type of the coordinate triplet. More...
using	Coord_t = Coords_t::Scalar
	Type of the coordinate. More...

Public Member Functions
	BoxBoundedGeo ()=default
	Default constructor: sets an empty volume. More...
	BoxBoundedGeo (Coord_t x_min, Coord_t x_max, Coord_t y_min, Coord_t y_max, Coord_t z_min, Coord_t z_max)
	Constructor: sets the boundaries in world coordinates as specified. More...
	BoxBoundedGeo (Coords_t lower, Coords_t upper)
	Constructor: sets the boundaries in world coordinates as specified. More...
Dimension queries
double	MinX () const
	Returns the world x coordinate of the start of the box. More...
double	MaxX () const
	Returns the world x coordinate of the end of the box. More...
double	CenterX () const
	Returns the world x coordinate of the center of the box. More...
double	SizeX () const
	Returns the full size in the X dimension. More...
double	HalfSizeX () const
	Returns the size from the center to the border on X dimension. More...
double	MinY () const
	Returns the world y coordinate of the start of the box. More...
double	MaxY () const
	Returns the world y coordinate of the end of the box. More...
double	CenterY () const
	Returns the world y coordinate of the center of the box. More...
double	SizeY () const
	Returns the full size in the Y dimension. More...
double	HalfSizeY () const
	Returns the size from the center to the border on Y dimension. More...
double	MinZ () const
	Returns the world z coordinate of the start of the box. More...
double	MaxZ () const
	Returns the world z coordinate of the end of the box. More...
double	CenterZ () const
	Returns the world z coordinate of the center of the box. More...
double	SizeZ () const
	Returns the full size in the Z dimension. More...
double	HalfSizeZ () const
	Returns the size from the center to the border on Z dimension. More...
geo::Point_t	Min () const
	Returns the corner point with the smallest coordinates. More...
geo::Point_t	Max () const
	Returns the corner point with the largest coordinates. More...
geo::Point_t	Center () const
	Returns the center point of the box. More...
Containment in the full volume
bool	ContainsX (double x, double const wiggle=1) const
	Returns whether this TPC contains the specified world x coordinate. More...
bool	ContainsY (double y, double const wiggle=1) const
	Returns whether this TPC contains the specified world y coordinate. More...
bool	ContainsZ (double z, double const wiggle=1) const
	Returns whether this TPC contains the specified world z coordinate. More...
bool	ContainsYZ (double y, double z, double const wiggle=1) const
	Returns if TPC contains the specified world y and z coordinates. More...
bool	ContainsPosition (geo::Point_t const &point, double wiggle=1.0) const
	Returns whether this volume contains the specified point. More...
bool	ContainsPosition (TVector3 const &point, double wiggle=1.0) const
bool	ContainsPosition (double const *point, double wiggle=1.0) const
Containment in a fiducial volume
bool	InFiducialX (double x, double neg_margin, double pos_margin) const
	Returns whether TPC fiducial volume contains world x coordinate. More...
bool	InFiducialX (double x, double margin) const
	Returns whether TPC fiducial volume contains world x coordinate. More...
bool	InFiducialY (double y, double neg_margin, double pos_margin) const
	Returns whether TPC fiducial volume contains world y coordinate. More...
bool	InFiducialY (double y, double margin) const
	Returns whether TPC fiducial volume contains world y coordinate. More...
bool	InFiducialZ (double z, double neg_margin, double pos_margin) const
	Returns whether TPC fiducial volume contains world z coordinate. More...
bool	InFiducialZ (double z, double margin) const
	Returns whether TPC fiducial volume contains world z coordinate. More...
Setting dimensions
void	SetBoundaries (Coord_t x_min, Coord_t x_max, Coord_t y_min, Coord_t y_max, Coord_t z_min, Coord_t z_max)
	Sets the boundaries in world coordinates as specified. More...
void	SetBoundaries (Coords_t lower, Coords_t upper)
	Sets the boundaries in world coordinates as specified. More...
void	ExtendToInclude (Coord_t x, Coord_t y, Coord_t z)
	Extends the current box to also include the specified point. More...
void	ExtendToInclude (geo::Point_t const &point)
	Extends the current box to also include the specified point. More...
void	ExtendToInclude (BoxBoundedGeo const &box)
	Extends the current box to also include the specified one. More...
std::vector< TVector3 >	GetIntersections (TVector3 const &TrajectoryStart, TVector3 const &TrajectoryDirect) const
	Calculates the entry and exit points of a trajectory on the box surface. More...
std::vector< geo::Point_t >	GetIntersections (geo::Point_t const &TrajectoryStart, geo::Vector_t const &TrajectoryDirect) const
	Calculates the entry and exit points of a trajectory on the box surface. More...

Static Public Member Functions
static bool	CoordinateContained (double c, double min, double max, double wiggle=1.)
	Returns whether the specified coordinate is in a range. More...
static bool	CoordinateContained (double c, double const *range, double wiggle=1.)
	Returns whether the specified coordinate is in a range. More...
static void	set_min (Coord_t &var, Coord_t value)
	Sets var to value if value is smaller than the current var value. More...
static void	set_max (Coord_t &var, Coord_t value)
	Sets var to value if value is larger than the current var value. More...
static void	set_min (Coords_t &var, geo::Point_t const &value)
	Sets each coordinate of var to the one in value if the latter is smaller. More...
static void	set_max (Coords_t &var, geo::Point_t const &value)
	Sets each coordinate of var to the one in value if the latter is larger. More...

Private Member Functions
void	SortCoordinates ()
	Makes sure each coordinate of the minimum point is smaller than maximum. More...

Private Attributes
Coords_t	c_min
	minimum coordinates (x, y, z) More...
Coords_t	c_max
	maximum coordinates (x, y, z) More...

Detailed Description

A base class aware of world box coordinates

An object describing a simple shape can inherit from this one to gain access to a common boundary checking interface.

The boundary is a simple box with axes parallel to the coordinate system.

Definition at line 35 of file BoxBoundedGeo.h.

Member Typedef Documentation

using geo::BoxBoundedGeo::Coord_t = Coords_t::Scalar

Type of the coordinate.

Definition at line 38 of file BoxBoundedGeo.h.

using geo::BoxBoundedGeo::Coords_t = geo::Point_t

Type of the coordinate triplet.

Definition at line 37 of file BoxBoundedGeo.h.

Constructor & Destructor Documentation

geo::BoxBoundedGeo::BoxBoundedGeo ( )

default

Default constructor: sets an empty volume.

See also

SetBoundaries

We allow for a default construction since the derived object might need some specific action before being aware of its boundaries. In that case, SetBoundaries() will set the boundaries.

geo::BoxBoundedGeo::BoxBoundedGeo ( Coord_t  x_min, Coord_t  x_max, Coord_t  y_min, Coord_t  y_max, Coord_t  z_min, Coord_t  z_max  )

inline

Constructor: sets the boundaries in world coordinates as specified.

Parameters

x_min	lower x coordinate
x_max	upper x coordinate
y_min	lower y coordinate
y_max	upper y coordinate
z_min	lower z coordinate
z_max	upper z coordinate

See also

SetBoundaries()

Note that is assumed that each minimum is larger than its maximum, and no check is performed.

Definition at line 64 of file BoxBoundedGeo.h.

References c_max, SortCoordinates(), x_max, and x_min.

       :
      c_min{ x_min, y_min, z_min }, c_max{ x_max, y_max, z_max }
      { SortCoordinates(); }

geo::BoxBoundedGeo::BoxBoundedGeo ( Coords_t  lower, Coords_t  upper  )

inline

Constructor: sets the boundaries in world coordinates as specified.

Parameters

lower	lower coordinates (x, y, z)
upper	upper coordinates (x, y, z)

See also

SetBoundaries()

Note that is assumed that each minimum is larger than its maximum, and no check is performed.

Definition at line 81 of file BoxBoundedGeo.h.

References SortCoordinates().

                                                 :
      c_min(lower), c_max(upper)
      { SortCoordinates(); }

Member Function Documentation

geo::Point_t geo::BoxBoundedGeo::Center ( ) const

inline

Returns the center point of the box.

Definition at line 141 of file BoxBoundedGeo.h.

References CenterX(), CenterY(), and CenterZ().

Referenced by geo::buildDriftVolumes(), geo::CryostatGeo::GetCenter(), and geo::PlaneGeo::UpdatePlaneNormal().

      { return { CenterX(), CenterY(), CenterZ() }; }

double geo::BoxBoundedGeo::CenterX ( ) const

inline

Returns the world x coordinate of the center of the box.

Definition at line 96 of file BoxBoundedGeo.h.

References MaxX(), and MinX().

Referenced by Center().

{ return (MinX() + MaxX()) / 2.; }

double geo::BoxBoundedGeo::CenterY ( ) const

inline

Returns the world y coordinate of the center of the box.

Definition at line 111 of file BoxBoundedGeo.h.

References MaxY(), and MinY().

Referenced by Center().

{ return (MinY() + MaxY()) / 2.; }

double geo::BoxBoundedGeo::CenterZ ( ) const

inline

Returns the world z coordinate of the center of the box.

Definition at line 126 of file BoxBoundedGeo.h.

References MaxZ(), and MinZ().

Referenced by Center().

{ return (MinZ() + MaxZ()) / 2.; }

bool geo::BoxBoundedGeo::ContainsPosition ( geo::Point_t const &  point, double  wiggle = 1.0  ) const

inline

Returns whether this volume contains the specified point.

Parameters

point	the point [cm]
wiggle	expansion factor for the range

Returns

whether the specified coordinate is in this volume

If the wiggle is larger than 1, each size of the volume is expanded by the wiggle factor. If the wiggle is less than 1, each size is shrinked.

Definition at line 207 of file BoxBoundedGeo.h.

References ContainsX(), and ContainsYZ().

Referenced by ContainsPosition(), ContainsYZ(), and geo::GeometryCore::MaterialName().

      {
        return ContainsX(point.X(), wiggle)
          && ContainsYZ(point.Y(), point.Z(), wiggle);
      } // ContainsPosition()

bool geo::BoxBoundedGeo::ContainsPosition	(	TVector3 const &	point,
		double	wiggle = 1.0
	)		const

See also

ContainsPosition(geo::Point_t const&, double) const.

Definition at line 18 of file BoxBoundedGeo.cxx.

References ContainsPosition(), and geo::vect::toPoint().

    { return ContainsPosition(geo::vect::toPoint(point), wiggle); }

bool geo::BoxBoundedGeo::ContainsPosition	(	double const *	point,
		double	wiggle = 1.0
	)		const

See also

ContainsPosition(geo::Point_t const&, double) const.

Definition at line 23 of file BoxBoundedGeo.cxx.

References geo::vect::makePointFromCoords().

    { return ContainsPosition(geo::vect::makePointFromCoords(point), wiggle); }

bool geo::BoxBoundedGeo::ContainsX ( double  x, double const  wiggle = 1  ) const

inline

Returns whether this TPC contains the specified world x coordinate.

Parameters

x	the absolute ("world") coordinate x
wiggle	expansion factor for the range (see ContainsPosition())

Returns

whether the specified coordinate is in this TPC

See also

ContainsPosition()

Note that x is by definition the drift direction, and a reconstructed x typically depends on an assumption respect to the event time.

Definition at line 161 of file BoxBoundedGeo.h.

References CoordinateContained(), MaxX(), and MinX().

Referenced by ContainsPosition().

      { return CoordinateContained(x, MinX(), MaxX(), wiggle); }

bool geo::BoxBoundedGeo::ContainsY ( double  y, double const  wiggle = 1  ) const

inline

Returns whether this TPC contains the specified world y coordinate.

Parameters

y	the absolute ("world") coordinate y
wiggle	expansion factor for the range (see ContainsPosition())

Returns

whether the specified coordinate is in this TPC

See also

ContainsPosition()

Definition at line 171 of file BoxBoundedGeo.h.

References CoordinateContained(), MaxY(), and MinY().

Referenced by ContainsYZ().

      { return CoordinateContained(y, MinY(), MaxY(), wiggle); }

bool geo::BoxBoundedGeo::ContainsYZ ( double  y, double  z, double const  wiggle = 1  ) const

inline

Returns if TPC contains the specified world y and z coordinates.

Parameters

y	the absolute ("world") coordinate y
z	the absolute ("world") coordinate z
wiggle	expansion factor for the range (see ContainsPosition())

Returns

whether the specified coordinate is in this TPC

See also

ContainsPosition()

Definition at line 192 of file BoxBoundedGeo.h.

References ContainsPosition(), ContainsY(), and ContainsZ().

Referenced by ContainsPosition().

      { return ContainsY(y, wiggle) && ContainsZ(z, wiggle); }

bool geo::BoxBoundedGeo::ContainsZ ( double  z, double const  wiggle = 1  ) const

inline

Returns whether this TPC contains the specified world z coordinate.

Parameters

z	the absolute ("world") coordinate z
wiggle	expansion factor for the range (see ContainsPosition())

Returns

whether the specified coordinate is in this TPC

See also

ContainsPosition()

Definition at line 181 of file BoxBoundedGeo.h.

References CoordinateContained(), MaxZ(), and MinZ().

Referenced by ContainsYZ().

      { return CoordinateContained(z, MinZ(), MaxZ(), wiggle); }

static bool geo::BoxBoundedGeo::CoordinateContained ( double  c, double  min, double  max, double  wiggle = 1.  )

inlinestatic

Returns whether the specified coordinate is in a range.

Parameters

c	the coordinate
min	lower boundary of the range
max	upper boundary of the range
wiggle	expansion factor for the range

Returns

whether the specified coordinate is in a range

If the wiggle is larger than 1, the range is expanded by the wiggle factor. If the wiggle is less than 1, the range is shrinked.

Definition at line 333 of file BoxBoundedGeo.h.

Referenced by ContainsX(), ContainsY(), ContainsZ(), CoordinateContained(), InFiducialX(), InFiducialY(), and InFiducialZ().

      {
        return (c >= (min > 0? min / wiggle: min * wiggle))
          && (c <= (max < 0? max / wiggle: max * wiggle));
      } // CoordinateContained()

static bool geo::BoxBoundedGeo::CoordinateContained ( double  c, double const *  range, double  wiggle = 1.  )

inlinestatic

Returns whether the specified coordinate is in a range.

Parameters

c	the coordinate
range	pointer to [ lower boundary, upper boundary ] of the range
wiggle	expansion factor for the range

Returns

whether the specified coordinate is in a range

See also

CoordinateContained(double, double, double, double)

If the wiggle is larger than 1, the range is expanded by the wiggle factor. If the wiggle is less than 1, the range is shrinked.

Definition at line 351 of file BoxBoundedGeo.h.

References CoordinateContained().

      { return CoordinateContained(c, range[0], range[1], wiggle); }

void geo::BoxBoundedGeo::ExtendToInclude ( Coord_t  x, Coord_t  y, Coord_t  z  )

inline

Extends the current box to also include the specified point.

Parameters

x	x coordinate of the point to include
y	y coordinate of the point to include
z	z coordinate of the point to include

Definition at line 392 of file BoxBoundedGeo.h.

Referenced by geo::PlaneGeo::BoundingBox(), evd_tool::StandardDrawer::DetOutline3D(), and lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry().

      { ExtendToInclude(geo::Point_t(x, y, z)); }

void geo::BoxBoundedGeo::ExtendToInclude ( geo::Point_t const &  point )

inline

Extends the current box to also include the specified point.

Parameters

point

coordinates of the point to include

Definition at line 399 of file BoxBoundedGeo.h.

References c_max, c_min, set_max(), and set_min().

      { 
        set_min(c_min, point);
        set_max(c_max, point);
      }

void geo::BoxBoundedGeo::ExtendToInclude ( BoxBoundedGeo const &  box )

inline

Extends the current box to also include the specified one.

Parameters

box	the box to include

It is assumed that the box has its boundaries properly sorted.

Definition at line 411 of file BoxBoundedGeo.h.

References c_max, c_min, GetIntersections(), Max(), Min(), set_max(), and set_min().

      {
        set_min(c_min, box.Min());
        set_max(c_max, box.Max());
      } // ExtendToInclude()

std::vector< TVector3 > geo::BoxBoundedGeo::GetIntersections	(	TVector3 const &	TrajectoryStart,
		TVector3 const &	TrajectoryDirect
	)		const

Calculates the entry and exit points of a trajectory on the box surface.

Author

Christoph Rudolf von Rohr (crohr.nosp@m.@fna.nosp@m.l.gov)

Date

July 27th, 2015

Parameters

TrajectoryStart	position of the trajectory source
TrajectoryDirect	direction vector of the trajectory

This member is public since it just gives an output and does not change any member. The algorithm works only for a box shaped active volume with facing walls parallel to axis. If the return std::vector is empty the trajectory does not intersect with the box. Normally the return value should have one (if the trajectory originates in the box) or two (else) entries. If the return value has two entries the first represents the entry point and the second the exit point

Definition at line 118 of file BoxBoundedGeo.cxx.

Referenced by ExtendToInclude(), and GetIntersections().

  {
    std::vector<TVector3> intersections;
    for (auto const& point: GetIntersections(geo::Point_t(TrajectoryStart), geo::Vector_t(TrajectoryDirect)))
      intersections.emplace_back(point.X(), point.Y(), point.Z());
    return intersections;
  } // GetIntersections(TVector3)

std::vector< geo::Point_t > geo::BoxBoundedGeo::GetIntersections	(	geo::Point_t const &	TrajectoryStart,
		geo::Vector_t const &	TrajectoryDirect
	)		const

Calculates the entry and exit points of a trajectory on the box surface.

Author

Christoph Rudolf von Rohr (crohr.nosp@m.@fna.nosp@m.l.gov)

Date

July 27th, 2015

Parameters

TrajectoryStart	position of the trajectory source
TrajectoryDirect	direction vector of the trajectory

This member is public since it just gives an output and does not change any member. The algorithm works only for a box shaped active volume with facing walls parallel to axis. If the return std::vector is empty the trajectory does not intersect with the box. Normally the return value should have one (if the trajectory originates in the box) or two (else) entries. If the return value has two entries the first represents the entry point and the second the exit point

Definition at line 27 of file BoxBoundedGeo.cxx.

References geo::vect::bindCoord(), c_max, c_min, geo::vect::coord(), GetIntersections(), Max(), and Min().

          {
  
    std::vector<geo::Point_t> IntersectionPoints;
    std::vector<double> LineParameters;
    
    // Generate normal vectors and offsets for every plane of the box
    // All normal vectors are headed outwards
    // BUG the double brace syntax is required to work around clang bug 21629
    // (https://bugs.llvm.org/show_bug.cgi?id=21629)
    static std::array<geo::Vector_t, 6U> const NormalVectors = {{
      -geo::Xaxis<geo::Vector_t>(), geo::Xaxis<geo::Vector_t>(), // anode, cathode,
      -geo::Yaxis<geo::Vector_t>(), geo::Yaxis<geo::Vector_t>(), // bottom, top, 
      -geo::Zaxis<geo::Vector_t>(), geo::Zaxis<geo::Vector_t>()  // upstream, downstream
    }};
    // BUG the double brace syntax is required to work around clang bug 21629
    // (https://bugs.llvm.org/show_bug.cgi?id=21629)
    std::array<geo::Point_t, 6U> const NormalVectorOffsets = {{
      geo::Point_t{ Min().X(), Min().Y(), Min().Z() }, // Anode offset
      geo::Point_t{ Max().X(), Min().Y(), Min().Z() }, // Cathode
      geo::Point_t{ Min().X(), Min().Y(), Min().Z() }, // Bottom
      geo::Point_t{ Min().X(), Max().Y(), Min().Z() }, // Top
      geo::Point_t{ Min().X(), Min().Y(), Min().Z() }, // upstream
      geo::Point_t{ Min().X(), Min().Y(), Max().Z() }  // downstream
    }};
    
    // Loop over all surfaces of the box 
    for(unsigned int face_no = 0; face_no < NormalVectors.size(); face_no++)
    {
      // Check if trajectory and surface are not parallel
      if(NormalVectors[face_no].Dot(TrajectoryDirect))
      {
        // Calculate the line parameter for the intersection points
        LineParameters.push_back( NormalVectors[face_no].Dot(NormalVectorOffsets.at(face_no) - TrajectoryStart)
                                / NormalVectors[face_no].Dot(TrajectoryDirect) );
      }
      else continue;
      
      // Calculate intersection point using the line parameter
      IntersectionPoints.push_back( TrajectoryStart + LineParameters.back()*TrajectoryDirect );
      
      // Coordinate which should be ignored when checking for limits added by Christoph Rudolf von Rohr 05/21/2016
      unsigned int NoCheckCoord;
      
      // Calculate NoCheckCoord out of the face_no
      if(face_no % 2)
      {
          // Convert odd face number to coordinate
          NoCheckCoord = (face_no - 1)/2;
      }
      else
      {
          // Convert even face number to coordinate
          NoCheckCoord = face_no/2;
      }
      
      // Loop over all three space coordinates
      unsigned int coord = 0;
      for(auto extractCoord: geo::vect::coordReaders<geo::Point_t>())
      {
        auto const lastPointCoord = geo::vect::bindCoord(IntersectionPoints.back(), extractCoord);
        auto const minCoord = geo::vect::bindCoord(c_min, extractCoord);
        auto const maxCoord = geo::vect::bindCoord(c_max, extractCoord);
        
        // Changed by Christoph Rudolf von Rohr 05/21/2016
        // Then check if point is not within the surface limits at this coordinate, without looking
        // at the plane normal vector coordinate. We can assume, that our algorithm already found this coordinate correctily.
        // In rare cases, looking for boundaries in this coordinate causes unexpected behavior due to floating point inaccuracies.
        if( coord++ != NoCheckCoord && ((lastPointCoord() > maxCoord()) || (lastPointCoord() < minCoord)) )
        {
          // if off limits, get rid of the useless data and break the coordinate loop
          LineParameters.pop_back();
          IntersectionPoints.pop_back();
          break;
        }
      }// coordinate loop
    }// Surcaces loop
    
    // sort points according to their parameter value (first is entry, second is exit)
    if(LineParameters.size() == 2 && LineParameters.front() > LineParameters.back())
    {
      std::swap(IntersectionPoints.front(),IntersectionPoints.back());
    }
    
    return IntersectionPoints;
  } // GetIntersections()

double geo::BoxBoundedGeo::HalfSizeX ( ) const

inline

Returns the size from the center to the border on X dimension.

Definition at line 102 of file BoxBoundedGeo.h.

References SizeX().

{ return SizeX() / 2.0; }

double geo::BoxBoundedGeo::HalfSizeY ( ) const

inline

Returns the size from the center to the border on Y dimension.

Definition at line 117 of file BoxBoundedGeo.h.

References SizeY().

{ return SizeY() / 2.0; }

double geo::BoxBoundedGeo::HalfSizeZ ( ) const

inline

Returns the size from the center to the border on Z dimension.

Definition at line 132 of file BoxBoundedGeo.h.

References SizeZ().

{ return SizeZ() / 2.0; }

bool geo::BoxBoundedGeo::InFiducialX ( double  x, double  neg_margin, double  pos_margin  ) const

inline

Returns whether TPC fiducial volume contains world x coordinate.

Parameters

x	the absolute ("world") coordinate x
neg_margin	how far within the TPC the fiducial region starts
pos_margin	how far before the TPC the fiducial region ends

Returns

whether the specified coordinate is in this TPC fiducial volume

The fiducial volume is defined by the specified margins, that denote how much of the coordinate is not fiducial. For example,

bool bWithin = tpc->InFiducialX(x, 5., 8.);

on a TPC with x from 0 to 100 (cm, presumably) will return true for all x between 5 and 92. If positive margin is not specified, it's assumed to be the same as the negative one. Specifying a negative mergin effectively extends the TPC volume. Note that x is by definition the drift direction, and a reconstructed x typically depends on an assumption respect to the event time.

Definition at line 243 of file BoxBoundedGeo.h.

References CoordinateContained(), MaxX(), and MinX().

Referenced by InFiducialX().

      {
        return CoordinateContained(x, MinX() + neg_margin, MaxX() - pos_margin);
      }

bool geo::BoxBoundedGeo::InFiducialX ( double  x, double  margin  ) const

inline

Returns whether TPC fiducial volume contains world x coordinate.

See also

InFiducialX(double, double, double) const

Margins are symmetric.

Definition at line 253 of file BoxBoundedGeo.h.

References InFiducialX().

      { return InFiducialX(x, margin, margin); }

bool geo::BoxBoundedGeo::InFiducialY ( double  y, double  neg_margin, double  pos_margin  ) const

inline

Returns whether TPC fiducial volume contains world y coordinate.

Parameters

y	the absolute ("world") coordinate y
neg_margin	how far within the TPC the fiducial region starts
pos_margin	how far before the TPC the fiducial region ends

Returns

whether the specified coordinate is in this TPC fiducial volume

The fiducial volume is defined by the specified margins, that denote how much of the coordinate is not fiducial. For example,

bool bWithin = tpc->InFiducialY(y, 5., 8.);

on a TPC with y from 0 to 100 (cm, presumably) will return true for all y between 5 and 92. If positive margin is not specified, it's assumed to be the same as the negative one. Specifying a negative mergin effectively extends the TPC volume.

Definition at line 274 of file BoxBoundedGeo.h.

References CoordinateContained(), MaxY(), and MinY().

Referenced by InFiducialY().

      {
        return CoordinateContained(y, MinY() + neg_margin, MaxY() - pos_margin);
      }

bool geo::BoxBoundedGeo::InFiducialY ( double  y, double  margin  ) const

inline

Returns whether TPC fiducial volume contains world y coordinate.

See also

InFiducialY(double, double, double) const

Margins are symmetric.

Definition at line 284 of file BoxBoundedGeo.h.

References InFiducialY().

      { return InFiducialY(y, margin, margin); }

bool geo::BoxBoundedGeo::InFiducialZ ( double  z, double  neg_margin, double  pos_margin  ) const

inline

Returns whether TPC fiducial volume contains world z coordinate.

Parameters

z	the absolute ("world") coordinate y
neg_margin	how far within the TPC the fiducial region starts
pos_margin	how far before the TPC the fiducial region ends

Returns

whether the specified coordinate is in this TPC fiducial volume

The fiducial volume is defined by the specified margins, that denote how much of the coordinate is not fiducial. For example,

bool bWithin = tpc->InFiducialZ(z, 5., 8.);

on a TPC with z from 0 to 100 (cm, presumably) will return true for all z between 5 and 92. If positive margin is not specified, it's assumed to be the same as the negative one. Specifying a negative mergin effectively extends the TPC volume.

Definition at line 305 of file BoxBoundedGeo.h.

References CoordinateContained(), MaxZ(), and MinZ().

Referenced by InFiducialZ().

      {
        return CoordinateContained(z, MinZ() + neg_margin, MaxZ() - pos_margin);
      }

bool geo::BoxBoundedGeo::InFiducialZ ( double  z, double  margin  ) const

inline

Returns whether TPC fiducial volume contains world z coordinate.

See also

InFiducialZ(double, double, double) const

Margins are symmetric.

Definition at line 315 of file BoxBoundedGeo.h.

References CoordinateContained(), and InFiducialZ().

      { return InFiducialZ(z, margin, margin); }

geo::Point_t geo::BoxBoundedGeo::Max ( ) const

inline

Returns the corner point with the largest coordinates.

Definition at line 138 of file BoxBoundedGeo.h.

References c_max.

Referenced by ExtendToInclude(), GetIntersections(), geo::GeometryCore::MaterialName(), geo::CryostatGeo::PrintCryostatInfo(), and geo::TPCGeo::PrintTPCInfo().

{ return c_max; }

double geo::BoxBoundedGeo::MaxX ( ) const

inline

Returns the world x coordinate of the end of the box.

Definition at line 93 of file BoxBoundedGeo.h.

References c_max.

Referenced by geo::CryostatGeo::Boundaries(), CenterX(), ContainsX(), evd_tool::ICARUSDrawer::DetOutline3D(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry(), mvapid::MVAAlg::GetDetectorEdges(), InFiducialX(), evd::SimulationDrawer::MCTruthOrtho(), pma::Node3D::Node3D(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), SizeX(), TPCarea(), and geo::GeometryCore::WorldBox().

{ return c_max.X(); }

double geo::BoxBoundedGeo::MaxY ( ) const

inline

Returns the world y coordinate of the end of the box.

Definition at line 108 of file BoxBoundedGeo.h.

References c_max.

Referenced by geo::CryostatGeo::Boundaries(), CenterY(), ContainsY(), evd_tool::ICARUSDrawer::DetOutline3D(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry(), mvapid::MVAAlg::GetDetectorEdges(), InFiducialY(), pma::Node3D::Node3D(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), tca::SaveCRInfo(), SizeY(), TPCarea(), and geo::GeometryCore::WorldBox().

{ return c_max.Y(); }

double geo::BoxBoundedGeo::MaxZ ( ) const

inline

Returns the world z coordinate of the end of the box.

Definition at line 123 of file BoxBoundedGeo.h.

References c_max.

Referenced by geo::CryostatGeo::Boundaries(), CenterZ(), ContainsZ(), evd_tool::ICARUSDrawer::DetOutline3D(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry(), mvapid::MVAAlg::GetDetectorEdges(), InFiducialZ(), pma::Node3D::Node3D(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), tca::SaveCRInfo(), SizeZ(), TPCarea(), and geo::GeometryCore::WorldBox().

{ return c_max.Z(); }

geo::Point_t geo::BoxBoundedGeo::Min ( ) const

inline

Returns the corner point with the smallest coordinates.

Definition at line 135 of file BoxBoundedGeo.h.

References c_min.

Referenced by ExtendToInclude(), GetIntersections(), geo::GeometryCore::MaterialName(), geo::CryostatGeo::PrintCryostatInfo(), and geo::TPCGeo::PrintTPCInfo().

{ return c_min; }

double geo::BoxBoundedGeo::MinX ( ) const

inline

Returns the world x coordinate of the start of the box.

Definition at line 90 of file BoxBoundedGeo.h.

References c_min.

Referenced by geo::CryostatGeo::Boundaries(), CenterX(), ContainsX(), evd_tool::ICARUSDrawer::DetOutline3D(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry(), mvapid::MVAAlg::GetDetectorEdges(), InFiducialX(), pma::Track3D::InitFromMiddle(), evd::SimulationDrawer::MCTruthOrtho(), pma::Node3D::Node3D(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), evgen::ActiveVolumeVertexSampler::sample_vertex_pos(), SizeX(), TPCarea(), and geo::GeometryCore::WorldBox().

{ return c_min.X(); }

double geo::BoxBoundedGeo::MinY ( ) const

inline

Returns the world y coordinate of the start of the box.

Definition at line 105 of file BoxBoundedGeo.h.

References c_min.

Referenced by geo::CryostatGeo::Boundaries(), CenterY(), ContainsY(), evd_tool::ICARUSDrawer::DetOutline3D(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry(), mvapid::MVAAlg::GetDetectorEdges(), InFiducialY(), pma::Node3D::Node3D(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), tca::SaveCRInfo(), SizeY(), TPCarea(), and geo::GeometryCore::WorldBox().

{ return c_min.Y(); }

double geo::BoxBoundedGeo::MinZ ( ) const

inline

Returns the world z coordinate of the start of the box.

Definition at line 120 of file BoxBoundedGeo.h.

References c_min.

Referenced by geo::CryostatGeo::Boundaries(), CenterZ(), ContainsZ(), evd_tool::ICARUSDrawer::DetOutline3D(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry(), mvapid::MVAAlg::GetDetectorEdges(), InFiducialZ(), pma::Node3D::Node3D(), evgen::NucleonDecay::produce(), evgen::NeutronOsc::produce(), tca::SaveCRInfo(), SizeZ(), TPCarea(), and geo::GeometryCore::WorldBox().

{ return c_min.Z(); }

static void geo::BoxBoundedGeo::set_max ( Coord_t &  var, Coord_t  value  )

inlinestatic

Sets var to value if value is larger than the current var value.

Definition at line 446 of file BoxBoundedGeo.h.

References fhicl::detail::atom::value().

Referenced by ExtendToInclude().

      { if (value > var) var = value; }

static void geo::BoxBoundedGeo::set_max ( Coords_t &  var, geo::Point_t const &  value  )

inlinestatic

Sets each coordinate of var to the one in value if the latter is larger.

Definition at line 458 of file BoxBoundedGeo.h.

      {
        if (value.X() > var.X()) var.SetX(value.X());
        if (value.Y() > var.Y()) var.SetY(value.Y());
        if (value.Z() > var.Z()) var.SetZ(value.Z());
      }

static void geo::BoxBoundedGeo::set_min ( Coord_t &  var, Coord_t  value  )

inlinestatic

Sets var to value if value is smaller than the current var value.

Definition at line 442 of file BoxBoundedGeo.h.

References fhicl::detail::atom::value().

Referenced by ExtendToInclude().

      { if (value < var) var = value; }

static void geo::BoxBoundedGeo::set_min ( Coords_t &  var, geo::Point_t const &  value  )

inlinestatic

Sets each coordinate of var to the one in value if the latter is smaller.

Definition at line 450 of file BoxBoundedGeo.h.

      {
        if (value.X() < var.X()) var.SetX(value.X());
        if (value.Y() < var.Y()) var.SetY(value.Y());
        if (value.Z() < var.Z()) var.SetZ(value.Z());
      }

void geo::BoxBoundedGeo::SetBoundaries ( Coord_t  x_min, Coord_t  x_max, Coord_t  y_min, Coord_t  y_max, Coord_t  z_min, Coord_t  z_max  )

inline

Sets the boundaries in world coordinates as specified.

Parameters

x_min	lower x coordinate
x_max	upper x coordinate
y_min	lower y coordinate
y_max	upper y coordinate
z_min	lower z coordinate
z_max	upper z coordinate

Definition at line 367 of file BoxBoundedGeo.h.

References c_max, c_min, and SortCoordinates().

Referenced by geo::PlaneGeo::BoundingBox(), geo::CryostatGeo::InitCryoBoundaries(), and geo::TPCGeo::InitTPCBoundaries().

      {
        c_min.SetXYZ(x_min, y_min, z_min);
        c_max.SetXYZ(x_max, y_max, z_max);
        SortCoordinates();
      }

void geo::BoxBoundedGeo::SetBoundaries ( Coords_t  lower, Coords_t  upper  )

inline

Sets the boundaries in world coordinates as specified.

Parameters

lower	lower coordinates (x, y, z)
upper	upper coordinates (x, y, z)

Definition at line 383 of file BoxBoundedGeo.h.

References c_max, c_min, and SortCoordinates().

      { c_min = lower; c_max = upper; SortCoordinates(); }

double geo::BoxBoundedGeo::SizeX ( ) const

inline

Returns the full size in the X dimension.

Definition at line 99 of file BoxBoundedGeo.h.

References MaxX(), and MinX().

Referenced by HalfSizeX().

{ return MaxX() - MinX(); }

double geo::BoxBoundedGeo::SizeY ( ) const

inline

Returns the full size in the Y dimension.

Definition at line 114 of file BoxBoundedGeo.h.

References MaxY(), and MinY().

Referenced by HalfSizeY().

{ return MaxY() - MinY(); }

double geo::BoxBoundedGeo::SizeZ ( ) const

inline

Returns the full size in the Z dimension.

Definition at line 129 of file BoxBoundedGeo.h.

References MaxZ(), and MinZ().

Referenced by HalfSizeZ().

{ return MaxZ() - MinZ(); }

void geo::BoxBoundedGeo::SortCoordinates ( )

private

Makes sure each coordinate of the minimum point is smaller than maximum.

Definition at line 127 of file BoxBoundedGeo.cxx.

References geo::vect::bindCoord(), c_max, c_min, max, and min.

Referenced by BoxBoundedGeo(), and SetBoundaries().

                                      {
    
    for (auto coordMan: geo::vect::coordManagers<geo::Point_t>()) {
      auto min = geo::vect::bindCoord(c_min, coordMan);
      auto max = geo::vect::bindCoord(c_max, coordMan);
      if (min() > max()) {
        auto temp = min();
        min = max();
        max = temp;
      }
    } // for
    
  } // BoxBoundedGeo::SortCoordinates()

Member Data Documentation

Coords_t geo::BoxBoundedGeo::c_max

private

maximum coordinates (x, y, z)

Definition at line 469 of file BoxBoundedGeo.h.

Referenced by BoxBoundedGeo(), ExtendToInclude(), GetIntersections(), Max(), MaxX(), MaxY(), MaxZ(), SetBoundaries(), and SortCoordinates().

Coords_t geo::BoxBoundedGeo::c_min

private

minimum coordinates (x, y, z)

Definition at line 468 of file BoxBoundedGeo.h.

Referenced by ExtendToInclude(), GetIntersections(), Min(), MinX(), MinY(), MinZ(), SetBoundaries(), and SortCoordinates().

---

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

• larcorealg/v1_24_01/source/larcorealg/Geometry/BoxBoundedGeo.h
• larcorealg/v1_24_01/source/larcorealg/Geometry/BoxBoundedGeo.cxx