hkl/hkl-geometry-private.h

   1 /* This file is part of the hkl library.
   2  *
   3  * The hkl library is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * The hkl library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with the hkl library.  If not, see <http://www.gnu.org/licenses/>.
  15  *
  16  * Copyright (C) 2003-2017 Synchrotron SOLEIL
  17  *                         L'Orme des Merisiers Saint-Aubin
  18  *                         BP 48 91192 GIF-sur-YVETTE CEDEX
  19  *
  20  * Authors: Picca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
  21  */
  22 #ifndef __HKL_GEOMETRY_PRIVATE_H__
  23 #define __HKL_GEOMETRY_PRIVATE_H__
  24
  25 #include <stddef.h>                     // for size_t
  26 #include <stdio.h>                      // for FILE
  27 #include "hkl-parameter-private.h"      // for darray_parameter
  28 #include "hkl-quaternion-private.h"     // for _HklQuaternion
  29 #include "hkl-source-private.h"         // for HklSource
  30 #include "hkl-vector-private.h"         // for HklQuaternion
  31 #include "hkl.h"                        // for HklGeometry, etc
  32 #include "hkl/ccan/darray/darray.h"     // for darray
  33 #include "hkl/ccan/list/list.h"
  34
  35 G_BEGIN_DECLS
  36
  37 #define HKL_HOLDER_SAMPLE_IDX 0
  38 #define HKL_HOLDER_DETECTOR_IDX 1
  39
  40 typedef struct _HklHolder HklHolder;
  41
  42 typedef void (* HklGeometryListMultiplyFunction) (HklGeometryList *self,
  43                                                   HklGeometryListItem *item);
  44
  45 typedef darray(HklHolder *) darray_holder;
  46
  47 struct HklHolderConfig {
  48         int gc;
  49         size_t *idx;
  50         size_t len;
  51 };
  52
  53 struct _HklHolder {
  54         struct HklHolderConfig *config;
  55         HklGeometry *geometry;
  56         HklQuaternion q;
  57 };
  58
  59 typedef struct _HklGeometryOperations HklGeometryOperations;
  60
  61 struct _HklGeometryOperations
  62 {
  63         HklHolder* (*sample_holder_get) (const HklGeometry *self, const HklSample *sample);
  64
  65         HklHolder* (*detector_holder_get) (const HklGeometry *self, const HklDetector *detector);
  66
  67         HklVector (*ki_get) (const HklGeometry *geometry);
  68
  69         HklVector (*kf_get) (const HklGeometry *self, const HklDetector *detector);
  70 };
  71
  72 struct _HklGeometry
  73 {
  74         const HklFactory *factory;
  75         HklSource source;
  76         darray_parameter axes;
  77         darray_holder holders;
  78         const HklGeometryOperations *ops;
  79 };
  80
  81 static inline HklHolder *hkl_geometry_sample_holder_get_real(const HklGeometry *self,
  82                                                              UNUSED const HklSample *sample)
  83 {
  84         return darray_item(self->holders, HKL_HOLDER_SAMPLE_IDX);
  85 }
  86
  87 static inline HklHolder *hkl_geometry_detector_holder_get_real(const HklGeometry *self,
  88                                                                UNUSED const HklDetector *detector)
  89 {
  90         return darray_item(self->holders, HKL_HOLDER_DETECTOR_IDX);
  91 }
  92
  93 static inline HklVector hkl_geometry_ki_get_real(const HklGeometry *self)
  94 {
  95         HklVector ki;
  96
  97         hkl_source_compute_ki(&self->source, &ki);
  98
  99         return ki;
 100 }
 101
 102 static inline HklVector hkl_geometry_kf_get_real(const HklGeometry *self,
 103                                                  UNUSED const HklDetector *detector)
 104 {
 105         HklVector kf = {{HKL_TAU / self->source.wave_length, 0, 0}};
 106         HklHolder *detector_holder = darray_item(self->holders, HKL_HOLDER_DETECTOR_IDX);
 107
 108         hkl_vector_rotated_quaternion(&kf, &detector_holder->q);
 109
 110         return kf;
 111 }
 112
 113 #define HKL_GEOMETRY_OPERATIONS_DEFAULTS                                \
 114         .sample_holder_get = hkl_geometry_sample_holder_get_real,       \
 115                 .detector_holder_get = hkl_geometry_detector_holder_get_real, \
 116                 .ki_get = hkl_geometry_ki_get_real,                     \
 117                 .kf_get = hkl_geometry_kf_get_real
 118
 119 extern const HklGeometryOperations hkl_geometry_operations_defaults;
 120
 121 #define HKL_GEOMETRY_ERROR hkl_geometry_error_quark ()
 122
 123 static inline GQuark hkl_geometry_error_quark (void)
 124 {
 125         return g_quark_from_static_string ("hkl-geometry-error-quark");
 126 }
 127
 128 typedef enum {
 129         HKL_GEOMETRY_ERROR_AXIS_GET, /* can not get the axis */
 130         HKL_GEOMETRY_ERROR_AXIS_SET, /* can not set the axis */
 131 } HklGeometryError;
 132
 133 struct _HklGeometryList
 134 {
 135         HklGeometryListMultiplyFunction multiply;
 136         struct list_head items;
 137         size_t n_items;
 138 };
 139
 140 struct _HklGeometryListItem
 141 {
 142         struct list_node list;
 143         HklGeometry *geometry;
 144 };
 145
 146 /*************/
 147 /* HklHolder */
 148 /*************/
 149
 150 extern HklParameter *hkl_holder_add_rotation(HklHolder *self,
 151                                              char const *name,
 152                                              double x, double y, double z,
 153                                              const HklUnit *punit);
 154
 155 extern HklParameter *hkl_holder_add_rotation_with_origin(HklHolder *self,
 156                                                          const char *name,
 157                                                          double x, double y, double z,
 158                                                          double ox, double oy, double oz,
 159                                                          const HklUnit *punit);
 160
 161 extern HklParameter *hkl_holder_add_translation(HklHolder *self,
 162                                                 char const *name,
 163                                                 double x, double y, double z,
 164                                                 const HklUnit *punit);
 165
 166 extern HklVector hkl_holder_transformation_apply(const HklHolder *self,
 167                                                  const HklVector *v);
 168
 169 /***************/
 170 /* HklGeometry */
 171 /***************/
 172
 173 extern HklGeometry *hkl_geometry_new(const HklFactory *factory,
 174                                      const HklGeometryOperations *ops);
 175
 176 extern int hkl_geometry_init_geometry(HklGeometry *self,
 177                                       const HklGeometry *src);
 178
 179 extern HklHolder *hkl_geometry_add_holder(HklGeometry *self);
 180
 181 extern void hkl_geometry_update(HklGeometry *self);
 182
 183 extern int hkl_geometry_get_axis_idx_by_name(const HklGeometry *self,
 184                                              const char *name);
 185
 186 /* internally require do not use the hkl_geometry_axis_get */
 187 extern HklParameter *hkl_geometry_get_axis_by_name(HklGeometry *self,
 188                                                    const char *name);
 189
 190 extern double hkl_geometry_distance(const HklGeometry *self,
 191                                     const HklGeometry *ref);
 192
 193 extern double hkl_geometry_distance_orthodromic(const HklGeometry *self,
 194                                                 const HklGeometry *ref);
 195
 196 extern int hkl_geometry_closest_from_geometry_with_range(HklGeometry *self,
 197                                                          const HklGeometry *ref);
 198
 199 extern int hkl_geometry_is_valid(const HklGeometry *self);
 200
 201 extern int hkl_geometry_is_valid_range(const HklGeometry *self);
 202
 203 extern HklHolder *hkl_geometry_sample_holder_get(const HklGeometry *self, const HklSample *sample);
 204
 205 extern HklHolder *hkl_geometry_detector_holder_get(const HklGeometry *self, const HklDetector *detector);
 206
 207 extern HklVector hkl_geometry_ki_get(const HklGeometry *self);
 208
 209 extern HklVector hkl_geometry_kf_get(const HklGeometry *self,
 210                                      const HklDetector *detector);
 211
 212 /*******************/
 213 /* HklGeometryList */
 214 /*******************/
 215
 216 extern HklGeometryList *hkl_geometry_list_new(void);
 217
 218 extern HklGeometryList *hkl_geometry_list_new_copy(const HklGeometryList *self);
 219
 220 extern void hkl_geometry_list_add(HklGeometryList *self, const HklGeometry *geometry);
 221
 222 extern void hkl_geometry_list_reset(HklGeometryList *self);
 223
 224 extern void hkl_geometry_list_sort(HklGeometryList *self, HklGeometry *ref);
 225
 226 extern void hkl_geometry_list_fprintf(FILE *f, const HklGeometryList *self);
 227
 228 extern void hkl_geometry_list_multiply(HklGeometryList *self);
 229
 230 extern void hkl_geometry_list_multiply_from_range(HklGeometryList *self);
 231
 232 extern void hkl_geometry_list_remove_invalid(HklGeometryList *self);
 233
 234 /***********************/
 235 /* HklGeometryListItem */
 236 /***********************/
 237
 238 extern HklGeometryListItem *hkl_geometry_list_item_new(const HklGeometry *geometry);
 239
 240 extern HklGeometryListItem *hkl_geometry_list_item_new_copy(const HklGeometryListItem *self);
 241
 242 extern void hkl_geometry_list_item_free(HklGeometryListItem *self);
 243
 244 G_END_DECLS
 245
 246 #endif /* __HKL_GEOMETRY_PRIVATE_H__ */