hkl/hkl-engine-e4c.c

   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-2016 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 #include <gsl/gsl_sys.h>                // for gsl_isnan
  23 #include "hkl-factory-private.h"        // for autodata_factories_, etc
  24 #include "hkl-pseudoaxis-common-q-private.h"  // for hkl_engine_q2_new, etc
  25 #include "hkl-pseudoaxis-common-hkl-private.h"  // for hkl_mode_operations, etc
  26 #include "hkl-pseudoaxis-common-psi-private.h"  // for hkl_engine_psi_new, etc
  27 #include "hkl-pseudoaxis-common-readonly-private.h"
  28
  29 #define OMEGA "omega"
  30 #define CHI "chi"
  31 #define PHI "phi"
  32 #define TTH "tth"
  33
  34 /************/
  35 /* mode hkl */
  36 /************/
  37
  38 static int _bissector_func(const gsl_vector *x, void *params, gsl_vector *f)
  39 {
  40         const double omega = x->data[0];
  41         const double tth = x->data[3];
  42
  43         CHECK_NAN(x->data, x->size);
  44
  45         RUBh_minus_Q(x->data, params, f->data);
  46         f->data[3] = tth - 2 * fmod(omega,M_PI);
  47
  48         return  GSL_SUCCESS;
  49 }
  50
  51 static const HklFunction bissector_func = {
  52         .function = _bissector_func,
  53         .size = 4,
  54 };
  55
  56 static HklMode *bissector(void)
  57 {
  58         static const char* axes[] = {OMEGA, CHI, PHI, TTH};
  59         static const HklFunction *functions[] = {&bissector_func};
  60         static const HklModeAutoInfo info = {
  61                 HKL_MODE_AUTO_INFO(__func__, axes, axes, functions),
  62         };
  63
  64         return hkl_mode_auto_new(&info,
  65                                  &hkl_mode_operations,
  66                                  TRUE);
  67 }
  68
  69 static HklMode *constant_omega(void)
  70 {
  71         static const char* axes_r[] = {OMEGA, CHI, PHI, TTH};
  72         static const char* axes_w[] = {CHI, PHI, TTH};
  73         static const HklFunction *functions[] = {&RUBh_minus_Q_func};
  74         static const HklModeAutoInfo info = {
  75                 HKL_MODE_AUTO_INFO(__func__, axes_r, axes_w, functions),
  76         };
  77
  78         return hkl_mode_auto_new(&info,
  79                                  &hkl_mode_operations,
  80                                  TRUE);
  81 }
  82
  83 static HklMode *constant_chi(void)
  84 {
  85         static const char* axes_r[] = {OMEGA, CHI, PHI, TTH};
  86         static const char* axes_w[] = {OMEGA, PHI, TTH};
  87         static const HklFunction *functions[] = {&RUBh_minus_Q_func};
  88         static const HklModeAutoInfo info = {
  89                 HKL_MODE_AUTO_INFO(__func__, axes_r, axes_w, functions),
  90         };
  91
  92         return hkl_mode_auto_new(&info,
  93                                  &hkl_mode_operations,
  94                                  TRUE);
  95 }
  96
  97 static HklMode *constant_phi(void)
  98 {
  99         static const char* axes_r[] = {OMEGA, CHI, PHI, TTH};
 100         static const char* axes_w[] = {OMEGA, CHI, TTH};
 101         static const HklFunction *functions[] = {&RUBh_minus_Q_func};
 102         static const HklModeAutoInfo info = {
 103                 HKL_MODE_AUTO_INFO(__func__, axes_r, axes_w, functions),
 104         };
 105
 106         return hkl_mode_auto_new(&info,
 107                                  &hkl_mode_operations,
 108                                  TRUE);
 109 }
 110
 111 static HklMode *double_diffraction(void)
 112 {
 113         static const char* axes[] = {OMEGA, CHI, PHI, TTH};
 114         static const HklFunction *functions[] = {&double_diffraction_func};
 115         static const HklModeAutoInfo info = {
 116                 HKL_MODE_AUTO_INFO_WITH_PARAMS(__func__, axes, axes,
 117                                                functions, double_diffraction_parameters),
 118         };
 119
 120         return hkl_mode_auto_new(&info,
 121                                  &hkl_mode_operations,
 122                                  TRUE);
 123 }
 124
 125 static HklMode *psi_constant(void)
 126 {
 127         static const char* axes[] = {OMEGA, CHI, PHI, TTH};
 128         static const HklFunction *functions[] = {&psi_constant_vertical_func};
 129         static const HklModeAutoInfo info = {
 130                 HKL_MODE_AUTO_INFO_WITH_PARAMS(__func__, axes, axes,
 131                                                functions, psi_constant_parameters),
 132         };
 133
 134         return hkl_mode_auto_new(&info,
 135                                  &psi_constant_vertical_mode_operations,
 136                                  TRUE);
 137 }
 138
 139 static HklEngine *hkl_engine_e4c_hkl_new(HklEngineList *engines)
 140 {
 141         HklEngine *self;
 142         HklMode *default_mode;
 143
 144         self = hkl_engine_hkl_new(engines);
 145
 146         default_mode = bissector();
 147         hkl_engine_add_mode(self, default_mode);
 148         hkl_engine_mode_set(self, default_mode);
 149
 150         hkl_engine_add_mode(self, constant_omega());
 151         hkl_engine_add_mode(self, constant_chi());
 152         hkl_engine_add_mode(self, constant_phi());
 153         hkl_engine_add_mode(self, double_diffraction());
 154         hkl_engine_add_mode(self, psi_constant());
 155
 156         return self;
 157 }
 158
 159 /************/
 160 /* mode psi */
 161 /************/
 162
 163 static HklMode *psi(void)
 164 {
 165         static const char *axes[] = {OMEGA, CHI, PHI, TTH};
 166         static const HklFunction *functions[] = {&psi_func};
 167         static const HklModeAutoInfo info = {
 168                 HKL_MODE_AUTO_INFO_WITH_PARAMS(__func__, axes, axes,
 169                                                functions, psi_parameters),
 170         };
 171
 172         return hkl_mode_psi_new(&info);
 173 }
 174
 175 static HklEngine *hkl_engine_e4c_psi_new(HklEngineList *engines)
 176 {
 177         HklEngine *self;
 178         HklMode *default_mode;
 179
 180         self = hkl_engine_psi_new(engines);
 181
 182         default_mode = psi();
 183         hkl_engine_add_mode(self, default_mode);
 184         hkl_engine_mode_set(self, default_mode);
 185
 186         return self;
 187 }
 188
 189 /*****************/
 190 /* mode readonly */
 191 /*****************/
 192
 193 REGISTER_READONLY_INCIDENCE(hkl_engine_e4c_incidence_new,
 194                             P99_PROTECT({OMEGA, CHI, PHI}),
 195                             surface_parameters_y);
 196
 197 REGISTER_READONLY_EMERGENCE(hkl_engine_e4c_emergence_new,
 198                             P99_PROTECT({OMEGA, CHI, PHI, TTH}),
 199                             surface_parameters_y);
 200
 201 /********/
 202 /* E4CV */
 203 /********/
 204
 205 #define HKL_GEOMETRY_EULERIAN4C_VERTICAL_DESCRIPTION                    \
 206         "+ xrays source fix allong the :math:`\\vec{x}` direction (1, 0, 0)\n" \
 207         "+ 3 axes for the sample\n"                                     \
 208         "\n"                                                            \
 209         "  + **" OMEGA "** : rotating around the :math:`-\\vec{y}` direction (0, -1, 0)\n" \
 210         "  + **" CHI "** : rotating around the :math:`\\vec{x}` direction (1, 0, 0)\n" \
 211         "  + **" PHI "** : rotating around the :math:`-\\vec{y}` direction (0, -1, 0)\n" \
 212         "\n"                                                            \
 213         "+ 1 axis for the detector\n"                                   \
 214         "\n"                                                            \
 215         "  + **" TTH "** : rotation around the :math:`-\\vec{y}` direction (0, -1, 0)\n"
 216
 217 static const char* hkl_geometry_eulerian4C_vertical_axes[] = {OMEGA, CHI, PHI, TTH};
 218
 219 static HklGeometry *hkl_geometry_new_eulerian4C_vertical(const HklFactory *factory)
 220 {
 221         HklGeometry *self = hkl_geometry_new(factory);
 222         HklHolder *h;
 223
 224         h = hkl_geometry_add_holder(self);
 225         hkl_holder_add_rotation_axis(h, OMEGA, 0, -1, 0);
 226         hkl_holder_add_rotation_axis(h, CHI, 1, 0, 0);
 227         hkl_holder_add_rotation_axis(h, PHI, 0, -1, 0);
 228
 229         h = hkl_geometry_add_holder(self);
 230         hkl_holder_add_rotation_axis(h, TTH, 0, -1, 0);
 231
 232         return self;
 233 }
 234
 235 static HklEngineList *hkl_engine_list_new_eulerian4C_vertical(const HklFactory *factory)
 236 {
 237         HklEngineList *self = hkl_engine_list_new();
 238
 239         hkl_engine_e4c_hkl_new(self);
 240         hkl_engine_e4c_psi_new(self);
 241         hkl_engine_q_new(self);
 242         hkl_engine_e4c_incidence_new(self);
 243
 244         return self;
 245 }
 246
 247 REGISTER_DIFFRACTOMETER(eulerian4C_vertical, "E4CV", HKL_GEOMETRY_EULERIAN4C_VERTICAL_DESCRIPTION);
 248
 249
 250 /***************/
 251 /* SOLEIL MARS */
 252 /***************/
 253
 254 #define HKL_GEOMETRY_TYPE_SOLEIL_MARS_DESCRIPTION                       \
 255         "+ xrays source fix allong the :math:`\\vec{x}` direction (1, 0, 0)\n" \
 256         "+ 3 axes for the sample\n"                                     \
 257         "\n"                                                            \
 258         "  + **" OMEGA "** : rotating around the :math:`\\vec{z}` direction (0, -1, 0)\n" \
 259         "  + **" CHI "** : rotating around the :math:`\\vec{x}` direction (-1, 0, 0)\n" \
 260         "  + **" PHI "** : rotating around the :math:`\\vec{z}` direction (0, 0, 1)\n" \
 261         "\n"                                                            \
 262         "+ 1 axis for the detector\n"                                   \
 263         "\n"                                                            \
 264         "  + **" TTH "** : rotation around the :math:`\\vec{z}` direction (0, -1, 0)\n"
 265
 266 static const char* hkl_geometry_soleil_mars_axes[] = {OMEGA, CHI, PHI, TTH};
 267
 268 static HklGeometry *hkl_geometry_new_soleil_mars(const HklFactory *factory)
 269 {
 270         HklGeometry *self = hkl_geometry_new(factory);
 271         HklHolder *h;
 272
 273         h = hkl_geometry_add_holder(self);
 274         hkl_holder_add_rotation_axis(h, OMEGA, 0, -1, 0);
 275         hkl_holder_add_rotation_axis(h, CHI, -1, 0, 0);
 276         hkl_holder_add_rotation_axis(h, PHI, 0, 0, 1);
 277
 278         h = hkl_geometry_add_holder(self);
 279         hkl_holder_add_rotation_axis(h, TTH, 0, -1, 0);
 280
 281         return self;
 282 }
 283
 284 static HklEngineList *hkl_engine_list_new_soleil_mars(const HklFactory *factory)
 285 {
 286         HklEngineList *self = hkl_engine_list_new();
 287
 288         hkl_engine_e4c_hkl_new(self);
 289         hkl_engine_e4c_psi_new(self);
 290         hkl_engine_q_new(self);
 291         hkl_engine_e4c_incidence_new(self);
 292
 293         return self;
 294 }
 295
 296 REGISTER_DIFFRACTOMETER(soleil_mars, "SOLEIL MARS", HKL_GEOMETRY_TYPE_SOLEIL_MARS_DESCRIPTION);
 297
 298 /********/
 299 /* E4CH */
 300 /********/
 301
 302 #define HKL_GEOMETRY_TYPE_EULERIAN4C_HORIZONTAL_DESCRIPTION             \
 303         "+ xrays source fix allong the :math:`\\vec{x}` direction (1, 0, 0)\n" \
 304         "+ 3 axes for the sample\n"                                     \
 305         "\n"                                                            \
 306         "  + **" OMEGA "** : rotating around the :math:`\\vec{z}` direction (0, 0, 1)\n" \
 307         "  + **" CHI "** : rotating around the :math:`\\vec{x}` direction (1, 0, 0)\n" \
 308         "  + **" PHI "** : rotating around the :math:`\\vec{z}` direction (0, 0, 1)\n" \
 309         "\n"                                                            \
 310         "+ 1 axis for the detector\n"                                   \
 311         "\n"                                                            \
 312         "  + **" TTH "** : rotation around the :math:`\\vec{z}` direction (0, 0, 1)\n"
 313
 314 static const char* hkl_geometry_eulerian4C_horizontal_axes[] = {OMEGA, CHI, PHI, TTH};
 315
 316 static HklGeometry *hkl_geometry_new_eulerian4C_horizontal(const HklFactory *factory)
 317 {
 318         HklGeometry *self = hkl_geometry_new(factory);
 319         HklHolder *h;
 320
 321         h = hkl_geometry_add_holder(self);
 322         hkl_holder_add_rotation_axis(h, OMEGA, 0, 0, 1);
 323         hkl_holder_add_rotation_axis(h, CHI, 1, 0, 0);
 324         hkl_holder_add_rotation_axis(h, PHI, 0, 0, 1);
 325
 326         h = hkl_geometry_add_holder(self);
 327         hkl_holder_add_rotation_axis(h, TTH, 0, 0, 1);
 328
 329         return self;
 330 }
 331
 332 static HklEngineList *hkl_engine_list_new_eulerian4C_horizontal(const HklFactory *factory)
 333 {
 334         HklEngineList *self = hkl_engine_list_new();
 335
 336         hkl_engine_e4c_hkl_new(self);
 337         hkl_engine_e4c_psi_new(self);
 338         hkl_engine_q_new(self);
 339         hkl_engine_e4c_incidence_new(self);
 340         hkl_engine_e4c_emergence_new(self);
 341
 342         return self;
 343 }
 344
 345 REGISTER_DIFFRACTOMETER(eulerian4C_horizontal, "E4CH", HKL_GEOMETRY_TYPE_EULERIAN4C_HORIZONTAL_DESCRIPTION);