histogram.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2011,2014 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef HISTOGRAM_HPP
#define HISTOGRAM_HPP 1


#include <vector>
#include <stdint.h>


enum histogram_accumulation_e {
    HISTOGRAM_ACCUMULATION_CLOSEST = 0, 
    HISTOGRAM_ACCUMULATION_LINEAR,      
};


class Histogram
{

public:

    virtual ~Histogram() {}

};


class Histogram1D : public Histogram
{
    uint32_t            _n;         
    double              _range[2];  
    double              _step;      
    std::vector<double> _data;      
public:

    Histogram1D( uint32_t n, const double range[2] );

    Histogram1D( uint32_t n, const std::vector<double> &xdata,
                 histogram_accumulation_e type = HISTOGRAM_ACCUMULATION_CLOSEST );

    Histogram1D( uint32_t n, const std::vector<double> &xdata, const std::vector<double> &wdata,
                 histogram_accumulation_e type = HISTOGRAM_ACCUMULATION_CLOSEST );

    virtual ~Histogram1D();

    uint32_t n( void ) const { return( _n ); }

    double step( void ) const { return( _step ); }

    double coord( uint32_t i ) const;

    void accumulate( uint32_t i, double weight ) {
        _data[i] += weight;
    }

    void accumulate( uint32_t i ) {
        _data[i] += 1.0;
    }

    void accumulate_closest( double x, double weight = 1.0 );

    void accumulate_closest( const std::vector<double> &xdata );

    void accumulate_closest( const std::vector<double> &xdata,
                             const std::vector<double> &wdata );

    void accumulate_linear( double x, double weight = 1.0 );

    void accumulate_linear( const std::vector<double> &xdata );

    void accumulate_linear( const std::vector<double> &xdata,
                            const std::vector<double> &wdata );

    void convert_to_density( void );

    void get_range( double range[2] ) const;
    
    void get_bin_range( double &min, double &max ) const;
    
    std::vector<double> &get_data( void ) { return( _data ); }

    const std::vector<double> &get_data( void ) const { return( _data ); }

    const double &operator()( uint32_t i ) const {
        return( _data[i] );
    }

    double &operator()( uint32_t i ) {
        return( _data[i] );
    }

    const Histogram1D &operator*=( double x );
};


class Histogram2D : public Histogram
{
    uint32_t            _n;         
    uint32_t            _m;         
    double              _range[4];  
    double              _nstep;     
    double              _mstep;     
    std::vector<double> _data;      
public:

    Histogram2D( uint32_t n, uint32_t m, const double range[4] );

    Histogram2D( uint32_t n, uint32_t m, 
                 const std::vector<double> &xdata,
                 const std::vector<double> &ydata,
                 histogram_accumulation_e type = HISTOGRAM_ACCUMULATION_CLOSEST );

    Histogram2D( uint32_t n, uint32_t m, 
                 const std::vector<double> &xdata,
                 const std::vector<double> &ydata,
                 const std::vector<double> &wdata,
                 histogram_accumulation_e type = HISTOGRAM_ACCUMULATION_CLOSEST );

    virtual ~Histogram2D();

    uint32_t n( void ) const { return( _n ); }

    uint32_t m( void ) const { return( _m ); }

    double nstep( void ) const { return( _nstep ); }

    double mstep( void ) const { return( _mstep ); }

    double icoord( uint32_t i ) const;

    double jcoord( uint32_t j ) const;

    void accumulate( uint32_t i, uint32_t j, double weight ) {
        _data[i+j*_n] += weight;
    }

    void accumulate_closest( double x, double y, double weight );

    void accumulate_linear( double x, double y, double weight );

    void convert_to_density( void );

    void get_range( double range[4] ) const;
    
    void get_bin_range( double &min, double &max ) const;
    
    std::vector<double> &get_data( void ) { return( _data ); }

    const std::vector<double> &get_data( void ) const { return( _data ); }

    const double &operator()( uint32_t i, uint32_t j ) const {
        return( _data[i+j*_n] );
    }

    double &operator()( uint32_t i, uint32_t j ) {
        return( _data[i+j*_n] );
    }

    const Histogram2D &operator*=( double x );
};


#endif