RGHistoLimits.hh

Go to the documentation of this file.

//======================================================================
/*! \file RGHistoLimits.hh
 *
 *  Include file for class RGHistoLimits
 */
//======================================================================

#ifndef RG_HISTO_LIMITS_HH
#define RG_HISTO_LIMITS_HH

#include <TH1.h>
#include "RBaseFunctions.hh"

//======================================================================
/*! class RGHistoLimits
 *
 *  This class defines axis information for histogram display.
 */

class RGHistoLimits
{
  //------------------------------------------------------------
  /*! \object_doc{RGHistoLimits} */
  GObject(RGHistoLimits);
  //------------------------------------------------------------

  protected:

    Int_t     dimension;        ///< Histogram dimension

    // limites et autorisations d'échelle log
    Double_t  lim_x_min;        ///< Axis lower limit
    Double_t  lim_x_max;        ///< Axis upper limit
    Double_t  lim_y_min;        ///< Axis lower limit
    Double_t  lim_y_max;        ///< Axis upper limit
    Double_t  lim_z_min;        ///< Axis lower limit
    Double_t  lim_z_max;        ///< Axis upper limit

    Double_t  log_x_min;        ///< Lower limit for log scale
    Double_t  log_y_min;        ///< Lower limit for log scale
    Double_t  log_z_min;        ///< Lower limit for log scale

    bool      allow_x_log;      ///< Test if log scale allowed
    bool      allow_y_log;      ///< Test if log scale allowed
    bool      allow_z_log;      ///< Test if log scale allowed

    // bornes effectives et état d'échelle log
    Double_t  x_min;            ///< Current display lower bound
    Double_t  x_max;            ///< Current display upper bound
    Double_t  y_min;            ///< Current display lower bound
    Double_t  y_max;            ///< Current display upper bound
    Double_t  z_min;            ///< Current display lower bound
    Double_t  z_max;            ///< Current display upper bound

    bool      x_log;            ///< Log scale status
    bool      y_log;            ///< Log scale status
    bool      z_log;            ///< Log scale status

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RGHistoLimits ( TH1 * hptr = NULL );
    RGHistoLimits ( const RGHistoLimits &original );

    RGHistoLimits & operator = ( const RGHistoLimits &original );

    virtual void  Affect ( const RGHistoLimits &original );

    virtual ~RGHistoLimits();

  //------------------------------------------------------------
  // Functions
  public:

    virtual void      Reset       ( );
    virtual Int_t     SetHisto    ( TH1 * hptr = NULL, const bool reset = true );

    virtual bool      IsDataSet ( ) const;    // inline

  protected:
    virtual void      Set1DHisto  ( const TH1 * hptr );
    virtual void      Set2DHisto  ( const TH1 * hptr );
    virtual void      Set3DHisto  ( const TH1 * hptr );

  public:

    virtual bool      SetXLog ( const Bool_t b = kTRUE );
    virtual bool      SetYLog ( const Bool_t b = kTRUE );
    virtual bool      SetZLog ( const Bool_t b = kTRUE );

    virtual void      SetXFull ( );
    virtual void      SetYFull ( );
    virtual void      SetZFull ( );

    virtual void      Unzoom  ( );      // inline

  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
    ClassDef(RGHistoLimits,0);
} ;

//----------------------------------------------------------------------
//  Inline functions
#include "icc/RGHistoLimits.icc"

//======================================================================
#endif