geoalgo::Cylinder Class Reference

Representation of a 3D Cylinder volume. A Cylinder object inherits from a geoalgo::Line. More...

#include "GeoCylinder.h"

Inheritance diagram for geoalgo::Cylinder:

Public Member Functions
	Cylinder ()
	Default constructor. More...
virtual	~Cylinder ()
	Default destructor. More...
	Cylinder (const double x_min, const double y_min, const double z_min, const double x_max, const double y_max, const double z_max, const double radius)
	Alternative ctor (0) More...
	Cylinder (const Point_t &min, const Vector_t &max, const double radius)
	Altenartive ctor (1) More...
bool	Contain (const Point_t &pt) const
	Containment evaluation. More...
double	GetRadius ()
	Getters. More...
void	SetRadius (double r)
	Setters. More...
const Point_t &	Pt1 () const
	Start getter. More...
void	Pt1 (const double x, const double y, const double z)
	Pt1 setter. More...
template<class T >
void	Pt1 (const T &pt1)
	Pt1 setter template. More...
const Point_t &	Pt2 () const
	Direction getter. More...
void	Pt2 (const double x, const double y, const double z)
	Pt2 setter. More...
template<class T >
void	Pt2 (const T &pt2)
	Pt2 setter template. More...

Protected Member Functions
void	check_and_raise (const Point_t &p1, const Point_t &p2) const
	Compatibility check. More...

Protected Attributes
double	_radius
	Radius of the cylinder. More...
GeoAlgo	_geoAlgo
Point_t	_pt1
	First point denoting infinite line. More...
Vector_t	_pt2
	Second point denoting infinite line. More...

Detailed Description

Representation of a 3D Cylinder volume. A Cylinder object inherits from a geoalgo::Line.

Remarks

input: 2 points, which define the line representing the central axis of the cylinder a radius, defining the radius of the cylinder

Definition at line 30 of file GeoCylinder.h.

Constructor & Destructor Documentation

geoalgo::Cylinder::Cylinder

(

)

Default constructor.

Definition at line 8 of file GeoCylinder.cxx.

Referenced by ~Cylinder().

    : Line()
    , _radius (0.)
  {}

virtual geoalgo::Cylinder::~Cylinder ( )

inlinevirtual

Default destructor.

Definition at line 38 of file GeoCylinder.h.

References Contain(), Cylinder(), max, min, pt, radius, x_max, and x_min.

{};

geoalgo::Cylinder::Cylinder	(	const double	x_min,
		const double	y_min,
		const double	z_min,
		const double	x_max,
		const double	y_max,
		const double	z_max,
		const double	radius
	)

Alternative ctor (0)

Definition at line 13 of file GeoCylinder.cxx.

    : Line(x_min, y_min, z_min, x_max, y_max, z_max)
    , _radius ( radius )
  {}

geoalgo::Cylinder::Cylinder	(	const Point_t &	min,
		const Vector_t &	max,
		const double	radius
	)

Altenartive ctor (1)

Definition at line 20 of file GeoCylinder.cxx.

    : Line(min, max)
    , _radius ( radius )
  { 
    if(min.size()!=3 || max.size()!=3)
      throw GeoAlgoException("Cylinder ctor accepts only 3D Point!");
  }

Member Function Documentation

void geoalgo::Line::check_and_raise ( const Point_t &  p1, const Point_t &  p2  ) const

protectedinherited

Compatibility check.

Definition at line 43 of file GeoLine.cxx.

Referenced by geoalgo::DirectedLine::DirectedLine(), geoalgo::Line::Line(), geoalgo::Line::Pt1(), geoalgo::Line::Pt2(), and geoalgo::Line::~Line().

  { 
    if(p1.size()!=3) throw GeoAlgoException("<<check_and_raise>> Pt1 is not 3 dimensional point!");
    if(p2.size()!=3) throw GeoAlgoException("<<check_and_raise>> Pt2 is not 3 dimensional point!");
    if(p1 == p2) throw GeoAlgoException("<<check_and_raise>> Two identical points not allowed for Line ctor!"); 
  }

bool geoalgo::Cylinder::Contain

(

const Point_t &

pt

)

const

Containment evaluation.

Test if a point is contained within the box

Definition at line 28 of file GeoCylinder.cxx.

References _geoAlgo, geoalgo::Line::_pt1, geoalgo::Line::_pt2, _radius, geoalgo::Vector::Angle(), and geoalgo::GeoAlgo::SqDist().

