diff options
Diffstat (limited to 'src/image.h')
-rw-r--r-- | src/image.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/image.h b/src/image.h index 92047aa1..d6e22aee 100644 --- a/src/image.h +++ b/src/image.h @@ -103,6 +103,14 @@ typedef struct _imagefeaturelist ImageFeatureList; * by-product of the scattering vector calculation and can be used later for * calculating intensities from differential scattering cross sections. * + * <structfield>candidate_cells</structfield> is an array of unit cells directly + * returned by the low-level indexing system. <structfield>ncells</structfield> + * is the number of candidate unit cells which were found. The maximum number + * of cells which may be returned is <function>MAX_CELL_CANDIDATES</function>. + * <structfield>indexed_cell</structfield> contains the "correct" unit cell + * after cell reduction or matching has been performed. The job of the cell + * reduction is to convert the list of candidate cells into a single indexed + * cell, or <function>NULL</function> on failure. **/ struct image; |