LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | Private Attributes | Friends | List of all members
recob::Hit Class Reference

2D representation of charge deposited in the TDC/wire plane More...

#include "Hit.h"

Public Member Functions

 Hit ()
 Default constructor: a hit with no signal. More...
 
 Hit (raw::ChannelID_t channel, raw::TDCtick_t start_tick, raw::TDCtick_t end_tick, float peak_time, float sigma_peak_time, float rms, float peak_amplitude, float sigma_peak_amplitude, float summedADC, float hit_integral, float hit_sigma_integral, short int multiplicity, short int local_index, float goodness_of_fit, int dof, geo::View_t view, geo::SigType_t signal_type, geo::WireID wireID)
 Constructor: directly sets all the fields. More...
 
float TimeDistanceAsRMS (float time) const
 Returns the distance of the specified time from peak, in RMS units. More...
 
Accessors
raw::TDCtick_t StartTick () const
 Initial tdc tick for hit. More...
 
raw::TDCtick_t EndTick () const
 Final tdc tick for hit. More...
 
float PeakTime () const
 Time of the signal peak, in tick units. More...
 
float SigmaPeakTime () const
 Uncertainty for the signal peak, in tick units. More...
 
float RMS () const
 RMS of the hit shape, in tick units. More...
 
float PeakAmplitude () const
 The estimated amplitude of the hit at its peak, in ADC units. More...
 
float SigmaPeakAmplitude () const
 Uncertainty on estimated amplitude of the hit at its peak, in ADC units. More...
 
float SummedADC () const
 The sum of calibrated ADC counts of the hit (0. by default) More...
 
float Integral () const
 Integral under the calibrated signal waveform of the hit, in tick x ADC units. More...
 
float SigmaIntegral () const
 Initial tdc tick for hit. More...
 
short int Multiplicity () const
 How many hits could this one be shared with. More...
 
short int LocalIndex () const
 How well do we believe we know this hit? More...
 
float GoodnessOfFit () const
 Degrees of freedom in the determination of the hit signal shape (-1 by default) More...
 
int DegreesOfFreedom () const
 Initial tdc tick for hit. More...
 
raw::ChannelID_t Channel () const
 ID of the readout channel the hit was extracted from. More...
 
geo::View_t View () const
 View for the plane of the hit. More...
 
geo::SigType_t SignalType () const
 Signal type for the plane of the hit. More...
 
geo::WireID const & WireID () const
 Initial tdc tick for hit. More...
 
float PeakTimePlusRMS (float sigmas=+1.) const
 Returns a time sigmas RMS away from the peak time. More...
 
float PeakTimeMinusRMS (float sigmas=+1.) const
 Returns a time sigmas RMS away from the peak time. More...
 

Private Attributes

raw::ChannelID_t fChannel
 ID of the readout channel the hit was extracted from. More...
 
raw::TDCtick_t fStartTick
 initial tdc tick for hit More...
 
raw::TDCtick_t fEndTick
 final tdc tick for hit More...
 
float fPeakTime
 time of the signal peak, in tick units More...
 
float fSigmaPeakTime
 uncertainty for the signal peak, in tick units More...
 
float fRMS
 RMS of the hit shape, in tick units. More...
 
float fPeakAmplitude
 the estimated amplitude of the hit at its peak, in ADC units More...
 
float fSigmaPeakAmplitude
 uncertainty on estimated amplitude of the hit at its peak, in ADC units More...
 
float fSummedADC
 the sum of calibrated ADC counts of the hit More...
 
float fIntegral
 the integral under the calibrated signal waveform of the hit, in tick x ADC units More...
 
float fSigmaIntegral
 the uncertainty of integral under the calibrated signal waveform of the hit, in ADC units More...
 
short int fMultiplicity
 how many hits could this one be shared with More...
 
short int fLocalIndex
 index of this hit among the Multiplicity() hits in the signal window More...
 
float fGoodnessOfFit
 how well do we believe we know this hit? More...
 
int fNDF
 degrees of freedom in the determination of the hit shape More...
 
geo::View_t fView
 view for the plane of the hit More...
 
geo::SigType_t fSignalType
 signal type for the plane of the hit More...
 
geo::WireID fWireID
 WireID for the hit (Cryostat, TPC, Plane, Wire) More...
 

Friends

class HitCreator
 
std::ostream & operator<< (std::ostream &o, const Hit &a)
 
bool operator< (const Hit &a, const Hit &b)
 

Detailed Description

2D representation of charge deposited in the TDC/wire plane

Hits are assumed to be made from deconvoluted, unipolar, calibrated signals. They identify a charge deposit in a specific location and time; the location is absolute and unique in the detector, while the time is relative to the start of sampling (tick time).

The version 14 of recob::Hit introduces the following changes:

Definition at line 46 of file Hit.h.

Constructor & Destructor Documentation

recob::Hit::Hit ( )

Default constructor: a hit with no signal.

Definition at line 19 of file Hit.cxx.

