Mantid::Algorithms::MaxentEntropyNegativeValues Class Reference

MaxentEntropyNegativeValues : Class defining the entropy of a 'PosNeg' image (i.e. More...

#include <MaxentEntropyNegativeValues.h>

Inheritance diagram for Mantid::Algorithms::MaxentEntropyNegativeValues:

Public Member Functions
std::vector< double >	correctValues (const std::vector< double > &values, double newValue) override
	Corrects the image. More...
std::vector< double >	derivative (const std::vector< double > &values, double background) override
	Returns the first derivative at a given point. More...
std::vector< double >	secondDerivative (const std::vector< double > &values, double background) override
	Returns the second derivative at a given point. More...
Public Member Functions inherited from Mantid::Algorithms::MaxentEntropy
virtual std::vector< double >	correctValues (const std::vector< double > &value, double newValue)=0
virtual std::vector< double >	derivative (const std::vector< double > &values, double background)=0
	MaxentEntropy ()=default
virtual std::vector< double >	secondDerivative (const std::vector< double > &values, double background)=0
virtual	~MaxentEntropy ()=default

Detailed Description

MaxentEntropyNegativeValues : Class defining the entropy of a 'PosNeg' image (i.e.

a set of real numbers). References:

1. A. J. Markvardsen, "Polarised neutron diffraction measurements of PrBa2Cu3O6+x and the Bayesian statistical analysis of such data".
2. P. F. Smith and M. A. Player, "Deconvolution of bipolar ultrasonic signals using a modified maximum entropy method"

Definition at line 21 of file MaxentEntropyNegativeValues.h.

Member Function Documentation

correctValues()

std::vector< double > Mantid::Algorithms::MaxentEntropyNegativeValues::correctValues ( const std::vector< double > &  values, double  newValue  )

overridevirtual

Corrects the image.

For PosNeg images there is nothing to correct so we just return the vector we were given

Parameters

values	: [input] The values of the image as a vector
newValue	: [input] The new value to use (unused variable)

Returns

: The corrected values as a vector

Implements Mantid::Algorithms::MaxentEntropy.

Definition at line 57 of file MaxentEntropyNegativeValues.cpp.

References UNUSED_ARG.

derivative()

std::vector< double > Mantid::Algorithms::MaxentEntropyNegativeValues::derivative ( const std::vector< double > &  values, double  background  )

overridevirtual

Returns the first derivative at a given point.

Parameters

values	: [input] The values of the image as a vector
background	: [input] The background

Returns

: The first derivative as a vector

Implements Mantid::Algorithms::MaxentEntropy.

Definition at line 18 of file MaxentEntropyNegativeValues.cpp.

secondDerivative()

std::vector< double > Mantid::Algorithms::MaxentEntropyNegativeValues::secondDerivative ( const std::vector< double > &  values, double  background  )

overridevirtual

Returns the second derivative at a given point.

Parameters

values	: [input] The values of the image as a vector
background	: [input] The background

Returns

: The second derivative as a vector

Implements Mantid::Algorithms::MaxentEntropy.

Definition at line 36 of file MaxentEntropyNegativeValues.cpp.

---

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

• Framework/Algorithms/inc/MantidAlgorithms/MaxEnt/MaxentEntropyNegativeValues.h
• Framework/Algorithms/src/MaxEnt/MaxentEntropyNegativeValues.cpp