Clipper
Public Member Functions | List of all members
clipper::BasisFn_spline Class Reference

simple smooth basis function More...

#include <resol_basisfn.h>

Inheritance diagram for clipper::BasisFn_spline:
clipper::BasisFn_base

Public Member Functions

 BasisFn_spline (const HKL_info &hklinfo, const int &nbins_, const ftype power=1.0)
 constructor: include whole reflection list in histogram
 
 BasisFn_spline (const HKL_data_base &hkldata, const int &nbins_, const ftype power=1.0)
 constructor: include only non-missing reflections in histogram
 
ftype f_s (const ftype &s, const std::vector< ftype > &params) const
 the value of the resolution function (override for speed)
 
const BasisFn_base::Fderivfderiv_s (const ftype &s, const std::vector< ftype > &params) const
 the derivative of the resolution function w.r.t. the parameters
 
FNtype type () const
 the type of the function: optionally used to improve convergence More...
 
int num_diagonals () const
 number of non-zero diagonals in the upper triangle of the curvatures More...
 
ftype f (const HKL &hkl, const Cell &cell, const std::vector< ftype > &params) const
 the value of the resolution function (override for speed) More...
 
const BasisFn_base::Fderivfderiv (const HKL &hkl, const Cell &cell, const std::vector< ftype > &params) const
 the derivatives of the resolution function w.r.t. the parameters More...
 
- Public Member Functions inherited from clipper::BasisFn_base
 BasisFn_base ()
 null constructor
 
 BasisFn_base (const int &np)
 constructor: takes number of parameters
 
const int & num_params () const
 the number of parameters of this basis function
 
virtual ftype f (const HKL &hkl, const Cell &cell, const std::vector< ftype > &params) const
 the value of the resolution function More...
 
virtual const Fderivfderiv (const HKL &hkl, const Cell &cell, const std::vector< ftype > &params) const =0
 the value of the resolution function and its first two derivatives More...
 
virtual FNtype type () const
 the type of the function: optionally used to improve convergence More...
 
virtual int num_diagonals () const
 number of non-zero diagonals in the upper triangle of the curvatures More...
 

Additional Inherited Members

- Public Types inherited from clipper::BasisFn_base
enum  FNtype { GENERAL , LINEAR }
 enumeration of function types: optionally used to improve convergence
 
- Protected Member Functions inherited from clipper::BasisFn_base
Fderivresult () const
 provide write access to result for subclasses
 
virtual ~BasisFn_base ()
 destructor
 

Detailed Description

simple smooth basis function

This class fits a Bspline through reflections on the basis of resolution.

Member Function Documentation

◆ type()

FNtype clipper::BasisFn_spline::type ( ) const
inlinevirtual

the type of the function: optionally used to improve convergence

Reimplemented from clipper::BasisFn_base.

◆ num_diagonals()

int clipper::BasisFn_spline::num_diagonals ( ) const
inlinevirtual

number of non-zero diagonals in the upper triangle of the curvatures

Reimplemented from clipper::BasisFn_base.

◆ f()

ftype clipper::BasisFn_spline::f ( const HKL hkl,
const Cell cell,
const std::vector< ftype > &  params 
) const
inlinevirtual

the value of the resolution function (override for speed)

Reimplemented from clipper::BasisFn_base.

◆ fderiv()

const BasisFn_base::Fderiv & clipper::BasisFn_spline::fderiv ( const HKL hkl,
const Cell cell,
const std::vector< ftype > &  params 
) const
inlinevirtual

the derivatives of the resolution function w.r.t. the parameters

Implements clipper::BasisFn_base.


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