trkf::KHitWireX Class Reference

#include <KHitWireX.h>

Inheritance diagram for trkf::KHitWireX:

Public Member Functions
	KHitWireX (const detinfo::DetectorPropertiesData &detProp, const art::Ptr< recob::Hit > &hit, const std::shared_ptr< const Surface > &psurf)
	Constructor from Hit. More...
	KHitWireX (const geo::WireID &wireid, double x, double xerr)
	Constructor from wire id (mainly for testing). More...
const art::Ptr< recob::Hit > &	getHit () const
	Get original hit. More...
bool	subpredict (const KETrack &tre, KVector< 1 >::type &pvec, KSymMatrix< 1 >::type &perr, KHMatrix< 1 >::type &hmatrix) const override
Public Member Functions inherited from trkf::KHit< 1 >
	KHit ()
	Default constructor. More...
	KHit (const std::shared_ptr< const Surface > &psurf)
	Initializing Constructor – surface only. More...
	KHit (const std::shared_ptr< const Surface > &psurf, const typename KVector< N >::type &mvec, const typename KSymMatrix< N >::type &merr)
	Fully Initializing Constructor. More...
virtual	~KHit ()
	Destructor. More...
void	setMeasVector (const typename KVector< N >::type &mvec)
	Set measurement vector. More...
void	setMeasError (const typename KSymMatrix< N >::type &merr)
	Set measurement error. More...
const KVector< N >::type &	getMeasVector () const
	Measurement vector. More...
const KSymMatrix< N >::type &	getMeasError () const
	Measurement error matrix. More...
const KVector< N >::type &	getPredVector () const
	Prediction vector. More...
const KSymMatrix< N >::type &	getPredError () const
	Prediction matrix. More...
const KVector< N >::type &	getResVector () const
	Residual vector. More...
const KSymMatrix< N >::type &	getResError () const
	Residual error matrix. More...
const KSymMatrix< N >::type &	getResInvError () const
	Residual inv. error matrix. More...
const KHMatrix< N >::type &	getH () const
	Kalman H-matrix. More...
double	getChisq () const
	Incremental chisquare. More...
bool	predict (const KETrack &tre, const Propagator &prop, const KTrack *ref=0) const
	Prediction method (return false if fail). More...
void	update (KETrack &tre) const
	Update track method. More...
virtual bool	subpredict (const KETrack &tre, typename KVector< N >::type &pvec, typename KSymMatrix< N >::type &perr, typename KHMatrix< N >::type &hmatrix) const =0
	Calculate prediction function (return via arguments). More...
virtual std::ostream &	Print (std::ostream &out, bool doTitle=true) const
	Printout. More...
Public Member Functions inherited from trkf::KHitBase
	KHitBase ()
	Default constructor. More...
	KHitBase (const std::shared_ptr< const Surface > &psurf, int plane=-1)
	Initializing Constructor. More...
virtual	~KHitBase ()=default
	Destructor. More...
const std::shared_ptr< const Surface > &	getPredSurface () const
	Predition surface. More...
double	getPredDistance () const
	Prediction distance. More...
const std::shared_ptr< const Surface > &	getMeasSurface () const
	Measurement surface. More...
int	getMeasPlane () const
	Measurement plane index. More...
int	getID () const
	Unique id. More...
void	setMeasSurface (const std::shared_ptr< const Surface > &psurf)
	Measurement surface. More...
void	setMeasPlane (int plane)
	Measurement plane. More...

Private Attributes
art::Ptr< recob::Hit >	fHit

Additional Inherited Members
Protected Attributes inherited from trkf::KHitBase
std::shared_ptr< const Surface >	fPredSurf
	Prediction surface. More...
double	fPredDist
	Prediction distance. More...
int	fID
	Unique id. More...

Detailed Description

Definition at line 34 of file KHitWireX.h.

Constructor & Destructor Documentation

trkf::KHitWireX::KHitWireX	(	const detinfo::DetectorPropertiesData &	detProp,
		const art::Ptr< recob::Hit > &	hit,
		const std::shared_ptr< const Surface > &	psurf
	)

Constructor from Hit.

Constructor.

Arguments:

hit - Hit. psurf - Measurement surface (can be null).

The measurement surface is only a suggestion. It is allowed to be specified to allow measurements to whare surfaces to save memory.

