lar::util::simple_geo::Volume< Point > Class Template Reference

Volume delimited by two points. More...

#include "SimpleGeo.h"

Inheritance diagram for lar::util::simple_geo::Volume< Point >:

Public Types
using	Point_t = typename Base_t::Point_t
using	Volume_t = Volume< Point_t >
using	Area_t = Area< Point_t >

Public Member Functions
	Volume ()=default
	Volume (Point_t const &a, Point_t const &b)
auto	DeltaZ () const
bool	isEmptyZ () const
unsigned int	nonEmptyDims () const
bool	isNullZ () const
bool	isNull () const
bool	isEmpty () const
bool	isLine () const
bool	isPlane () const
bool	isVolume () const
auto	thinnestSize () const
unsigned int	thinnestSide () const
	Returns the index of the thinnest side (0 is x, 1 is y) More...
void	IncludePoint (Point_t const &point)
void	Include (Volume_t const &volume)
void	Intersect (Volume_t const &volume)
auto	DeltaY () const
bool	isEmptyY () const
bool	isNullY () const
void	Include (Area_t const &area)
void	Intersect (Area_t const &area)
Point_t const &	Min () const
Point_t const &	Max () const
Point_t	Center () const
auto	DeltaX () const
bool	isEmptyX () const
bool	isNullX () const
bool	operator== (Area_t const &as) const
bool	operator!= (Area_t const &as) const

Protected Types
using	Data_t = typename Point_t::Data_t

Static Protected Member Functions
static void	set_min (Data_t &var, Data_t val)
static void	set_max (Data_t &var, Data_t val)
static void	set_min_max (Data_t &min_var, Data_t &max_var, Data_t val)
static void	set_sorted (Data_t &min_var, Data_t &max_var, Data_t a, Data_t b)

Protected Attributes
Point_t	min
Point_t	max

Private Types
using	Base_t = Area< Point >

Detailed Description

template<typename Point = Point3D<double>>
class lar::util::simple_geo::Volume< Point >

Volume delimited by two points.

Definition at line 261 of file SimpleGeo.h.

Member Typedef Documentation

template<typename Point = Point2D<double>>

using lar::util::simple_geo::Area< Point >::Area_t = Area<Point_t>

inherited

Definition at line 206 of file SimpleGeo.h.

template<typename Point = Point3D<double>>

using lar::util::simple_geo::Volume< Point >::Base_t = Area<Point>

private

Definition at line 262 of file SimpleGeo.h.

template<typename Point >

using lar::util::simple_geo::AreaBase< Point >::Data_t = typename Point_t::Data_t

protectedinherited

Definition at line 176 of file SimpleGeo.h.

template<typename Point = Point3D<double>>

using lar::util::simple_geo::Volume< Point >::Point_t = typename Base_t::Point_t

Definition at line 265 of file SimpleGeo.h.

template<typename Point = Point3D<double>>

using lar::util::simple_geo::Volume< Point >::Volume_t = Volume<Point_t>

Definition at line 266 of file SimpleGeo.h.

Constructor & Destructor Documentation

template<typename Point = Point3D<double>>

lar::util::simple_geo::Volume< Point >::Volume ( )

default

template<typename Point = Point3D<double>>

lar::util::simple_geo::Volume< Point >::Volume ( Point_t const &  a, Point_t const &  b  )

inline

Definition at line 270 of file SimpleGeo.h.

References max, min, and z.

          : Base_t(a, b)
          { Base_t::set_sorted(Base_t::min.z, Base_t::max.z, a.z, b.z); }

Member Function Documentation

template<typename Point >

Point_t lar::util::simple_geo::AreaBase< Point >::Center ( ) const

inlineinherited

Definition at line 142 of file SimpleGeo.h.

References max, and min.

{ return (min + max) * 0.5; }

template<typename Point >

auto lar::util::simple_geo::AreaBase< Point >::DeltaX ( ) const

inlineinherited

Definition at line 144 of file SimpleGeo.h.

{ return Max().x - Min().x; }

template<typename Point = Point2D<double>>

auto lar::util::simple_geo::Area< Point >::DeltaY ( ) const

inlineinherited

Definition at line 214 of file SimpleGeo.h.

{ return Base_t::Max().y - Base_t::Min().y; }

template<typename Point = Point3D<double>>

auto lar::util::simple_geo::Volume< Point >::DeltaZ ( ) const

inline

Definition at line 274 of file SimpleGeo.h.

{ return Base_t::Max().z - Base_t::Min().z; }

