cmf::MetaData Struct Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/CovarianceMatrixFit/dataProducts/Structs.h"

Public Member Functions
	MetaData ()
	MetaData (bool const &mc, cmf::DetType_t const &det, cmf::FileType_t const &ft, cmf::SelectionType_t const &st, cmf::InteractionType_t const &it, std::string const &ep)
	MetaData (bool const &mc, cmf::DetType_t const &det, cmf::FileType_t const &ft, cmf::SelectionType_t const &st, cmf::InteractionType_t const &it, int const &ep)
long	MCKey () const
long	DetectorKey () const
long	PeriodKey () const
long	FileKey () const
long	SelectionKey () const
long	InteractionKey () const
long	BeamTypeKey () const
long	DetectorBeamSelectionKey () const
long	Period () const
long	Key () const
std::string	PeriodString () const
std::string	DetectorString () const
std::string	ToString () const
std::string	ToStringLatex () const
std::string	DetectorFilePeriodString () const
bool	IsNuMuSelected () const
bool	IsNuMuQuantiles () const
bool	IsNuESelected () const
bool	IsNCSelected () const
bool	IsCosmicMuon () const
bool	IsRockMuon () const
cmf::BeamType_t	BeamType () const
cmf::MetaDataLite	LiteMD () const
bool	operator== (MetaData const &other) const
bool	operator< (MetaData const &other) const

Public Attributes
bool	isMC
cmf::DetType_t	detector
cmf::FileType_t	fileType
cmf::SelectionType_t	selectionType
cmf::InteractionType_t	interactionType
long	period

Detailed Description

Definition at line 95 of file Structs.h.

Constructor & Destructor Documentation

cmf::MetaData::MetaData

(

)

Definition at line 86 of file Structs.cxx.

  : isMC           (false)
  , detector       (cmf::kUnknownDet)
  , fileType       (kUnknownFileType)
  , selectionType  (kUnknownSelection)
  , interactionType(kUnknownInteraction)
  , period         (0)
  {}

cmf::MetaData::MetaData	(	bool const &	mc,
		cmf::DetType_t const &	det,
		cmf::FileType_t const &	ft,
		cmf::SelectionType_t const &	st,
		cmf::InteractionType_t const &	it,
		std::string const &	ep
	)

Definition at line 96 of file Structs.cxx.

References period, and cmf::PeriodStringToInt().

  : isMC           (mc)
  , detector       (det)
  , fileType       (ft)
  , selectionType  (st)
  , interactionType(it)
  {
    period = cmf::PeriodStringToInt(ep);
  }

cmf::MetaData::MetaData	(	bool const &	mc,
		cmf::DetType_t const &	det,
		cmf::FileType_t const &	ft,
		cmf::SelectionType_t const &	st,
		cmf::InteractionType_t const &	it,
		int const &	ep
	)

Definition at line 112 of file Structs.cxx.

  : isMC           (mc)
  , detector       (det)
  , fileType       (ft)
  , selectionType  (st)
  , interactionType(it)
  , period         (ep)
  {}

Member Function Documentation

cmf::BeamType_t cmf::MetaData::BeamType

(

)

const

Definition at line 178 of file Structs.cxx.

References POTSpillRate::beam, LOG_DEBUG, period, PeriodString(), and cmf::PeriodToBeamType().

Referenced by DetectorBeamSelectionKey(), cmf::ShifterAndWeighter::FileSystWeight(), cmf::EventListManipulator::FillTextFile(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), cmf::ShifterAndWeighter::NormSystWeight(), cmf::RecoEnergy(), ToString(), and ToStringLatex().

  {

    // NOvA Period and Epoch naming scheme from:
    // https://cdcvs.fnal.gov/redmine/projects/novaart/wiki/Period_and_Epoch_Naming
                cmf::BeamType_t beam = cmf::PeriodToBeamType(this->PeriodString());

    LOG_DEBUG("UnknownBeamType")
      << "period : "
      <<  period
      << " Cannot identify beam type";

    return beam;
  }  

long cmf::MetaData::BeamTypeKey ( ) const

inline

Definition at line 126 of file Structs.h.

References cmf::BeamTypeKey().

{ return cmf::BeamTypeKey(this->BeamType());       }

long cmf::MetaData::DetectorBeamSelectionKey

(

)

const

Definition at line 194 of file Structs.cxx.

References BeamType(), detector, cmf::DetectorBeamSelectionTypesToKey(), and selectionType.

Referenced by cmf::CovarianceMatrixMaker::beginJob(), cmf::FillSpectrumFromSingleList(), and makeInitialDecorrelatedErrorPlot().

  {
    return cmf::DetectorBeamSelectionTypesToKey(detector, this->BeamType(), selectionType);
  }

