hkl/hkl-pseudoaxis-common-psi-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-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 #ifndef __HKL_PSEUDOAXIS_COMMON_PSI_PRIVATE_H__
  23 #define __HKL_PSEUDOAXIS_COMMON_PSI_PRIVATE_H__
  24
  25 #include <gsl/gsl_vector_double.h>      // for gsl_vector
  26 #include "hkl-pseudoaxis-auto-private.h"  // for HklFunction, etc
  27 #include "hkl-pseudoaxis-private.h"     // for _HklEngine, _HklMode
  28 #include "hkl-vector-private.h"         // for HklVector
  29 #include "hkl.h"                        // for HklEngine, HklMode, etc
  30
  31 G_BEGIN_DECLS
  32
  33 typedef struct _HklModePsi HklModePsi;
  34 typedef struct _HklEnginePsi HklEnginePsi;
  35
  36 struct _HklModePsi
  37 {
  38         HklMode parent;
  39         HklVector Q0;
  40         HklVector hkl0;
  41 };
  42
  43 struct _HklEnginePsi
  44 {
  45         HklEngine engine;
  46         HklParameter *psi;
  47 };
  48
  49 extern HklMode *hkl_mode_psi_new(
  50         const HklModeAutoInfo *info);
  51
  52 extern HklEngine *hkl_engine_psi_new(HklEngineList *engines);
  53
  54 extern int _psi_func(const gsl_vector *x, void *params, gsl_vector *f);
  55
  56 static const HklFunction psi_func = {
  57         .function = _psi_func,
  58         .size = 4,
  59 };
  60
  61 static const HklParameter psi_parameters[] = {
  62         {
  63                 HKL_PARAMETER_DEFAULTS, .name = "h2", ._value = 1,
  64                 .description = "h coordinate of the reference plan",
  65                 .range = { .min=-1, .max=1 },
  66         },
  67         {
  68                 HKL_PARAMETER_DEFAULTS, .name = "k2", ._value = 1,
  69                 .description = "k coordinate of the reference plan",
  70                 .range = { .min=-1, .max=1 },
  71         },
  72         {
  73                 HKL_PARAMETER_DEFAULTS, .name = "l2", ._value = 1,
  74                 .description = "l coordinate of the reference plan",
  75                 .range = { .min=-1, .max=1 },
  76         },
  77 };
  78
  79 G_END_DECLS
  80
  81 #endif /* __HKL_PSEUDOAXIS_COMMON_PSI_PRIVATE_H__ */