recob Namespace Reference

Reconstruction base classes. More...

Namespaces
	details
	dumper
	tracking

Classes
class	ChargedSpacePointCollectionCreator
	Creates a collection of space points with associated charge. More...
class	Cluster
	Set of hits with a 2D structure. More...
class	DumpChargedSpacePoints
	Prints the content of all the space points and charge on screen. More...
class	DumpClusters
	Prints the content of all the clusters on screen. More...
class	DumpPCAxes
	Prints the content of all the PCA axis object on screen. More...
class	DumpPFParticles
	Prints the content of all the ParticleFlow particles on screen. More...
class	DumpSeeds
	Prints the content of all the seeds on screen. More...
class	DumpSpacePoints
	Prints the content of all the space points on screen. More...
class	DumpTracks
	Prints the content of all the tracks on screen. More...
class	DumpVertices
	Prints the content of all the vertices on screen. More...
class	Edge
	Edge is an object containing the results of a Principal Components Analysis of a group of space points. More...
class	EndPoint2D
class	Event
class	Hit
	2D representation of charge deposited in the TDC/wire plane More...
class	HitAndAssociationsWriterBase
	Base class handling a collection of hits and its associations. More...
class	HitAndAssociationsWriterManager
	A helper to centralise creation of a hit collection data product. More...
class	HitCollectionAssociator
	A class handling a collection of hits and its associations. More...
class	HitCollectionCreator
	A class handling a collection of hits and its associations. More...
class	HitCreator
	Class managing the creation of a new recob::Hit object. More...
class	HitRefinerAssociator
	A class handling a collection of hits and its associations. More...
class	MCSFitResult
	Class storing the result of the Maximum Likelihood fit of Multiple Coulomb Scattering angles between segments within a Track or Trajectory. More...
class	OpFlash
struct	OpFlashSortByTime
class	OpHit
class	OpWaveform
	Class holding the regions of interest of signal from a photon detector channel. More...
class	PCAxis
class	PFParticle
	Hierarchical representation of particle flow. More...
class	PointCharge
	Charge reconstructed in the active volume. More...
class	Seed
class	Shower
class	Slice
class	SpacePoint
class	Track
	Track from a non-cascading particle.A recob::Track consists of a recob::TrackTrajectory, plus additional members relevant for a "fitted" track: More...
class	TrackFitHitInfo
	Object storing per-hit information from a track fit. More...
class	TrackHitMeta
	Data related to recob::Hit associated with recob::Track.The purpose is to collect several variables that do not work well alone inside track class and are related to 2D hits along the 3D trajectory. So in the first place it is the hit index along the trajectory. There is also dx associated to hit to help dE/dx calculations. More...
class	TrackTrajectory
	A trajectory in space reconstructed from hits. More...
class	Trajectory
	A trajectory in space reconstructed from hits. More...
class	TrajectoryPointFlags
	Set of flags pertaining a point of the track. More...
struct	TrajectoryPointFlagTraits
	Namespace for the trajectory point flags. More...
class	Vertex
	Definition of vertex object for LArSoft. More...
class	VertexAssnMeta
	Class storing the meta-data for track-vertex association: status, propagation distance, impact parameter, impact parameter error, chi2. More...
class	Wire
	Class holding the regions of interest of signal from a channel. More...
class	WireCreator
	Class managing the creation of a new recob::Wire object. More...

Typedefs
using	HitCollectionCreatorManager = HitAndAssociationsWriterManager< HitCollectionCreator >
	A manager for recob::HitCollectionCreator writer class. More...
using	SVector5 = tracking::SVector5
using	SMatrixSym55 = tracking::SMatrixSym55

Functions
std::ostream &	operator<< (std::ostream &o, Cluster const &c)
bool	operator< (Cluster const &a, Cluster const &b)
std::ostream &	operator<< (std::ostream &o, const Edge &a)
	Streaming operator: prints the edge a into the specified stream. More...
bool	operator< (const Edge &a, const Edge &b)
	Comparison operator: strict ordering of edge by ID. More...
bool	operator< (const Edge &e, Edge::ID_t id)
	Comparison operator: strict ordering of edge by ID. More...
bool	operator< (Edge::ID_t id, const Edge &e)
	Comparison operator: strict ordering of edge by ID. More...
std::ostream &	operator<< (std::ostream &o, const EndPoint2D &ep)
std::ostream &	operator<< (std::ostream &o, const Event &a)
bool	operator< (const Event &a, const Event &b)
std::ostream &	operator<< (std::ostream &o, Hit const &hit)
bool	operator< (const Hit &a, const Hit &b)
bool	operator< (const OpFlash &a, const OpFlash &b)
std::ostream &	operator<< (std::ostream &out, OpFlash const &flash)
bool	operator< (const OpHit &a, const OpHit &b)
std::ostream &	operator<< (std::ostream &out, OpHit const &hit)
std::ostream &	operator<< (std::ostream &o, const PCAxis &a)
bool	operator< (const PCAxis &a, const PCAxis &b)
std::ostream &	operator<< (std::ostream &o, const PFParticle &c)
bool	operator< (const PFParticle &a, const PFParticle &b)
std::ostream &	operator<< (std::ostream &out, recob::PointCharge const &charge)
	Dumps the content of a recob::PointCharge object into an output stream. More...
void	CrossProd (double x1, double x2, double x3, double y1, double y2, double y3, double &out1, double &out2, double &out3)
std::ostream &	operator<< (std::ostream &o, Seed const &a)
bool	operator< (const Seed &a, const Seed &b)
std::ostream &	operator<< (std::ostream &o, Shower const &a)
bool	operator< (const Shower &a, const Shower &b)
std::ostream &	operator<< (std::ostream &o, const SpacePoint &a)
bool	operator< (const SpacePoint &a, const SpacePoint &b)
bool	operator< (SpacePoint const &s, SpacePoint::ID_t id)
	Comparison of a space point with an ID, for sorting and lookup. More...
bool	operator< (SpacePoint::ID_t id, SpacePoint const &s)
	Comparison of a space point with an ID, for sorting and lookup. More...
std::ostream &	operator<< (std::ostream &stream, Track const &a)
bool	operator< (const Track &a, const Track &b)
std::ostream &	operator<< (std::ostream &o, const TrackHitMeta &a)
bool	operator< (const TrackHitMeta &a, const TrackHitMeta &b)
std::ostream &	operator<< (std::ostream &&out, TrackTrajectory const &traj)
	Prints trajectory content into a stream. More...
std::ostream &	operator<< (std::ostream &out, Trajectory const &traj)
	Prints trajectory content into a stream. More...
std::ostream &	operator<< (std::ostream &out, recob::TrajectoryPointFlags const &flags)
	Dumps flags into a stream with default verbosity. More...
std::ostream &	operator<< (std::ostream &o, const Vertex &a)
bool	operator< (const Vertex &a, const Vertex &b)

Detailed Description

Reconstruction base classes.

Definition of utility objects for use in the 3D clustering for LArSoft.

The objects defined in this module are intended for internal use by the 3D clustering (see Cluster3D_module.cc in larreco/ClusterFinder). These objects mostly contain volatile information and are not suitable for storage in the art event store

Author

usher.nosp@m.@sla.nosp@m.c.sta.nosp@m.nfor.nosp@m.d.edu

Typedef Documentation

using recob::HitCollectionCreatorManager = typedef HitAndAssociationsWriterManager<HitCollectionCreator>

A manager for recob::HitCollectionCreator writer class.

Definition at line 991 of file HitCreator.h.

using recob::SMatrixSym55 = typedef tracking::SMatrixSym55

Definition at line 10 of file TrackFitHitInfo.h.

using recob::SVector5 = typedef tracking::SVector5

Definition at line 9 of file TrackFitHitInfo.h.

Function Documentation

void recob::CrossProd	(	double	x1,
		double	x2,
		double	x3,
		double	y1,
		double	y2,
		double	y3,
		double &	out1,
		double &	out2,
		double &	out3
	)

Definition at line 287 of file Seed.cxx.

References y1, y2, and y3.