20  : fChannel(raw::InvalidChannelID)
21  , fStartTick(0)
22  , fEndTick(0)
23  , fPeakTime(0.)
24  , fSigmaPeakTime(-1.)
25  , fRMS(0.)
26  , fPeakAmplitude(0.)
27  , fSigmaPeakAmplitude(-1.)
28  , fSummedADC(0.)
29  , fIntegral(0.)
30  , fSigmaIntegral(-1.)
31  , fMultiplicity(0)
32  , fLocalIndex(-1)
33  , fGoodnessOfFit(0.)
34  , fNDF(-1)
35  , fView(geo::kUnknown)
36  , fSignalType(geo::kMysteryType)
37  , fWireID() // invalid
38  {}
recob::Hit::fPeakAmplitude
float fPeakAmplitude
the estimated amplitude of the hit at its peak, in ADC units
Definition: Hit.h:58
recob::Hit::fStartTick
raw::TDCtick_t fStartTick
initial tdc tick for hit
Definition: Hit.h:53
geo::kMysteryType
Who knows?
Definition: geo_types.h:153
recob::Hit::fSummedADC
float fSummedADC
the sum of calibrated ADC counts of the hit
Definition: Hit.h:61
geo::kUnknown
Unknown view.
Definition: geo_types.h:142
recob::Hit::fSigmaPeakAmplitude
float fSigmaPeakAmplitude
uncertainty on estimated amplitude of the hit at its peak, in ADC units
Definition: Hit.h:60
recob::Hit::fView
geo::View_t fView
view for the plane of the hit
Definition: Hit.h:70
recob::Hit::fSignalType
geo::SigType_t fSignalType
signal type for the plane of the hit
Definition: Hit.h:71
recob::Hit::fEndTick
raw::TDCtick_t fEndTick
final tdc tick for hit
Definition: Hit.h:54
recob::Hit::fSigmaPeakTime
float fSigmaPeakTime
uncertainty for the signal peak, in tick units
Definition: Hit.h:56
recob::Hit::fMultiplicity
short int fMultiplicity
how many hits could this one be shared with
Definition: Hit.h:66
raw::InvalidChannelID
constexpr ChannelID_t InvalidChannelID
ID of an invalid channel.
Definition: RawTypes.h:31
recob::Hit::fPeakTime
float fPeakTime
time of the signal peak, in tick units
Definition: Hit.h:55
recob::Hit::fChannel
raw::ChannelID_t fChannel
ID of the readout channel the hit was extracted from.
Definition: Hit.h:52
recob::Hit::fNDF
int fNDF
degrees of freedom in the determination of the hit shape
Definition: Hit.h:69
recob::Hit::fRMS
float fRMS
RMS of the hit shape, in tick units.
Definition: Hit.h:57
recob::Hit::fWireID
geo::WireID fWireID
WireID for the hit (Cryostat, TPC, Plane, Wire)
Definition: Hit.h:72
recob::Hit::fSigmaIntegral
float fSigmaIntegral
the uncertainty of integral under the calibrated signal waveform of the hit, in ADC units ...
Definition: Hit.h:65
recob::Hit::fGoodnessOfFit
float fGoodnessOfFit
how well do we believe we know this hit?
Definition: Hit.h:68
recob::Hit::fLocalIndex
short int fLocalIndex
index of this hit among the Multiplicity() hits in the signal window
Definition: Hit.h:67
recob::Hit::fIntegral
float fIntegral
the integral under the calibrated signal waveform of the hit, in tick x ADC units ...
Definition: Hit.h:63
recob::Hit::Hit ( raw::ChannelID_t  channel,
raw::TDCtick_t  start_tick,
raw::TDCtick_t  end_tick,
float  peak_time,
float  sigma_peak_time,
float  rms,
float  peak_amplitude,
float  sigma_peak_amplitude,
float  summedADC,
float  hit_integral,
float  hit_sigma_integral,
short int  multiplicity,
short int  local_index,
float  goodness_of_fit,
int  dof,
geo::View_t  view,
geo::SigType_t  signal_type,
geo::WireID  wireID 
)

Constructor: directly sets all the fields.

Parameters
channelID of the readout channel the hit was extracted from
start_tickinitial tdc tick for hit
end_tickfinal tdc tick for hit
peak_timetdc for the peak charge deposition
sigma_peak_timeuncertainty for tdc of the peak
rmsRMS of the hit shape
peak_amplitudethe estimated amplitude of the hit at its peak
sigma_peak_amplitudethe uncertainty on the estimated amplitude of the hit at its peak
summedADCthe sum of calibrated ADC counts of the hit
hit_integralthe integral under the calibrated signal waveform of the hit
hit_sigma_integraluncertainty on the integral under the calibrated signal waveform of the hit
multiplicityhow many hits could this one be shared with
local_indexindex of this hit among the Multiplicity() hits in the signal window
goodness_of_fithow well do we believe we know this hit?
dofnumber of degrees of freedom in the determination of hit shape
viewview for the plane of the hit
signal_typesignal type for the plane of the hit
wireIDWireID for the hit (Cryostat TPC Plane Wire)

The tick parameters are real numbers, since they can in principle come from some processing.

Definition at line 41 of file Hit.cxx.

