IMP logo
IMP Reference Guide  develop.182d9373c4,2021/04/12
The Integrative Modeling Platform
IMP::statistics::ChiSquareMetric Class Reference

Compute the distance between two configurations using chi2. More...

#include <IMP/statistics/ChiSquareMetric.h>

+ Inheritance diagram for IMP::statistics::ChiSquareMetric:

Detailed Description

Compute the distance between two configurations using chi2.

Each configurations is defined by a list of data points and a list of standard deviations. The distance between the two configurations is defined as the chi2.

Definition at line 24 of file statistics/ChiSquareMetric.h.

Public Member Functions

 ChiSquareMetric (Floats data_exp, int constr_type=0)
 
void add_configuration (Floats data, Floats stddev, double weight=1.0)
 
double do_get_weight (unsigned i) const
 get the weight for the i-th configuration More...
 
double get_chi_square_experimental (unsigned i) const
 get chi2 from experimental data for the i-th configuration More...
 
Floats get_data (unsigned i) const
 get the list of data points for the i-th configuration More...
 
double get_distance (unsigned int i, unsigned int j) const
 
unsigned int get_number_of_items () const
 
Floats get_standard_deviation (unsigned i) const
 get the list of standard deviations for the i-th configuration More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::statistics::Metric
double get_weight (unsigned int i) const
 Return a weight for the point. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::statistics::Metric
 Metric (std::string name)
 
virtual double do_get_weight (unsigned int i) const
 By default return 1.0. More...
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

void IMP::statistics::ChiSquareMetric::add_configuration ( Floats  data,
Floats  stddev,
double  weight = 1.0 
)

add a configuration, defined by a list of data points, a list of standard deviations, and one weight.

double IMP::statistics::ChiSquareMetric::do_get_weight ( unsigned  i) const

get the weight for the i-th configuration

double IMP::statistics::ChiSquareMetric::get_chi_square_experimental ( unsigned  i) const

get chi2 from experimental data for the i-th configuration

Floats IMP::statistics::ChiSquareMetric::get_data ( unsigned  i) const

get the list of data points for the i-th configuration

Floats IMP::statistics::ChiSquareMetric::get_standard_deviation ( unsigned  i) const

get the list of standard deviations for the i-th configuration

virtual ::IMP::VersionInfo IMP::statistics::ChiSquareMetric::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 61 of file statistics/ChiSquareMetric.h.


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