Referenced by ~Cylinder().

                                                {

    // get a vector that defines the axis of the cylinder
    Vector_t axis = _pt1-_pt2;
    Vector_t dirpt = pt-_pt2;

    // angle of point w.r.t. the axis
    double angleMin = axis.Angle(dirpt);
    
    // if the angle is > 90 -> outside -> return
    if (angleMin > 0.5*3.14)
      return false;
    
    // revert the axis direction
    axis = _pt2-_pt1;
    dirpt = pt-_pt1;
    angleMin = axis.Angle(dirpt);
    
    // if the angle is > 90 -> outside -> return
    if (angleMin > 0.5*3.14)
      return false;

    // if still here, all that is left to verify is
    // that the point isn't more than a radius
    // away from the cylinder axis
    // 1) make a line corresponding to the axis
    // 2) get the distance between the point and the line
    double radial_dist_sq = _geoAlgo.SqDist(*this,pt);
    
    if (radial_dist_sq > _radius*_radius)
      return false;
    
    return true;

  }

double geoalgo::Cylinder::GetRadius ( )

inline

Getters.

Definition at line 52 of file GeoCylinder.h.

References _radius.

{ return _radius; }

const Point_t & geoalgo::Line::Pt1 ( ) const

inherited

Start getter.

Definition at line 24 of file GeoLine.cxx.

References geoalgo::Line::_pt1.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::GeoAlgo::SqDist(), and geoalgo::Line::~Line().

{ return _pt1; }

void geoalgo::Line::Pt1 ( const double  x, const double  y, const double  z  )

inherited

Pt1 setter.

Definition at line 27 of file GeoLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, geoalgo::Line::check_and_raise(), x, y, and z.

  { 
    _pt1[0] = x; 
    _pt1[1] = y; 
    _pt1[2] = z; 
    check_and_raise(_pt1,_pt2);
  }

template<class T >

void geoalgo::Line::Pt1 ( const T &  pt1 )

inlineinherited

Pt1 setter template.

Definition at line 75 of file GeoLine.h.

References geoalgo::Line::check_and_raise().

    { 
      _pt1 = Point_t(pt1); 
      check_and_raise(_pt1,_pt2);
    }

const Point_t & geoalgo::Line::Pt2 ( ) const

inherited

Direction getter.

Definition at line 25 of file GeoLine.cxx.

References geoalgo::Line::_pt2.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), and geoalgo::Line::~Line().

{ return _pt2; }

void geoalgo::Line::Pt2 ( const double  x, const double  y, const double  z  )

inherited

Pt2 setter.

Definition at line 35 of file GeoLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, geoalgo::Line::check_and_raise(), x, y, and z.

  { 
    _pt2[0] = x; 
    _pt2[1] = y; 
    _pt2[2] = z; 
    check_and_raise(_pt1,_pt2);
  }

template<class T >

void geoalgo::Line::Pt2 ( const T &  pt2 )

inlineinherited

Pt2 setter template.

Definition at line 83 of file GeoLine.h.

References geoalgo::Line::check_and_raise().

    { 
      _pt2 = Vector_t(pt2);
      check_and_raise(_pt1,_pt2);
    }

void geoalgo::Cylinder::SetRadius ( double  r )

inline

Setters.

Definition at line 54 of file GeoCylinder.h.

References _radius.

{ _radius = r; }

Member Data Documentation

GeoAlgo geoalgo::Cylinder::_geoAlgo

protected

Definition at line 61 of file GeoCylinder.h.

Referenced by Contain().

Point_t geoalgo::Line::_pt1

protectedinherited

First point denoting infinite line.

Definition at line 61 of file GeoLine.h.

Referenced by Contain(), geoalgo::DirectedLine::Dir(), geoalgo::DirectedLine::DirectedLine(), geoalgo::Line::Line(), geoalgo::Line::Pt1(), and geoalgo::Line::Pt2().

Vector_t geoalgo::Line::_pt2

protectedinherited

Second point denoting infinite line.

Definition at line 62 of file GeoLine.h.

Referenced by Contain(), geoalgo::DirectedLine::Dir(), geoalgo::DirectedLine::DirectedLine(), geoalgo::Line::Line(), geoalgo::Line::Pt1(), and geoalgo::Line::Pt2().

double geoalgo::Cylinder::_radius

protected

Radius of the cylinder.

Definition at line 58 of file GeoCylinder.h.

Referenced by Contain(), GetRadius(), and SetRadius().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/GeoAlgo/GeoCylinder.h
• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/GeoAlgo/GeoCylinder.cxx