59  : fChannel(channel)
60  , fStartTick(start_tick)
61  , fEndTick(end_tick)
62  , fPeakTime(peak_time)
63  , fSigmaPeakTime(sigma_peak_time)
64  , fRMS(rms)
65  , fPeakAmplitude(peak_amplitude)
66  , fSigmaPeakAmplitude(sigma_peak_amplitude)
67  , fSummedADC(summedADC)
68  , fIntegral(hit_integral)
69  , fSigmaIntegral(hit_sigma_integral)
70  , fMultiplicity(multiplicity)
71  , fLocalIndex(local_index)
72  , fGoodnessOfFit(goodness_of_fit)
73  , fNDF(dof)
74  , fView(view)
75  , fSignalType(signal_type)
76  , fWireID(wireID)
77  {}
recob::Hit::fPeakAmplitude
float fPeakAmplitude
the estimated amplitude of the hit at its peak, in ADC units
Definition: Hit.h:58
recob::Hit::fStartTick
raw::TDCtick_t fStartTick
initial tdc tick for hit
Definition: Hit.h:53
recob::Hit::fSummedADC
float fSummedADC
the sum of calibrated ADC counts of the hit
Definition: Hit.h:61
recob::Hit::fSigmaPeakAmplitude
float fSigmaPeakAmplitude
uncertainty on estimated amplitude of the hit at its peak, in ADC units
Definition: Hit.h:60
recob::Hit::fView
geo::View_t fView
view for the plane of the hit
Definition: Hit.h:70
recob::Hit::fSignalType
geo::SigType_t fSignalType
signal type for the plane of the hit
Definition: Hit.h:71
recob::Hit::fEndTick
raw::TDCtick_t fEndTick
final tdc tick for hit
Definition: Hit.h:54
recob::Hit::fSigmaPeakTime
float fSigmaPeakTime
uncertainty for the signal peak, in tick units
Definition: Hit.h:56
recob::Hit::fMultiplicity
short int fMultiplicity
how many hits could this one be shared with
Definition: Hit.h:66
recob::Hit::fPeakTime
float fPeakTime
time of the signal peak, in tick units
Definition: Hit.h:55
recob::Hit::fChannel
raw::ChannelID_t fChannel
ID of the readout channel the hit was extracted from.
Definition: Hit.h:52
recob::Hit::fNDF
int fNDF
degrees of freedom in the determination of the hit shape
Definition: Hit.h:69
recob::Hit::fRMS
float fRMS
RMS of the hit shape, in tick units.
Definition: Hit.h:57
recob::Hit::fWireID
geo::WireID fWireID
WireID for the hit (Cryostat, TPC, Plane, Wire)
Definition: Hit.h:72
recob::Hit::fSigmaIntegral
float fSigmaIntegral
the uncertainty of integral under the calibrated signal waveform of the hit, in ADC units ...
Definition: Hit.h:65
recob::Hit::fGoodnessOfFit
float fGoodnessOfFit
how well do we believe we know this hit?
Definition: Hit.h:68
recob::Hit::fLocalIndex
short int fLocalIndex
index of this hit among the Multiplicity() hits in the signal window
Definition: Hit.h:67
recob::Hit::fIntegral
float fIntegral
the integral under the calibrated signal waveform of the hit, in tick x ADC units ...
Definition: Hit.h:63

Member Function Documentation

raw::ChannelID_t recob::Hit::Channel ( ) const
inline

ID of the readout channel the hit was extracted from.

Definition at line 268 of file Hit.h.

References fChannel.

Referenced by lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), evdb_tool::DrawSkewHits::Draw(), evdb_tool::DrawGausHits::Draw(), trkf::KHitContainerWireLine::fill(), trkf::KHitContainerWireX::fill(), microboone::CosmicRemovalAna::FillMCInfo(), apa::DisambigAlg::FindChanTimeEndPts(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), cheat::BackTracker::HitToAvgSimIDEs(), cheat::BackTracker::HitToSimIDEs_Ps(), cheat::BackTracker::HitToTrackIDEs(), hit::DisambigCheater::InitHitToWids(), trkf::KHitWireLine::KHitWireLine(), trkf::KHitWireX::KHitWireX(), apa::DisambigAlg::MakeCloseHits(), apa::DisambigAlg::MakeDisambigHit(), cluster::ClusterCrawlerAlg::MergeHits(), trkf::SortByWire::operator()(), recob::operator<(), recob::operator<<(), recob::HitRefinerAssociator::prepare_associations(), lar_pandora::LArPandoraEventDump::PrintHit(), apa::DisambigAlg::RunDisambig(), cheat::BackTracker::TrackIdsToHits_Ps(), cheat::BackTracker::TrackIdToHits_Ps(), and apa::DisambigAlg::UseEndPts().

269 {
270  return fChannel;
271 }
recob::Hit::fChannel
raw::ChannelID_t fChannel
ID of the readout channel the hit was extracted from.
Definition: Hit.h:52
int recob::Hit::DegreesOfFreedom ( ) const
inline

Initial tdc tick for hit.

Definition at line 264 of file Hit.h.

References fNDF.

Referenced by cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), cluster::ClusterCrawlerAlg::MergeHits(), and recob::operator<<().

265 {
266  return fNDF;
267 }
recob::Hit::fNDF
int fNDF
degrees of freedom in the determination of the hit shape
Definition: Hit.h:69
raw::TDCtick_t recob::Hit::EndTick ( ) const
inline

Final tdc tick for hit.

Definition at line 216 of file Hit.h.

References fEndTick.

Referenced by hit::HitAnaAlg::FillHitInfo(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), shower::LArPandoraShowerAlg::OrganizeHits(), and calo::GnocchiCalorimetry::OrganizeHitsSnippets().

