Mantid::Algorithms::MaxentEntropyPositiveValues Class Reference

MaxentEntropyPositiveValues : Class defining the entropy of a positive image (i.e. More...

#include <MaxentEntropyPositiveValues.h>

Inheritance diagram for Mantid::Algorithms::MaxentEntropyPositiveValues:

Public Member Functions
std::vector< double >	correctValues (const std::vector< double > &values, double newValue) override
	Corrects a negative value. 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

MaxentEntropyPositiveValues : Class defining the entropy of a positive image (i.e.

a set of positive numbers). See J. Skilling and R. K Bryan, "Maximum entropy image reconstruction: general algorithm".

Definition at line 18 of file MaxentEntropyPositiveValues.h.

Member Function Documentation

correctValues()

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

overridevirtual

Corrects a negative value.

Parameters

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

Returns

: The corrected values

Implements Mantid::Algorithms::MaxentEntropy.

Definition at line 50 of file MaxentEntropyPositiveValues.cpp.

derivative()

std::vector< double > Mantid::Algorithms::MaxentEntropyPositiveValues::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 MaxentEntropyPositiveValues.cpp.

secondDerivative()

std::vector< double > Mantid::Algorithms::MaxentEntropyPositiveValues::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 (unused)

Returns

: The second derivative as a vector

Implements Mantid::Algorithms::MaxentEntropy.

Definition at line 35 of file MaxentEntropyPositiveValues.cpp.

References UNUSED_ARG.

---

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

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