Spec1Dim.hh

Go to the documentation of this file.

//======================================================================
/*! \file Spec1Dim.hh
 *
 *  Déclaration des méthodes de la classe Spec1Dim qui est une classe
 *  de base pour les spectres à 1 dimension.
 */
//======================================================================


#ifndef SPEC_1DIM_HH
#define SPEC_1DIM_HH

#include "EventCommon.hh"
#include "Spectrum.hh"
#include "Param.hh"


//======================================================================
/*! \class Spec1Dim
 *
 *  Classe de base pour les spectres à 1 dimension.
 */

class Spec1Dim : public Spectrum
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObjectV(Spec1Dim);
//----------------------------------------------------------------------

  protected:
    u_int   x_dim;      ///< Nombre de canaux de la dimension X
    double  x_min;      ///< Valeur minimum de la dimension X
    double  x_max;      ///< Valeur maximum de la dimension X
    double  x_bin;      ///< largeur d'un bin sur l'axe X

  public:

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

    // Constructeur
    Spec1Dim ( const string & spec_name,
               const u_int nx, const double x1, const double x2 );

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

    // Destructeur
    virtual ~Spec1Dim ();

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

    // retourne la dimension d'un spectre.
    virtual u_int Dimension ( ) const;

    // retourne le nombre de canaux de la dimension X
    virtual u_int Xdim ( ) const;

    // retourne la valeur minimum de la dimension X
    virtual double Xmin ( ) const;

    // retourne la valeur maximum de la dimension X
    virtual double Xmax ( ) const;

    // retourne le bin sur l'axe X correspondant à la valeur d'une donnée    virtual int BinX ( const Data &d ) const;

//----------------------------------------------------------------------
//  METHODES PROTEGEES
//----------------------------------------------------------------------

  protected:

    // Méthode générique qui retourne une chaîne décrivant un axe
    string  AxisDefinition ( const Param &p,
                             const u_int dim,
                             const double min,
                             const double max ) const;

    // Méthode générique qui retourne une chaîne décrivant un axe
    string  AxisDefinition ( const string &label,
                             const u_int dim,
                             const double min,
                             const double max ) const;


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


//======================================================================
//  METHODES INLINE
//======================================================================

/*! Méthode qui retourne la dimension d'un spectre.
 */
inline u_int Spec1Dim::Dimension ( ) const
  { return (1); }


/*!/ Retourne le nombre de canaux de la dimension X.
 */
inline u_int Spec1Dim::Xdim ( ) const
  { return (x_dim); }

/*! Retourne la valeur minimum de la dimension X.
 */
inline double Spec1Dim::Xmin ( ) const
  { return (x_min); }

/*! Retourne la valeur maximum de la dimension X.
 */
inline double Spec1Dim::Xmax ( ) const
  { return (x_max); }


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

    virtual int BinX ( const Data &d ) const;

//----------------------------------------------------------------------
//  METHODES PROTEGEES
//----------------------------------------------------------------------

  protected:

    // Méthode générique qui retourne une chaîne décrivant un axe
    string  AxisDefinition ( const Param &p,
                             const u_int dim,
                             const double min,
                             const double max ) const;

    // Méthode générique qui retourne une chaîne décrivant un axe
    string  AxisDefinition ( const string &label,
                             const u_int dim,
                             const double min,
                             const double max ) const;


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


//======================================================================
//  METHODES INLINE
//======================================================================

/*! Méthode qui retourne la dimension d'un spectre.
 */
inline u_int Spec1Dim::Dimension ( ) const
  { return (1); }


/*!/ Retourne le nombre de canaux de la dimension X.
 */
inline u_int Spec1Dim::Xdim ( ) const
  { return (x_dim); }

/*! Retourne la valeur minimum de la dimension X.
 */
inline double Spec1Dim::Xmin ( ) const
  { return (x_min); }

/*! Retourne la valeur maximum de la dimension X.
 */
inline double Spec1Dim::Xmax ( ) const
  { return (x_max); }


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