template<typename Point = Point2D<double>>

void lar::util::simple_geo::Area< Point >::Include ( Area_t const &  area )

inlineinherited

Definition at line 240 of file SimpleGeo.h.

References lar::util::simple_geo::AreaBase< Point >::max, and lar::util::simple_geo::AreaBase< Point >::min.

          { IncludePoint(area.min); IncludePoint(area.max); }

template<typename Point = Point3D<double>>

void lar::util::simple_geo::Volume< Point >::Include ( Volume_t const &  volume )

inline

Definition at line 301 of file SimpleGeo.h.

References lar::util::simple_geo::AreaBase< Point >::max, and lar::util::simple_geo::AreaBase< Point >::min.

          { IncludePoint(volume.min); IncludePoint(volume.max); }

template<typename Point = Point3D<double>>

void lar::util::simple_geo::Volume< Point >::IncludePoint ( Point_t const &  point )

inline

Definition at line 295 of file SimpleGeo.h.

References max, min, and z.

          {
            Base_t::IncludePoint(point);
            Base_t::set_min_max(Base_t::min.z, Base_t::max.z, point.z);
          }

template<typename Point = Point2D<double>>

void lar::util::simple_geo::Area< Point >::Intersect ( Area_t const &  area )

inlineinherited

Definition at line 243 of file SimpleGeo.h.

References max, lar::util::simple_geo::AreaBase< Point >::max, min, lar::util::simple_geo::AreaBase< Point >::min, and lar::util::simple_geo::Point2D< Data >::y.

          {
            Base_t::Intersect(area);
            Base_t::set_max(Base_t::min.y, area.min.y);
            Base_t::set_min(Base_t::max.y, area.max.y);
            if (isNullY())
              throw typename Base_t::NullIntersection("null y dimension");
          }

template<typename Point = Point3D<double>>

void lar::util::simple_geo::Volume< Point >::Intersect ( Volume_t const &  volume )

inline

Definition at line 304 of file SimpleGeo.h.

References max, lar::util::simple_geo::AreaBase< Point >::max, min, lar::util::simple_geo::AreaBase< Point >::min, and z.

          {
            Base_t::Intersect(volume);
            Base_t::set_max(Base_t::min.z, volume.min.z);
            Base_t::set_min(Base_t::max.z, volume.max.z);
            if (isNullZ())
              throw typename Base_t::NullIntersection("null z dimension");
          }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isEmpty ( ) const

inline

Definition at line 280 of file SimpleGeo.h.

{ return nonEmptyDims() == 0; }

template<typename Point >

bool lar::util::simple_geo::AreaBase< Point >::isEmptyX ( ) const

inlineinherited

Definition at line 145 of file SimpleGeo.h.

{ return (DeltaX() == 0); }

template<typename Point = Point2D<double>>

bool lar::util::simple_geo::Area< Point >::isEmptyY ( ) const

inlineinherited

Definition at line 215 of file SimpleGeo.h.

{ return DeltaY() == 0; }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isEmptyZ ( ) const

inline

Definition at line 275 of file SimpleGeo.h.

{ return DeltaZ() == 0; }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isLine ( ) const

inline

Definition at line 281 of file SimpleGeo.h.

{ return nonEmptyDims() == 1; }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isNull ( ) const

inline

Definition at line 279 of file SimpleGeo.h.

{ return Base_t::isNull() || isNullZ(); }

template<typename Point >

bool lar::util::simple_geo::AreaBase< Point >::isNullX ( ) const

inlineinherited

Definition at line 146 of file SimpleGeo.h.

{ return Max().x < Min().x; }

template<typename Point = Point2D<double>>

bool lar::util::simple_geo::Area< Point >::isNullY ( ) const

inlineinherited

Definition at line 218 of file SimpleGeo.h.

{ return Base_t::Max().y < Base_t::Min().y; }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isNullZ ( ) const

inline

Definition at line 278 of file SimpleGeo.h.

{ return Base_t::Max().z < Base_t::Min().z; }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isPlane ( ) const

inline

Definition at line 282 of file SimpleGeo.h.

{ return nonEmptyDims() == 2; }

template<typename Point = Point3D<double>>

bool lar::util::simple_geo::Volume< Point >::isVolume ( ) const

inline

Definition at line 283 of file SimpleGeo.h.

{ return nonEmptyDims() == 3; }

template<typename Point >

Point_t const& lar::util::simple_geo::AreaBase< Point >::Max ( ) const

inlineinherited

Definition at line 141 of file SimpleGeo.h.

