HistogramDefinition.hh

Go to the documentation of this file.

///
/// @file  HistogramDefinition.hh
/// @brief Histogram definition class
///

//**** This file is a part of the HAMMER library
//**** Copyright (C) 2016 - 2020 The HAMMER Collaboration
//**** HAMMER is licensed under version 3 of the GPL; see COPYING for details
//**** Please note the MCnet academic guidelines; see GUIDELINES for details

// -*- C++ -*-
#ifndef HAMMER_MATH_HISTOGRAMDEFINITION_HH
#define HAMMER_MATH_HISTOGRAMDEFINITION_HH

#include <vector>
#include <utility>

#include "Hammer/Tools/HammerSerial.fhh"
#include "Hammer/Tools/Utils.hh"
#include "Hammer/IndexTypes.hh"

#include "Hammer/Math/Tensor.hh"

#include "Hammer/Math/MultiDim/BinnedIndexing.hh"
#include "Hammer/Math/MultiDim/SequentialIndexing.hh"

namespace Hammer {

    namespace MD = MultiDimensional;

    class Log;

    class HistogramDefinition {

    public:

        HistogramDefinition(bool hasUnderOverFlow, const IndexList& numBins, const MD::BinEdgeList& binEdges,
                            bool shouldCompress, bool keepErrors);
        HistogramDefinition(bool hasUnderOverFlow, const IndexList& numBins, const MD::BinRangeList& ranges,
                            bool shouldCompress, bool keepErrors);
        HistogramDefinition(bool hasUnderOverFlow, const MD::BinEdgeList& binEdges, bool shouldCompress, bool keepErrors);

        HistogramDefinition(const Serial::FBHistoDefinition* msgreader);
    public:


        void addFixedData(MultiDimensional::SharedTensorData data);
        void resetFixedData();
        const Tensor& getFixedData(EventUID id, const std::string& schemeName, LabelsList tensorLabels) const;

        const MD::BinnedIndexing<MD::SequentialIndexing>& getIndexing() const;
        bool shouldCompress() const;
        void setCompression(bool value);
        bool shouldKeepErrors() const;
        void setKeepErrors(bool value);

        void write(flatbuffers::FlatBufferBuilder* msgwriter, const std::string& name) const;

        bool checkDefinition(const Serial::FBHistoDefinition* msgreader) const;
    private:
        /// @brief    logging facility
        /// @return   stream to be used for logging
        Log& getLog() const;

        void read(const Serial::FBHistoDefinition* msgreader);

    private:
        MD::BinnedIndexing<MD::SequentialIndexing> _indexing;
        bool _compressHistograms;
        bool _keepErrors;

        using FixedKey = std::pair<EventUID, SchemeName>;
        mutable UMap<FixedKey, Tensor> _fixedData;

        std::map<IndexLabel, MultiDimensional::SharedTensorData> _fixedDataPool;

    };


} // namespace Hammer

#endif