DUNEAnaHitUtils.h

Go to the documentation of this file.

/**
 *
 * @file dunereco/AnaUtils/DUNEAnaHitUtils.h
 *
 * @brief Utility containing helpful functions for end users to access information about Hits
*/

#ifndef DUNE_ANA_HIT_UTILS_H
#define DUNE_ANA_HIT_UTILS_H

//STL
#include <cmath>
#include <string>
#include <vector>
//ROOT
//ART
#include "art/Framework/Principal/Event.h"
//LARSOFT
#include "lardataobj/RecoBase/Hit.h"
//DUNE
#include "dunereco/AnaUtils/DUNEAnaUtilsBase.h"

namespace dune_ana
{
/**
 *
 * @brief DUNEAnaHitUtils class
 *
*/
class DUNEAnaHitUtils:DUNEAnaUtilsBase
{
public:
    /**
    * @brief  Get the space points associated with the hit.
    *
    * @param  pHit is the spacepoint for which we want the hits
    * @param  evt is the underlying art event
    * @param  hitLabel is the label for the hit producer
    * @param  hitToSpacePointLabel is the label for the association between hit and space point
    * 
    * @return vector of art::Ptrs to the hits 
    */
    static std::vector<art::Ptr<recob::SpacePoint>> GetSpacePoints(const art::Ptr<recob::Hit> &pHit, 
        const art::Event &evt, const std::string &hitLabel, const std::string &hitToSpacePointLabel);

    /**
    * @brief  Get all hits on a specific plane
    *
    * @param  hits the hit vector to be searched for hits on a specific plane
    * @param  planeID the requested plane number
    * 
    * @return the hit vector containing hits on a specific plane
    */
    static std::vector<art::Ptr<recob::Hit>> GetHitsOnPlane(const std::vector<art::Ptr<recob::Hit>> &hits, 
        const geo::PlaneID::PlaneID_t planeID);

    /**
    * @brief  get the lifetime correction for a hit, assumes the detector properties GetTriggerOffset is T0
    *
    * @param  phit is the hit 
    * 
    * @return the charge normalisation correction
    */
    static double LifetimeCorrection(detinfo::DetectorClocksData const& clockData,
                                     detinfo::DetectorPropertiesData const& detProp,
                                     const art::Ptr<recob::Hit> &pHit);

    /**
    * @brief  get the lifetime correction for a particular time
    *
    * @param  timeinTicks the time in ticks
    * @param  t0InMicroS the t0 time in micro seconds
    * 
    * @return the charge normalisation correction
    */
    static double LifetimeCorrection(detinfo::DetectorClocksData const& clockData,
                                     detinfo::DetectorPropertiesData const& detProp,
                                     const double timeInTicks, const double t0InMicroS);

    /**
    * @brief  get the total hit charge, corrected for lifetime
    *
    * @param  hits the vector of hits to be summed over
    * 
    * @return the lifetime corrected total hit charge
    */
    static double LifetimeCorrectedTotalHitCharge(detinfo::DetectorClocksData const& clockData,
                                                  detinfo::DetectorPropertiesData const& detProp,
                                                  const std::vector<art::Ptr<recob::Hit> > &hits);
};

} // namespace dune_ana


#endif // DUNE_ANA_HIT_UTILS_H