SpecHMean.hh

Go to the documentation of this file.

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

#ifndef SPEC_HMEAN_HH
#define SPEC_HMEAN_HH

#include "SpecHSum.hh"


//======================================================================
/*! \class SpecHMean
 *
 *  The class is used to cumulated other spectra or histograms and
 *  divide by the number of incrementations.
 */
class SpecHMean : public SpecHSum
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpecHMean);
//----------------------------------------------------------------------

  protected:
    TH1 * histo_sum;    ///< Pointer to the intermediate cumulated histogram
    int   incr_count;   ///< Number of incrementation occurences

  public:

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

    // Constructor
    SpecHMean ( const string & spec_name, Spectrum * spec );
    SpecHMean ( const string & spec_name, const TH1 * hptr );

    // Copy constructor
    SpecHMean ( const SpecHMean & original );

    // Destructorr
    virtual ~SpecHMean ();

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

  protected:
    virtual TH1 * SetHistoMean ( const TH1 * hptr = NULL );

    virtual void  Reset ( );

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

  public:

    // Retourne l'identificateur du type de spectre.
    u_int   TypeId ( ) const;

    // Retourne le nom du type de spectre.
    string  Type ( ) const;

    const   TH1 * GetSumHisto ( ) const;     // inline
    u_int   GetIncrementCount ( );

    // Définition d'un spectre de type donné    static  Spectrum * NewSpectrumDef ( const string       & name,
                                        const string       & defstr,
                                        const EventManager * evt_mgr,
                                        int                & error );


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


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

/*! Retourne l'identificateur du type de spectre.
 */
inline u_int SpecHMean::TypeId ( ) const
  { return (spectrumTypeHMean); }

/*! Retourne le nom du type de spectre.
 */
inline string SpecHMean::Type ( ) const
  { return (SPECTRUM_TYPE_TXT_HMEAN); }

/*! Return the number of incrementations for the average.*/
inline u_int SpecHMean::GetIncrementCount ( )
  { return ( incr_count ); }

/*! Returns the pointer to the summed histogram for the spectrum.*/
inline const TH1 * SpecHMean::GetSumHisto ( ) const
  { return ( histo_sum ); }


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

    static  Spectrum * NewSpectrumDef ( const string       & name,
                                        const string       & defstr,
                                        const EventManager * evt_mgr,
                                        int                & error );


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


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

/*! Retourne l'identificateur du type de spectre.
 */
inline u_int SpecHMean::TypeId ( ) const
  { return (spectrumTypeHMean); }

/*! Retourne le nom du type de spectre.
 */
inline string SpecHMean::Type ( ) const
  { return (SPECTRUM_TYPE_TXT_HMEAN); }

/*! Return the number of incrementations for the average.*/
inline u_int SpecHMean::GetIncrementCount ( )
  { return ( incr_count ); }

/*! Returns the pointer to the summed histogram for the spectrum.*/
inline const TH1 * SpecHMean::GetSumHisto ( ) const
  { return ( histo_sum ); }


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