Prod5Loaders.h

Go to the documentation of this file.

#pragma once

#include "CAFAna/Core/Loaders.h"

#include <map>
#include <string>

namespace ana
{
  /// Base class for prod4 loaders.
  class Prod5LoadersBase: public Loaders
  {
  protected:
    /// Set a range of FD and ND MC and ND data paths.
    ///
    /// Provides this method for all derived classes. Can use this method to
    /// set any number of paths - any blank paths will be ignored.
    ///
    /// \param fdmc_nonswap String describing the path/samweb definition for
    ///   FarDet MC non-swap files.
    /// \param fdmc_fluxswap String describing the path/samweb definition for
    ///   FarDet MC flux-swap files.
    /// \param fdmc_tauswap String describing the path/samweb definition for
    ///   FarDet MC tau files (default empty sting).
    /// \param ndmc String describing the path/samweb definition for
    ///   NearDet MC files (default empty string).
    /// \param nddata String describing the path/samweb definition for
    ///   NearDet data files (default empty string).
    void SetLoaderPaths(const std::string& fdmc_nonswap,
                        const std::string& fdmc_fluxswap,
                        const std::string& fdmc_tauswap="",
                        const std::string& ndmc="",
                        const std::string& nddata="");

    /// Set FarDet MC paths.
    ///
    /// Sets nonswap, fluxswap and tau (if applicable) using the format:
    /// prefix_[nonswap|fluxswap|tau]_suffix.
    ///
    /// \param prefix String describing the first part of the file path (e.g.
    ///   "prod_caf_R17-11-14-prod4reco.d_fd_genie").
    /// \param suffix String describing the second part of the file path (e.g.
    ///   "fhc_nova_v08_full_caf_v1").
    /// \param noTau Boolean flag not to set tau file path (default is false,
    ///  tau file paths will be set).
    void SetLoaderFDMCPaths(const std::string& prefix,
                            const std::string& suffix,
                            const bool noTau=false);

    /// Set NearDet MC paths.
    ///
    /// \param ndmc String describing the path/samweb definition for
    ///   NearDet MC files (default empty string).
    void SetLoaderNDMCPath(const std::string& ndmc);

    /// Utility to convert CAF type enum to a string description.
    ///
    /// \param type ECAFType that specifies the CAF type.
    /// \return String describing the CAF type.
    const std::string ECAFTypeToString(ECAFType type);
    std::string ECAFTypeFlatToTier(ECAFType type,
                                   EFlatness flat,
                                   bool flatCAFsExist) const;

    /// Get string describing the associated systematic.
    ///
    /// \return String describing the systematic associated with this loader.
    virtual std::string GetSystString() const = 0;
  };

  /// Provide the data loaders only, base class for other loaders
  class Prod5DataLoaders: public Prod5LoadersBase
  {
  public:
    /// Create data loaders instance.
    ///
    /// \param type ECAFType to specify the CAF type.
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param WhichPeriod String describing the desired range
    ///   (e.g. "full" - default, "period4", "epoch6a").
    /// \param WhichNDPeriod String describing the desired range
    ///   (e.g. "full" - default, "period4", "epoch6a").
    Prod5DataLoaders(ECAFType type,
                     FluxType flux,
                     std::string WhichPeriod="full",
                     std::string WhichNDPeriod="full",
                     EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "Data";}

  // Some useful protected members
  protected:
    const std::string cafType;  ///< A string describing the CAF type,
                                ///< e.g nueconcat2018
    const std::string dataTier; ///< from "caf" to "flatsumdecaf"
    const std::string fluxType;  ///< A string describing the flux,
                                 ///< e.g nonswap
  };

  /// For nominal spectra and reweighting systs (xsec/flux)
  class Prod5NomLoaders: public Prod5DataLoaders
  {
  public:
    /// Create Nominal loaders instance.
    ///
    /// \param type ECAFType to specify the CAF type.
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param WhichPeriod String describing the desired range
    ///   (e.g. "full" - default, "period4", "epoch6a").
    /// \param WhichNDPeriod String describing the desired range
    ///   (e.g. "full" - default, "period4", "epoch6a").
    Prod5NomLoaders(ECAFType type,
                    FluxType flux,
                    std::string WhichPeriod="full",
                    std::string WhichNDPeriod="full",
                    EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "Nominal";}
  };

