LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
trkf::HitState Class Reference

Class for a measurement on a recob::tracking::Plane (plane defined by a wire and the drift direction). More...

#include "TrackState.h"

Public Member Functions

 HitState (double hitMeas, double hitMeasErr2, geo::WireID const &wireId, const geo::WireGeo &wgeom)
 
 HitState (double hitMeas, double hitMeasErr2, geo::WireID &&wireId, const geo::WireGeo &wgeom)
 
double hitMeas () const
 
double hitMeasErr2 () const
 
const Planeplane () const
 
const geo::WireIDwireId () const
 
std::ostream & dump (std::ostream &out=std::cout) const
 

Private Attributes

double fHitMeas
 
double fHitMeasErr2
 
const geo::WireID fWireId
 
Plane fPlane
 

Detailed Description

Class for a measurement on a recob::tracking::Plane (plane defined by a wire and the drift direction).

Author
G. Cerati (FNAL, MicroBooNE)
Date
2017
Version
1.0

This class collects the measurement information from a Hit on wire. The information are the measured (1D) position, its error, and the measurement plane (defined by the wire and the drift direction)

Definition at line 42 of file TrackState.h.

Constructor & Destructor Documentation

trkf::HitState::HitState ( double  hitMeas,
double  hitMeasErr2,
geo::WireID const &  wireId,
const geo::WireGeo wgeom 
)
inline

Definition at line 44 of file TrackState.h.

48  : fHitMeas(hitMeas)
50  , fWireId(wireId)
52  {}
double fHitMeas
Definition: TrackState.h:73
const geo::WireID & wireId() const
Definition: TrackState.h:62
double hitMeas() const
Definition: TrackState.h:59
double hitMeasErr2() const
Definition: TrackState.h:60
double fHitMeasErr2
Definition: TrackState.h:74
Plane makePlane(recob::tracking::Point_t const &pos, recob::tracking::Vector_t const &dir)
helper function to construct a recob::tracking::Plane from a Point_t and a Vector_t; the point is on ...
const geo::WireID fWireId
Definition: TrackState.h:75
trkf::HitState::HitState ( double  hitMeas,
double  hitMeasErr2,
geo::WireID &&  wireId,
const geo::WireGeo wgeom 
)
inline

Definition at line 53 of file TrackState.h.

54  : fHitMeas(hitMeas)
56  , fWireId(std::move(wireId))
58  {}
double fHitMeas
Definition: TrackState.h:73
double hitMeas() const
Definition: TrackState.h:59
double hitMeasErr2() const
Definition: TrackState.h:60
double fHitMeasErr2
Definition: TrackState.h:74
Plane makePlane(recob::tracking::Point_t const &pos, recob::tracking::Vector_t const &dir)
helper function to construct a recob::tracking::Plane from a Point_t and a Vector_t; the point is on ...
const geo::WireID fWireId
Definition: TrackState.h:75

Member Function Documentation

std::ostream& trkf::HitState::dump ( std::ostream &  out = std::cout) const
inline

Definition at line 63 of file TrackState.h.

References recob::tracking::Plane::direction(), hitMeas(), hitMeasErr2(), plane(), geo::PlaneID::Plane, recob::tracking::Plane::position(), geo::WireID::Wire, and wireId().

64  {
65  out << "HitState with meas=" << hitMeas() << " err2=" << hitMeasErr2()
66  << " plane=" << wireId().Plane << " wire=" << wireId().Wire
67  << " on plane with pos=" << plane().position() << " and dir=" << plane().direction()
68  << "\n";
69  return out;
70  }
Vector_t const & direction() const
Reference direction orthogonal to the plane.
Definition: TrackingPlane.h:70
const geo::WireID & wireId() const
Definition: TrackState.h:62
double hitMeas() const
Definition: TrackState.h:59
WireID_t Wire
Index of the wire within its plane.
Definition: geo_types.h:563
double hitMeasErr2() const
Definition: TrackState.h:60
const Plane & plane() const
Definition: TrackState.h:61
Point_t const & position() const
Reference position on the plane.
Definition: TrackingPlane.h:66
PlaneID_t Plane
Index of the plane within its TPC.
Definition: geo_types.h:481
double trkf::HitState::hitMeas ( ) const
inline

Definition at line 59 of file TrackState.h.

References fHitMeas.

Referenced by dump(), trkf::TrackState::residual(), and trkf::KFTrackState::updateWithHitState().

59 { return fHitMeas; }
double fHitMeas
Definition: TrackState.h:73
double trkf::HitState::hitMeasErr2 ( ) const
inline

Definition at line 60 of file TrackState.h.

References fHitMeasErr2.

Referenced by trkf::TrackState::combinedError2(), dump(), and trkf::KFTrackState::updateWithHitState().

60 { return fHitMeasErr2; }
double fHitMeasErr2
Definition: TrackState.h:74
const Plane& trkf::HitState::plane ( ) const
inline

Definition at line 61 of file TrackState.h.

References fPlane.

Referenced by dump(), trkf::TrackState::dump(), and trkf::KFTrackState::updateWithHitState().

61 { return fPlane; }
const geo::WireID& trkf::HitState::wireId ( ) const
inline

Definition at line 62 of file TrackState.h.

References fWireId.

Referenced by dump().

62 { return fWireId; }
const geo::WireID fWireId
Definition: TrackState.h:75

Member Data Documentation

double trkf::HitState::fHitMeas
private

Definition at line 73 of file TrackState.h.

Referenced by hitMeas().

double trkf::HitState::fHitMeasErr2
private

Definition at line 74 of file TrackState.h.

Referenced by hitMeasErr2().

const geo::WireID trkf::HitState::fWireId
private

Definition at line 75 of file TrackState.h.

Referenced by wireId().


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