ShowerRecoTools::ShowerExampleTool Class Reference

Inheritance diagram for ShowerRecoTools::ShowerExampleTool:

Public Member Functions
	ShowerExampleTool (const fhicl::ParameterSet &pset)
int	CalculateElement (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder) override
int	RunShowerTool (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder, std::string evd_display_name_append="")
void	SetPtr (art::ProducesCollector *collector)
void	InitaliseProducerPtr (reco::shower::ShowerProducedPtrsHolder &uniqueproducerPtrs)

Protected Member Functions
const shower::LArPandoraShowerAlg &	GetLArPandoraShowerAlg () const
template<class T >
art::Ptr< T >	GetProducedElementPtr (std::string Name, reco::shower::ShowerElementHolder &ShowerEleHolder, int iter=-1)
template<class T >
void	InitialiseProduct (std::string Name, std::string InstanceName="")
template<class T , class A , class B >
void	AddSingle (A &a, B &b, std::string Name)
int	GetVectorPtrSize (std::string Name)
void	PrintPtrs ()
void	PrintPtr (std::string Name)

Private Member Functions
void	InitialiseProducers () override
int	AddAssociations (const art::Ptr< recob::PFParticle > &pfpPtr, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder) override

Private Attributes
art::InputTag	fPFParticleLabel
int	fVerbose

Detailed Description

Definition at line 18 of file ShowerExampleTool_tool.cc.

Constructor & Destructor Documentation

ShowerRecoTools::ShowerExampleTool::ShowerExampleTool

(

const fhicl::ParameterSet &

pset

)

Definition at line 42 of file ShowerExampleTool_tool.cc.

    : //Setup the algs and others here
    IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
    , fPFParticleLabel(pset.get<art::InputTag>("PFParticleLabel"))
    , fVerbose(pset.get<int>("Verbose"))
  {}

Member Function Documentation

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

overrideprivatevirtual

Reimplemented from ShowerRecoTools::IShowerTool.

Definition at line 127 of file ShowerExampleTool_tool.cc.

References reco::shower::ShowerElementHolder::CheckElement(), DEFINE_ART_CLASS_TOOL, fVerbose, and ShowerRecoTools::IShowerTool::GetVectorPtrSize().

  {
    //Here you add elements to associations defined. You can get the art::Ptrs by  GetProducedElementPtr<T>. Then you can add single like a usally association using AddSingle<assn<T>. Assn below.

    //First check the element has been set
    if (!ShowerEleHolder.CheckElement("myvertex")) {
      if (fVerbose) mf::LogError("ShowerExampleTooAddAssn") << "vertex not set." << std::endl;
      return 1;
    }

    //Then you can get the size of the vector which the unique ptr hold so that you can do associations. If you are comfortable in the fact that your element will always be made when a shower is made you don't need to to do this you can just get the art ptr as:      const art::Ptr<recob::Vertex> vertexptr = GetProducedElementPtr<recob::Vertex>("myvertex", ShowerEleHolder);. Note doing this when you allow partial showers to be set can screw up the assocation for the partial shower.
    int ptrsize = GetVectorPtrSize("myvertex");

    const art::Ptr<recob::Vertex> vertexptr =
      GetProducedElementPtr<recob::Vertex>("myvertex", ShowerEleHolder, ptrsize);
    const art::Ptr<recob::Shower> showerptr =
      GetProducedElementPtr<recob::Shower>("shower", ShowerEleHolder);
    AddSingle<art::Assns<recob::Shower, recob::Vertex>>(showerptr, vertexptr, "myvertexassan");

    return 0;
  }

template<class T , class A , class B >

void ShowerRecoTools::IShowerTool::AddSingle ( A &  a, B &  b, std::string  Name  )

inlineprotectedinherited

Definition at line 152 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::AddSingle().

    {
      UniquePtrs->AddSingle<T>(a, b, Name);
    }

int ShowerRecoTools::ShowerExampleTool::CalculateElement ( const art::Ptr< recob::PFParticle > &  pfparticle, art::Event &  Event, reco::shower::ShowerElementHolder &  ShowerEleHolder  )

overridevirtual

Implements ShowerRecoTools::IShowerTool.

Definition at line 58 of file ShowerExampleTool_tool.cc.

