An isotropic Lorentzian peak shape of a Bragg peak. More...

Inheritance diagram for IsotropicLorentzPeakShape:

Public Member Functions
	IsotropicLorentzPeakShape (double max_intensity, double domainsize)

IsotropicLorentzPeakShape *	clone () const override
	Returns a clone of this ISample object.

void	accept (INodeVisitor *visitor) const override
	Calls the INodeVisitor's visit method.

double	evaluate (const kvector_t q, const kvector_t q_lattice_point) const override
	Evaluates the peak shape at q from a reciprocal lattice point at q_lattice_point.

Public Member Functions inherited from IPeakShape
	IPeakShape (const NodeMeta &meta, const std::vector< double > &PValues)

virtual bool	angularDisorder () const
	Indicates if the peak shape encodes angular disorder, in which case all peaks in a spherical shell are needed.

Public Member Functions inherited from ISample
	ISample (const NodeMeta &meta, const std::vector< double > &PValues)

virtual const Material *	material () const
	Returns nullptr, unless overwritten to return a specific material.

std::vector< const Material * >	containedMaterials () const
	Returns set of unique materials contained in this ISample.

Public Member Functions inherited from ICloneable
	ICloneable (const ICloneable &)=delete

	ICloneable (ICloneable &&)=default

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

Public Member Functions inherited from INode
	INode (const NodeMeta &meta, const std::vector< double > &PValues)

virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node.

void	registerChild (INode *node)

virtual std::vector< const INode * >	getChildren () const
	Returns a vector of children (const).

virtual void	setParent (const INode *newParent)

const INode *	parent () const

INode *	parent ()

int	copyNumber (const INode *node) const
	Returns copyNumber of child, which takes into account existence of children with same name.

std::string	displayName () const
	Returns display name, composed from the name of node and it's copy number.

ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children.

Public Member Functions inherited from IParameterized
	IParameterized (const std::string &name="")

	IParameterized (const IParameterized &other)

IParameterized &	operator= (const IParameterized &other)=delete

ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool.

std::string	parametersToString () const
	Returns multiline string representing available parameters.

RealParameter &	registerParameter (const std::string &name, double *parpointer)

void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")

void	setParameterValue (const std::string &name, double value)

void	setVectorValue (const std::string &base_name, kvector_t value)

RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'.

virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed.

void	removeParameter (const std::string &name)

void	removeVector (const std::string &base_name)

void	setName (const std::string &name)

const std::string &	getName () const

Additional Inherited Members
Static Public Member Functions inherited from IParameterized
static std::string	XComponentName (const std::string &base_name)

static std::string	YComponentName (const std::string &base_name)

static std::string	ZComponentName (const std::string &base_name)

Protected Attributes inherited from INode
const size_t	m_NP

std::vector< double >	m_P

Detailed Description

An isotropic Lorentzian peak shape of a Bragg peak.

Definition at line 68 of file IPeakShape.h.

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

/home/www/ba/Sample/Correlations/IPeakShape.h
/home/www/ba/Sample/Correlations/IPeakShape.cpp

Public Member Functions

Additional Inherited Members

Detailed Description