TAnalysisLoop.hxx

Go to the documentation of this file.

#include <vector>

#include <TOADatabase.hxx>
#include <nd280EventLoop.hxx>

#include "TAnalysisModuleBase.hxx"

/// Used to expose globals that may be of use to other modules.
namespace AnalysisLoopGlobals {
/// Holds the number of processed events.
///
/// Used by an interrupt handler in RunEventAnalysis.cxx to report loop progress.
extern int EventNumber;
///\brief Holds the name of the module that is currently executing
/// TAnalysisBase::Process
///
/// Set by ND::TAnalysisLoop::Operator().
/// Used by an interrupt handler in RunEventAnalysis.cxx to report loop progress.
extern std::string CurrentlyProcessingModule;
/// Used to notify the event loop to stop processing events and finish quickly.
extern bool StopProcessing;
}

namespace ND {
class TAnalysisLoop;
OA_EXCEPTION(EProductionException, EeventAnalysis);

/// Generate an analysis tree to summarize the event reconstruction.  This
/// should be replaced by the general eventAnalysis tree, but that's not ready.
class TAnalysisLoop : public ND::TND280EventLoopFunction {
 public:
  ///\brief Initialize any class specific variables.
  ///
  /// Most of the work can be done in ND::TAnalysisLoop::Initialize.
  ///\warning Don't create histograms here!
  TAnalysisLoop();
  virtual ~TAnalysisLoop();

  ///\brief Print a usage message.
  ///
  /// \note This is generally called when there is a command line input error.
  void Usage(void);

  ///\brief Set an option and return true if it is valid.
  ///
  /// This is called by the event loop command line argument processing code
  /// for each "-O [name]=[value]" option found on the command line.  If the
  /// command line has "-O [name]" without a value, then the value string will
  /// be equal to "".  This must return false if the option was not correctly
  /// processed.
  virtual bool SetOption(std::string, std::string);

  /// \brief Called for each event inside the event loop, and returns true if
  /// the event should be saved to the output file.
  ///
  /// If the remainder of the current file should be skipped, this should
  /// throw the ENextEventLoopFile exception.
  bool operator()(ND::TND280Event& event);

  ///\brief Called after the arguments are processes by before reading the
  /// first event.
  ///
  /// The output file is open so any histograms will be added to the
  /// output file.
  virtual void Initialize(void);

  ///\brief Called before the first event of a file is read, but you should
  /// prefer TAnalysisLoop::Initialize for general initialization.
  ///
  /// This method will be called once for each input file.
  virtual void BeginFile(ND::TVInputFile* input);

  ///\brief Called after the last event of a file is read, but you should
  /// prefer TAnalysisLoop: Finalize() for general finalization.
  ///
  /// This method will be called once for each input file.
  virtual void EndFile(ND::TVInputFile*);

  ///\brief Called after The last event but before the output file is closed.
  ///
  /// Because of an idiosyncrasy in the way root handles histograms, objects
  /// created in Initialize() will already be stored in the output file.
  using ND::TND280EventLoopFunction::Finalize;
  virtual void Finalize(ND::TND280Output* const output);

 private:
  /// Private typedef which makes talking to fAnalysisModules slightly nicer.
  typedef std::pair<std::string, ND::TAnalysisModuleBase*> ModDescriptor;
  /// Private typedef which makes talking to fAnalysisModules slightly nicer.
  typedef std::vector<ModDescriptor>::iterator ModDescripterator;
  /// Private typedef which makes talking to fAnalysisModules slightly nicer.
  typedef std::vector<ModDescriptor>::const_iterator CModDescripterator;

  ///\brief Method to set the the default enable/disable values for all
  /// modules in fAnalysisModules map.
  void SetModuleDefaults();

  ///\brief Searches through TAnalysisLoop::fAnalysisModules for a street
  /// module named Bob.
  ///
  ///\returns std::vector::end if none is found.
  ModDescripterator FindNamedModule(
      std::vector<TAnalysisLoop::ModDescriptor>& ModMap,
      std::string ModuleName);

  ///\brief Searches through TAnalysisLoop::fAnalysisModules for a street
  /// module named Bob.
  ///
  ///\returns std::vector::end if none is found.
  CModDescripterator FindNamedModule(
      std::vector<TAnalysisLoop::ModDescriptor> const& ModMap,
      std::string ModuleName);

  /// Keep track of the events that have been read.
  int fEventCount;

  /// Flag if the full event (not the analysis format) is also to be saved
  /// This overrides any -preselection=<&lt;moduleclass&gt;> settings
  bool fSaveOriginalFullEvent;

  /// Set automatically if the oaEvent tree needs to be saved in output
  /// file.
  bool fSaveOutputOaEventTree;

  /// Internal map of all modules.
  std::vector<ModDescriptor> fAnalysisModules;

  ///\brief Store whether a module has been set to disabled/enables by user
  /// as well as whether the disable/enable all options have been set.
  ///
  /// fUserEnabled takes highest precidence over fDisableAll and fEnableAll.
  std::map<std::string, bool> fUserEnabled;

  /// This is overridden by fEnableAll.
  bool fDisableAll;
  ///\brief Enables All modules, if a given module
  /// isn't disabled in fUserEnabled.
  bool fEnableAll;

  /// Controls production mode
  bool fProduction;
  ///\brief If set to true during execution will result in execution
  /// termination at the end of the next event.
  bool fExit;

  /// Control validation mode
  bool fValidation;

  /// The ND280 geometry to be saved
  TGeoManager* fGeom;
  /// Flag to control saving ND280 geometry
  bool fGeometry;
};
}