References reco::shower::ShowerElementHolder::CheckElement(), reco::shower::ShowerElementHolder::CheckElementTag(), art::fill_ptr_vector(), fPFParticleLabel, fVerbose, reco::shower::ShowerElementHolder::GetElement(), reco::shower::ShowerElementHolder::GetShowerNumber(), art::ProductRetriever::getValidHandle(), util::kBogusD, util::kBogusI, recob::Vertex::position(), reco::shower::ShowerElementHolder::PrintElements(), ShowerRecoTools::IShowerTool::PrintPtr(), ShowerRecoTools::IShowerTool::PrintPtrs(), reco::shower::ShowerElementHolder::SetElement(), and reco::shower::ShowerElementHolder::SetElementTag().

  {

    //In here calculate a shower or element (or multiple). It can be something used to create the recob::shower i.e. the direction. These have specific names so be careful to make these correctly. Alternative you can create something completely new e.g. recob::Vertex and add it the shower element holder

    //Now we are calculating the property of the shower like pfparticle. You have access to everything in the event. Maybe you want the vertex.

    auto const vtxHandle = Event.getValidHandle<std::vector<recob::Vertex>>(fPFParticleLabel);
    std::vector<art::Ptr<recob::Vertex>> vertices;
    art::fill_ptr_vector(vertices, vtxHandle);

    //Remember the module goes through the tools and if you want to (fcl param) it will loop over them twice. You can check to see if a element has been set with a specific name:
    bool shower_direction_set = ShowerEleHolder.CheckElement("ShowerDirection");

    geo::Vector_t ShowerDirection = {-999, -999, -999};

    //Then you can go and get that element if you want to use it and fill it in for you.
    if (shower_direction_set) { ShowerEleHolder.GetElement("ShowerDirection", ShowerDirection); }

    //Do some crazy physics - Some legacy code in here for ease.
    recob::Vertex const& proposed_vertex = *vertices[0];
    auto pos = proposed_vertex.position();

    if (ShowerDirection.X() < 0) { pos *= -1.; }
    recob::Vertex new_vertex{pos, {}, util::kBogusD, util::kBogusI};
    geo::Point_t recobshower_err = pos * 0.1;
    //You can set elements of the recob::shower just choose the right name (you can acess them later). You can give the property an error anf this must be done the for standard recob::shower properties; The standard is to access the name via a fcl file.
    ShowerEleHolder.SetElement(pos, recobshower_err, "ShowerStartPosition");

    //You can also set the same element with a different name so that you can compare downstream two tools.
    //The standard is to actually define the name in fcl.
    ShowerEleHolder.SetElement(pos, recobshower_err, "ShowerExampleTool_ShowerStartPosition");

    //Or you can set one of the save elements
    ShowerEleHolder.SetElement(new_vertex, "myvertex");

    //Or a new unsave one.
    std::vector<double> xyz_vec = {pos.X(), pos.Y(), pos.Z()};
    ShowerEleHolder.SetElement(xyz_vec, "xyz");

    //If you want to check if your element was actually made before the shower is made you can set a bool. If partial showers is turned off then the shower will not be made if this element is not filled. Properties i.e. elements with errors i.e. ShowerStartPosition  will not be checked. There is no way to store properties in the Event, only products are stored. You can make your own class which holds the error. The defualt is not to check the element. The recob::shower properties are checked however.
    ShowerEleHolder.SetElement(xyz_vec, "xyz", true);

    //You can see if an element will be checked before the shower is save with
    bool will_be_checked = ShowerEleHolder.CheckElementTag("xyz");

    if (will_be_checked) { std::cout << "Element checked at save time" << std::endl; }

    //You can also changed the tag.
    ShowerEleHolder.SetElementTag("xyz", false);

    //Note: Elements that are actually saved because you defined them in InitialiseProducers will be checked regardless. We don't want you saving nothign now.

    //You can also get the shower number that you are current one (the first shower number is 0).
    int showernum = ShowerEleHolder.GetShowerNumber();
    if (fVerbose > 1) std::cout << "You on are shower: " << showernum << std::endl;

    //You can also read out what ptr are set and what elements are set:.
    PrintPtrs();
    PrintPtr("myvertex");
    ShowerEleHolder.PrintElements();

    //Remember to add make a new fcl parmas list for your new tool. For examles see showertools.fcl. And remember to add it the the list in the module fcl params list.

    return 0;
  }

const shower::LArPandoraShowerAlg& ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg ( ) const

inlineprotectedinherited

Definition at line 82 of file IShowerTool.h.

Referenced by ShowerRecoTools::ShowerLengthPercentile::CalculateElement(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPCAPropergationStartPosition::CalculateElement(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPFPVertexStartPosition::CalculateElement(), ShowerRecoTools::ShowerDirectionCheater::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateElement(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateShowerPCA(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::FindInitialTrackHits(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::FindTrackSpacePoints(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::FitSegmentAndCalculateResidual(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneFrontOfSPSPool(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneTrack(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::RunTestOfIncrementalSpacePointFinder(), ShowerRecoTools::ShowerTrackPCADirection::ShowerPCAVector(), and ShowerRecoTools::ShowerIncrementalTrackHitFinder::ShowerPCAVector().

    {
      return fLArPandoraShowerAlg;
    };

template<class T >

art::Ptr<T> ShowerRecoTools::IShowerTool::GetProducedElementPtr ( std::string  Name, reco::shower::ShowerElementHolder &  ShowerEleHolder, int  iter = -1  )

inlineprotectedinherited

Definition at line 102 of file IShowerTool.h.

References reco::shower::ShowerElementHolder::CheckElement(), reco::shower::ShowerProducedPtrsHolder::CheckUniqueProduerPtr(), reco::shower::ShowerProducedPtrsHolder::GetArtPtr(), and reco::shower::ShowerElementHolder::GetShowerNumber().

    {

      //Check the element has been set
      bool check_element = ShowerEleHolder.CheckElement(Name);
      if (!check_element) {
        throw cet::exception("IShowerTool") << "tried to get a element that does not exist. Failed "
                                               "at making the art ptr for Element: "
                                            << Name << std::endl;
      }

      //Check the unique ptr has been set.
      bool check_ptr = UniquePtrs->CheckUniqueProduerPtr(Name);
      if (!check_ptr) {
        throw cet::exception("IShowerTool")
          << "tried to get a ptr that does not exist. Failed at making the art ptr for Element"
          << Name;
      }

      //Check if the user has defined an index if not just use the current shower index/
      int index;
      if (iter != -1) { index = iter; }
      else {
        index = ShowerEleHolder.GetShowerNumber();
      }

      //Make the ptr
      return UniquePtrs->GetArtPtr<T>(Name, index);
    }

int ShowerRecoTools::IShowerTool::GetVectorPtrSize ( std::string  Name )

inlineprotectedinherited

Definition at line 158 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::GetVectorPtrSize().

Referenced by AddAssociations(), ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder::AddAssociations(), and ShowerRecoTools::ShowerPCADirection::AddAssociations().

{ return UniquePtrs->GetVectorPtrSize(Name); }

void ShowerRecoTools::IShowerTool::InitaliseProducerPtr ( reco::shower::ShowerProducedPtrsHolder &  uniqueproducerPtrs )

inlineinherited

Definition at line 68 of file IShowerTool.h.

    {
      UniquePtrs = &uniqueproducerPtrs;
    }

void ShowerRecoTools::ShowerExampleTool::InitialiseProducers ( )

overrideprivatevirtual

Reimplemented from ShowerRecoTools::IShowerTool.

Definition at line 49 of file ShowerExampleTool_tool.cc.

  {
    //Do you create something and you want to save it the event. Initialsie here. For every event with have a vector of showers so each one has a vertex. This is what we are saving. Make sure to use the name "myvertex" later down the line.
    InitialiseProduct<std::vector<recob::Vertex>>("myvertex");

    //We can also do associations
    InitialiseProduct<art::Assns<recob::Shower, recob::Vertex>>("myvertexassan");
  }

template<class T >

void ShowerRecoTools::IShowerTool::InitialiseProduct ( std::string  Name, std::string  InstanceName = ""  )

inlineprotectedinherited

Definition at line 137 of file IShowerTool.h.

References art::ProducesCollector::produces(), and reco::shower::ShowerProducedPtrsHolder::SetShowerUniqueProduerPtr().

    {

      if (collectorPtr == nullptr) {
        mf::LogWarning("IShowerTool") << "The art::ProducesCollector ptr has not been set";
        return;
      }

      collectorPtr->produces<T>(InstanceName);
      UniquePtrs->SetShowerUniqueProduerPtr(type<T>(), Name, InstanceName);
    }

void ShowerRecoTools::IShowerTool::PrintPtr ( std::string  Name )

inlineprotectedinherited

Definition at line 162 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::PrintPtr().

Referenced by CalculateElement().

{ UniquePtrs->PrintPtr(Name); }

void ShowerRecoTools::IShowerTool::PrintPtrs ( )

inlineprotectedinherited

Definition at line 160 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::PrintPtrs().

Referenced by CalculateElement().

{ UniquePtrs->PrintPtrs(); }

int ShowerRecoTools::IShowerTool::RunShowerTool ( const art::Ptr< recob::PFParticle > &  pfparticle, art::Event &  Event, reco::shower::ShowerElementHolder &  ShowerEleHolder, std::string  evd_display_name_append = ""  )

inlineinherited

Definition at line 46 of file IShowerTool.h.

    {

      int calculation_status = CalculateElement(pfparticle, Event, ShowerEleHolder);
      if (calculation_status != 0) return calculation_status;
      if (fRunEventDisplay) {
        IShowerTool::GetLArPandoraShowerAlg().DebugEVD(
          pfparticle, Event, ShowerEleHolder, evd_display_name_append);
      }
      return calculation_status;
    }

void ShowerRecoTools::IShowerTool::SetPtr ( art::ProducesCollector *  collector )

inlineinherited

Definition at line 65 of file IShowerTool.h.

{ collectorPtr = collector; }

Member Data Documentation

art::InputTag ShowerRecoTools::ShowerExampleTool::fPFParticleLabel

private

Definition at line 38 of file ShowerExampleTool_tool.cc.

Referenced by CalculateElement().

int ShowerRecoTools::ShowerExampleTool::fVerbose

private

Definition at line 39 of file ShowerExampleTool_tool.cc.

Referenced by AddAssociations(), and CalculateElement().

---

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

• larpandora/v09_22_05/source/larpandora/LArPandoraEventBuilding/LArPandoraShower/Tools/ShowerExampleTool_tool.cc