217 {
218  return fEndTick;
219 }
recob::Hit::fEndTick
raw::TDCtick_t fEndTick
final tdc tick for hit
Definition: Hit.h:54
float recob::Hit::GoodnessOfFit ( ) const
inline

Degrees of freedom in the determination of the hit signal shape (-1 by default)

Definition at line 260 of file Hit.h.

References fGoodnessOfFit.

Referenced by hit::GausHitFinderAna::analyze(), hit::HitAnaAlg::FillHitInfo(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), tca::LongPulseHit(), and recob::operator<<().

261 {
262  return fGoodnessOfFit;
263 }
recob::Hit::fGoodnessOfFit
float fGoodnessOfFit
how well do we believe we know this hit?
Definition: Hit.h:68
float recob::Hit::Integral ( ) const
inline

Integral under the calibrated signal waveform of the hit, in tick x ADC units.

Uncertainty of integral under the calibrated signal waveform of the hit, in ADC units

Definition at line 244 of file Hit.h.

References fIntegral.

Referenced by cluster::ClusterCrawlerAlg::AddHit(), hit::GausHitFinderAna::analyze(), trkf::SpacePointAna::analyze(), NuShowerEff::analyze(), calo::TrackCalorimetryAlg::AnalyzeHit(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), calo::CalorimetryAlg::dEdx_AREA(), trkf::Track3DKalmanSPS::dQdxCalc(), microboone::CosmicRemovalAna::FillAllTagsInfo(), hit::HitAnaAlg::FillHitInfo(), microboone::CosmicRemovalAna::FillMCInfo(), lar_pandora::PFParticleHitDumper::FillReco2D(), hit::HitAnaAlg::FindAndStoreHitsInRange(), ClusteringValidation::ClusterAnalyser::FindTrueTrack(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), calo::GnocchiCalorimetry::GetCharge(), lcvn::HitHelper::GetWaveform(), util::PxHitConverter::HitToPxHit(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), shower::LArPandoraShowerAlg::OrganizeHits(), calo::GnocchiCalorimetry::OrganizeHitsSnippets(), cluster::LineCluster::produce(), cluster::ClusterCrawler::produce(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), and reco::RecobClusterParameters::UpdateParameters().

245 {
246  return fIntegral;
247 }
recob::Hit::fIntegral
float fIntegral
the integral under the calibrated signal waveform of the hit, in tick x ADC units ...
Definition: Hit.h:63
short int recob::Hit::LocalIndex ( ) const
inline

How well do we believe we know this hit?

Definition at line 256 of file Hit.h.

References fLocalIndex.

Referenced by cluster::ClusterCrawlerAlg::AddHit(), cluster::ClusterCrawlerAlg::ChkClusterNearbyHits(), recob::operator<<(), and cluster::ClusterCrawlerAlg::SortByMultiplet().

257 {
258  return fLocalIndex;
259 }
recob::Hit::fLocalIndex
short int fLocalIndex
index of this hit among the Multiplicity() hits in the signal window
Definition: Hit.h:67
short int recob::Hit::Multiplicity ( ) const
inline

How many hits could this one be shared with.

Index of this hit among the Multiplicity() hits in the signal window (-1 by default)

Definition at line 252 of file Hit.h.

References fMultiplicity.

Referenced by cluster::ClusterCrawlerAlg::AddHit(), hit::GausHitFinderAna::analyze(), cluster::ClusterCrawlerAlg::ChkClusterNearbyHits(), hit::HitAnaAlg::FindAndStoreHitsInRange(), tca::LongPulseHit(), cluster::ClusterCrawlerAlg::MergeHits(), and recob::operator<<().

253 {
254  return fMultiplicity;
255 }
recob::Hit::fMultiplicity
short int fMultiplicity
how many hits could this one be shared with
Definition: Hit.h:66
float recob::Hit::PeakAmplitude ( ) const
inline

The estimated amplitude of the hit at its peak, in ADC units.

Definition at line 232 of file Hit.h.

References fPeakAmplitude.

Referenced by trkf::SpacePointAna::analyze(), calo::CalorimetryAlg::dEdx_AMP(), hit::HitAnaAlg::FillHitInfo(), hit::HitAnaAlg::FindAndStoreHitsInRange(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), calo::GnocchiCalorimetry::GetCharge(), pma::Hit3D::Hit3D(), util::PxHitConverter::HitToPxHit(), hit::HitFilterAlg::IsGoodHit(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), cluster::ClusterCrawlerAlg::MergeHits(), and recob::operator<<().

233 {
234  return fPeakAmplitude;
235 }
recob::Hit::fPeakAmplitude
float fPeakAmplitude
the estimated amplitude of the hit at its peak, in ADC units
Definition: Hit.h:58
float recob::Hit::PeakTime ( ) const
inline

Time of the signal peak, in tick units.

Definition at line 220 of file Hit.h.

References fPeakTime.

