Hit.h

Go to the documentation of this file.

#ifndef LARDATAOBJ_RECOBASE_HIT_H
#define LARDATAOBJ_RECOBASE_HIT_H

// C/C++ standard librraies
#include <iosfwd>

// LArSoft libraries
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h" // raw::ChannelID_t
#include "larcoreobj/SimpleTypesAndConstants/geo_types.h" // geo::View_t, geo::SignalType, geo::WireID

namespace recob {

  class Hit {
  public:
    Hit();

  private:
    raw::ChannelID_t fChannel; 
    raw::TDCtick_t fStartTick; 
    raw::TDCtick_t fEndTick;   
    float fPeakTime;           
    float fSigmaPeakTime;      
    float fRMS;                
    float fPeakAmplitude;      
    float
      fSigmaPeakAmplitude; 
    float fSummedADC;      
    float
      fIntegral; 
    float
      fSigmaIntegral; 
    short int fMultiplicity; 
    short int fLocalIndex; 
    float fGoodnessOfFit;  
    int fNDF;              
    geo::View_t fView;     
    geo::SigType_t fSignalType; 
    geo::WireID fWireID;        

    friend class HitCreator; // helper to create hits

  public:
    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);


    raw::TDCtick_t StartTick() const;

    raw::TDCtick_t EndTick() const;

    float PeakTime() const;

    float SigmaPeakTime() const;

    float RMS() const;

    float PeakAmplitude() const;

    float SigmaPeakAmplitude() const;

    float SummedADC() const;

    float Integral() const;

    float SigmaIntegral() const;

    short int Multiplicity() const;

    short int LocalIndex() const;

    float GoodnessOfFit() const;

    int DegreesOfFreedom() const;

    raw::ChannelID_t Channel() const;

    geo::View_t View() const;

    geo::SigType_t SignalType() const;

    geo::WireID const& WireID() const;



    float PeakTimePlusRMS(float sigmas = +1.) const;
    float PeakTimeMinusRMS(float sigmas = +1.) const;

    float TimeDistanceAsRMS(float time) const;

    friend std::ostream& operator<<(std::ostream& o, const Hit& a);
    friend bool operator<(const Hit& a, const Hit& b);

  }; // class Hit
} // namespace recob

inline raw::TDCtick_t recob::Hit::StartTick() const
{
  return fStartTick;
}
inline raw::TDCtick_t recob::Hit::EndTick() const
{
  return fEndTick;
}
inline float recob::Hit::PeakTime() const
{
  return fPeakTime;
}
inline float recob::Hit::SigmaPeakTime() const
{
  return fSigmaPeakTime;
}
inline float recob::Hit::RMS() const
{
  return fRMS;
}
inline float recob::Hit::PeakAmplitude() const
{
  return fPeakAmplitude;
}
inline float recob::Hit::SigmaPeakAmplitude() const
{
  return fSigmaPeakAmplitude;
}
inline float recob::Hit::SummedADC() const
{
  return fSummedADC;
}
inline float recob::Hit::Integral() const
{
  return fIntegral;
}
inline float recob::Hit::SigmaIntegral() const
{
  return fSigmaIntegral;
}
inline short int recob::Hit::Multiplicity() const
{
  return fMultiplicity;
}
inline short int recob::Hit::LocalIndex() const
{
  return fLocalIndex;
}
inline float recob::Hit::GoodnessOfFit() const
{
  return fGoodnessOfFit;
}
inline int recob::Hit::DegreesOfFreedom() const
{
  return fNDF;
}
inline raw::ChannelID_t recob::Hit::Channel() const
{
  return fChannel;
}
inline geo::SigType_t recob::Hit::SignalType() const
{
  return fSignalType;
}
inline geo::View_t recob::Hit::View() const
{
  return fView;
}
inline geo::WireID const& recob::Hit::WireID() const
{
  return fWireID;
}

inline float recob::Hit::PeakTimePlusRMS(float sigmas /* = +1. */) const
{
  return PeakTime() + sigmas * RMS();
}

inline float recob::Hit::PeakTimeMinusRMS(float sigmas /* = +1. */) const
{
  return PeakTimePlusRMS(-sigmas);
}

inline float recob::Hit::TimeDistanceAsRMS(float time) const
{
  return (time - PeakTime()) / RMS();
}

#endif // LARDATAOBJ_RECOBASE_HIT_H