Referenced by recob::Seed::GetDistanceFrom().

  {
    out1 = (x2 * y3 - x3 * y2);
    out2 = (x3 * y1 - x1 * y3);
    out3 = (x1 * y2 - x2 * y1);
  }

bool recob::operator<	(	const Track &	a,
		const Track &	b
	)

Definition at line 37 of file Track.cxx.

References recob::Track::ID().

  {
    if (a.ID() != b.ID()) return a.ID() < b.ID();

    return false; //They are equal
  }

bool recob::operator<	(	const PFParticle &	a,
		const PFParticle &	b
	)

Definition at line 45 of file PFParticle.cxx.

References recob::PFParticle::Self().

  {
    return a.Self() < b.Self();
  }

bool recob::operator<	(	const Vertex &	a,
		const Vertex &	b
	)

Definition at line 58 of file Vertex.cxx.

References recob::Vertex::XYZ().

  {
    double xyza[3] = {0.};
    double xyzb[3] = {0.};
    a.XYZ(xyza);
    b.XYZ(xyzb);

    return xyza[2] < xyzb[2];
  }

bool recob::operator<	(	const Shower &	a,
		const Shower &	b
	)

Definition at line 62 of file Shower.cxx.

References recob::Shower::ID().

  {
    if (a.ID() != b.ID()) return a.ID() < b.ID();

    return false; //They are equal
  }

bool recob::operator< ( SpacePoint const &  s, SpacePoint::ID_t  id  )

inline

Comparison of a space point with an ID, for sorting and lookup.

Definition at line 62 of file SpacePoint.h.

References recob::SpacePoint::ID().

  {
    return s.ID() < id;
  }

bool recob::operator<	(	const SpacePoint &	a,
		const SpacePoint &	b
	)

Definition at line 64 of file SpacePoint.cxx.

References recob::SpacePoint::ID().

  {
    if (a.ID() != b.ID()) return a.ID() < b.ID();

    return false; //They are equal
  }

bool recob::operator< ( SpacePoint::ID_t  id, SpacePoint const &  s  )

inline

Comparison of a space point with an ID, for sorting and lookup.

Definition at line 67 of file SpacePoint.h.

References recob::SpacePoint::ID().

  {
    return id < s.ID();
  }

bool recob::operator<	(	const PCAxis &	a,
		const PCAxis &	b
	)

Definition at line 69 of file PCAxis.cxx.

References recob::PCAxis::getID().

  {
    if (a.getID() != b.getID()) return a.getID() < b.getID();

    return false; //They are equal
  }

bool recob::operator<	(	const Event &	a,
		const Event &	b
	)

Definition at line 71 of file Event.cxx.

References recob::Event::Energy().

  {
    return a.Energy() < b.Energy();
  }

bool recob::operator< ( const TrackHitMeta &  a, const TrackHitMeta &  b  )

inline

Definition at line 80 of file TrackHitMeta.h.

References recob::TrackHitMeta::Index().

  {
    return a.Index() < b.Index();
  }

bool recob::operator<	(	const OpHit &	a,
		const OpHit &	b
	)

Definition at line 80 of file OpHit.cxx.

References recob::OpHit::PE().

  {
    return a.PE() < b.PE();
  }

bool recob::operator<	(	const OpFlash &	a,
		const OpFlash &	b
	)

Definition at line 88 of file OpFlash.cxx.

References recob::OpFlash::Time().

  {
    return a.Time() < b.Time();
  }

bool recob::operator<	(	const Hit &	a,
		const Hit &	b
	)

Definition at line 106 of file Hit.cxx.

References recob::Hit::Channel(), recob::Hit::PeakTime(), and recob::Hit::View().

  {
    if (a.Channel() != b.Channel()) return a.Channel() < b.Channel();
    if (a.View() != b.View()) return a.View() < b.View();
    if (a.PeakTime() != b.PeakTime()) return a.PeakTime() < b.PeakTime();

    return false; //They are equal
  }               // operator< (Hit, Hit)

bool recob::operator< ( const Edge &  a, const Edge &  b  )

inline