Referenced by cluster::ClusterCrawlerAlg::AddHit(), pfpf::PFPAna::analyze(), cluster::ClusterAna::analyze(), hit::GausHitFinderAna::analyze(), trkf::SpacePointAna::analyze(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), cluster::ClusterCrawlerAlg::ChkClusterNearbyHits(), nnet::EmTrack< N >::classify_hits(), cluster::ClusterCrawlerAlg::ClusterLoop(), trkf::SpacePointAlg::compatible(), shower::EMShowerAlg::Construct3DPoint_(), trkf::SpacePointAlg::correctedTime(), cluster::SmallClusterFinderAlg::CreateHighHitlist(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), calo::CalorimetryAlg::dEdx_AMP(), calo::CalorimetryAlg::dEdx_AREA(), lar_cluster3d::StandardHit3DBuilder::DistanceFromPointToHitWire(), cluster::HoughBaseAlg::FastTransform(), trkf::SpacePointAlg::fillComplexSpacePoint(), hit::HitAnaAlg::FillHitInfo(), microboone::CosmicRemovalAna::FillMCInfo(), lar_pandora::PFParticleHitDumper::FillReco2D(), trkf::SpacePointAlg::fillSpacePoint(), hit::HitAnaAlg::FindAndStoreHitsInRange(), apa::DisambigAlg::FindChanTimeEndPts(), cluster::SmallClusterFinderAlg::FindSmallClusters(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), ems::EMShower3D::GetCloseHits(), pma::ProjectionMatchingAlg::GetCloseHits_(), trkf::SeedFinderAlgorithm::GetHitDistAndProj(), calo::Calorimetry::GetPitch(), pma::Track3D::GetUnconstrainedProj3D(), lcvn::HitHelper::GetWaveform(), shower::TCShowerAlg::goodHit(), tss::Hit2D::Hit2D(), ems::Hit2D::Hit2D(), pma::Hit3D::Hit3D(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), cluster::MergeClusterAlg::HitCoordinates(), shower::LArPandoraShowerAlg::HitCoordinates(), shower::EMShowerAlg::HitCoordinates_(), util::PxHitConverter::HitToPxHit(), hit::DisambigCheater::InitHitToWids(), trkf::KHitWireLine::KHitWireLine(), trkf::KHitWireX::KHitWireX(), apa::DisambigAlg::MakeCloseHits(), apa::DisambigAlg::MakeDisambigHit(), trkf::Track3DKalmanHitAlg::makeSeed(), trkf::SpacePointAlg::makeSpacePoints(), cluster::ClusterCrawlerAlg::MergeHits(), lar_cluster3d::Hit2DSetCompare::operator()(), recob::operator<(), recob::operator<<(), shower::EMShowerAlg::OrderShowerHits_(), PeakTimePlusRMS(), lar_pandora::LArPandoraEventDump::PrintHit(), nnet::EmTrackClusterId2out::produce(), nnet::EmTrackClusterId::produce(), nnet::EmTrackMichelId::produce(), apa::DisambigAlg::RunDisambig(), evd::HitSelector::SaveHits(), cluster::SmallClusterFinderAlg::SelectLocalHitlist(), lar_cluster3d::SetHitTimeOrder(), TimeDistanceAsRMS(), and cluster::ClusterCrawlerAlg::VtxConstraint().

221 {
222  return fPeakTime;
223 }
recob::Hit::fPeakTime
float fPeakTime
time of the signal peak, in tick units
Definition: Hit.h:55
float recob::Hit::PeakTimeMinusRMS ( float  sigmas = +1.) const
inline

Returns a time sigmas RMS away from the peak time.

Parameters
sigmasthe number of RMS units to move away
Returns
the shifted time in TDC ticks

PeakTimePlusRMS() returns PeakTime() + sigmas x RMS(); PeakTimeMinusRMS() returns PeakTime() - sigmas x RMS().

Note
StartTime() of recob::Hit version <=13 was defined by GausHitFinder to be PeakTimePlusRMS(-1.), and EndTime() was PeakTimePlusRMS(+1.).

Definition at line 290 of file Hit.h.

References PeakTimePlusRMS().

Referenced by hit::GausHitFinderAna::analyze(), lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), hit::HitAnaAlg::FindAndStoreHitsInRange(), trkf::SeedFinderAlgorithm::GetHitDistAndProj(), apa::DisambigAlg::HitsOverlapInTime(), cheat::BackTracker::HitToAvgSimIDEs(), cheat::BackTracker::HitToSimIDEs_Ps(), cheat::BackTracker::HitToTrackIDEs(), hit::DisambigCheater::InitHitToWids(), apa::DisambigAlg::MakeCloseHits(), cluster::ClusterCrawlerAlg::MergeHits(), cheat::BackTracker::TrackIdsToHits_Ps(), cheat::BackTracker::TrackIdToHits_Ps(), and reco::RecobClusterParameters::UpdateParameters().

291 {
292  return PeakTimePlusRMS(-sigmas);
293 }
recob::Hit::PeakTimePlusRMS
float PeakTimePlusRMS(float sigmas=+1.) const
Returns a time sigmas RMS away from the peak time.
Definition: Hit.h:285
float recob::Hit::PeakTimePlusRMS ( float  sigmas = +1.) const
inline

Returns a time sigmas RMS away from the peak time.

Parameters
sigmasthe number of RMS units to move away
Returns
the shifted time in TDC ticks

PeakTimePlusRMS() returns PeakTime() + sigmas x RMS(); PeakTimeMinusRMS() returns PeakTime() - sigmas x RMS().

Note
StartTime() of recob::Hit version <=13 was defined by GausHitFinder to be PeakTimePlusRMS(-1.), and EndTime() was PeakTimePlusRMS(+1.).

Definition at line 285 of file Hit.h.

References PeakTime(), and RMS().

Referenced by hit::GausHitFinderAna::analyze(), lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), hit::HitAnaAlg::FindAndStoreHitsInRange(), trkf::SeedFinderAlgorithm::GetHitDistAndProj(), apa::DisambigAlg::HitsOverlapInTime(), cheat::BackTracker::HitToAvgSimIDEs(), cheat::BackTracker::HitToSimIDEs_Ps(), cheat::BackTracker::HitToTrackIDEs(), hit::DisambigCheater::InitHitToWids(), apa::DisambigAlg::MakeCloseHits(), cluster::ClusterCrawlerAlg::MergeHits(), PeakTimeMinusRMS(), cheat::BackTracker::TrackIdsToHits_Ps(), cheat::BackTracker::TrackIdToHits_Ps(), and reco::RecobClusterParameters::UpdateParameters().

286 {
287  return PeakTime() + sigmas * RMS();
288 }
recob::Hit::RMS
float RMS() const
RMS of the hit shape, in tick units.
Definition: Hit.h:228
recob::Hit::PeakTime
float PeakTime() const
Time of the signal peak, in tick units.
Definition: Hit.h:220
float recob::Hit::RMS ( ) const
inline

RMS of the hit shape, in tick units.

Definition at line 228 of file Hit.h.

References fRMS.

Referenced by cluster::ClusterCrawlerAlg::AddHit(), lar_cluster3d::StandardHit3DBuilder::BuildHit3D(), cluster::ClusterCrawlerAlg::ChkClusterNearbyHits(), hit::HitAnaAlg::FillHitInfo(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), hit::HitFilterAlg::IsGoodHit(), trkf::KHitWireX::KHitWireX(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), PeakTimePlusRMS(), lar_pandora::LArPandoraEventDump::PrintHit(), and TimeDistanceAsRMS().

229 {
230  return fRMS;
231 }
recob::Hit::fRMS
float fRMS
RMS of the hit shape, in tick units.
Definition: Hit.h:57
float recob::Hit::SigmaIntegral ( ) const
inline

Initial tdc tick for hit.

Definition at line 248 of file Hit.h.

References fSigmaIntegral.

Referenced by hit::GausHitFinderAna::analyze(), hit::HitAnaAlg::FillHitInfo(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), cluster::ClusterCrawlerAlg::MergeHits(), and recob::operator<<().

249 {
250  return fSigmaIntegral;
251 }
recob::Hit::fSigmaIntegral
float fSigmaIntegral
the uncertainty of integral under the calibrated signal waveform of the hit, in ADC units ...
Definition: Hit.h:65
float recob::Hit::SigmaPeakAmplitude ( ) const
inline

Uncertainty on estimated amplitude of the hit at its peak, in ADC units.

Definition at line 236 of file Hit.h.

References fSigmaPeakAmplitude.

Referenced by hit::HitAnaAlg::FillHitInfo(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), cluster::ClusterCrawlerAlg::MergeHits(), and recob::operator<<().

237 {
238  return fSigmaPeakAmplitude;
239 }
recob::Hit::fSigmaPeakAmplitude
float fSigmaPeakAmplitude
uncertainty on estimated amplitude of the hit at its peak, in ADC units
Definition: Hit.h:60
float recob::Hit::SigmaPeakTime ( ) const
inline

Uncertainty for the signal peak, in tick units.

Definition at line 224 of file Hit.h.

References fSigmaPeakTime.

Referenced by hit::GausHitFinderAna::analyze(), trkf::SpacePointAna::analyze(), cluster::HoughBaseAlg::FastTransform(), trkf::SpacePointAlg::fillComplexSpacePoint(), hit::HitAnaAlg::FillHitInfo(), trkf::SpacePointAlg::fillSpacePoint(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), trkf::KHitWireLine::KHitWireLine(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), and reco::RecobClusterParameters::UpdateParameters().

225 {
226  return fSigmaPeakTime;
227 }
recob::Hit::fSigmaPeakTime
float fSigmaPeakTime
uncertainty for the signal peak, in tick units
Definition: Hit.h:56
geo::SigType_t recob::Hit::SignalType ( ) const
inline

Signal type for the plane of the hit.

ID of the wire the hit is on (Cryostat, TPC, Plane, Wire)

Definition at line 272 of file Hit.h.

References fSignalType.

Referenced by trkf::Track3DKalmanSPS::dQdxCalc(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), cluster::ClusterCrawlerAlg::MergeHits(), and recob::operator<<().

273 {
274  return fSignalType;
275 }
recob::Hit::fSignalType
geo::SigType_t fSignalType
signal type for the plane of the hit
Definition: Hit.h:71
raw::TDCtick_t recob::Hit::StartTick ( ) const
inline

Initial tdc tick for hit.

Definition at line 212 of file Hit.h.

References fStartTick.

Referenced by cluster::ClusterCrawlerAlg::areInSameMultiplet(), hit::HitAnaAlg::FillHitInfo(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), shower::LArPandoraShowerAlg::OrganizeHits(), calo::GnocchiCalorimetry::OrganizeHitsSnippets(), and cluster::ClusterCrawlerAlg::SortByMultiplet().

213 {
214  return fStartTick;
215 }
recob::Hit::fStartTick
raw::TDCtick_t fStartTick
initial tdc tick for hit
Definition: Hit.h:53
float recob::Hit::SummedADC ( ) const
inline

The sum of calibrated ADC counts of the hit (0. by default)

Definition at line 240 of file Hit.h.

References fSummedADC.

Referenced by trkf::SpacePointAna::analyze(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), calo::GnocchiCalorimetry::GetCharge(), ems::Hit2D::Hit2D(), pma::Hit3D::Hit3D(), util::PxHitConverter::HitToPxHit(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), cluster::LineCluster::produce(), and cluster::ClusterCrawler::produce().

241 {
242  return fSummedADC;
243 }
recob::Hit::fSummedADC
float fSummedADC
the sum of calibrated ADC counts of the hit
Definition: Hit.h:61
float recob::Hit::TimeDistanceAsRMS ( float  time) const
inline

Returns the distance of the specified time from peak, in RMS units.

Parameters
timethe time, in TDC tick units
Returns
the distance of the specified time from peak, in RMS units

This returns (ticks - PeakTime()) / RMS(). There is no protection in case RMS is 0!

Definition at line 295 of file Hit.h.

References PeakTime(), and RMS().

296 {
297  return (time - PeakTime()) / RMS();
298 }
recob::Hit::RMS
float RMS() const
RMS of the hit shape, in tick units.
Definition: Hit.h:228
recob::Hit::PeakTime
float PeakTime() const
Time of the signal peak, in tick units.
Definition: Hit.h:220
geo::View_t recob::Hit::View ( ) const
inline

View for the plane of the hit.

Definition at line 276 of file Hit.h.

References fView.

