trkf::KHitGroup Class Reference

#include <KHitGroup.h>

Public Member Functions
	KHitGroup (bool has_path=false, double path=0.)
	Default constructor. More...
virtual	~KHitGroup ()
	Destructor. More...
const std::shared_ptr< const Surface > &	getSurface () const
	Surface accessor. More...
int	getPlane () const
	Plane index. More...
const std::vector< std::shared_ptr< const KHitBase > > &	getHits () const
	Measurement collection accessor. More...
bool	getHasPath () const
	Path flag. More...
double	getPath () const
	Estimated path distance. More...
void	clear ()
	Clear the collection. More...
void	addHit (const std::shared_ptr< const KHitBase > &hit)
	Add a mesaurement into the colleciton. More...
void	setPath (bool has_path, double path)
	Set path flag and estimated path distance. More...
bool	operator== (const KHitGroup &obj) const
	Equivalance operator. More...
bool	operator< (const KHitGroup &obj) const
	Less than operator. More...

Private Attributes
std::shared_ptr< const Surface >	fSurf
	Common surface. More...
int	fPlane
	Plane index of measurements. More...
std::vector< std::shared_ptr< const KHitBase > >	fHits
	Measuement collection. More...
bool	fHasPath
	Path flag. More...
double	fPath
	Estimated path distance. More...

Detailed Description

Definition at line 37 of file KHitGroup.h.

Constructor & Destructor Documentation

trkf::KHitGroup::KHitGroup	(	bool	has_path = false,
		double	path = 0.
	)

Default constructor.

Default Constructor.

Arguments:

has_path - Path flag (optional). path - Estimated path distance (optional).

Definition at line 23 of file KHitGroup.cxx.

                                                 :
    fPlane(-1),
    fHasPath(has_path),
    fPath(path)
  {}

trkf::KHitGroup::~KHitGroup ( )

virtual

Destructor.

Definition at line 30 of file KHitGroup.cxx.

  {}

Member Function Documentation

void trkf::KHitGroup::addHit

(

const std::shared_ptr< const KHitBase > &

hit

)

Add a mesaurement into the colleciton.

Add a mesaurement into the colleciton.

Arguments:

hit - Measurement to add.

Definition at line 39 of file KHitGroup.cxx.

  {
    // Make sure that the measurement pointer is not null (throw exception if null).

    if(hit.get() == 0)
      throw cet::exception("KHitGroup") << "Attempt to add null measurement.\n";

    // If the stored common surface pointer has not yet been initialized,
    // initialize it now.
    // Otherwise, make sure that the new measurement surface matches
    // the common surface (pointer to same surface object).
    // Throw exception if the new surface doesn't match.

    if(hit->getMeasPlane() < 0)
      throw cet::exception("KHitGroup") << __func__ << ": invalid hit plane " << hit->getMeasPlane() << "\n";

    if(fSurf.get() == 0) {
      fSurf = hit->getMeasSurface();
      fPlane = hit->getMeasPlane();
    }
    else {
      if(fSurf.get() != hit->getMeasSurface().get())
        throw cet::exception("KHitGroup") << "Attempt to add non-matching measurement.\n";
      if(hit->getMeasPlane() != fPlane) {
        throw cet::exception("KHitGroup") << __func__ << ": hit plane mismatch, "
          << hit->getMeasPlane() << " vs. " << fPlane << "\n";
      }
      if (fPlane < 0)
        throw cet::exception("KHitGroup") << __func__ << ": invalid plane " << fPlane << "\n";
    }

    // Everything OK.  Add the measurement.

    fHits.push_back(hit);
  }

void trkf::KHitGroup::clear ( )

inline

Clear the collection.

Definition at line 67 of file KHitGroup.h.

{fHits.clear();}

bool trkf::KHitGroup::getHasPath ( ) const

inline

Path flag.

Definition at line 59 of file KHitGroup.h.

{return fHasPath;}

const std::vector<std::shared_ptr<const KHitBase> >& trkf::KHitGroup::getHits ( ) const

inline

Measurement collection accessor.

Definition at line 56 of file KHitGroup.h.

{return fHits;}

double trkf::KHitGroup::getPath ( ) const

inline

Estimated path distance.

Definition at line 62 of file KHitGroup.h.

{return fPath;}

int trkf::KHitGroup::getPlane ( ) const

inline

Plane index.

Definition at line 53 of file KHitGroup.h.

{return fPlane;}

const std::shared_ptr<const Surface>& trkf::KHitGroup::getSurface ( ) const

inline

Surface accessor.

Definition at line 50 of file KHitGroup.h.

{return fSurf;}

bool trkf::KHitGroup::operator<

(

const KHitGroup &

obj

)

const

Less than operator.

Less than operator.

Objects with path flag false compare equal (return false). Objects with path flag true compare according to estimated path distance. Objects with path flag false are not comparable to objects with path flag true (throw exception).

Arguments:

g - Comparison object.

Returned value: True if less than.

Definition at line 107 of file KHitGroup.cxx.

  {
    bool result = false;
    if(fHasPath != obj.fHasPath)
      throw cet::exception("KHitGroup") << "Attempt to compare incomparable objects.\n";
    if(fHasPath)
      result = fPath < obj.fPath;
    return result;
  }

bool trkf::KHitGroup::operator==

(

const KHitGroup &

obj

)

const

Equivalance operator.

Equivalance operator.

Objects with path flag false compare equal. Objects with path flag true compare according to estimated path distance.

Arguments:

g - Comparison object.

Returned value: True if equal.

Definition at line 86 of file KHitGroup.cxx.

  {
    bool result =
      (!fHasPath && !obj.fHasPath) ||
      (fHasPath && obj.fHasPath && fPath == obj.fPath);
    return result;
  }

void trkf::KHitGroup::setPath ( bool  has_path, double  path  )

inline

Set path flag and estimated path distance.

Definition at line 73 of file KHitGroup.h.

{fHasPath = has_path; fPath = path;}

Member Data Documentation

bool trkf::KHitGroup::fHasPath

private

Path flag.

Definition at line 87 of file KHitGroup.h.

std::vector<std::shared_ptr<const KHitBase> > trkf::KHitGroup::fHits

private

Measuement collection.

Definition at line 86 of file KHitGroup.h.

double trkf::KHitGroup::fPath

private

Estimated path distance.

Definition at line 88 of file KHitGroup.h.

int trkf::KHitGroup::fPlane

private

Plane index of measurements.

Definition at line 85 of file KHitGroup.h.

std::shared_ptr<const Surface> trkf::KHitGroup::fSurf

private

Common surface.

Definition at line 84 of file KHitGroup.h.

---

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

• lardata/lardata/RecoObjects/KHitGroup.h
• lardata/lardata/RecoObjects/KHitGroup.cxx