geoalgo::Trajectory Class Reference

#include "GeoTrajectory.h"

Inheritance diagram for geoalgo::Trajectory:

Public Member Functions
	Trajectory (size_t npoints=0, size_t ndimension=0)
	Default ctor to specify # points and dimension of each point. More...
virtual	~Trajectory ()
	Default dtor. More...
	Trajectory (const std::vector< std::vector< double >> &obj)
	Alternative ctor (0) using a vector of mere vector point expression. More...
	Trajectory (const std::vector< geoalgo::Point_t > &obj)
	Alternative ctor (1) using a vector of point. More...
double	Length (size_t start_step=0, size_t end_step=0) const
	The summed-length along all trajectory points. More...
bool	IsLonger (double) const
	Check if the trajectory is longer than specified value. More...
Vector	Dir (size_t i=0) const
	The direction at a specified trajectory point. More...
void	push_back (const Point_t &obj)
	push_back overrie w/ dimensionality check More...
Trajectory &	operator+= (const Point_t &rhs)
void	compat (const Point_t &obj) const
	Dimensionality check function w/ Trajectory. More...
void	compat (const Trajectory &obj) const
	Dimensionality check function w/ Point_t. More...
template<class T >
void	push_back (const T &obj)
	push_back template More...

Public Attributes
T	elements
	STL member. More...

Protected Member Functions
Vector	_Dir_ (size_t i) const
	Returns a direction vector at a specified trajectory point w/o size check. More...

Friends
std::ostream &	operator<< (std::ostream &o, Trajectory const &a)
	Streamer. More...

Detailed Description

This class represents a trajectory which is an ordered list of Point. It is a friend class w/ geoalgo::Point_t hence it has an access to protected functions that avoids dimensionality sanity checks for speed.

Definition at line 31 of file GeoTrajectory.h.

Constructor & Destructor Documentation

geoalgo::Trajectory::Trajectory	(	size_t	npoints = 0,
		size_t	ndimension = 0
	)

Default ctor to specify # points and dimension of each point.

Definition at line 8 of file GeoTrajectory.cxx.

Referenced by ~Trajectory().

    : std::vector<geoalgo::Point_t>(npoints, Point_t(ndimension))
  {}

virtual geoalgo::Trajectory::~Trajectory ( )

inlinevirtual

Default dtor.

Definition at line 38 of file GeoTrajectory.h.

References Dir(), IsLonger(), Length(), push_back(), Trajectory(), and lar::dump::vector().

{}

geoalgo::Trajectory::Trajectory

(

const std::vector< std::vector< double >> &

obj

)

Alternative ctor (0) using a vector of mere vector point expression.

Definition at line 12 of file GeoTrajectory.cxx.

References push_back().

  {
    this->reserve(obj.size());
    for (auto const& p : obj)
      this->push_back(Point_t(p));
  }

geoalgo::Trajectory::Trajectory

(

const std::vector< geoalgo::Point_t > &

obj

)

Alternative ctor (1) using a vector of point.

Definition at line 19 of file GeoTrajectory.cxx.

References push_back().

  {
    this->reserve(obj.size());
    for (auto const& p : obj)
      this->push_back(p);
  }

Member Function Documentation

Vector geoalgo::Trajectory::_Dir_ ( size_t  i ) const

protected

Returns a direction vector at a specified trajectory point w/o size check.

Definition at line 110 of file GeoTrajectory.cxx.

Referenced by Dir(), and operator+=().

  {
    return ((*this)[i + 1] - (*this)[i]);
  }

void geoalgo::Trajectory::compat

(

const Point_t &

obj

)

const

Dimensionality check function w/ Trajectory.

Definition at line 70 of file GeoTrajectory.cxx.

References util::begin(), and util::size().

Referenced by geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::GeoAlgo::Intersection(), operator+=(), push_back(), and geoalgo::GeoAlgo::SqDist().

  {

    if (!size()) return;
    if ((*(this->begin())).size() != obj.size()) {

      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " size mismatch: " << (*(this->begin())).size() << " != " << obj.size() << std::endl;
      throw GeoAlgoException(msg.str());
    }
  }

void geoalgo::Trajectory::compat

(

const Trajectory &

obj

)

const

Dimensionality check function w/ Point_t.

Definition at line 83 of file GeoTrajectory.cxx.

References util::begin(), and util::size().

  {

    if (!size() || !(obj.size())) return;

    if ((*(this->begin())).size() != (*obj.begin()).size()) {

      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " size mismatch: " << (*(this->begin())).size() << " != " << (*obj.begin()).size()
          << std::endl;
      throw GeoAlgoException(msg.str());
    }
  }

Vector geoalgo::Trajectory::Dir

(

size_t

i = 0

)

const

The direction at a specified trajectory point.

Definition at line 98 of file GeoTrajectory.cxx.

References _Dir_(), and util::size().

Referenced by ~Trajectory().

  {

    if (size() < (i + 2)) {
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " length=" << size() << " is too short to find a direction @ index=" << i << std::endl;
      throw GeoAlgoException(msg.str());
    }
    return _Dir_(i);
  }

bool geoalgo::Trajectory::IsLonger

(

double

ref

)

const

Check if the trajectory is longer than specified value.

Definition at line 48 of file GeoTrajectory.cxx.

References util::size().

Referenced by ~Trajectory().

  {

    if (size() < 2) return false;

    double length = 0;
    for (size_t i = 0; i < size() - 1; ++i) {

      length += (*this)[i]._Dist_((*this)[i + 1]);

      if (length > ref) return true;
    }

    return false;
  }

double geoalgo::Trajectory::Length	(	size_t	start_step = 0,
		size_t	end_step = 0
	)		const

The summed-length along all trajectory points.

Definition at line 26 of file GeoTrajectory.cxx.

References util::size().

Referenced by ~Trajectory().

  {

    if (end_step == 0)
      end_step = size() - 1; // By default end_step is 0. Then consider the whole trajectory()

    // Sanity checks
    if (start_step >= end_step) throw GeoAlgoException("Cannot have start step >= end step!");

    if (end_step >= size()) throw GeoAlgoException("Requested step index bigger than size!");

    // if length < 2, no length
    if (size() < 2) return 0;

    double length = 0;
    for (size_t i = start_step; i < end_step; ++i)

      length += (*this)[i]._Dist_((*this)[i + 1]);

    return length;
  }

Trajectory& geoalgo::Trajectory::operator+= ( const Point_t &  rhs )

inline

Definition at line 59 of file GeoTrajectory.h.

References _Dir_(), compat(), and push_back().

    {
      push_back(rhs);
      return *this;
    }

void geoalgo::Trajectory::push_back

(

const Point_t &

obj

)

push_back overrie w/ dimensionality check

Definition at line 64 of file GeoTrajectory.cxx.

References compat(), and util::size().

Referenced by operator+=(), push_back(), Trajectory(), and ~Trajectory().

  {
    compat(obj);
    if (!(size() && obj == (*rbegin()))) std::vector<geoalgo::Point_t>::push_back(obj);
  }

template<class T >

void geoalgo::Trajectory::push_back ( const T &  obj )

inline

push_back template

Definition at line 81 of file GeoTrajectory.h.

References pt, and push_back().

    {
      Point_t pt(obj);
      push_back(pt);
    }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, Trajectory const &  a  )

friend

Streamer.

Definition at line 90 of file GeoTrajectory.h.

    {
      o << "Trajectory with " << a.size() << " points " << std::endl;
      for (auto const& p : a)
        o << " " << p << std::endl;
      return o;
    }

Member Data Documentation

T std::vector< T >::elements

inherited

STL member.

---

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

• larcorealg/v09_13_01/source/larcorealg/GeoAlgo/GeoTrajectory.h
• larcorealg/v09_13_01/source/larcorealg/GeoAlgo/GeoTrajectory.cxx