Referenced by trkf::SpacePointAna::analyze(), apa::DisambigAlg::AssessDisambigSoFar(), trkf::SpacePointAlg::compatible(), trkf::SpacePointAlg::correctedTime(), lar_pandora::PFParticleMonitoring::CountHitsByType(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), cluster::HoughBaseAlg::FastTransform(), apa::DisambigAlg::FindChanTimeEndPts(), shower::EMShowerAlg::FinddEdx_(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), calo::GnocchiCalorimetry::GetPitch(), apa::DisambigAlg::HitsOverlapInTime(), trkf::SpacePointAlg::makeSpacePoints(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<(), recob::operator<<(), lar_pandora::LArPandoraEventDump::PrintHit(), apa::DisambigAlg::RunDisambig(), shower::TCShowerAnalysis::truthMatcher(), and reco::RecobClusterParameters::UpdateParameters().

277 {
278  return fView;
279 }
recob::Hit::fView
geo::View_t fView
view for the plane of the hit
Definition: Hit.h:70
geo::WireID const & recob::Hit::WireID ( ) const
inline

Initial tdc tick for hit.

Definition at line 280 of file Hit.h.

References fWireID.

Referenced by ClusteringValidation::ClusterAnalyser::Analyse(), pfpf::PFPAna::analyze(), cluster::ClusterAna::analyze(), hit::GausHitFinderAna::analyze(), trkf::SpacePointAna::analyze(), calo::TrackCalorimetryAlg::AnalyzeHit(), cluster::ClusterCrawlerAlg::areInSameMultiplet(), lar_pandora::LArPandoraOutput::BuildClusters(), mvapid::MVAAlg::CalcSegmentdEdxDist(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), evd::HitSelector::ChangeHit(), nnet::EmTrack< N >::classify_hits(), trkf::SpacePointAlg::compatible(), shower::EMShowerAlg::Construct3DPoint_(), trkf::SpacePointAlg::correctedTime(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), calo::CalorimetryAlg::dEdx_AMP(), calo::CalorimetryAlg::dEdx_AREA(), trkf::Track3DKalmanSPS::dQdxCalc(), ems::EndPoint::EndPoint(), cluster::HoughBaseAlg::FastTransform(), trkf::KHitContainerWireLine::fill(), trkf::KHitContainerWireX::fill(), trkf::SpacePointAlg::fillComplexSpacePoint(), lar_pandora::PFParticleHitDumper::FillReco2D(), lar_pandora::PFParticleHitDumper::FillReco3D(), trkf::SpacePointAlg::fillSpacePoint(), apa::DisambigAlg::FindChanTimeEndPts(), shower::EMShowerAlg::FinddEdx_(), cluster::ClusterCrawlerAlg::FixMultipletLocalIndices(), ems::EMShower3D::GetCloseHits(), pma::ProjectionMatchingAlg::GetCloseHits_(), trkf::SeedFinderAlgorithm::GetHitDistAndProj(), lcvn::HitHelper::GetID(), calo::GnocchiCalorimetry::GetLocation(), calo::GnocchiCalorimetry::GetLocationAtWires(), calo::Calorimetry::GetPitch(), calo::GnocchiCalorimetry::GetPitch(), pma::Track3D::GetUnconstrainedProj3D(), shower::TCShowerAlg::goodHit(), tss::Hit2D::Hit2D(), ems::Hit2D::Hit2D(), pma::Hit3D::Hit3D(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), cluster::MergeClusterAlg::HitCoordinates(), shower::LArPandoraShowerAlg::HitCoordinates(), shower::EMShowerAlg::HitCoordinates_(), shower::EMShowerAlg::HitPosition_(), util::PxHitConverter::HitToPxHit(), hit::HitFilterAlg::IsGoodHit(), trkf::KHitWireLine::KHitWireLine(), trkf::KHitWireX::KHitWireX(), trkf::Track3DKalmanHitAlg::makeSeed(), trkf::SpacePointAlg::makeSpacePoints(), cluster::ClusterCrawlerAlg::MergeHits(), recob::operator<<(), shower::LArPandoraShowerAlg::OrderShowerHits(), shower::EMShowerAlg::OrderShowerHits_(), shower::LArPandoraShowerAlg::OrganizeHits(), calo::GnocchiCalorimetry::OrganizeHitsSnippets(), cluster::ClusterCrawler::produce(), sce::SCECorrection::produce(), trkf::TrackKalmanCheater::produce(), nnet::EmTrackClusterId2out::produce(), nnet::EmTrackClusterId::produce(), nnet::EmTrackMichelId::produce(), evd::HitSelector::SaveHits(), trkf::SpacePointAlg::separation(), cluster::ClusterCrawlerAlg::SortByMultiplet(), SortByWire(), cluster::sortHitsByWire(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), pma::ProjectionMatchingAlg::validate_on_adc(), and cluster::ClusterCrawlerAlg::VtxConstraint().

281 {
282  return fWireID;
283 }
recob::Hit::fWireID
geo::WireID fWireID
WireID for the hit (Cryostat, TPC, Plane, Wire)
Definition: Hit.h:72

Friends And Related Function Documentation

friend class HitCreator
friend

Definition at line 74 of file Hit.h.

bool operator< ( const Hit &  a,
const Hit &  b 
)
friend

Definition at line 106 of file Hit.cxx.

107  {
108  if (a.Channel() != b.Channel()) return a.Channel() < b.Channel();
109  if (a.View() != b.View()) return a.View() < b.View();
110  if (a.PeakTime() != b.PeakTime()) return a.PeakTime() < b.PeakTime();
111 
112  return false; //They are equal
113  } // operator< (Hit, Hit)
std::ostream& operator<< ( std::ostream &  o,
const Hit &  a 
)
friend

Member Data Documentation

raw::ChannelID_t recob::Hit::fChannel
private

ID of the readout channel the hit was extracted from.

Definition at line 52 of file Hit.h.

Referenced by Channel().

raw::TDCtick_t recob::Hit::fEndTick
private

final tdc tick for hit

Definition at line 54 of file Hit.h.

Referenced by EndTick().

float recob::Hit::fGoodnessOfFit
private

how well do we believe we know this hit?

Definition at line 68 of file Hit.h.

Referenced by GoodnessOfFit().

float recob::Hit::fIntegral
private

the integral under the calibrated signal waveform of the hit, in tick x ADC units

Definition at line 63 of file Hit.h.

Referenced by Integral().

short int recob::Hit::fLocalIndex
private

index of this hit among the Multiplicity() hits in the signal window

Definition at line 67 of file Hit.h.

Referenced by LocalIndex().

short int recob::Hit::fMultiplicity
private

how many hits could this one be shared with

Definition at line 66 of file Hit.h.

Referenced by Multiplicity().

int recob::Hit::fNDF
private

degrees of freedom in the determination of the hit shape

Definition at line 69 of file Hit.h.

Referenced by DegreesOfFreedom().

float recob::Hit::fPeakAmplitude
private

the estimated amplitude of the hit at its peak, in ADC units

Definition at line 58 of file Hit.h.

Referenced by PeakAmplitude().

float recob::Hit::fPeakTime
private

time of the signal peak, in tick units

Definition at line 55 of file Hit.h.

Referenced by PeakTime().

float recob::Hit::fRMS
private

RMS of the hit shape, in tick units.

Definition at line 57 of file Hit.h.

Referenced by RMS().

float recob::Hit::fSigmaIntegral
private

the uncertainty of integral under the calibrated signal waveform of the hit, in ADC units

Definition at line 65 of file Hit.h.

Referenced by SigmaIntegral().

float recob::Hit::fSigmaPeakAmplitude
private

uncertainty on estimated amplitude of the hit at its peak, in ADC units

Definition at line 60 of file Hit.h.

Referenced by SigmaPeakAmplitude().

float recob::Hit::fSigmaPeakTime
private

uncertainty for the signal peak, in tick units

Definition at line 56 of file Hit.h.

Referenced by SigmaPeakTime().

geo::SigType_t recob::Hit::fSignalType
private

signal type for the plane of the hit

Definition at line 71 of file Hit.h.

Referenced by SignalType().

raw::TDCtick_t recob::Hit::fStartTick
private

initial tdc tick for hit

Definition at line 53 of file Hit.h.

Referenced by StartTick().

float recob::Hit::fSummedADC
private

the sum of calibrated ADC counts of the hit

Definition at line 61 of file Hit.h.

Referenced by SummedADC().

geo::View_t recob::Hit::fView
private

view for the plane of the hit

Definition at line 70 of file Hit.h.

Referenced by View().

geo::WireID recob::Hit::fWireID
private

WireID for the hit (Cryostat, TPC, Plane, Wire)

Definition at line 72 of file Hit.h.

Referenced by WireID().

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