LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_pandora::LArPandoraOutput::Settings Class Reference

Settings class. More...

#include "LArPandoraOutput.h"

Public Member Functions

 Settings ()
 Default constructor. More...
 
void Validate () const
 Check the parameters and throw an exception if they are not valid. More...
 

Public Attributes

const pandora::Pandora * m_pPrimaryPandora
 
bool m_shouldRunStitching
 
bool m_shouldProduceSlices
 Whether to produce output slices e.g. may not want to do this if only (re)processing single slices. More...
 
bool m_shouldProduceAllOutcomes
 If all outcomes should be produced in separate collections (choose false if you only require the consolidated output) More...
 
std::string m_allOutcomesInstanceLabel
 The label for the instance producing all outcomes. More...
 
bool m_shouldProduceTestBeamInteractionVertices
 Whether to write the test beam interaction vertices in a separate collection. More...
 
std::string m_testBeamInteractionVerticesInstanceLabel
 The label for the test beam interaction vertices. More...
 
bool m_isNeutrinoRecoOnlyNoSlicing
 If we are running the neutrino reconstruction only with no slicing. More...
 
std::string m_hitfinderModuleLabel
 The hit finder module label. More...
 

Detailed Description

Settings class.

Definition at line 80 of file LArPandoraOutput.h.

Constructor & Destructor Documentation

lar_pandora::LArPandoraOutput::Settings::Settings ( )

Default constructor.

Definition at line 1181 of file LArPandoraOutput.cxx.

1182  : m_pPrimaryPandora(nullptr)
1183  , m_shouldRunStitching(false)
1187  {}
const pandora::Pandora * m_pPrimaryPandora
bool m_isNeutrinoRecoOnlyNoSlicing
If we are running the neutrino reconstruction only with no slicing.
bool m_shouldProduceTestBeamInteractionVertices
Whether to write the test beam interaction vertices in a separate collection.
bool m_shouldProduceAllOutcomes
If all outcomes should be produced in separate collections (choose false if you only require the cons...

Member Function Documentation

void lar_pandora::LArPandoraOutput::Settings::Validate ( ) const

Check the parameters and throw an exception if they are not valid.

Definition at line 1191 of file LArPandoraOutput.cxx.

References m_allOutcomesInstanceLabel, m_pPrimaryPandora, and m_shouldProduceAllOutcomes.

Referenced by lar_pandora::LArPandoraOutput::ProduceArtOutput().

1192  {
1193  if (!m_pPrimaryPandora)
1194  throw cet::exception("LArPandora")
1195  << " LArPandoraOutput::Settings::Validate --- primary Pandora instance does not exist ";
1196 
1197  if (!m_shouldProduceAllOutcomes) return;
1198 
1199  if (m_allOutcomesInstanceLabel.empty())
1200  throw cet::exception("LArPandora")
1201  << " LArPandoraOutput::Settings::Validate --- all outcomes instance label not set ";
1202  }
const pandora::Pandora * m_pPrimaryPandora
std::string m_allOutcomesInstanceLabel
The label for the instance producing all outcomes.
bool m_shouldProduceAllOutcomes
If all outcomes should be produced in separate collections (choose false if you only require the cons...
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33

Member Data Documentation

std::string lar_pandora::LArPandoraOutput::Settings::m_allOutcomesInstanceLabel

The label for the instance producing all outcomes.

Definition at line 98 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandora::ProcessPandoraOutput(), lar_pandora::LArPandoraOutput::ProduceArtOutput(), and Validate().

std::string lar_pandora::LArPandoraOutput::Settings::m_hitfinderModuleLabel

The hit finder module label.

Definition at line 105 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandoraOutput::CopyAllHitsToSingleSlice(), and lar_pandora::LArPandora::LArPandora().

bool lar_pandora::LArPandoraOutput::Settings::m_isNeutrinoRecoOnlyNoSlicing

If we are running the neutrino reconstruction only with no slicing.

Definition at line 104 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandoraOutput::BuildSlices(), and lar_pandora::LArPandora::LArPandora().

const pandora::Pandora* lar_pandora::LArPandoraOutput::Settings::m_pPrimaryPandora
bool lar_pandora::LArPandoraOutput::Settings::m_shouldProduceAllOutcomes

If all outcomes should be produced in separate collections (choose false if you only require the consolidated output)

Definition at line 97 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandora::ProcessPandoraOutput(), lar_pandora::LArPandoraOutput::ProduceArtOutput(), and Validate().

bool lar_pandora::LArPandoraOutput::Settings::m_shouldProduceSlices

Whether to produce output slices e.g. may not want to do this if only (re)processing single slices.

Definition at line 95 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandora::LArPandora(), and lar_pandora::LArPandoraOutput::ProduceArtOutput().

bool lar_pandora::LArPandoraOutput::Settings::m_shouldProduceTestBeamInteractionVertices

Whether to write the test beam interaction vertices in a separate collection.

Definition at line 100 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandora::LArPandora(), and lar_pandora::LArPandoraOutput::ProduceArtOutput().

bool lar_pandora::LArPandoraOutput::Settings::m_shouldRunStitching
std::string lar_pandora::LArPandoraOutput::Settings::m_testBeamInteractionVerticesInstanceLabel

The label for the test beam interaction vertices.

Definition at line 102 of file LArPandoraOutput.h.

Referenced by lar_pandora::LArPandora::LArPandora(), and lar_pandora::LArPandoraOutput::ProduceArtOutput().


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