Comparison operator: strict ordering of edge by ID.

Definition at line 128 of file Edge.h.

References recob::Edge::ID().

  {
    return a.ID() < b.ID();
  }

bool recob::operator< ( const Edge &  e, Edge::ID_t  id  )

inline

Comparison operator: strict ordering of edge by ID.

Definition at line 133 of file Edge.h.

References recob::Edge::ID().

  {
    return e.ID() < id;
  }

bool recob::operator< ( Edge::ID_t  id, const Edge &  e  )

inline

Comparison operator: strict ordering of edge by ID.

Definition at line 138 of file Edge.h.

References recob::Edge::ID().

  {
    return id < e.ID();
  }

bool recob::operator<	(	Cluster const &	a,
		Cluster const &	b
	)

Definition at line 188 of file Cluster.cxx.

References recob::Cluster::EndTick(), recob::Cluster::hasPlane(), recob::Cluster::ID(), recob::Cluster::Plane(), recob::Cluster::StartTick(), and recob::Cluster::View().

Referenced by reco::Cluster3D::clearStatusBits(), reco::PrincipalComponents::setAveHitDoca(), and reco::ClusterHit2D::setHit().

  {

    if (a.hasPlane() && b.hasPlane() && a.Plane() != b.Plane()) return a.Plane() < b.Plane();
    if (a.View() != b.View()) return a.View() < b.View();
    if (a.ID() != b.ID()) return a.ID() < b.ID();
    if (a.StartTick() != b.StartTick()) return a.StartTick() < b.StartTick();
    if (a.EndTick() != b.EndTick()) return a.EndTick() < b.EndTick();

    return false; // they are equal enough
  }               // operator < (Cluster, Cluster)

bool recob::operator<	(	const Seed &	a,
		const Seed &	b
	)

Definition at line 315 of file Seed.cxx.

References recob::Seed::fSeedPoint.

  {
    if (a.fSeedPoint[2] != b.fSeedPoint[2]) { return a.fSeedPoint[2] < b.fSeedPoint[2]; }
    else if (a.fSeedPoint[1] != b.fSeedPoint[1]) {
      return a.fSeedPoint[1] < b.fSeedPoint[1];
    }

    return a.fSeedPoint[0] < b.fSeedPoint[0];
  }

std::ostream& recob::operator<<	(	std::ostream &	stream,
		Track const &	a
	)

Definition at line 20 of file Track.cxx.

References util::end(), recob::Track::EndDirection(), recob::Track::ID(), recob::Track::NumberTrajectoryPoints(), recob::Track::Phi(), art::right(), recob::Track::Theta(), and recob::Track::VertexDirection().

  {
    auto const& start = a.VertexDirection();
    auto const& end = a.EndDirection();
    stream << std::setiosflags(std::ios::fixed) << std::setprecision(3) << "\n Track ID "
           << std::setw(4) << std::right << a.ID() << " Theta = " << std::setw(6) << std::right
           << a.Theta() << " Phi = " << std::setw(6) << std::right << a.Phi()
           << "\n  StartCosines : ( " << start.X() << " ; " << start.Y() << " ; " << start.Z()
           << ")  EndCosines : ( " << end.X() << " ; " << end.Y() << " ; " << end.Z() << ")"
           << "\n  #Position and Direction = " << std::setw(5) << std::right
           << a.NumberTrajectoryPoints();
    stream << std::endl;

    return stream;
  }

std::ostream& recob::operator<<	(	std::ostream &	o,
		const PFParticle &	c
	)

Definition at line 33 of file PFParticle.cxx.

References recob::PFParticle::IsPrimary(), recob::PFParticle::NumDaughters(), recob::PFParticle::PdgCode(), and art::right().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << "PFParticle hypothesis PDG Code " << std::setw(8) << std::right << c.PdgCode()
      << ", is primary = " << c.IsPrimary() << ", # Daughters " << std::setw(5) << std::right
      << c.NumDaughters() << std::endl;

    return o;
  }

std::ostream& recob::operator<<	(	std::ostream &	o,
		const EndPoint2D &	ep
	)

Definition at line 39 of file EndPoint2D.cxx.

References geo::CryostatID::Cryostat, recob::EndPoint2D::DriftTime(), recob::EndPoint2D::ID(), geo::PlaneID::Plane, art::right(), geo::TPCID::TPC, recob::EndPoint2D::View(), geo::WireID::Wire, and recob::EndPoint2D::WireID().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << "EndPoint2D ID " << std::setw(5) << std::right << ep.ID() << " WireID : \n"
      << "\tCryostat = " << std::setw(7) << std::right << ep.WireID().Cryostat
      << "\tTPC = " << std::setw(7) << std::right << ep.WireID().TPC << "\tPlane = " << std::setw(7)
      << std::right << ep.WireID().Plane << "\tWire Number = " << std::setw(7) << std::right
      << ep.WireID().Wire << " View = " << std::setw(9) << std::right << ep.View()
      << " Time = " << std::setw(9) << std::right << ep.DriftTime();

    return o;
  }

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

Definition at line 43 of file PCAxis.cxx.

References recob::PCAxis::fAveHitDoca, recob::PCAxis::fAvePosition, recob::PCAxis::fEigenValues, recob::PCAxis::fEigenVectors, recob::PCAxis::fID, recob::PCAxis::fNumHitsUsed, recob::PCAxis::fSvdOK, and art::right().

  {
    if (a.fSvdOK) {
      o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
      o << " PCAxis ID " << a.fID << " run with " << a.fNumHitsUsed << " space points" << std::endl;
      o << "   - center position: " << std::setw(6) << a.fAvePosition[0] << ", "
        << a.fAvePosition[1] << ", " << a.fAvePosition[2] << std::endl;
      o << "   - eigen values: " << std::setw(8) << std::right << a.fEigenValues[0] << ", "
        << a.fEigenValues[1] << ", " << a.fEigenValues[2] << std::endl;
      o << "   - average doca: " << a.fAveHitDoca << std::endl;
      o << "   - Principle axis: " << std::setw(7) << std::setprecision(4) << a.fEigenVectors[0][0]
        << ", " << a.fEigenVectors[0][1] << ", " << a.fEigenVectors[0][2] << std::endl;
      o << "   - second axis:    " << std::setw(7) << std::setprecision(4) << a.fEigenVectors[1][0]
        << ", " << a.fEigenVectors[1][1] << ", " << a.fEigenVectors[1][2] << std::endl;
      o << "   - third axis:     " << std::setw(7) << std::setprecision(4) << a.fEigenVectors[2][0]
        << ", " << a.fEigenVectors[2][1] << ", " << a.fEigenVectors[2][2] << std::endl;
    }
    else
      o << " Principal Components Axis is not valid" << std::endl;

    return o;
  }

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

Definition at line 46 of file Vertex.cxx.

References recob::Vertex::id_, and recob::Vertex::pos_.

  {
    o << std::setprecision(5);
    o << "Vertex ID    " << a.id_ << std::setw(5) << " (x,y,z)  = (" << a.pos_.X() << ","
      << a.pos_.Y() << "," << a.pos_.Z() << ")";

    return o;
  }

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

Definition at line 50 of file Shower.cxx.

References recob::Shower::best_plane(), recob::Shower::dEdx(), recob::Shower::Energy(), recob::Shower::ID(), and art::right().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(3);
    o << " Shower ID " << std::setw(4) << std::right << a.ID();
    o << " Energy    " << std::setw(4) << std::right << a.Energy()[a.best_plane()];
    o << " dEdx    " << std::setw(4) << std::right << a.dEdx()[a.best_plane()];
    return o;
  }

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

Definition at line 51 of file SpacePoint.cxx.

References recob::SpacePoint::ID(), art::right(), and recob::SpacePoint::XYZ().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << " SpacePoint ID " << std::setw(5) << std::right << a.ID() << " (X,Y,Z) = (" << std::setw(5)
      << std::right << a.XYZ()[0] << " , " << std::setw(5) << std::right << a.XYZ()[1] << " , "
      << std::setw(5) << std::right << a.XYZ()[2] << ")";

    return o;
  }

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

