BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | List of all members
ParameterDistribution Class Reference

A parametric distribution function, for use with any model parameter. More...

+ Inheritance diagram for ParameterDistribution:

Public Member Functions

 ParameterDistribution (const std::string &par_name, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())
 
 ParameterDistribution (const std::string &par_name, const IDistribution1D &distribution, size_t nbr_samples, double xmin, double xmax)
 
 ParameterDistribution (const ParameterDistribution &other)
 
ParameterDistribution & operator= (const ParameterDistribution &other)
 Overload assignment operator.
 
ParameterDistribution & linkParameter (std::string par_name)
 
std::string getMainParameterName () const
 get the main parameter's name
 
size_t getNbrSamples () const
 get number of samples for this distribution
 
double getSigmaFactor () const
 get the sigma factor
 
const IDistribution1D * getDistribution () const
 
IDistribution1D * getDistribution ()
 
std::vector< ParameterSample > generateSamples () const
 generate list of sampled values with their weight
 
std::vector< std::string > getLinkedParameterNames () const
 get list of linked parameter names
 
RealLimits getLimits () const
 
double getMinValue () const
 
double getMaxValue () const
 
- 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.
 
virtual ParameterPool * createParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children.
 
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)
 

Detailed Description

A parametric distribution function, for use with any model parameter.

Definition at line 28 of file ParameterDistribution.h.

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