 IMP Reference Guide  2.5.0 The Integrative Modeling Platform
IMP::statistics::HistogramD< D, Grid > Class Template Reference

Dynamically build a histogram embedded in D-dimensional space. More...

#include <IMP/statistics/HistogramD.h> Inheritance diagram for IMP::statistics::HistogramD< D, Grid >:

## Detailed Description

### template<int D, class Grid = algebra::GridD< D, typename algebra::DenseGridStorageD<D, double>, double, typename algebra::DefaultEmbeddingD<D> >> class IMP::statistics::HistogramD< D, Grid >

Dynamically build a histogram embedded in D-dimensional space.

Definition at line 27 of file HistogramD.h.

## Public Types

typedef Grid CountGrid

## Public Member Functions

HistogramD (double voxel_size, const algebra::BoundingBoxD< D > &bb)

void add (const algebra::VectorD< D > &x, double weight=1)

algebra::BoundingBoxD< D > get_bounding_box () const

const CountGrid & get_counts () const

unsigned int get_dimension () const

HistogramD< D > get_frequencies () const

algebra::VectorD< D > get_mean () const

FloatPair get_minimum_and_maximum () const

HistogramD< D > get_probability_distribution_function () const

algebra::VectorD< D > get_standard_deviation (const algebra::VectorD< D > &mean) const

double get_total_count () const
Get the sum of all counts in the histogram. More...

void show (std::ostream &out=std::cout) const

## Member Function Documentation

template<int D, class Grid = algebra::GridD< D, typename algebra::DenseGridStorageD<D, double>, double, typename algebra::DefaultEmbeddingD<D> >>
 void IMP::statistics::HistogramD< D, Grid >::add ( const algebra::VectorD< D > & x, double weight = 1 )

Increase the count for the bin that holds a value that is in range for this histogram.

Definition at line 35 of file HistogramD.h.

template<int D, class Grid = algebra::GridD< D, typename algebra::DenseGridStorageD<D, double>, double, typename algebra::DefaultEmbeddingD<D> >>
 HistogramD IMP::statistics::HistogramD< D, Grid >::get_probability_distribution_function ( ) const

Get a histogram that has the pdf value as the value for the bin.

Definition at line 53 of file HistogramD.h. Here is the call graph for this function:

template<int D, class Grid = algebra::GridD< D, typename algebra::DenseGridStorageD<D, double>, double, typename algebra::DefaultEmbeddingD<D> >>
 double IMP::statistics::HistogramD< D, Grid >::get_total_count ( ) const

Get the sum of all counts in the histogram.

Definition at line 45 of file HistogramD.h.

The documentation for this class was generated from the following file: