SpecOper.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpecOper.hh
 *
 *  Déclaration des fonctions de la classe SpecOper classe de base
 *  pour les spectres opérant sur d'autres spectres.
 */
//======================================================================

#ifndef SPEC_OPER_HH
#define SPEC_OPER_HH

#include "SpecCalc.hh"

//======================================================================
/*! \class SpecOper
 *
 *  Classe de base des spectres opérant sur d'autres spectres.
 *  Ces spectres représentent des opérations sur d'autres spectres
 *  (qui doivent être de même dimension), en prenant éventuellement
 *  en compte des coefficients.
 */
class SpecOper : public SpecCalc
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObjectV(SpecOper);
//----------------------------------------------------------------------

  public:
    static Double_t   epsilon;  ///< Limite de test des divisions par zéro

  protected:
    Int_t   oper_num;     ///< Nombre de spectres opérandes
    Int_t   coef_num;     ///< Nombre de coefficients

  #ifndef __MAKECINT__
    Spectrum   ** oper;   ///< Table des pointeurs des spectres opérandes
    Double_t    * coef;   ///< Table des coefficients
  #endif

  public:

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

    // Constructeur
    SpecOper ( const string & spec_name, const Int_t ncoef = 0 );

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

    // Destructeur
    virtual ~SpecOper ();

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

  protected:
    static  Int_t   SetOperData ( const string       & def_str,
                                  const EventManager * evt_mgr,
                                  Int_t              & nop,
                                  Spectrum        ** & op,
                                  Int_t              & nco,
                                  Double_t         * & co );

    virtual Int_t   SetOperData ( const string & defstr, const EventManager * evt_mgr );

    // définition de l'histo résultat à partir d'une opérande
    virtual void    SetHistoBad ( );
    virtual void    SetHisto    ( const Int_t op = 0 );

    // pas d'incrémentation auto du spectre
    virtual void    IncrementSpectrum ( );

  public:

    //----------------------------------------------------------
    /*! Fonction qui vérifie que les spectres opérandes sont compatible
     *  avec le type de spectre-opération, et que les opérandes sont compatibles
     *  entre elles (dimensions, binning, ...).
     */
    virtual bool    CheckOperands ( ) const = 0;

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

    virtual void    Increment ( );
    virtual bool    IsUpdated ( ) const;

    // Retourne une chaîne décrivant le spectre.
    virtual string  Definition ( ) const;

    // Ecriture des données du spectre dans une chaîne de définition.
    virtual string  DefinitionString ( ) const;

    //----------------------------------------------------------
    // fonctions spécifiques
    virtual Int_t   GetCoefficientNumber  ( ) const;
    virtual Int_t   GetOperandNumber      ( ) const;

    virtual Spectrum  * GetOperand     ( const Int_t n ) const;
    virtual Double_t    GetCoefficient ( const Int_t n ) const;

    virtual bool    UsesSpectrum ( const Spectrum *sp, const bool rec = true ) const;


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


//======================================================================
//  FONCTIONS INLINE
//======================================================================

/*! Incrémentation automatique du spectre: on retire le bit
 *  indiquant que le spectre est à jour.
 *  Il doit être recalculé avant sauvegarde ou affichage.
 */
inline void SpecOper::IncrementSpectrum ( )
  {
    // on retire le bit indiquant que le spectre a été calculé    status = status - (status & spectrumUpdated);
  }

/*! Fonction générique pour l'incrémentation d'un spectre: on retire le bit
 *  indiquant que le spectre est à jour.
 *  Il doit être recalculé avant sauvegarde ou affichage.
 */
inline void SpecOper::Increment ( )
  {
    // on retire le bit indiquant que le spectre a été calculé
    status = status - (status & spectrumUpdated);
  }


/*! Fonction qui renvoit le nombre de coefficients pour le calcul du spectre.
 */
inline Int_t SpecOper::GetCoefficientNumber ( ) const
  { return (coef_num); }

/*! Fonction qui renvoit le nombre de spectres operandes.
 */
inline Int_t SpecOper::GetOperandNumber ( ) const
  { return (oper_num); }


/*! Retourne le pointeur sur un spectre opérande.
 *  \param  n   numéro de l'opérande
 */
inline Spectrum * SpecOper::GetOperand ( const Int_t n ) const
  { return ( ((n >= 0) && (n < oper_num)) ? oper[n] : NULL ); }

/*! Retourne la valeur d'un coefficient.
 *  \param  n   numéro du coefficient
 */
inline Double_t SpecOper::GetCoefficient ( const Int_t n ) const
  { return ( ((n >= 0) && (n < coef_num)) ? coef[n] : 0. ); }

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

    status = status - (status & spectrumUpdated);
  }

/*! Fonction générique pour l'incrémentation d'un spectre: on retire le bit
 *  indiquant que le spectre est à jour.
 *  Il doit être recalculé avant sauvegarde ou affichage.
 */
inline void SpecOper::Increment ( )
  {
    // on retire le bit indiquant que le spectre a été calculé    status = status - (status & spectrumUpdated);
  }


/*! Fonction qui renvoit le nombre de coefficients pour le calcul du spectre.
 */
inline Int_t SpecOper::GetCoefficientNumber ( ) const
  { return (coef_num); }

/*! Fonction qui renvoit le nombre de spectres operandes.
 */
inline Int_t SpecOper::GetOperandNumber ( ) const
  { return (oper_num); }


/*! Retourne le pointeur sur un spectre opérande.
 *  \param  n   numéro de l'opérande
 */
inline Spectrum * SpecOper::GetOperand ( const Int_t n ) const
  { return ( ((n >= 0) && (n < oper_num)) ? oper[n] : NULL ); }

/*! Retourne la valeur d'un coefficient.
 *  \param  n   numéro du coefficient
 */
inline Double_t SpecOper::GetCoefficient ( const Int_t n ) const
  { return ( ((n >= 0) && (n < coef_num)) ? coef[n] : 0. ); }

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

    status = status - (status & spectrumUpdated);
  }


/*! Fonction qui renvoit le nombre de coefficients pour le calcul du spectre.
 */
inline Int_t SpecOper::GetCoefficientNumber ( ) const
  { return (coef_num); }

/*! Fonction qui renvoit le nombre de spectres operandes.
 */
inline Int_t SpecOper::GetOperandNumber ( ) const
  { return (oper_num); }


/*! Retourne le pointeur sur un spectre opérande.
 *  \param  n   numéro de l'opérande
 */
inline Spectrum * SpecOper::GetOperand ( const Int_t n ) const
  { return ( ((n >= 0) && (n < oper_num)) ? oper[n] : NULL ); }

/*! Retourne la valeur d'un coefficient.
 *  \param  n   numéro du coefficient
 */
inline Double_t SpecOper::GetCoefficient ( const Int_t n ) const
  { return ( ((n >= 0) && (n < coef_num)) ? coef[n] : 0. ); }

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