Streaming operator: prints the edge a into the specified stream.

Definition at line 53 of file Edge.cxx.

References recob::Edge::FirstPointID(), recob::Edge::ID(), recob::Edge::Length(), and recob::Edge::SecondPointID().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << " Edge ID " << a.ID() << " has length " << std::setw(6) << a.Length() << " cm"
      << std::endl;
    o << "   - First Point ID: " << a.FirstPointID() << ", second point ID: " << a.SecondPointID()
      << std::endl;

    return o;
  }

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

Definition at line 58 of file Event.cxx.

References recob::Event::Energy(), recob::Event::fID, and recob::Event::SigmaEnergy().

  {

    o << std::setprecision(5);
    o << "Event " << a.fID << std::setw(5) << " Energy = " << a.Energy() << " +/- "
      << a.SigmaEnergy() << std::endl;

    return o;
  }

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

inline

Definition at line 74 of file TrackHitMeta.h.

References recob::TrackHitMeta::Index().

  {
    o << a.Index();
    return o;
  }

std::ostream& recob::operator<<	(	std::ostream &	o,
		Hit const &	hit
	)

Definition at line 82 of file Hit.cxx.

References recob::Hit::Channel(), recob::Hit::DegreesOfFreedom(), recob::Hit::EndTick(), recob::Hit::GoodnessOfFit(), recob::Hit::Integral(), recob::Hit::LocalIndex(), recob::Hit::Multiplicity(), recob::Hit::PeakAmplitude(), recob::Hit::PeakTime(), art::right(), recob::Hit::RMS(), recob::Hit::SigmaIntegral(), recob::Hit::SigmaPeakAmplitude(), recob::Hit::SigmaPeakTime(), recob::Hit::SignalType(), recob::Hit::StartTick(), recob::Hit::SummedADC(), recob::Hit::View(), and recob::Hit::WireID().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << " Channel " << std::setw(5) << std::right << hit.Channel() << " View = " << std::setw(3)
      << std::right << hit.View() << " Signal type = " << std::setw(3) << std::right
      << hit.SignalType() << " Wire = " << std::setw(3) << std::right << hit.WireID()
      << "\n\tStartTick = " << std::setw(7) << std::right << hit.StartTick()
      << "\tEndTick = " << std::setw(7) << std::right << hit.EndTick()
      << "\tPeakTime = " << std::setw(7) << std::right << hit.PeakTime() << " +/- " << std::setw(7)
      << std::right << hit.SigmaPeakTime() << "\tRMS = " << std::setw(7) << std::right << hit.RMS()
      << "\n\tAmplitude = " << std::setw(7) << std::right << hit.PeakAmplitude() << " +/- "
      << std::setw(7) << std::right << hit.SigmaPeakAmplitude() << "\tIntegral = " << std::setw(7)
      << std::right << hit.Integral() << " +/- " << std::setw(7) << std::right
      << hit.SigmaIntegral() << "\tADCsum = " << std::setw(7) << std::right << hit.SummedADC()
      << "\tMultiplicity = " << std::setw(5) << std::right << hit.LocalIndex() << " of "
      << hit.Multiplicity() << "\tGoodnessOfFit = " << std::setw(7) << std::right
      << hit.GoodnessOfFit() << " DoF = " << std::setw(7) << std::right << hit.DegreesOfFreedom()
      << std::endl;
    return o;
  } // operator<< (std::ostream, Hit)

std::ostream & recob::operator<<	(	std::ostream &	out,
		OpHit const &	hit
	)

Human-readable, single-line almost-complete dump of the hit content.

Frame() value is not printed. No end-of-line added.

Definition at line 86 of file OpHit.cxx.

References recob::OpHit::Amplitude(), recob::OpHit::Area(), recob::OpHit::DefaultTime, recob::OpHit::FastToTotal(), recob::OpHit::HasStartTime(), recob::OpHit::OpChannel(), recob::OpHit::PE(), recob::OpHit::PeakTime(), recob::OpHit::PeakTimeAbs(), recob::OpHit::RiseTime(), recob::OpHit::StartTime(), and recob::OpHit::Width().

  {
    // single line output

    out << "Hit on optical channel " << hit.OpChannel();
    if (hit.HasStartTime()) out << " starting at " << hit.StartTime();
    out << " us, peak at " << hit.PeakTime() << " us (absolute: " << hit.PeakTimeAbs() << " us)";
    if (hit.RiseTime() != OpHit::DefaultTime) out << "; rise time: " << hit.RiseTime() << " us";
    out << "; width " << hit.Width() << " us, amplitude " << hit.Amplitude() << " ADC#, integral "
        << hit.Area() << " ADC#, " << hit.PE() << " photoelectrons";
    if (hit.FastToTotal() > 0.0) out << "; fast fraction: " << hit.FastToTotal();

    return out;
  }

std::ostream & recob::operator<<	(	std::ostream &	out,
		OpFlash const &	flash
	)

Human-readable, almost-complete dump of the hit content.

Frame() value is not printed. No end-of-line added.

Definition at line 100 of file OpFlash.cxx.

References recob::OpFlash::AbsTime(), recob::OpFlash::FastToTotal(), recob::OpFlash::hasXCenter(), recob::OpFlash::InBeamFrame(), recob::OpFlash::OnBeamTime(), recob::OpFlash::PE(), recob::OpFlash::PEs(), recob::OpFlash::Time(), recob::OpFlash::TimeWidth(), recob::OpFlash::TotalPE(), recob::OpFlash::WireCenters(), recob::OpFlash::WireWidths(), recob::OpFlash::XCenter(), recob::OpFlash::XWidth(), recob::OpFlash::YCenter(), recob::OpFlash::YWidth(), recob::OpFlash::ZCenter(), and recob::OpFlash::ZWidth().

  {

    out << "Optical flash at " << flash.Time() << " us (absolute: " << flash.AbsTime() << " us) "
        << flash.TimeWidth() << " us long, centered at (";
    if (flash.hasXCenter())
      out << flash.XCenter();
    else
      out << "?";
    out << ", " << flash.YCenter() << ", " << flash.ZCenter() << ") cm of extension +/- (";
    if (flash.hasXCenter())
      out << flash.XWidth();
    else
      out << "?";
    out << ", " << flash.YWidth() << ", " << flash.ZWidth() << ") cm ";
    if (!flash.hasXCenter()) out << " (x: n/a)";

    out << "\n  " << (flash.InBeamFrame() ? "" : "not ")
        << "in beam frame (on beam time: " << flash.OnBeamTime() << ")";

    out << "\n  total p.e.: " << flash.TotalPE() << " (fast/total fraction: " << flash.FastToTotal()
        << ")";
    std::size_t const nPEs = flash.PEs().size();
    if (nPEs > 0) {
      out << " across " << nPEs << " channels; non-empty:";
      constexpr unsigned int pageSize = 8;
      unsigned int line = 0;
      for (std::size_t i = 0; i < nPEs; ++i) {
        double const pe = flash.PE(i);
        if (pe == 0.0) continue;
        if (line-- == 0) {
          line = pageSize;
          out << "\n  ";
        }
        out << "  [" << i << "] " << pe;
      }
    }
    else {
      out << ", no channels recorded;";
    }

    std::size_t const nWireCenters = flash.WireCenters().size();
    std::size_t const nWireWidths = flash.WireWidths().size();
    std::size_t const nWires = std::max(nWireCenters, nWireWidths);
    out << "\n  ";
    if (nWires) {
      out << nWires << " wires recorded (center +/- width):";
      constexpr unsigned int pageSize = 5;
      unsigned int line = 0;
      for (std::size_t i = 0; i < nWires; ++i) {
        if (line-- == 0) {
          line = pageSize;
          out << "\n  ";
        }
        out << "  [" << i << "] (";
        if (i < nWireCenters)
          out << flash.WireCenters()[i];
        else
          out << "n/a";
        out << " +/- ";
        if (i < nWireWidths)
          out << flash.WireWidths()[i];
        else
          out << "n/a";
        out << ")";
      }
    }
    else
      out << "no wire information recorded";

    return out;
  } // std::ostream& operator<<(std::ostream&, OpFlash const&)

std::ostream& recob::operator<< ( std::ostream &  out, recob::PointCharge const &  charge  )

inline

Dumps the content of a recob::PointCharge object into an output stream.

Definition at line 131 of file PointCharge.h.

References recob::PointCharge::dump().

  {
    charge.dump(out);
    return out;
  }

std::ostream& recob::operator<<	(	std::ostream &	o,
		Cluster const &	c
	)

Definition at line 168 of file Cluster.cxx.

References geo::CryostatID::Cryostat, recob::Cluster::EndTick(), recob::Cluster::EndWire(), recob::Cluster::ID(), recob::Cluster::Integral(), recob::Cluster::NHits(), geo::PlaneID::Plane, recob::Cluster::Plane(), art::right(), recob::Cluster::StartTick(), recob::Cluster::StartWire(), recob::Cluster::SummedADC(), geo::TPCID::TPC, recob::Cluster::View(), and recob::Cluster::Width().

Referenced by reco::Cluster3D::clearStatusBits(), reco::ClusterHit3D::operator==(), reco::PrincipalComponents::setAveHitDoca(), and reco::ClusterHit2D::setHit().

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << "Cluster ID " << std::setw(5) << std::right << c.ID() << " : Cryo = " << std::setw(3)
      << std::right << c.Plane().Cryostat << " TPC = " << std::setw(3) << std::right
      << c.Plane().TPC << " Plane = " << std::setw(3) << std::right << c.Plane().Plane
      << " View = " << std::setw(3) << std::right << c.View() << " StartWire = " << std::setw(7)
      << std::right << c.StartWire() << " EndWire = " << std::setw(7) << std::right << c.EndWire()
      << " StartTime = " << std::setw(9) << std::right << c.StartTick()
      << " EndTime = " << std::setw(9) << std::right << c.EndTick()
      << " N hits =      " << std::setw(5) << std::right << c.NHits()
      << " Width =       " << std::setw(5) << std::right << c.Width()
      << " Charge(fit) = " << std::setw(10) << std::right << c.Integral()
      << " Charge(ADC) = " << std::setw(10) << std::right << c.SummedADC();
    return o;
  } // operator<< (ostream, Cluster)

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

Definition at line 303 of file Seed.cxx.

References recob::Seed::fSeedDirection, and recob::Seed::fSeedPoint.

  {
    o << "Printing seed contents : " << a.fSeedPoint[0] << " " << a.fSeedPoint[1] << " "
      << a.fSeedPoint[2] << ", " << a.fSeedDirection[0] << " " << a.fSeedDirection[1] << " "
      << a.fSeedDirection[2];

    return o;
  }

std::ostream & recob::operator<<	(	std::ostream &	out,
		recob::TrajectoryPointFlags const &	flags
	)

Dumps flags into a stream with default verbosity.

Definition at line 124 of file TrajectoryPointFlags.cxx.

References recob::TrajectoryPointFlags::dump().

{
  flags.dump(out);
  return out;
}

std::ostream & recob::operator<<	(	std::ostream &	out,
		recob::Trajectory const &	traj
	)

Prints trajectory content into a stream.

Template Parameters

Stream

type of the output stream

Parameters

out	stream to output the information into
traj	trajectory to be printed

Returns

a reference to stream

See recob::Trajectory::Dump() for details.

Definition at line 130 of file Trajectory.cxx.

References recob::Trajectory::Dump().

{
  traj.Dump(out);
  return out;
}

std::ostream & recob::operator<<	(	std::ostream &&	out,
		recob::TrackTrajectory const &	traj
	)

Prints trajectory content into a stream.

Template Parameters

Stream

type of the output stream

Parameters

out	stream to output the information into
traj	trajectory to be printed

Returns

a reference to stream

See recob::Trajectory::Dump() for details.

Definition at line 99 of file TrackTrajectory.cxx.

References recob::TrackTrajectory::Dump().

{
  traj.Dump(out);
  return out;
}