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...
	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...
Public Member Functions inherited from geoalgo::Line
	Line ()
	Default constructor. More...
virtual	~Line ()
	Default destructor. More...
	Line (const double x1, const double y1, const double z1, const double x2, const double y2, const double z2)
	Alternative ctor (1) More...
	Line (const Point_t &pt1, const Point_t &pt2)
	Altenartive ctor (2) More...
const Point_t &	Pt1 () const
	Start getter. More...
const Point_t &	Pt2 () const
	Direction getter. More...
void	Pt1 (const double x, const double y, const double z)
	Pt1 setter. More...
void	Pt2 (const double x, const double y, const double z)
	Pt2 setter. More...
template<class T , class U >
	Line (const T &pt1, const U &pt2)
	Alternative ctor using template (3) More...
template<class T >
void	Pt1 (const T &pt1)
	Pt1 setter template. More...
template<class T >
void	Pt2 (const T &pt2)
	Pt2 setter template. More...
	Line ()
	Default constructor. More...
virtual	~Line ()
	Default destructor. More...
	Line (const double x1, const double y1, const double z1, const double x2, const double y2, const double z2)
	Alternative ctor (1) More...
	Line (const Point_t &pt1, const Point_t &pt2)
	Altenartive ctor (2) More...
const Point_t &	Pt1 () const
	Start getter. More...
const Point_t &	Pt2 () const
	Direction getter. More...
void	Pt1 (const double x, const double y, const double z)
	Pt1 setter. More...
void	Pt2 (const double x, const double y, const double z)
	Pt2 setter. More...
template<class T , class U >
	Line (const T &pt1, const U &pt2)
	Alternative ctor using template (3) More...
template<class T >
void	Pt1 (const T &pt1)
	Pt1 setter template. More...
template<class T >
void	Pt2 (const T &pt2)
	Pt2 setter template. More...

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

Additional Inherited Members
Protected Member Functions inherited from geoalgo::Line
void	check_and_raise (const Point_t &p1, const Point_t &p2) const
	Compatibility check. More...
void	check_and_raise (const Point_t &p1, const Point_t &p2) const
	Compatibility check. More...

Detailed Description

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

Representation of a 3D Cylinder volume. A Cylinder object inherits from a geoalgo::Line 2 points, which define the line representing the central axis of the cylinder a radius, defining the radius of the cylinder.

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 31 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.h.

Constructor & Destructor Documentation

geoalgo::Cylinder::Cylinder

(

)

Default constructor.

Definition at line 6 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.cxx.

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

virtual geoalgo::Cylinder::~Cylinder ( )

inlinevirtual

Default destructor.

Definition at line 39 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.h.

{};

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 11 of file larcorealg/larcorealg/GeoAlgo/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 18 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.cxx.

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

geoalgo::Cylinder::Cylinder

(

)

Default constructor.

virtual geoalgo::Cylinder::~Cylinder ( )

inlinevirtual

Default destructor.

Definition at line 37 of file sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCylinder.h.

{};

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)

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

Altenartive ctor (1)

Member Function Documentation

bool geoalgo::Cylinder::Contain

(

const Point_t &

pt

)

const

Containment evaluation.

Test if a point is contained within the box

bool geoalgo::Cylinder::Contain

(

const Point_t &

pt

)

const

Containment evaluation.

Test if a point is contained within the box

Definition at line 26 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.cxx.

                                                {

    // 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 51 of file sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCylinder.h.

{ return _radius; }

double geoalgo::Cylinder::GetRadius ( )

inline

Getters.

Definition at line 53 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.h.

{ return _radius; }

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

inline

Setters.

Definition at line 53 of file sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCylinder.h.

{ _radius = r; }

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

inline

Setters.

Definition at line 55 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.h.

{ _radius = r; }

Member Data Documentation

GeoAlgo geoalgo::Cylinder::_geoAlgo

protected

Definition at line 62 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.h.

double geoalgo::Cylinder::_radius

protected

Radius of the cylinder.

Definition at line 59 of file larcorealg/larcorealg/GeoAlgo/GeoCylinder.h.

---

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

• larcorealg/larcorealg/GeoAlgo/GeoCylinder.h
• sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCylinder.h
• larcorealg/larcorealg/GeoAlgo/GeoCylinder.cxx
• sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCylinder.cxx