Definition at line 30 of file KHitWireX.cxx.

    : KHit(psurf), fHit(hit)
  {
    // Extract wire id.
    geo::WireID wireid = hit->WireID();

    // Check the surface (determined by wire id).  If the
    // surface pointer is null, make a new SurfWireX surface and
    // update the base class appropriately.  Otherwise, just check
    // that the specified surface agrees with the wire id.

    if (psurf.get() == 0) {
      std::shared_ptr<const Surface> new_psurf(new SurfWireX(wireid));
      setMeasSurface(new_psurf);
    }
    else {
      SurfWireX check_surf(wireid);
      if (!check_surf.isEqual(*psurf))
        throw cet::exception("KHitWireX") << "Measurement surface doesn't match wire id.\n";
    }

    setMeasPlane(hit->WireID().Plane);

    // Extract time information from hit.

    double t = hit->PeakTime();
    double terr = hit->RMS(); // hit->SigmaPeakTime();

    // Don't let the time error be less than 1./sqrt(12.) ticks.
    // This should be removed when hit errors are fixed.

    if (terr < 1. / std::sqrt(12.)) terr = 1. / std::sqrt(12.);

    // Calculate position and error.

    double x =
      detProp.ConvertTicksToX(t, hit->WireID().Plane, hit->WireID().TPC, hit->WireID().Cryostat);
    double xerr = terr * detProp.GetXTicksCoefficient();

    // Update measurement vector and error matrix.

    trkf::KVector<1>::type mvec(1, x);
    setMeasVector(mvec);

    trkf::KSymMatrix<1>::type merr(1);
    merr(0, 0) = xerr * xerr;
    setMeasError(merr);

    // Set the unique id from a combination of the channel number and the time.

    fID = (hit->Channel() % 200000) * 10000 + (int(std::abs(t)) % 10000);
  }

trkf::KHitWireX::KHitWireX	(	const geo::WireID &	wireid,
		double	x,
		double	xerr
	)

Constructor from wire id (mainly for testing).

Constructor.

Arguments:

wireid - Wire id. x - X coordinate. xerr - X error.

Definition at line 93 of file KHitWireX.cxx.

    : KHit(std::shared_ptr<const Surface>(new SurfWireX(wireid)))
  {
    // Get services.

    art::ServiceHandle<geo::Geometry const> geom;

    // Get plane number.

    setMeasPlane(wireid.Plane);

    // Update measurement vector and error matrix.

    trkf::KVector<1>::type mvec(1, x);
    setMeasVector(mvec);

    trkf::KSymMatrix<1>::type merr(1);
    merr(0, 0) = xerr * xerr;
    setMeasError(merr);
  }

Member Function Documentation

const art::Ptr<recob::Hit>& trkf::KHitWireX::getHit ( ) const

inline

Get original hit.

Definition at line 48 of file KHitWireX.h.

    {
      return fHit;
    }

bool trkf::KHitWireX::subpredict ( const KETrack &  tre, KVector< 1 >::type &  pvec, KSymMatrix< 1 >::type &  perr, KHMatrix< 1 >::type &  hmatrix  ) const

override

Definition at line 115 of file KHitWireX.cxx.

  {
    // Make sure that the track surface and the measurement surface are the
    // same. Throw an exception if they are not.

    if (!getMeasSurface()->isEqual(*tre.getSurface()))
      throw cet::exception("KHitWireX") << "Track surface not the same as measurement surface.\n";

    // Prediction is just u track perameter and error.

    int size = tre.getVector().size();
    pvec.resize(1, /* preserve */ false);
    pvec.clear();
    pvec(0) = tre.getVector()(0);

    perr.resize(1, /* preserve */ false);
    perr.clear();
    perr(0, 0) = tre.getError()(0, 0);

    // Update prediction error to include contribution from track slope.

    art::ServiceHandle<geo::Geometry const> geom;
    double pitch = geom->WirePitch();
    double slope = tre.getVector()(2);
    double slopevar = pitch * pitch * slope * slope / 12.;
    perr(0, 0) += slopevar;

    // Hmatrix - du/du = 1., all others are zero.

    hmatrix.resize(1, size, /* preserve */ false);
    hmatrix.clear();
    hmatrix(0, 0) = 1.;

    return true;
  }

Member Data Documentation

art::Ptr<recob::Hit> trkf::KHitWireX::fHit

private

Definition at line 62 of file KHitWireX.h.

---

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

• lardata/lardata/RecoObjects/KHitWireX.h
• lardata/lardata/RecoObjects/KHitWireX.cxx