clipper::Skeleton_base< T1, T2 > Class Template Reference
Base class for skeleton calculation methods. More...
#include <function_object_bases.h>
Inheritance diagram for clipper::Skeleton_base< T1, T2 >:
Public Member Functions | |
| virtual bool | operator() (Xmap< T1 > &xskl, const Xmap< T2 > &xmap) const =0 |
| Skeletonisation function definition. | |
| virtual | ~Skeleton_base () |
| destructor | |
Detailed Description
template<class T1, class T2>
class clipper::Skeleton_base< T1, T2 >
Base class for skeleton calculation methods.
Member Function Documentation
template<class T1, class T2>
| virtual bool clipper::Skeleton_base< T1, T2 >::operator() | ( | Xmap< T1 > & | xskl, | |
| const Xmap< T2 > & | xmap | |||
| ) | const [pure virtual] |
Skeletonisation function definition.
In the implementations, this function will do the actual skeletonisation.
- Parameters:
-
xskl int/short/char map. On input this may hold 1 for any grid point which is to be considered for skeletonisation, and 0 for any other point (e.g. low density, solvent) [This feaure may not be present in all implementations]. On output this map holds 1 for any grid point which is part of a skeleton ridge, and 0 for any point which is not. xmap float/double map. This map holds the actual electron density values for the map.
- Returns:
- true on success.
Implemented in clipper::Skeleton_basic, and clipper::Skeleton_fast< T1, T2 >.
The documentation for this class was generated from the following file:
