clipper::Convolution_search_base< T > Class Template Reference
Base class for convolution search methods. More...
#include <function_object_bases.h>
Inheritance diagram for clipper::Convolution_search_base< T >:
Public Member Functions | |
| virtual bool | operator() (Xmap< T > &result, const NXmap< T > &srchval, const NX_operator&nxop) const =0 |
| virtual | ~Convolution_search_base () |
| destructor | |
Detailed Description
template<class T>
class clipper::Convolution_search_base< T >
Base class for convolution search methods.
: constructor or initialiser. This allows precalculation of some of the coefficients required. The () operator performs an actual search in that map for a given target.
Member Function Documentation
template<class T >
| virtual bool clipper::Convolution_search_base< T >::operator() | ( | Xmap< T > & | result, | |
| const NXmap< T > & | srchval, | |||
| const NX_operator& | nxop | |||
| ) | const [pure virtual] |
In the implementations, this function will do the actual convolution search calculation.
- Parameters:
-
result The convolution search residual map, containing the value of the search function for each offset of the search model. The search function is a least squares residual, or may be a negative log likelihood, therefore it is positive and low values represent better fits. srchval Map of the target density for which to search. nxop Operator relating the coordinate frames of the search target and the crystallographic map, used to rotate the search target.
- Returns:
- true on success.
Implemented in clipper::Convolution_search_slow< T >, and clipper::Convolution_search_fft< T >.
The documentation for this class was generated from the following file:
