ChiSquaredModule Class Reference

Description

Calculation of chi2 between two data sets.

Definition at line 23 of file ChiSquaredModule.h.

Inheritance diagram for ChiSquaredModule:

Collaboration diagram for ChiSquaredModule:

Public Member Functions
	ChiSquaredModule ()=default
	ChiSquaredModule (const ChiSquaredModule &other)=default
	~ChiSquaredModule () override=default
ChiSquaredModule *	clone () const override
	clone method More...
virtual const IIntensityFunction *	getIntensityFunction () const
	Returns data rescaler. More...
double	residual (double a, double b, double weight) override
virtual void	setIntensityFunction (const IIntensityFunction &intensity_function)
	Sets data rescaler. More...
void	setVarianceFunction (const IVarianceFunction &variance_function)
	Sets squared function. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
const IVarianceFunction *	varianceFunction () const
	Returns squared function. More...

Protected Attributes
std::unique_ptr< IIntensityFunction >	m_intensity_function
std::unique_ptr< IVarianceFunction >	m_variance_function

Constructor & Destructor Documentation

ChiSquaredModule() [1/2]

ChiSquaredModule::ChiSquaredModule ( )

default

Referenced by clone().

ChiSquaredModule() [2/2]

ChiSquaredModule::ChiSquaredModule ( const ChiSquaredModule &  other )

default

~ChiSquaredModule()

ChiSquaredModule::~ChiSquaredModule ( )

overridedefault

Member Function Documentation

clone()

ChiSquaredModule* ChiSquaredModule::clone ( ) const

inlineoverridevirtual

clone method

Implements IChiSquaredModule.

Definition at line 29 of file ChiSquaredModule.h.

{ return new ChiSquaredModule(*this); }

References ChiSquaredModule().

Here is the call graph for this function:

getIntensityFunction()

const IIntensityFunction * IChiSquaredModule::getIntensityFunction ( ) const

virtualinherited

Returns data rescaler.

Definition at line 45 of file IChiSquaredModule.cpp.

{
    return m_intensity_function.get();
}

References IChiSquaredModule::m_intensity_function.

residual()

double ChiSquaredModule::residual ( double  a, double  b, double  weight  )

overridevirtual

Implements IChiSquaredModule.

Definition at line 22 of file ChiSquaredModule.cpp.

{
    double value_simu = a;
    double value_real = b;
 
    if (m_intensity_function) {
        value_simu = m_intensity_function->evaluate(value_simu);
        value_real = m_intensity_function->evaluate(value_real);
    }
 
    double variance = m_variance_function->variance(value_real, value_simu);
    double normalize = variance <= 0 ? std::numeric_limits<double>::min() : std::sqrt(variance);
 
    return std::sqrt(weight) * (value_simu - value_real) / normalize;
}

References IChiSquaredModule::m_intensity_function, and IChiSquaredModule::m_variance_function.

setIntensityFunction()

void IChiSquaredModule::setIntensityFunction ( const IIntensityFunction &  intensity_function )

virtualinherited

Sets data rescaler.

Definition at line 50 of file IChiSquaredModule.cpp.

{
    m_intensity_function.reset(intensity_function.clone());
}

References IIntensityFunction::clone(), and IChiSquaredModule::m_intensity_function.

Here is the call graph for this function:

setVarianceFunction()

void IChiSquaredModule::setVarianceFunction ( const IVarianceFunction &  variance_function )

inherited

Sets squared function.

Definition at line 40 of file IChiSquaredModule.cpp.

{
    m_variance_function.reset(variance_function.clone());
}

References IVarianceFunction::clone(), and IChiSquaredModule::m_variance_function.

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

varianceFunction()

const IVarianceFunction * IChiSquaredModule::varianceFunction ( ) const

inherited

Returns squared function.

Definition at line 24 of file IChiSquaredModule.cpp.

{
    return m_variance_function.get();
}

References IChiSquaredModule::m_variance_function.

Member Data Documentation

m_intensity_function

std::unique_ptr<IIntensityFunction> IChiSquaredModule::m_intensity_function

protectedinherited

Definition at line 52 of file IChiSquaredModule.h.

Referenced by IChiSquaredModule::IChiSquaredModule(), IChiSquaredModule::getIntensityFunction(), residual(), and IChiSquaredModule::setIntensityFunction().

m_variance_function

std::unique_ptr<IVarianceFunction> IChiSquaredModule::m_variance_function

protectedinherited

Definition at line 51 of file IChiSquaredModule.h.

Referenced by IChiSquaredModule::IChiSquaredModule(), residual(), IChiSquaredModule::setVarianceFunction(), and IChiSquaredModule::varianceFunction().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Residual/ChiSquaredModule.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Residual/ChiSquaredModule.cpp