geoalgo::Cone Class Reference

Representation of a 3D semi-infinite line. Defines a 3D cone with the following properties:
Start point (or vertex), Direction, Length (or Length), Radius, opening angle
When 2 of Length, Radius, opening angle are defined the third is automatically set. More...

#include <GeoCone.h>

Inheritance diagram for geoalgo::Cone:

Public Member Functions
	Cone ()
	Default constructor. More...
virtual	~Cone ()
	Default destructor. More...
	Cone (const double x, const double y, const double z, const double dirx, const double diry, const double dirz, const double length, const double radius)
	Alternative ctor (1) More...
	Cone (const Point_t &start, const Vector_t &dir, const double length, const double radius)
	Alternative ctor (2) More...
double	Length () const
	Length getter. More...
double	Radius () const
	Length getter. More...
double	Angle () const
	Angle getter. More...
void	Length (const double l)
	Length setter. More...
void	Radius (const double r)
	Radius setter. More...
template<class T , class U >
	Cone (const T &start, const U &dir)
	Alternative ctor using template (3) More...
	Cone ()
	Default constructor. More...
virtual	~Cone ()
	Default destructor. More...
	Cone (const double x, const double y, const double z, const double dirx, const double diry, const double dirz, const double length, const double radius)
	Alternative ctor (1) More...
	Cone (const Point_t &start, const Vector_t &dir, const double length, const double radius)
	Alternative ctor (2) More...
double	Length () const
	Length getter. More...
double	Radius () const
	Length getter. More...
double	Angle () const
	Angle getter. More...
void	Length (const double l)
	Length setter. More...
void	Radius (const double r)
	Radius setter. More...
template<class T , class U >
	Cone (const T &start, const U &dir)
	Alternative ctor using template (3) More...
Public Member Functions inherited from geoalgo::HalfLine
	HalfLine ()
	Default constructor. More...
virtual	~HalfLine ()
	Default destructor. More...
	HalfLine (const double x, const double y, const double z, const double dirx, const double diry, const double dirz)
	Alternative ctor (1) More...
	HalfLine (const Point_t &start, const Vector_t &dir)
	Altenartive ctor (2) More...
const Point_t &	Start () const
	Start getter. More...
const Vector_t &	Dir () const
	Direction getter. More...
void	Start (const double x, const double y, const double z)
	Start setter. More...
void	Dir (const double x, const double y, const double z)
	Dir setter. More...
void	Start (const TVector3 &pt)
	Start setter. More...
void	Dir (const TVector3 &dir)
	Dir setter. More...
template<class T , class U >
	HalfLine (const T &start, const U &dir)
	Alternative ctor using template (3) More...
template<class T >
void	Start (const T &pos)
	Start setter template. More...
template<class T >
void	Dir (const T &dir)
	Dir setter template. More...
	HalfLine ()
	Default constructor. More...
virtual	~HalfLine ()
	Default destructor. More...
	HalfLine (const double x, const double y, const double z, const double dirx, const double diry, const double dirz)
	Alternative ctor (1) More...
	HalfLine (const Point_t &start, const Vector_t &dir)
	Altenartive ctor (2) More...
const Point_t &	Start () const
	Start getter. More...
const Vector_t &	Dir () const
	Direction getter. More...
void	Start (const double x, const double y, const double z)
	Start setter. More...
void	Dir (const double x, const double y, const double z)
	Dir setter. More...
void	Start (const TVector3 &pt)
	Start setter. More...
void	Dir (const TVector3 &dir)
	Dir setter. More...
template<class T , class U >
	HalfLine (const T &start, const U &dir)
	Alternative ctor using template (3) More...
template<class T >
void	Start (const T &pos)
	Start setter template. More...
template<class T >
void	Dir (const T &dir)
	Dir setter template. More...

Protected Attributes
double	_length
	Helight (length) of the cone. More...
double	_radius
	Radius of the cone at the base. More...
double	_angle
	Opening Angle. More...
Protected Attributes inherited from geoalgo::HalfLine
Point_t	_start
	Beginning of the half line. More...
Vector_t	_dir
	Direction of the half line from _start. More...

Additional Inherited Members
Protected Member Functions inherited from geoalgo::HalfLine
void	Normalize ()
	Normalize direction. More...
void	Normalize ()
	Normalize direction. More...

Detailed Description

Representation of a 3D semi-infinite line. Defines a 3D cone with the following properties:
Start point (or vertex), Direction, Length (or Length), Radius, opening angle
When 2 of Length, Radius, opening angle are defined the third is automatically set.