std::string cmf::MetaData::DetectorFilePeriodString ( ) const

inline

Definition at line 168 of file Structs.h.

References cmf::cFileTypeStrings, and mkDefs::fileType.

  {
    return (this->DetectorString()                +
            cmf::cFileTypeStrings[this->fileType] +
            this->PeriodString());
  }

long cmf::MetaData::DetectorKey ( ) const

inline

Definition at line 121 of file Structs.h.

References cmf::DetectorTypeKey().

Referenced by Key().

{ return cmf::DetectorTypeKey(detector);           }

std::string cmf::MetaData::DetectorString ( ) const

inline

Definition at line 151 of file Structs.h.

References cmf::cDetType_Strings, runNovaSAM::detector, and elec2geo::pos.

Referenced by cmf::EventListManipulator::FillTextFile(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), ToString(), and cmf::EventListManipulator::UseEventsFromMetaData().

  {
    // for backwards compatibility with previously made files we will
    // strip the "Det" off the name returned by the novadaq function
    auto name = cmf::cDetType_Strings[detector];
    auto pos  = name.find("Det");

    return (pos != std::string::npos) ? name.erase(pos, 3) : name;
  }

long cmf::MetaData::FileKey ( ) const

inline

Definition at line 123 of file Structs.h.

References cmf::FileTypeKey().

Referenced by Key().

{ return cmf::FileTypeKey(fileType);               }

long cmf::MetaData::InteractionKey ( ) const

inline

Definition at line 125 of file Structs.h.

References cmf::InteractionTypeKey().

Referenced by Key().

{ return cmf::InteractionTypeKey(interactionType); }

bool cmf::MetaData::IsCosmicMuon ( ) const

inline

Definition at line 139 of file Structs.h.

References cmf::kCosmicBackgroundFile.

Referenced by cmf::EventListManipulator::Deserialize(), and cmf::ShifterAndWeighter::Weight().

{ return fileType == cmf::kCosmicBackgroundFile;                            } 

bool cmf::MetaData::IsNCSelected

(

)

const

Definition at line 231 of file Structs.cxx.

References cmf::kNCSelection, and selectionType.

Referenced by cmf::PlotUtilities::MakeEnergySpectraFromBins(), and cmf::RecoEnergy().

  {
    return (this->selectionType == cmf::kNCSelection);
  }

bool cmf::MetaData::IsNuESelected

(

)

const

Definition at line 225 of file Structs.cxx.

References cmf::IsNuESelected(), and selectionType.

Referenced by cmf::PlotUtilities::MakeEnergySpectraFromBins(), cmf::RecoEnergy(), cmf::CovarianceBinUtility::SelectionHighEdges(), and cmf::CovarianceBinUtility::SelectionLowEdge().

  {
    return cmf::IsNuESelected(this->selectionType);
  }

bool cmf::MetaData::IsNuMuQuantiles

(

)

const

Definition at line 213 of file Structs.cxx.

References cmf::IsNuMuQuantiles(), and selectionType.

  {
    return cmf::IsNuMuQuantiles(this->selectionType);
  }

bool cmf::MetaData::IsNuMuSelected

(

)

const

Definition at line 219 of file Structs.cxx.

References cmf::IsNuMuSelected(), and selectionType.

Referenced by cmf::FillSpectrumFromSingleList(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), cmf::RecoEnergy(), cmf::CovarianceBinUtility::SelectionHighEdges(), and cmf::CovarianceBinUtility::SelectionLowEdge().

  {
    return cmf::IsNuMuSelected(this->selectionType);
  }

bool cmf::MetaData::IsRockMuon ( ) const

inline

Definition at line 140 of file Structs.h.

References cmf::kRockFluxSwap, cmf::kRockNonSwap, ana::operator<(), operator==(), and fhicl::other.

{ return (fileType == cmf::kRockFluxSwap || fileType == cmf::kRockNonSwap); } 

long cmf::MetaData::Key

(

)

const

Definition at line 200 of file Structs.cxx.

References DetectorKey(), FileKey(), InteractionKey(), MCKey(), PeriodKey(), and SelectionKey().

Referenced by operator<().

  {
    return ( this->MCKey()          *
            (this->DetectorKey()    +
             this->FileKey()        +
             this->SelectionKey()   +
             this->InteractionKey() +
             this->PeriodKey()
            )
           );
  }

cmf::MetaDataLite cmf::MetaData::LiteMD

(

)

const

Definition at line 127 of file Structs.cxx.

