Reflection data type objects. More...
#include <hkl_data.h>
Inheritance diagram for clipper::Datatype_base:
Protected Member Functions | |
| Datatype_base () | |
| initialise to 'missing' | |
| void | set_null () |
| initialise to 'missing' (all elements are set to null) | |
| void | friedel () |
| apply Friedel transformation to the data | |
| void | shift_phase (const ftype &dphi) |
| apply phase shift to the data | |
| bool | missing () const |
| return true if data is missing | |
| void | data_export (xtype array[]) const |
| conversion to array (for I/O) | |
| void | data_import (const xtype array[]) |
| conversion from array (for I/O) | |
Static Protected Member Functions | |
| static String | type () |
| return the name of this data type | |
| static int | data_size () |
| return number of data elements in this type | |
| static String | data_names () |
| return names of data elements in this type | |
Detailed Description
Reflection data type objects.
A class from which data type objects are usually derived
To define a new type for use in an HKL_data structure, subclass this class and override the following methods:
- constructor - initialises to NAN
- type() - returns type name, which is a list of the contained data
- friedel() - applies Fridel transformation
- shift_phase() - applies phase shift transformation
- missing() - checks if data is present
- data_size() - number of data elements in this type
- data_names() - names of data elements in this type
- data_export() - conversion to array (for I/O)
- data_import() - conversion from array (for I/O)
- scale() - (OPTIONAL) apply magnitude scale factor to data
- Note:
- polymorphism is NOT used here because virtual tables would be to expensive for every individual reflection, both in terms of space and cpu cycles.
The documentation for this class was generated from the following file:
