BCH2D.h

#ifndef __BCH2D__H
#define __BCH2D__H

/*
 * Copyright (C) 2007-2018, the BAT core developer team
 * All rights reserved.
 *
 * For the licensing terms see doc/COPYING.
 * For documentation see http://mpp.mpg.de/bat
 */

// ---------------------------------------------------------

#include "BCHistogramBase.h"

#include <vector>
#include <string>

class TH2;
class TGraph;
class TObject;

// ---------------------------------------------------------

class BCH2D : public BCHistogramBase
{

public:

    enum BCH2DBandType {
        kNoBands                  = -1, 
        kSmallestInterval          = 0  
                                     // kCentralIntervalOfYGivenX  = 1, //!< 1D central intervals in Y for each bin in X
                                     // kCentralIntervalOfXGivenY  = 2, //!< 1D central intervals in X for each bin in Y
                                     // kSmallestIntervalOfYGivenX = 3, //!< 1D smallest intervals in Y for each bin in X
                                     // kSmallestIntervalOfXGivenY = 4, //!< 1D smallest intervals in X for each bin in Y
                                     // kUpperLimitOfYGivenX       = 5, //!< 1D upper limits of Y for each bin in X
                                     // kUpperLimitOfXGivenY       = 6, //!< 1D upper limits of X for each bin in Y
                                     // kLowerLimitOfYGivenX       = 7, //!< 1D lower limits of Y for each bin in X
                                     // kLowerLimitOfXGivenY       = 8  //!< 1D lower limits of X for each bin in Y
    };

    enum BCH2DProfileType {
        kProfileMean   = 0,
        kProfileMedian = 1,
        kProfileMode   = 2
    };

    enum BCH2DProfileAxis {
        kProfileX = 0,
        kProfileY = 1
    };

    BCH2D(const TH2* const h = 0);

    BCH2D(const BCH2D& other);

    virtual ~BCH2D() {};

    TH2* GetHistogram()
    { return (TH2*)fHistogram; }

    BCH2DBandType GetBandType()
    { return fBandType; }

    bool GetLogz()
    { return fLogz; }

    bool GetDrawProfileX()
    { return fDrawProfileX; }

    BCH2DProfileType GetProfileXType()
    { return fProfileXType; }

    int GetProfileXLineColor()
    { return fProfileXLineColor; }

    int GetProfileXLineStyle()
    { return fProfileXLineStyle; }

    bool GetDrawProfileY()
    { return fDrawProfileY; }

    BCH2DProfileType GetProfileYType()
    { return fProfileYType; }

    int GetProfileYLineColor()
    { return fProfileYLineColor; }

    int GetProfileYLineStyle()
    { return fProfileYLineStyle; }

    using BCHistogramBase::CopyOptions;

    void CopyOptions(const BCH2D& other);

    using BCHistogramBase::SetGlobalMode;

    void SetGlobalMode(double x, double y)
    { std::vector<double> m(1, x); m.push_back(y); SetGlobalMode(m); }

    using BCHistogramBase::SetLocalMode;

    void SetLocalMode(double x, double y)
    { std::vector<double> m(1, x); m.push_back(y); SetLocalMode(m); }

    void SetBandType(BCH2DBandType bt)
    { fBandType = bt; }

    void SetLogz(bool flag = true)
    { fLogz = flag; }

    void SetDrawProfileX(bool flag = true)
    { fDrawProfileX = flag; }

    void SetProfileXType(BCH2DProfileType pt)
    { fProfileXType = pt; }

    void SetProfileXLineColor(int c)
    { fProfileXLineColor = c; }

    void SetProfileXLineStyle(int s)
    { fProfileXLineStyle = s; }

    void SetDrawProfileY(bool flag = true)
    { fDrawProfileY = flag; }

    void SetProfileYType(BCH2DProfileType pt)
    { fProfileYType = pt; }

    void SetProfileYLineColor(int c)
    { fProfileYLineColor = c; }

    void SetProfileYLineStyle(int s)
    { fProfileYLineStyle = s; }

    using BCHistogramBase::CheckIntervals;

    virtual void CheckIntervals(std::vector<double>& intervals);

    virtual std::vector<double> DefaultIntervals(int nbands = -1);

    virtual void DrawBands(const std::string& options = "same");

    virtual void DrawMarkers();

    TGraph* CalculateProfileGraph(BCH2DProfileAxis axis, BCH2DProfileType pt = kProfileMean);

    void DrawProfileGraphs();

protected:

    BCH2DBandType fBandType;

    bool fLogz;

    bool fDrawProfileX;

    BCH2DProfileType fProfileXType;

    int fProfileXLineColor;

    int fProfileXLineStyle;

    bool fDrawProfileY;

    BCH2DProfileType fProfileYType;

    int fProfileYLineColor;

    int fProfileYLineStyle;

};

// ---------------------------------------------------------

#endif