Definition at line 27 of file larcorealg/larcorealg/GeoAlgo/GeoCone.h.

Constructor & Destructor Documentation

geoalgo::Cone::Cone

(

)

Default constructor.

Definition at line 9 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

             : HalfLine()
  {
    _length = 1;
    _radius = 1;
    _angle = atan(_radius/_length);
  }

virtual geoalgo::Cone::~Cone ( )

inlinevirtual

Default destructor.

Definition at line 35 of file larcorealg/larcorealg/GeoAlgo/GeoCone.h.

{};

geoalgo::Cone::Cone	(	const double	x,
		const double	y,
		const double	z,
		const double	dirx,
		const double	diry,
		const double	dirz,
		const double	length,
		const double	radius
	)

Alternative ctor (1)

Definition at line 16 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

    : HalfLine(x, y, z, dirx, diry, dirz)
  {
    if (length == 0){
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " Cone Length cannot be 0." << std::endl;
      throw GeoAlgoException(msg.str());
    }
    _length = length;
    _radius = radius;
    _angle = atan(_radius/_length);
  }

geoalgo::Cone::Cone	(	const Point_t &	start,
		const Vector_t &	dir,
		const double	length,
		const double	radius
	)

Alternative ctor (2)

Definition at line 32 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

    : HalfLine( start,  dir )
  {
    if (length == 0){
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " Cone Length cannot be 0." << std::endl;
      throw GeoAlgoException(msg.str());
    }
    _length = length;
    _radius = radius;
    _angle  = atan(_radius/_length);
  }

template<class T , class U >

geoalgo::Cone::Cone ( const T &  start, const U &  dir  )

inline

Alternative ctor using template (3)

Definition at line 70 of file larcorealg/larcorealg/GeoAlgo/GeoCone.h.

      : Cone(Point_t(start), Vector_t(dir))
    {}

geoalgo::Cone::Cone

(

)

Default constructor.

virtual geoalgo::Cone::~Cone ( )

inlinevirtual

Default destructor.

Definition at line 35 of file sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCone.h.

{};

geoalgo::Cone::Cone	(	const double	x,
		const double	y,
		const double	z,
		const double	dirx,
		const double	diry,
		const double	dirz,
		const double	length,
		const double	radius
	)

Alternative ctor (1)

geoalgo::Cone::Cone	(	const Point_t &	start,
		const Vector_t &	dir,
		const double	length,
		const double	radius
	)

Alternative ctor (2)

template<class T , class U >

geoalgo::Cone::Cone ( const T &  start, const U &  dir  )

inline

Alternative ctor using template (3)

Definition at line 70 of file sbncode/sbncode/OpT0Finder/flashmatch/GeoAlgo/GeoCone.h.

      : Cone(Point_t(start), Vector_t(dir))
    {}

Member Function Documentation

double geoalgo::Cone::Angle

(

)

const

Angle getter.

Definition at line 51 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

{ return _angle; }

double geoalgo::Cone::Angle

(

)

const

Angle getter.

double geoalgo::Cone::Length

(

)

const

Length getter.

Definition at line 47 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

{ return _length; }

double geoalgo::Cone::Length

(

)

const

Length getter.

void geoalgo::Cone::Length

(

const double

l

)

Length setter.

Definition at line 53 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

  {
    if (l == 0){
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " Cone Length cannot be 0." << std::endl;
      throw GeoAlgoException(msg.str());
    }
    _length = l;
    _angle = atan(_radius/_length);
  }

void geoalgo::Cone::Length

(

const double

l

)

Length setter.

double geoalgo::Cone::Radius

(

)

const

Length getter.

double geoalgo::Cone::Radius

(

)

const

Length getter.

Definition at line 49 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

{ return _radius; }

void geoalgo::Cone::Radius

(

const double

r

)

Radius setter.

void geoalgo::Cone::Radius

(

const double

r

)

Radius setter.

Definition at line 65 of file larcorealg/larcorealg/GeoAlgo/GeoCone.cxx.

{ _radius = r; _angle = atan(_radius/_length); }

Member Data Documentation

double geoalgo::Cone::_angle

protected

Opening Angle.

Definition at line 63 of file larcorealg/larcorealg/GeoAlgo/GeoCone.h.

double geoalgo::Cone::_length

protected

Helight (length) of the cone.

Definition at line 61 of file larcorealg/larcorealg/GeoAlgo/GeoCone.h.

double geoalgo::Cone::_radius

protected

Radius of the cone at the base.

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

---

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

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