ShowerPandoraSlidingFitTrackFinder_tool.cc

Go to the documentation of this file.

//#############################################################################
//### Name:        ShowerPandoraSlidingFitTrackFinder                       ###
//### Author:      Dominic Barker (dominic.barker@sheffield.ac.uk           ###
//### Date:        30.07.19                                                 ###
//### Description: Tool for finding the initial shower track using the      ###
//###              pandora sliding fit calculation. This method is derived  ###
//###              from the PandoraTrackCreationModule.cc                   ###
//#############################################################################

//Framework Includes
#include "art/Utilities/ToolMacros.h"

//LArSoft Includes
#include "larcore/Geometry/Geometry.h"
#include "lardata/DetectorInfoServices/DetectorClocksService.h"
#include "lardata/DetectorInfoServices/DetectorPropertiesService.h"
#include "lardataobj/RecoBase/Hit.h"
#include "lardataobj/RecoBase/Shower.h"
#include "lardataobj/RecoBase/SpacePoint.h"
#include "lardataobj/RecoBase/Track.h"
#include "larpandora/LArPandoraEventBuilding/LArPandoraShower/Tools/IShowerTool.h"
#include "larpandora/LArPandoraInterface/Detectors/GetDetectorType.h"
#include "larpandora/LArPandoraInterface/Detectors/LArPandoraDetectorType.h"
#include "larpandoracontent/LArHelpers/LArPfoHelper.h"

namespace ShowerRecoTools {

  class ShowerPandoraSlidingFitTrackFinder : IShowerTool {
  public:
    ShowerPandoraSlidingFitTrackFinder(const fhicl::ParameterSet& pset);

    //Generic Track Finder
    int CalculateElement(const art::Ptr<recob::PFParticle>& pfparticle,
                         art::Event& Event,
                         reco::shower::ShowerElementHolder& ShowerEleHolder) override;

  private:
    void InitialiseProducers() override;

    //Function to add the assoctions
    int AddAssociations(const art::Ptr<recob::PFParticle>& pfpPtr,
                        art::Event& Event,
                        reco::shower::ShowerElementHolder& ShowerEleHolder) override;

    // Define standard art tool interface.
    art::ServiceHandle<geo::Geometry> fGeom;

    //fcl paramaters
    int fVerbose;
    float fSlidingFitHalfWindow; //To Describe
    float fMinTrajectoryPoints;  //Minimum number of trajectory point to say the track is good.
    std::string fInitialTrackOutputLabel;
    std::string fInitialTrackLengthOutputLabel;
    std::string fShowerStartPositionInputLabel;
    std::string fShowerDirectionInputLabel;
    std::string fInitialTrackSpacePointsInputLabel;
    std::string fInitialTrackHitsInputLabel;
  };

  ShowerPandoraSlidingFitTrackFinder::ShowerPandoraSlidingFitTrackFinder(
    const fhicl::ParameterSet& pset)
    : IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
    , fVerbose(pset.get<int>("Verbose"))
    , fSlidingFitHalfWindow(pset.get<float>("SlidingFitHalfWindow"))
    , fMinTrajectoryPoints(pset.get<float>("MinTrajectoryPoints"))
    , fInitialTrackOutputLabel(pset.get<std::string>("InitialTrackOutputLabel"))
    , fInitialTrackLengthOutputLabel(pset.get<std::string>("InitialTrackLengthOutputLabel"))
    , fShowerStartPositionInputLabel(pset.get<std::string>("ShowerStartPositionInputLabel"))
    , fShowerDirectionInputLabel(pset.get<std::string>("ShowerDirectionInputLabel"))
    , fInitialTrackSpacePointsInputLabel(pset.get<std::string>("InitialTrackSpacePointsInputLabel"))
    , fInitialTrackHitsInputLabel(pset.get<std::string>("InitialTrackHitsInputLabel"))
  {}

