1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
// Tell SWIG not to make constructor for these objects
%nodefault cbf_positioner_struct;
%nodefault cbf_goniometer;
%nodefault cbf_axis_struct;
// Tell SWIG what the object is, so we can build the class
typedef struct
{
double matrix [3][4];
cbf_axis_struct *axis;
size_t axes;
int matrix_is_valid;
double matrix_ratio_used;
size_t axis_index_limit;
}
cbf_positioner_struct;
typedef cbf_positioner_struct *cbf_positioner;
typedef cbf_positioner_struct *cbf_goniometer;
%feature("autodoc","1");
%extend cbf_positioner_struct{// Tell SWIG to attach functions to the structure
cbf_positioner_struct(){ // Constructor
// DO NOT CONSTRUCT WITHOUT A CBFHANDLE
cbf_failnez(CBF_ARGUMENT);
return NULL; /* Should never be executed */
}
~cbf_positioner_struct(){ // Destructor
cbf_failnez(cbf_free_positioner(self));
}
%feature("autodoc", "
Returns : double vector1,double vector2,double vector3
*args :
C prototype: int cbf_get_rotation_axis (cbf_goniometer goniometer,
unsigned int reserved, double *vector1, double *vector2,
double *vector3);
CBFLib documentation:
DESCRIPTION
cbf_get_rotation_axis sets *vector1, *vector2, and *vector3 to the 3
components of the goniometer rotation axis used for the exposure.
Any of the destination pointers may be NULL.
The parameter reserved is presently unused and should be set to 0.
ARGUMENTS
goniometer Goniometer handle. reserved Unused. Any value other
than 0 is invalid. vector1 Pointer to the destination x
component of the rotation axis. vector2 Pointer to the
destination y component of the rotation axis. vector3 Pointer to
the destination z component of the rotation axis.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_rotation_axis;
%apply double *OUTPUT {double *vector1, double *vector2, double *vector3};
void get_rotation_axis (double *vector1, double *vector2, double *vector3){
unsigned int reserved;
reserved = 0;
cbf_failnez(cbf_get_rotation_axis (self, reserved,
vector1, vector2, vector3));
}
%feature("autodoc", "
Returns : Float start,Float increment
*args :
C prototype: int cbf_get_rotation_range (cbf_goniometer goniometer,
unsigned int reserved, double *start, double *increment);
CBFLib documentation:
DESCRIPTION
cbf_get_rotation_range sets *start and *increment to the
corresponding values of the goniometer rotation axis used for the
exposure.
Either of the destination pointers may be NULL.
The parameter reserved is presently unused and should be set to 0.
ARGUMENTS
goniometer Goniometer handle. reserved Unused. Any value other
than 0 is invalid. start Pointer to the destination start
value. increment Pointer to the destination increment value.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_rotation_range;
%apply double *OUTPUT {double *start,double *increment};
void get_rotation_range(double *start,double *increment){
unsigned int reserved;
reserved = 0;
cbf_failnez(cbf_get_rotation_range (self,reserved, start,increment));
}
%feature("autodoc", "
Returns : double final1,double final2,double final3
*args : double ratio,double initial1,double initial2,double initial3
C prototype: int cbf_rotate_vector (cbf_goniometer goniometer,
unsigned int reserved, double ratio, double initial1,
double initial2, double initial3, double *final1,
double *final2, double *final3);
CBFLib documentation:
DESCRIPTION
cbf_rotate_vector sets *final1, *final2, and *final3 to the 3
components of the of the vector (initial1, initial2, initial3) after
reorientation by applying the goniometer rotations. The value ratio
specif ies the goniometer setting and varies from 0.0 at the
beginning of the exposure to 1.0 at the end, irrespective of the
actual rotation range.
Any of the destination pointers may be NULL.
The parameter reserved is presently unused and should be set to 0.
ARGUMENTS
goniometer Goniometer handle. reserved Unused. Any value other
than 0 is invalid. ratio Goniometer setting. 0 = beginning of
exposure, 1 = end. initial1 x component of the initial vector.
initial2 y component of the initial vector. initial3 z
component of the initial vector. vector1 Pointer to the
destination x component of the final vector. vector2 Pointer to
the destination y component of the final vector. vector3 Pointer
to the destination z component of the final vector.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")rotate_vector;
%apply double *OUTPUT {double *final1, double *final2, double *final3};
void rotate_vector (double ratio, double initial1, double initial2,
double initial3, double *final1, double *final2, double *final3){
unsigned int reserved;
reserved = 0;
cbf_failnez(cbf_rotate_vector (self, reserved, ratio, initial1,
initial2, initial3, final1, final2, final3));
}
%feature("autodoc", "
Returns : double reciprocal1,double reciprocal2,double reciprocal3
*args : double ratio,double wavelength,double real1,double real2,double real3
C prototype: int cbf_get_reciprocal (cbf_goniometer goniometer,
unsigned int reserved, double ratio, double wavelength,
double real1, double real2, double real3,
double *reciprocal1, double *reciprocal2,
double *reciprocal3);
CBFLib documentation:
DESCRIPTION
cbf_get_reciprocal sets *reciprocal1, * reciprocal2, and *
reciprocal3 to the 3 components of the of the reciprocal-space vector
corresponding to the real-space vector (real1, real2, real3). The
reciprocal-space vector is oriented to correspond to the goniometer
setting with all axes at 0. The value wavelength is the wavlength in
AA and the value ratio specifies the current goniometer setting and
varies from 0.0 at the beginning of the exposur e to 1.0 at the end,
irrespective of the actual rotation range.
Any of the destination pointers may be NULL.
The parameter reserved is presently unused and should be set to 0.
ARGUMENTS
goniometer Goniometer handle. reserved Unused. Any value
other than 0 is invalid. ratio Goniometer setting. 0 =
beginning of exposure, 1 = end. wavelength Wavelength in AA. real1
x component of the real-space vector. real2 y
component of the real-space vector. real3 z component of the
real-space vector. reciprocal1 Pointer to the destination x
component of the reciprocal-space vector. reciprocal2 Pointer to
the destination y component of the reciprocal-space vector.
reciprocal3 Pointer to the destination z component of the
reciprocal-space vector.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_reciprocal;
%apply double *OUTPUT {double *reciprocal1, double *reciprocal2,
double *reciprocal3};
void get_reciprocal (double ratio,double wavelength,
double real1, double real2, double real3,
double *reciprocal1, double *reciprocal2,
double *reciprocal3){
unsigned int reserved;
reserved = 0;
cbf_failnez(cbf_get_reciprocal(self,reserved, ratio, wavelength,
real1, real2, real3,reciprocal1,
reciprocal2,reciprocal3));
}
%feature("autodoc", "
Returns : Float vector1,Float vector2,Float vector3,Float offset1,Float offset2,
Float offset3,Float angle
*args : Float ratio
C prototype: int cbf_get_goniometer_poise(cbf_goniometer goniometer,
double ratio, double * vector1, double * vector2,
double * vector3, double * offset1, double * offset2,
double * offset3, double * angle);
CBFLib documentation:
DESCRIPTION
cbf_get_axis_poise sets vector1, vector2, vector3 to point to the
components of the axis vector for axis axis_id, offset1, offset2,
offset3 to point to the components of the axis base offset vector for
axis axis_id, and angle to point to the angle of rotation of axis
axis_id after application of the axis settings for frame frame_id,
using ratio, a value between 0 and 1, indicating how far into the
internal motion in the frame to go. If frame_id is the string \".
\", the first frame found is used. If there is more than one frame,
which frame will be found is indeterminate. If frame_id is NULL, the
overall setting for the scan are used, rather than those for any
particular frame. The vector and offset reported are the reference
vector and offset of the axis axis_id transformed by application of
all motions of the axes on which axis_id depends.
cbf_get_goniometer_poise vector1, vector2, vector3 to point to the
components of the axis vector for the goniometer axis, offset1,
offset2, offset3 to point to the components of the axis base offset
vector for the goniometer axis, and angle to point to the angle of
rotation of the goniometer axis after application of all axis
settings in the goniometer deriving the vector, offset and angle from
the resulting matrix. Calculation of the vector is indeterminate if
the angle is zero.
cbf_get_axis_reference_poise sets vector1, vector2, vector3 to point
to the components of the axis vector for axis axis_id, offset1,
offset2, offset3 to point to the components of the axis base offset
vector for axis axis_id unmodified by axis rotations. Any of the
pointers may be specified as NULL.
ARGUMENTS
handle CBF handle. ratio A number between 0 and 1
indication how far into the frame to go vector1 Pointer to the
first component of the axis vector vector2 Pointer to the second
component of the axis vector vector3 Pointer to the third
component of the axis vector offset1 Pointer to the first
component of the axis offset offset2 Pointer to the second
component of the axis offset offset3 Pointer to the third
component of the axis offset angle Pointer to the rotation
angle axis_id The specified axis frame_id The specified
frame positioner CBF goniometer
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_goniometer_poise;
%apply double *OUTPUT {double * vector1, double * vector2, double * vector3, double * offset1, double * offset2, double * offset3,
double * angle};
void get_goniometer_poise(double ratio,
double * vector1, double * vector2, double * vector3,
double * offset1, double * offset2, double * offset3,
double * angle){
cbf_failnez(cbf_get_goniometer_poise(self, ratio,
vector1, vector2, vector3,
offset1, offset2, offset3,angle));
}
}; // End of cbf_positioner
|
