votca 2024.2-dev
Loading...
Searching...
No Matches
votca::tools::Histogram Class Reference

class to generate histograms More...

#include <histogram.h>

Collaboration diagram for votca::tools::Histogram:

Classes

struct  options_t
 

Public Member Functions

 Histogram (const options_t &op)
 constructor
 
 Histogram ()
 
 ~Histogram ()
 destructor
 
void ProcessData (DataCollection< double >::selection *data)
 
double getMin () const
 returns the minimum value
 
double getMax () const
 return the maximum value
 
Index getN () const
 return the number of grid points
 
std::vector< double > & getPdf ()
 
double getInterval () const
 
void Normalize (void)
 

Private Attributes

std::vector< double > pdf_
 
double min_ = 0
 
double max_ = 0
 
double interval_
 
options_t options_
 

Detailed Description

class to generate histograms

This class produces a histogram out of a vector of values. This class is obsolate and only used in csg_boltzman. Use HistogramNew instead!

Definition at line 38 of file histogram.h.

Constructor & Destructor Documentation

◆ Histogram() [1/2]

votca::tools::Histogram::Histogram ( const options_t & op)

constructor

Definition at line 32 of file histogram.cc.

◆ Histogram() [2/2]

votca::tools::Histogram::Histogram ( )
default

◆ ~Histogram()

votca::tools::Histogram::~Histogram ( )
default

destructor

Member Function Documentation

◆ getInterval()

double votca::tools::Histogram::getInterval ( ) const
inline

Definition at line 60 of file histogram.h.

◆ getMax()

double votca::tools::Histogram::getMax ( ) const
inline

return the maximum value

Definition at line 56 of file histogram.h.

◆ getMin()

double votca::tools::Histogram::getMin ( ) const
inline

returns the minimum value

Definition at line 54 of file histogram.h.

◆ getN()

Index votca::tools::Histogram::getN ( ) const
inline

return the number of grid points

Definition at line 58 of file histogram.h.

◆ getPdf()

std::vector< double > & votca::tools::Histogram::getPdf ( )
inline

Definition at line 59 of file histogram.h.

◆ Normalize()

void votca::tools::Histogram::Normalize ( void )

Definition at line 116 of file histogram.cc.

◆ ProcessData()

void votca::tools::Histogram::ProcessData ( DataCollection< double >::selection * data)

process data and generate histogram

Definition at line 36 of file histogram.cc.

Member Data Documentation

◆ interval_

double votca::tools::Histogram::interval_
private

Definition at line 79 of file histogram.h.

◆ max_

double votca::tools::Histogram::max_ = 0
private

Definition at line 78 of file histogram.h.

◆ min_

double votca::tools::Histogram::min_ = 0
private

Definition at line 77 of file histogram.h.

◆ options_

options_t votca::tools::Histogram::options_
private

Definition at line 81 of file histogram.h.

◆ pdf_

std::vector<double> votca::tools::Histogram::pdf_
private

Definition at line 76 of file histogram.h.


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