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

Convolutes the intensity in 1 or 2 dimensions with a resolution function. More...

+ Inheritance diagram for ConvolutionDetectorResolution:

Public Types

typedef double(* cumulative_DF_1d) (double)
 

Public Member Functions

 ConvolutionDetectorResolution (cumulative_DF_1d res_function_1d)
 Constructor taking a 1 dimensional resolution function as argument.
 
 ConvolutionDetectorResolution (const IResolutionFunction2D &p_res_function_2d)
 Constructor taking a 2 dimensional resolution function as argument.
 
virtual void applyDetectorResolution (OutputData< double > *p_intensity_map) const
 Convolve given intensities with the encapsulated resolution.
 
virtual ConvolutionDetectorResolution * clone () const
 
void accept (INodeVisitor *visitor) const final
 Calls the INodeVisitor's visit method.
 
const IResolutionFunction2D * getResolutionFunction2D () const
 
std::vector< const INode * > getChildren () const
 Returns a vector of children (const).
 
- Public Member Functions inherited from IDetectorResolution
void applyDetectorResolutionPol (OutputData< Eigen::Matrix2d > *p_matrix_intensity) const
 Applies the detector resolution to the matrix-valued intensity data.
 
- 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 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 Member Functions

 ConvolutionDetectorResolution (const ConvolutionDetectorResolution &other)
 

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

Convolutes the intensity in 1 or 2 dimensions with a resolution function.

Limitation: this class assumes that the data points are evenly distributed on each axis

Definition at line 26 of file ConvolutionDetectorResolution.h.

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