  /// Loaders for absolute calibration paths/definitions.
  class Prod5AbsCalibLoaders: public Prod5NomLoaders
  {
  public:
    /// Create absolute calibration loaders instance.
    ///
    /// \a sign should be +1 (scale energies up) or -1 (scale energies down)
    ///
    /// \param type ECAFType to specify the CAF type.
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param sign Integer specifying shift up or down.
    /// \param WhichPeriod String describing the desired range
    ///   ("full" only).
    /// \param WhichNDPeriod String describing the desired range
    ///   ("full" only).
    Prod5AbsCalibLoaders(ECAFType type,
                         FluxType flux,
                         int sign,
                         std::string WhichPeriod="full",
                         std::string WhichNDPeriod="full",
                         EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "Calibration";}
  };

  /// Loaders for light level paths/definitions.
  class Prod5LightLevelLoaders: public Prod5NomLoaders
  {
  public:
    /// Create light level loaders instance.
    ///
    /// \warning Prod4 light level file definitions do not exist at present.
    ///
    /// \param type ECAFType to specify the CAF type.
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param sign Integer specifying shift up or down: +1 sigma is light
    ///   levels up, calibration down, 0 is no shift photon rewriter.
    /// \param WhichPeriod String describing the desired range
    ///   ("full" only).
    /// \param WhichNDPeriod String describing the desired range
    ///   ("full" only).
    Prod5LightLevelLoaders(ECAFType type,
                           FluxType flux,
                           int sign,
                           std::string WhichPeriod="full",
                           std::string WhichNDPeriod="full",
                           EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "Lightlevel";}
  };

  /// Loaders for Cherenkov paths/definitions.
  class Prod5CherenkovLoaders: public Prod5NomLoaders
  {
  public:
    /// Create Cherenkov loaders instance.
    ///
    /// \warning Prod4 Cherenkov file definitions do not exist at present.
    ///
    /// \param type ECAFType to specify the CAF type.
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param WhichPeriod String describing the desired range
    ///   ("full" only).
    /// \param WhichNDPeriod String describing the desired range
    ///   ("full" only).
    Prod5CherenkovLoaders(ECAFType type,
                          FluxType flux,
                          std::string WhichPeriod="full",
                          std::string WhichNDPeriod="full",
                          EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "Cherenkov";}
  };

  /// Loaders for calibration shape paths/definitions.
  class Prod5CalibShapeLoaders: public Prod5NomLoaders
  {
  public:
    /// Create calibration shape loaders instance.
    ///
    /// \param type ECAFType to specify the CAF type
    ///   (e.g. kFullCAF, kNueConcat)
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param WhichPeriod String describing the desired range
    ///   ("full" only).
    /// \param WhichNDPeriod String describing the desired range
    ///   ("full" only).
    Prod5CalibShapeLoaders(ECAFType type,
                           FluxType flux,
                           std::string WhichPeriod="full",
                           std::string WhichNDPeriod="full",
                           EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "CalibShape";}
  };
  
  /// Loaders for calibration drift (detector aging) paths/definitions.
  class Prod5CalibDriftLoaders: public Prod5NomLoaders
  {
  public:
    /// Create calibration drift loaders instance.
    ///
    /// \param type ECAFType to specify the CAF type
    ///   (e.g. kFullCAF, kNueConcat)
    /// \param flux FluxType to specify the flux (kFHC/kRHC).
    /// \param WhichPeriod String describing the desired range
    ///   ("full" only).
    /// \param WhichNDPeriod String describing the desired range
    ///   ("full" only).
    Prod5CalibDriftLoaders(ECAFType type,
                           FluxType flux,
                           std::string WhichPeriod="full",
                           std::string WhichNDPeriod="full",
                           EFlatness flat = kNormalCAF);

    std::string GetSystString() const override {return "CalibDrift";}
  };

} //namespace