References detector, Period(), and selectionType.

  {
    return MetaDataLite(this->detector, this->selectionType, this->Period());
  }

long cmf::MetaData::MCKey ( ) const

inline

Definition at line 120 of file Structs.h.

Referenced by Key().

{ return ((isMC) ? 1 : -1);                        }

bool cmf::MetaData::operator<

(

MetaData const &

other

)

const

Definition at line 248 of file Structs.cxx.

References Key().

  {
    return this->Key() < other.Key();
  }

bool cmf::MetaData::operator==

(

MetaData const &

other

)

const

Definition at line 237 of file Structs.cxx.

References detector, fileType, interactionType, isMC, period, and selectionType.

  {
    return (other.isMC            == this->isMC            &&
            other.detector        == this->detector        &&
            other.fileType        == this->fileType        &&
            other.selectionType   == this->selectionType   &&
            other.interactionType == this->interactionType &&
            other.period          == this->period);
  }

long cmf::MetaData::Period ( ) const

inline

Definition at line 128 of file Structs.h.

References cmf::IsNuESelected(), cmf::IsNuMuQuantiles(), cmf::IsNuMuSelected(), DCS_db_parser::period, string, and ToString().

Referenced by cmf::EventListManipulator::Deserialize(), cmf::DSTToEventList::endJob(), cmf::CAFToEventList::endJob(), LiteMD(), and cmf::EventListManipulator::UseEventsFromMetaData().

{ return period; }

long cmf::MetaData::PeriodKey ( ) const

inline

Definition at line 122 of file Structs.h.

References cmf::PeriodKey().

Referenced by Key().

{ return cmf::PeriodKey(period);                   }

std::string cmf::MetaData::PeriodString ( ) const

inline

Definition at line 162 of file Structs.h.

References DCS_db_parser::period, and art::to_string().

Referenced by BeamType(), ToString(), ToStringLatex(), cmf::EventListManipulator::UseEventsFromMetaData(), cmf::SelectionUtility::UsesDetAndBeam(), and cmf::SelectionUtility::UsesDetBeamAndSel().

  {
    return ("Period" + std::to_string(period));
  }

long cmf::MetaData::SelectionKey ( ) const

inline

Definition at line 124 of file Structs.h.

References cmf::SelectionTypeKey().

Referenced by Key().

{ return cmf::SelectionTypeKey(selectionType);     }

std::string cmf::MetaData::ToString

(

)

const

Definition at line 133 of file Structs.cxx.

References BeamType(), cmf::cBeamType_Strings, cmf::cFileTypeStrings, cmf::cInteractionType_Strings, cmf::cSelectionType_Strings, DetectorString(), fileType, interactionType, isMC, PeriodString(), selectionType, and string.

Referenced by cmf::EventListManipulator::Deserialize(), cmf::DSTToEventList::endJob(), cmf::CAFToEventList::endJob(), cmf::EventListManipulator::FillEventList(), cmf::FillSpectrumFromSingleList(), cmf::DSTToEventList::InitializeEventListColls(), cmf::CovarianceFitHelper::MakeDataMCCanv(), cmf::EventListManipulator::PeriodEventCap(), cmf::CMFCappedEventList::Serialize(), cmf::SerializeEventListColl(), cmf::ShifterAndWeighter::SetCurrentEvent(), and cmf::EventListManipulator::UseEventsFromMetaData().

  {
    std::string outType = (this->DetectorString() +
                           this->PeriodString()   +
                           cmf::cBeamType_Strings[this->BeamType()]);
    
    if(this->isMC){
      outType.insert(0, "MC");
      outType += cmf::cFileTypeStrings[fileType];
    }
    else
      outType.insert(0, "Data");
    
    outType += cmf::cSelectionType_Strings[selectionType];

    // this is not grouped with the other MC test to have the interaction type
    // be the last thing in the string
    if(this->isMC)
      outType += cmf::cInteractionType_Strings[interactionType];

    return outType;
  }

std::string cmf::MetaData::ToStringLatex

(

)

const

Definition at line 157 of file Structs.cxx.

References BeamType(), cmf::cBeamType_LatexStrings, cmf::cFileTypeStrings_Latex, cmf::cInteractionType_LatexStrings, cmf::cSelectionType_LatexStrings, detector, fileType, interactionType, isMC, cmf::kFARDET, cmf::kNEARDET, PeriodString(), selectionType, and string.

  {
    std::string outType("Data");
    if(this->isMC){
      outType  = "MC";
      outType += " " + cmf::cFileTypeStrings_Latex[fileType];
      outType += " " + cmf::cSelectionType_LatexStrings[selectionType];
      outType += " " + cmf::cInteractionType_LatexStrings[interactionType];
    }
    if(detector == cmf::kFARDET)  outType += " FD";
    if(detector == cmf::kNEARDET) outType += " ND";
    
    outType += this->PeriodString();

    outType += " " + cmf::cBeamType_LatexStrings[this->BeamType()];

    return outType;
  }

Member Data Documentation

cmf::DetType_t cmf::MetaData::detector

Definition at line 114 of file Structs.h.

Referenced by cmf::CovarianceMatrixMaker::beginJob(), cmf::ShifterAndWeighter::CurrentParameterValue(), cmf::EventListManipulator::Deserialize(), DetectorBeamSelectionKey(), cmf::ShifterAndWeighter::FileSystWeight(), cmf::FillSpectrumFromSingleList(), cmf::ShifterAndWeighter::FractionalShift(), MetadataUtils.metaDataMgr::getOutputFileName(), LiteMD(), cmf::CovarianceFitHelper::MakeDataMCCanv(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), makeInitialDecorrelatedErrorPlot(), cmf::ShifterAndWeighter::NormSystWeight(), cmf::CovarianceBinUtility::NuELowEdge(), operator==(), cmf::ShifterAndWeighter::OscillationWeight(), cmf::RecoEnergy(), cmf::CovarianceBinUtility::SelectionHighEdges(), cmf::CovarianceBinUtility::SelectionLowEdge(), ToStringLatex(), cmf::ShifterAndWeighter::TotalWeightFromWeighters(), cmf::EventListManipulator::UseEventsFromMetaData(), cmf::SelectionUtility::UsesDetAndBeam(), cmf::SelectionUtility::UsesDetBeamAndSel(), and cmf::ShifterAndWeighter::Weight().

cmf::FileType_t cmf::MetaData::fileType

Definition at line 115 of file Structs.h.

Referenced by cmf::EventListManipulator::Deserialize(), cmf::FillSpectrumFromSingleList(), operator==(), ToString(), ToStringLatex(), and cmf::EventListManipulator::UseEventsFromMetaData().

cmf::InteractionType_t cmf::MetaData::interactionType

Definition at line 117 of file Structs.h.

Referenced by cmf::ShifterAndWeighter::CMFSystVarWeight(), cmf::EventListManipulator::Deserialize(), operator==(), ToString(), ToStringLatex(), and cmf::EventListManipulator::UseEventsFromMetaData().

bool cmf::MetaData::isMC

Definition at line 113 of file Structs.h.

Referenced by cmf::EventListManipulator::Deserialize(), cmf::DSTToEventList::endJob(), cmf::CAFToEventList::endJob(), cmf::FillSpectrumFromSingleList(), cmf::EventListManipulator::FillTextFile(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), cmf::operator<<(), operator==(), cmf::SerializeEvents(), cmf::ShifterAndWeighter::SetCurrentEvent(), ToString(), ToStringLatex(), cmf::EventListManipulator::UseEventsFromMetaData(), and cmf::ShifterAndWeighter::Weight().

long cmf::MetaData::period

Definition at line 118 of file Structs.h.

Referenced by BeamType(), cmf::CovarianceMatrixMaker::beginJob(), cmf::FillSpectrumFromSingleList(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), makeInitialDecorrelatedErrorPlot(), MetaData(), and operator==().

cmf::SelectionType_t cmf::MetaData::selectionType

Definition at line 116 of file Structs.h.

Referenced by cmf::CovarianceMatrixMaker::beginJob(), cmf::EventListManipulator::Deserialize(), DetectorBeamSelectionKey(), cmf::DSTToEventList::endJob(), cmf::CAFToEventList::endJob(), cmf::ShifterAndWeighter::FileSystWeight(), cmf::FillSpectrumFromSingleList(), cmf::EventListManipulator::FillTextFile(), IsNCSelected(), IsNuESelected(), IsNuMuQuantiles(), IsNuMuSelected(), LiteMD(), cmf::CovarianceFitHelper::MakeDataMCCanv(), cmf::PlotUtilities::MakeEnergySpectraFromBins(), makeInitialDecorrelatedErrorPlot(), cmf::ShifterAndWeighter::NormSystWeight(), cmf::CovarianceBinUtility::NuELowEdge(), cmf::operator<<(), operator==(), cmf::RecoEnergy(), cmf::CovarianceBinUtility::SelectionHighEdges(), ToString(), ToStringLatex(), cmf::EventListManipulator::UseEventsFromMetaData(), and cmf::SelectionUtility::UsesDetBeamAndSel().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/CovarianceMatrixFit/dataProducts/Structs.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/CovarianceMatrixFit/dataProducts/Structs.cxx