References max.

{ return max; }

template<typename Point >

Point_t const& lar::util::simple_geo::AreaBase< Point >::Min ( ) const

inlineinherited

Definition at line 140 of file SimpleGeo.h.

References min.

{ return min; }

template<typename Point = Point3D<double>>

unsigned int lar::util::simple_geo::Volume< Point >::nonEmptyDims ( ) const

inline

Definition at line 276 of file SimpleGeo.h.

          { return Base_t::nonEmptyDims() + (isEmptyZ()? 0: 1); }

template<typename Point >

bool lar::util::simple_geo::AreaBase< Point >::operator!= ( Area_t const &  as ) const

inlineinherited

Definition at line 172 of file SimpleGeo.h.

References max, lar::util::simple_geo::AreaBase< Point >::max, min, and lar::util::simple_geo::AreaBase< Point >::min.

          { return (min != as.min) || (max != as.max); }

template<typename Point >

bool lar::util::simple_geo::AreaBase< Point >::operator== ( Area_t const &  as ) const

inlineinherited

Definition at line 170 of file SimpleGeo.h.

References max, lar::util::simple_geo::AreaBase< Point >::max, min, and lar::util::simple_geo::AreaBase< Point >::min.

          { return (min == as.min) && (max == as.max); }

template<typename Point >

static void lar::util::simple_geo::AreaBase< Point >::set_max ( Data_t &  var, Data_t  val  )

inlinestaticprotectedinherited

Definition at line 183 of file SimpleGeo.h.

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

template<typename Point >

static void lar::util::simple_geo::AreaBase< Point >::set_min ( Data_t &  var, Data_t  val  )

inlinestaticprotectedinherited

Definition at line 180 of file SimpleGeo.h.

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

template<typename Point >

static void lar::util::simple_geo::AreaBase< Point >::set_min_max ( Data_t &  min_var, Data_t &  max_var, Data_t  val  )

inlinestaticprotectedinherited

Definition at line 186 of file SimpleGeo.h.

          { set_min(min_var, val); set_max(max_var, val); }

template<typename Point >

static void lar::util::simple_geo::AreaBase< Point >::set_sorted ( Data_t &  min_var, Data_t &  max_var, Data_t  a, Data_t  b  )

inlinestaticprotectedinherited

Definition at line 190 of file SimpleGeo.h.

          {
            if (a > b) { min_var = b; max_var = a; }
            else       { min_var = a; max_var = b; }
          }

template<typename Point = Point3D<double>>

unsigned int lar::util::simple_geo::Volume< Point >::thinnestSide ( ) const

inline

Returns the index of the thinnest side (0 is x, 1 is y)

Definition at line 289 of file SimpleGeo.h.

          {
            return
              (DeltaZ() < Base_t::thinnestSize())? 2: Base_t::thinnestSide();
          }

template<typename Point = Point3D<double>>

auto lar::util::simple_geo::Volume< Point >::thinnestSize ( ) const

inline

Definition at line 285 of file SimpleGeo.h.

References min.

          { return std::min(DeltaZ(), Base_t::thinnestSize()); }

Member Data Documentation

template<typename Point >

Point_t lar::util::simple_geo::AreaBase< Point >::max

protectedinherited

Definition at line 178 of file SimpleGeo.h.

Referenced by lar::util::simple_geo::AreaBase< Point >::Include(), lar::util::simple_geo::Area< Point >::Include(), lar::util::simple_geo::Volume< Point >::Include(), lar::util::simple_geo::AreaBase< Point >::Intersect(), lar::util::simple_geo::Area< Point >::Intersect(), lar::util::simple_geo::Volume< Point >::Intersect(), lar::util::simple_geo::AreaBase< Point >::operator!=(), and lar::util::simple_geo::AreaBase< Point >::operator==().

template<typename Point >

Point_t lar::util::simple_geo::AreaBase< Point >::min

protectedinherited

Definition at line 178 of file SimpleGeo.h.

Referenced by lar::util::simple_geo::AreaBase< Point >::Include(), lar::util::simple_geo::Area< Point >::Include(), lar::util::simple_geo::Volume< Point >::Include(), lar::util::simple_geo::AreaBase< Point >::Intersect(), lar::util::simple_geo::Area< Point >::Intersect(), lar::util::simple_geo::Volume< Point >::Intersect(), lar::util::simple_geo::AreaBase< Point >::operator!=(), and lar::util::simple_geo::AreaBase< Point >::operator==().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/Geometry/SimpleGeo.h