/home/kolos/working/oh/oh/core/HistogramData.h

/*
    oh::HistogramData.h - OH private header file.
    
    Fredrik Sandin, Oct 2001
    Monika Barczyk, Feb 2003
    Sergei Kolos,   May 2004
*/

#ifndef OH_HISTOGRAM_DATA_H
#define OH_HISTOGRAM_DATA_H

#include <string>
#include <oh/core/Histogram.h>


namespace oh
{
    template <typename T>
    class HistogramData : public Histogram
    {
    public:
        static const ISType & type() {
            static const ISType type_ = oh::HistogramData<T>( ).ISInfo::type();
            return type_;
        }

        HistogramData( const std::string & cl = ClassName );

        ~HistogramData( );

        void set_dimension( oh::Histogram::Dimension d );

        oh::Histogram::Dimension get_dimension( ) const;

        std::string get_title( ) const;

        void set_title( const std::string& title );

        unsigned long get_number_of_axes( ) const;

        void get_annotations( std::vector< std::pair< std::string, std::string > > & ann ) const;

        void set_annotations( const std::vector< std::pair< std::string, std::string > > & ann );

        const std::string & get_axis_title( oh::Axis::ID axis ) const;

        void set_axis_title( oh::Axis::ID axis, const std::string & label );

        std::vector<long> & indices( oh::Axis::ID axis );

        const std::vector<long> & get_indices( oh::Axis::ID axis ) const;

        std::vector<std::string> & labels( oh::Axis::ID axis );

        const std::vector<std::string> & get_labels( oh::Axis::ID axis ) const;

        oh::Axis::Kind get_axis_type( oh::Axis::ID axis ) const;

        long get_bin_count( oh::Axis::ID axis ) const;

        const std::vector<double> & get_axis_range( oh::Axis::ID axis ) const;

        void get_axis_range( oh::Axis::ID axis, double & low, double & binwidth ) const;

        void set_axis_range( oh::Axis::ID axis, const std::vector<double> & edges );

        void set_axis_range( oh::Axis::ID axis, const double * edges, unsigned long size );

        void set_axis_range( oh::Axis::ID axis, double low, double binwidth, unsigned long nbins );

        double get_error( long x, long y, long z ) const;

        const double * get_errors( ) const;

        void set_errors( double * array, unsigned long size );

        void set_error( long x, long y, long z, double error );

        unsigned long get_entries( ) const;

        void set_entries( unsigned long entries );

        T get_bin_value( long x, long y, long z ) const;

        void set_bin_value( long x, long y, long z, T height );

        T * get_bins_array( bool orphan = false ) const;

        size_t get_bins_size( ) const;

        void set_bins_array( T * array, unsigned long size, bool release = false );

        void set_bins_array( const T * array, unsigned long size );

    protected:
        void publishGuts( ISostream & out ){
            Histogram::publishGuts( out );
            out.put( bins_, bins_size_ );
        }

        void refreshGuts( ISistream & in ){
            Histogram::refreshGuts( in );
            if ( release_ )
                delete[] bins_;
            in.get( &bins_, bins_size_ );
            release_ = true;
        }

    private:
        // Calculates the index for X, Y and Z
        long index( long indexX, long indexY, long indexZ ) const;

        // Allocates memory for bin heights
        void alloc_bins( );

        // Allocates memory for bin errors if necessary
        void alloc_errors( );

    private:

        T *             bins_;
        size_t          bins_size_;
        mutable bool    release_;

        static std::string                  ClassName;
    };
}

#include <oh/core/HistogramData.i>

#endif // OH_HISTOGRAM_DATA_H

---