  void ShowerPandoraSlidingFitTrackFinder::InitialiseProducers()
  {

    InitialiseProduct<std::vector<recob::Track>>(fInitialTrackOutputLabel);
    InitialiseProduct<art::Assns<recob::Shower, recob::Track>>("ShowerTrackAssn");
    InitialiseProduct<art::Assns<recob::Track, recob::Hit>>("ShowerTrackHitAssn");
  }

  //This whole idea is stolen from PandoraTrackCreationModule so credit goes to the Pandora guys.
  int ShowerPandoraSlidingFitTrackFinder::CalculateElement(
    const art::Ptr<recob::PFParticle>& pfparticle,
    art::Event& Event,
    reco::shower::ShowerElementHolder& ShowerEleHolder)
  {
    //This is all based on the shower vertex being known. If it is not lets not do the track
    if (!ShowerEleHolder.CheckElement(fShowerStartPositionInputLabel)) {
      if (fVerbose)
        mf::LogError("ShowerPandoraSlidingFitTrackFinder")
          << "Start position not set, returning " << std::endl;
      return 1;
    }
    if (!ShowerEleHolder.CheckElement(fShowerDirectionInputLabel)) {
      if (fVerbose)
        mf::LogError("ShowerPandoraSlidingFitTrackFinder")
          << "Direction not set, returning " << std::endl;
      return 1;
    }
    if (!ShowerEleHolder.CheckElement(fInitialTrackSpacePointsInputLabel)) {
      if (fVerbose)
        mf::LogError("ShowerPandoraSlidingFitTrackFinder")
          << "Initial Spacepoints not set, returning " << std::endl;
      return 1;
    }

    geo::Point_t ShowerStartPosition = {-999, -999, -999};
    ShowerEleHolder.GetElement(fShowerStartPositionInputLabel, ShowerStartPosition);

    geo::Vector_t ShowerDirection = {-999, -999, -999};
    ShowerEleHolder.GetElement(fShowerDirectionInputLabel, ShowerDirection);

    std::vector<art::Ptr<recob::SpacePoint>> spacepoints;
    ShowerEleHolder.GetElement(fInitialTrackSpacePointsInputLabel, spacepoints);

    // The track fitter tries to create a traj point from each spacepoint so if we don't have enough
    // spacepoints we will not get enough traj points, so let's not even try
    if (spacepoints.size() < fMinTrajectoryPoints) {
      if (fVerbose)
        mf::LogWarning("ShowerPandoraSlidingFitTrackFinder")
          << "Insufficient space points points to build track: " << spacepoints.size();
      return 1;
    }
    lar_pandora::LArPandoraDetectorType* detType(
      lar_pandora::detector_functions::GetDetectorType());
    // 'wirePitchW` is here used only to provide length scale for binning hits and performing sliding/local linear fits.
    const float wirePitchW(detType->WirePitchW());

    const pandora::CartesianVector vertexPosition(
      ShowerStartPosition.X(), ShowerStartPosition.Y(), ShowerStartPosition.Z());

    pandora::CartesianPointVector cartesianPointVector;
    for (const art::Ptr<recob::SpacePoint> spacePoint : spacepoints)
      cartesianPointVector.emplace_back(
        pandora::CartesianVector(spacePoint->XYZ()[0], spacePoint->XYZ()[1], spacePoint->XYZ()[2]));

    lar_content::LArTrackStateVector trackStateVector;
    pandora::IntVector indexVector;
    try {
      lar_content::LArPfoHelper::GetSlidingFitTrajectory(cartesianPointVector,
                                                         vertexPosition,
                                                         fSlidingFitHalfWindow,
                                                         wirePitchW,
                                                         trackStateVector,
                                                         &indexVector);
    }
    catch (const pandora::StatusCodeException&) {
      if (fVerbose)
        mf::LogWarning("ShowerPandoraSlidingFitTrackFinder")
          << "Unable to extract sliding fit trajectory" << std::endl;
      return 1;
    }
    if (trackStateVector.size() < fMinTrajectoryPoints) {
      if (fVerbose)
        mf::LogWarning("ShowerPandoraSlidingFitTrackFinder")
          << "Insufficient input trajectory points to build track: " << trackStateVector.size();
      return 1;
    }

    if (trackStateVector.empty())
      throw cet::exception("ShowerPandoraSlidingFitTrackFinder")
        << "BuildTrack - No input trajectory points provided " << std::endl;

    recob::tracking::Positions_t xyz;
    recob::tracking::Momenta_t pxpypz;
    recob::TrackTrajectory::Flags_t flags;

    for (const lar_content::LArTrackState& trackState : trackStateVector) {
      xyz.emplace_back(recob::tracking::Point_t(trackState.GetPosition().GetX(),
                                                trackState.GetPosition().GetY(),
                                                trackState.GetPosition().GetZ()));
      pxpypz.emplace_back(recob::tracking::Vector_t(trackState.GetDirection().GetX(),
                                                    trackState.GetDirection().GetY(),
                                                    trackState.GetDirection().GetZ()));

      // Set flag NoPoint if point has bogus coordinates, otherwise use clean flag set
      if (std::fabs(trackState.GetPosition().GetX() - util::kBogusF) <
            std::numeric_limits<float>::epsilon() &&
          std::fabs(trackState.GetPosition().GetY() - util::kBogusF) <
            std::numeric_limits<float>::epsilon() &&
          std::fabs(trackState.GetPosition().GetZ() - util::kBogusF) <
            std::numeric_limits<float>::epsilon()) {
        flags.emplace_back(recob::TrajectoryPointFlags(recob::TrajectoryPointFlags::InvalidHitIndex,
                                                       recob::TrajectoryPointFlagTraits::NoPoint));
      }
      else {
        flags.emplace_back(recob::TrajectoryPointFlags());
      }
    }

    // note from gc: eventually we should produce a TrackTrajectory, not a Track with empty covariance matrix and bogus chi2, etc.
    recob::Track InitialTrack = recob::Track(
      recob::TrackTrajectory(std::move(xyz), std::move(pxpypz), std::move(flags), false),
      util::kBogusI,
      util::kBogusF,
      util::kBogusI,
      recob::tracking::SMatrixSym55(),
      recob::tracking::SMatrixSym55(),
      pfparticle.key());

    ShowerEleHolder.SetElement(InitialTrack, fInitialTrackOutputLabel);

    float tracklength = (InitialTrack.Start() - InitialTrack.End()).R();

    ShowerEleHolder.SetElement(tracklength, fInitialTrackLengthOutputLabel);

    return 0;
  }

  int ShowerPandoraSlidingFitTrackFinder::AddAssociations(
    const art::Ptr<recob::PFParticle>& pfpPtr,
    art::Event& Event,
    reco::shower::ShowerElementHolder& ShowerEleHolder)
  {

    //Check the track has been set
    if (!ShowerEleHolder.CheckElement(fInitialTrackOutputLabel)) {
      if (fVerbose)
        mf::LogError("ShowerPandoraSlidingFitTrackFinderAddAssn")
          << "Track not set so the assocation can not be made  " << std::endl;
      return 1;
    }

    //Get the size of the ptr as it is.
    int trackptrsize = GetVectorPtrSize(fInitialTrackOutputLabel);

    const art::Ptr<recob::Track> trackptr = GetProducedElementPtr<recob::Track>(
      fInitialTrackOutputLabel, ShowerEleHolder, trackptrsize - 1);
    const art::Ptr<recob::Shower> showerptr =
      GetProducedElementPtr<recob::Shower>("shower", ShowerEleHolder);

    AddSingle<art::Assns<recob::Shower, recob::Track>>(showerptr, trackptr, "ShowerTrackAssn");

    std::vector<art::Ptr<recob::Hit>> TrackHits;
    ShowerEleHolder.GetElement(fInitialTrackHitsInputLabel, TrackHits);

    for (auto const& TrackHit : TrackHits) {
      AddSingle<art::Assns<recob::Track, recob::Hit>>(trackptr, TrackHit, "ShowerTrackHitAssn");
    }

    return 0;
  }

}

DEFINE_ART_CLASS_TOOL(ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder)