Edge is an object containing the results of a Principal Components Analysis of a group of space points. More...

#include "Edge.h"

Public Types
using	ID_t = unsigned int
	Type to represent `recob::Edge` IDs. More...

using	SpacePointID_t = recob::SpacePoint::ID_t
	Type to represent `recob::SpacePoint` IDs. More...

Public Member Functions
	Edge ()=default
	Default constructor (all invalid IDs). More...

	Edge (const double length, SpacePointID_t firstPointID, SpacePointID_t secondPointID, ID_t id=InvalidID)
	Constructor: assigns all values. More...

	Edge (SpacePoint const &firstPoint, SpacePoint const &secondPoint, ID_t id=InvalidID)
	Constructor: uses the specified spacepoints. More...

Access
double	Length () const
	Returns the length of this edge [cm]. More...

SpacePointID_t	FirstPointID () const
	Returns the ID of the SpacePoint this edge emanates from. More...

SpacePointID_t	SecondPointID () const
	Returns the ID of the SpacePoint this edge ends on. More...

ID_t	ID () const
	Returns the ID of this edge. More...

Static Public Attributes
static constexpr ID_t	InvalidID = std::numeric_limits<ID_t>::max()
	Special value for an invalid edge ID. More...

Private Attributes
double	fLength = 0.0
	Length of this Edge [cm]. More...

SpacePointID_t	fFirstPointID = recob::SpacePoint::InvalidID
	ID of the SpacePoint edge emanates from. More...

SpacePointID_t	fSecondPointID = recob::SpacePoint::InvalidID
	ID of the SpacePoint edge ends on. More...

ID_t	fID = InvalidID
	Edge ID. More...

Detailed Description

Edge is an object containing the results of a Principal Components Analysis of a group of space points.

The edge contains references to an emanating space point (FirstPointID()) and to an ending one (SecondPointID()). For convenience, it also stores the distance between those points.

To look up for a referenced space point, the easiest way is to start from a sorted list of space points (recob::SpacePoint sorts by ID value):

if (!std::is_sorted(points.begin(), points.end()))
  throw std::runtime_error("Space points not sorted!");
// find the first space point
auto const iFirstPoint = std::lower_bound
  (points.begin(), points.end(), edge.FirstPointID());
if ((iFirstPoint == points.end()) || (iFirstPoint->ID() != edge.FirstPointID())) {
  throw std::runtime_error
    ("First point not found: ID=" + std::to_string(edge.FirstPointID()));
}
recob::SpacePoint const& firstPoint = *iFirstPoint;
// find the second space point
auto const iSecondPoint = std::lower_bound
  (points.begin(), points.end(), edge.SecondPointID());
if ((iSecondPoint == points.end()) || (iSecondPoint->ID() != edge.SecondPointID())) {
  throw std::runtime_error
    ("Second point not found: ID=" + std::to_string(edge.SecondPointID()));
}
recob::SpacePoint const& secondPoint = *iSecondPoint;

Definition at line 59 of file Edge.h.

Member Typedef Documentation

using recob::Edge::ID_t = unsigned int

Type to represent recob::Edge IDs.

Definition at line 62 of file Edge.h.

using recob::Edge::SpacePointID_t = recob::SpacePoint::ID_t

Type to represent recob::SpacePoint IDs.

Definition at line 65 of file Edge.h.

Constructor & Destructor Documentation

recob::Edge::Edge ( )

default

Default constructor (all invalid IDs).

recob::Edge::Edge	(	const double	length,
		SpacePointID_t	firstPointID,
		SpacePointID_t	secondPointID,
		ID_t	id = `InvalidID`
	)

Constructor: assigns all values.

Parameters

length	the length of the edge [cm]
firstPointID	ID of the emanating space point
secondPointID	ID of the ending space point
id	_(default: `InvalidID`) ID of this edge

Definition at line 35 of file Edge.cxx.

39 : fLength(length), fFirstPointID(firstPointID), fSecondPointID(secondPointID), fID(id)

40 {}

recob::Edge::fLength

double fLength

Length of this Edge [cm].

Definition: Edge.h:114

recob::Edge::fSecondPointID

SpacePointID_t fSecondPointID

ID of the SpacePoint edge ends on.

Definition: Edge.h:118

recob::Edge::fFirstPointID

SpacePointID_t fFirstPointID

ID of the SpacePoint edge emanates from.

Definition: Edge.h:116

recob::Edge::fID

ID_t fID

Edge ID.

Definition: Edge.h:120

recob::Edge::Edge	(	SpacePoint const &	firstPoint,
		SpacePoint const &	secondPoint,
		ID_t	id = `InvalidID`
	)

Constructor: uses the specified spacepoints.

Parameters

firstPoint	the emanating space point
secondPoint	the ending space point
id	_(default: `InvalidID`) ID of this edge

Definition at line 43 of file Edge.cxx.

     : fLength(::spacePointDistance(firstPoint, secondPoint))
     , fFirstPointID(firstPoint.ID())
     , fSecondPointID(secondPoint.ID())
     , fID(id)
   {}