BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Protected Attributes | List of all members
FTDecayFunction2DVoigt Class Reference
Fourier-space decay functions

Two-dimensional pseudo-Voigt decay function in reciprocal space; corresponds to eta*Gauss + (1-eta)*Cauchy. More...

+ Inheritance diagram for FTDecayFunction2DVoigt:

Public Member Functions

 FTDecayFunction2DVoigt (const std::vector< double > P)
 
 FTDecayFunction2DVoigt (double decay_length_x, double decay_length_y, double gamma, double eta)
 
FTDecayFunction2DVoigt * clone () const
 
void accept (INodeVisitor *visitor) const final
 Calls the INodeVisitor's visit method.
 
double evaluate (double qx, double qy) const final
 evaluate Fourier transformed decay function for q in X,Y coordinates
 
double eta () const
 
- Public Member Functions inherited from IFTDecayFunction2D
 IFTDecayFunction2D (const NodeMeta &meta, const std::vector< double > &PValues)
 
double decayLengthX () const
 get decay length in distribution's X-direction
 
double decayLengthY () const
 get decay length in distribution's Y-direction
 
double gamma () const
 get angle between first lattice vector and X-axis of distribution (both in direct space)
 
std::pair< double, double > boundingReciprocalLatticeCoordinates (double qX, double qY, double a, double b, double alpha) const
 transform back to a*, b* basis: More...
 
- 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
 

Protected Attributes

const double & m_eta
 
- Protected Attributes inherited from IFTDecayFunction2D
const double & m_decay_length_x
 
const double & m_decay_length_y
 
const double & m_gamma
 
- Protected Attributes inherited from INode
const size_t m_NP
 
std::vector< double > m_P
 

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)
 

Detailed Description

Two-dimensional pseudo-Voigt decay function in reciprocal space; corresponds to eta*Gauss + (1-eta)*Cauchy.

Definition at line 91 of file FTDecay2D.h.

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