GEVPad.hh

Go to the documentation of this file.

//======================================================================
/*! \file GEVPad.hh
 *
 *  Déclaration des méthodes de la classe GEVPad, qui gère les
 *  spectres associés à une zone graphique (Pad).
 *
 *  mise à jour: 14 septembre 2009
 *    - nouveau modes de tracé (Root2.9 : classe RGHistoPlotModeSelect)
 *    - prise en compte des spectres 3D
 */
//======================================================================

#ifndef GEV_PAD_HH
#define GEV_PAD_HH

// includes de la bibliothèque Event
#include "EventManager.hh"
#include "GEVPlot.hh"
#include "GEVPadProperties.hh"
#include "GEVPadAxisProperties.hh"

#include "GEVPadContourList.hh"

// includes templates
#include "GListT.hh"

// includes ROOT
#include <TCanvas.h>
#include <TPad.h>
#include <TPaveText.h>


class GEVPage;
class GEVPageManager;

//======================================================================
/*! \class GEVPad
 *
 *  Classe qui gère un ensemble de spectres à afficher dans une zone
 *  graphique (Pad).
 *  Les instances de cette classe ne devraient être générées que par
 *  la classe GEVPage.
 *
 *  Des informations graphiques sont associées à chaque objet
 *  GEVPad:
 *  - position dans le canevas de la page (valeurs comprises entre 0 et 1
 *    en X et en Y; verticalement, 0 correspond au haut de page et 1 au
 *    bas de page, ce qui est inversé par rapport au canevas Root).
 *  - marges pour le tracé de la zone spectre
 *  - décalage des titres X et Y par rapport à la zone de tracé (ils sont
 *    associés au pad, plutôt qu'à l'histogramme comme c'est le cas dans
 *    ROOT).
 *
 *  Chaque pad définit une liste des contours qui y sont tracés.
 *  Les éléments de la liste représente un pointeur sur un contour
 *  et ses attributs de tracé dans le pad.
 *  Ils ne gèrent pas les contours, et se contentent d'y faire référence:
 *  les contours sont gérés de façon centralisée par le gestionnaire
 *  d'événements.
 */

class GEVPad : public GListT<GEVPlot>,
               public GEVPadProperties,
               public GEVPadAxisProperties
{
  friend class GEVPage;

  /// Itérateur des tracés de la collection (liste)
  typedef GListIterT<GEVPlot>   iterator;

//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(GEVPad);
//----------------------------------------------------------------------

  protected:
    EventManager      * event_mgr;  ///< Pointeur sur le gestionnaire d'événement
    GEVPage           * page_ptr;   ///< Pointeur sur la page contenant le pad

    TPad              * pad_ptr;    ///< Pointeur sur le pad ROOT associéaf9f21a7c8@

    GEVPadContourList   ctr_list;   ///< Liste des contours dans le pad

    // options d'affichage
    Bool_t              stat;         ///< Affichage des statistiques
    Bool_t              stat_entries; ///< Nombre d'entrées dans les statistiques
    Bool_t              stat_mean;    ///< Valeur moyenne dans les statistiques
    Bool_t              stat_rms;     ///< Ecart-type dans les statistiques
    Bool_t              stat_cont;    ///< Statistiques des contours

    Float_t             stat_size;    ///< Taille du texte statistique
    Int_t               stat_prec;    ///< Précision des statistiques
    TPaveText           stat_pave;    ///< Zone des statistiques

  public:

//----------------------------------------------------------------------
//  CONSTRUCTEUR / AFFECTATION / DESTRUCTEUR

    // Constructeur
    GEVPad ( const Double_t x0,
             const Double_t x1,
             const Double_t y0,
             const Double_t y1 );

    // Constructeur de recopie
    GEVPad ( const GEVPad & original );

    // Destructeur
    virtual ~GEVPad ( );

    // Opérateur d'affectation
    GEVPad & operator = ( const GEVPad & original );

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

  protected:

    // Mise en place
    virtual void SetPage    ( GEVPage *page );
    virtual void Setup      ( const string &name, TCanvas * c );

  public:
    // Informations associées au PAD
    virtual GEVPage         * GetPagePtr         ( ) const;
    virtual GEVPageManager  * GetPageManagerPtr  ( ) const;
    virtual EventManager    * GetEventManagerPtr ( ) const;

    virtual const Param     * GetXParamPtr   ( ) const;
    virtual const Param     * GetYParamPtr   ( ) const;
    virtual const Param     * GetZParamPtr   ( ) const;
    virtual Int_t             GetParamNumber ( ) const;

    // Options et info diverses
    virtual string  GetPlotOptionString ( const GEVPlot *hplot ) const;
    virtual UInt_t  GetPlotOptions      ( const GEVPlot *hplot ) const;

    virtual Int_t   Get1DplotNumber ( ) const;
    virtual Int_t   Get2DplotNumber ( ) const;
    virtual Int_t   Get3DplotNumber ( ) const;

    // options pour le pad
    virtual void  SetLogX ( const bool b = true );
    virtual void  SetLogY ( const bool b = true );
    virtual void  SetLogZ ( const bool b = true );
    virtual void  SetStat        ( const bool b = true );
    virtual void  SetStatEntries ( const bool b = true );
    virtual void  SetStatMean    ( const bool b = true );
    virtual void  SetStatRMS     ( const bool b = true );
    virtual void  SetStatCont    ( const bool b = true );

    // teste si modes log posibles
    virtual bool  CheckLogX ( );
    virtual bool  CheckLogY ( );
    virtual bool  CheckLogZ ( );
    virtual void  Unzoom ( );

    // Mise à jour (graphique), remise à valeur de la géométrie
    virtual void  ResetOptions  ( );
    virtual void  ResetGeometry ( );
    virtual void  Update        ( );

    virtual void  ExportPad     ( );

    //------------------------------------------------------------------
    // Gestion des spectres du pad
    virtual GEVPlot * AddSpectrum     ( const string &spec_name );
    virtual GEVPlot * AddSpectrumPlot ( GEVPlot * plot );

    virtual bool      UsesSpectrum    ( const Spectrum * sp ) const;
    virtual void      RemoveSpectrum  ( const Spectrum * sp );

    virtual GEVPlot * GetPlotPtr ( const Spectrum * spec_ptr  ) const;
    virtual GEVPlot * GetPlotPtr ( const string   & spec_name ) const;
    virtual GEVPlot * GetPlotPtr ( const u_int      spec_num  ) const;

    virtual TH1     * GetFirstHistoPtr ( ) const;
    virtual TPad    * GetTPadPtr       ( ) const;

    // sélection d'un spectre tracé dans le pad
    virtual Spectrum  * SelectSpectrum ( const UInt_t opt = 0 ) const;

    //------------------------------------------------------------------
    // tracé de contours dans le pad
    virtual GEVPadContour * AddContour      ( RContour       * ct,      const Int_t m = GEVPadContour::ctDrawNormal );
    virtual GEVPadContour * AddContour      ( const string   & ct_name, const Int_t m = GEVPadContour::ctDrawNormal );
    virtual GEVPadContour * AddContourPlot  ( GEVPadContour  & ct_plot );

    virtual bool  UsesContour     ( const RContour * ct ) const;
    virtual bool  RemoveContour   ( const RContour * ct );
    virtual bool  RemoveContour   ( const string   & ct_name );

    virtual void  ResetContourCounts     ( ) const;
    virtual void  IncrementContourCounts ( ) const;
    virtual void  AdaptContourList   ( );
    virtual void  DrawContourList    ( );
    virtual void  DrawStatPave       ( );

    virtual GEVPadContourList * GetContourListPtr ( );

    // écriture de la définition d'un pad dans un fichier
    virtual bool      Write           ( FILE * fptr ) const;
    virtual bool      WriteProperties ( FILE * fptr ) const;
    virtual bool      WriteContours   ( FILE * fptr ) const;

    static  GEVPad  * Read            ( FILE * fptr, GEVPage *pg );
    virtual bool      ReadProperties  ( FILE * fptr );
    virtual bool      ReadContours    ( FILE * fptr );

//----------------------------------------------------------------------
    // valeurs actuelles de la position dans le pad
    void      GetCurrentGeometry ( Double_t &x0, Double_t &x1,
                                   Double_t &y0, Double_t &y1) const;

//----------------------------------------------------------------------
//  SLOTS
    virtual void RangeAxisChanged ( );

//----------------------------------------------------------------------
//  pour ROOT...
  public:
    /*! Définition à usage de ROOT... */
    ClassDef(GEVPad,0);
} ;


//----------------------------------------------------------------------
//  METHODES INLINE
//----------------------------------------------------------------------

/*! Retourne le pointeur sur la page qui contient le pad.*/
inline GEVPage * GEVPad::GetPagePtr ( ) const
  { return (page_ptr); }

/*! Retourne le pointeur sur le gestionnaire d'événements.*/
inline EventManager * GEVPad::GetEventManagerPtr ( ) const
  { return (event_mgr); }

/*! Retourne le pointeur sur le pad ROOT du canevas.*/
inline TPad * GEVPad::GetTPadPtr ( ) const
  { return (pad_ptr); }

/*! Retourne le pointeur sur la liste de contours à tracer.*/
inline GEVPadContourList * GEVPad::GetContourListPtr ( )
  { return (&ctr_list); }

/*! Remise à zéro des statistiques des contours tracés dans la zone.*/
inline void GEVPad::ResetContourCounts ( ) const
  { ctr_list.ResetCounts(); }

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

/*! Retourne la géométrie actuelle (telle qu'affichée) du pad.
 *  \param  x0  valeur inférieur de X en retour
 *  \param  x1  valeur supérieur de X en retour
 *  \param  y0  valeur inférieur de Y en retour
 *  \param  y1  valeur supérieur de Y en retour
 */
inline void GEVPad::GetCurrentGeometry ( Double_t &x0, Double_t &x1, Double_t &y0, Double_t &y1) const
  { pad_ptr->GetPadPar ( x0, y1, x1, y0); y0 = 1. - y0; y1 = 1. - y1; }


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

/*! Valide l'affichage des statistiques.
 *  \param  b     affichage des statistiques
 */
inline void GEVPad::SetStat ( const bool b )
  { stat = b; }

/*! Valide l'affichage des statistiques.
 *  \param  b     affichage des statistiques
 */
inline void GEVPad::SetStatEntries ( const bool b )
  { stat_entries = b; }

/*! Valide l'affichage des statistiques.
 *  \param  b     affichage des statistiques
 */
inline void GEVPad::SetStatMean ( const bool b )
  { stat_mean = b; }

/*! Valide l'affichage des statistiques.
 *  \param  b     affichage des statistiques
 */
inline void GEVPad::SetStatRMS ( const bool b )
  { stat_rms = b; }

/*! Valide l'affichage des statistiques.
 *  \param  b     affichage des statistiques
 */
inline void GEVPad::SetStatCont ( const bool b )
  { stat_cont = b; }

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