forked from dials/cbflib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcbfdetectorwrappers.i
1354 lines (1251 loc) · 64.1 KB
/
cbfdetectorwrappers.i
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Tell SWIG not to make constructor for these objects
%nodefault cbf_detector_struct;
%nodefault cbf_detector;
// Tell SWIG what the object is, so we can build the class
typedef struct
{
cbf_positioner positioner;
double displacement [2], increment [2];
size_t axes, index [2];
}
cbf_detector_struct;
typedef cbf_detector_struct *cbf_detector;
%feature("autodoc","1");
%extend cbf_detector_struct{// Tell SWIG to attach functions to the structure
cbf_detector_struct(){ // Constructor
// DO NOT CONSTRUCT WITHOUT A CBFHANDLE
cbf_failnez(CBF_ARGUMENT);
return NULL; /* Should never be executed */
}
~cbf_detector_struct(){ // Destructor
cbf_failnez(cbf_free_detector(self));
}
%feature("autodoc", "
Returns :
*args : double indexfast,double indexslow,double centerfast,double centerslow
C prototype: int cbf_set_beam_center_fs (cbf_detector detector,
double *indexfast, double *indexslow, double *centerfast,
double *centerslow);
CBFLib documentation:
DESCRIPTION
cbf_get_beam_center sets *centerfast and *centerslow to the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector and *indexfast and
*indexslow to the corresponding indices. cbf_set_beam_center sets the
offsets in the axis category for the detector element axis with
precedence 1 to place the beam center at the position given in mm by
*centerfast and *centerslow as the displacements in mm along the
detector axes from pixel (0, 0) to the point at which the beam
intersects the detector at the indices given *indexfast and
*indexslow. cbf_set_reference_beam_center sets the displacments in
the array_structure_list_axis category to place the beam center at
the position given in mm by *centerfast and *centerslow as the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector at the indices given
by *indexfast and *indexslow. In order to achieve consistent results,
a reference detector should be used for detector to have all axes at
their reference settings.
Note that the precedence 1 axis is the fastest axis, so that
*centerfast and *indexfast are the fast axis components of the center
and *centerslow and *indexslow are the slow axis components of the
center.
The _fs calls give the displacments in a fast-to-slow order. The
calls with no suffix and the calls _sf calls give the displacements
in slow-to-fast order
Any of the destination pointers may be NULL for getting the beam
center. For setting the beam axis, either the indices of the center
must not be NULL.
The indices are non-negative for beam centers within the detector
surface, but the center for an axis with a negative increment will be
negative for a beam center within the detector surface.
For cbf_set_beam_center if the diffrn_data_frame category exists with
a row for the corresponding element id, the values will be set for
_diffrn_data_frame.center_fast and _diffrn_data_frame.center_slow in
millimetres and the value of _diffrn_data_frame.center_units will be
set to 'mm'.
For cbf_set_reference_beam_center if the diffrn_detector_element
category exists with a row for the corresponding element id, the
values will be set for _diffrn_detector_element.reference_center_fast
and _diffrn_detector_element.reference_center_slow in millimetres and
the value of _diffrn_detector_element.reference_units will be set to
'mm'.
ARGUMENTS
detector Detector handle. indexfast Pointer to the destination
fast index. indexslow Pointer to the destination slow index.
centerfast Pointer to the destination displacement along the fast
axis. centerslow Pointer to the destination displacement along the
slow axis.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")set_beam_center_fs;
void set_beam_center_fs(double *indexfast, double *indexslow,
double *centerfast,double *centerslow){
cbf_failnez(cbf_set_beam_center_fs(self, indexfast, indexslow,
centerfast, centerslow));
}
%feature("autodoc", "
Returns :
*args : double indexfast,double indexslow,double centerfast,double centerslow
C prototype: int cbf_set_reference_beam_center_fs (cbf_detector detector,
double *indexfast, double *indexslow, double *centerfast,
double *centerslow);
CBFLib documentation:
DESCRIPTION
cbf_get_beam_center sets *centerfast and *centerslow to the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector and *indexfast and
*indexslow to the corresponding indices. cbf_set_beam_center sets the
offsets in the axis category for the detector element axis with
precedence 1 to place the beam center at the position given in mm by
*centerfast and *centerslow as the displacements in mm along the
detector axes from pixel (0, 0) to the point at which the beam
intersects the detector at the indices given *indexfast and
*indexslow. cbf_set_reference_beam_center sets the displacments in
the array_structure_list_axis category to place the beam center at
the position given in mm by *centerfast and *centerslow as the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector at the indices given
by *indexfast and *indexslow. In order to achieve consistent results,
a reference detector should be used for detector to have all axes at
their reference settings.
Note that the precedence 1 axis is the fastest axis, so that
*centerfast and *indexfast are the fast axis components of the center
and *centerslow and *indexslow are the slow axis components of the
center.
The _fs calls give the displacments in a fast-to-slow order. The
calls with no suffix and the calls _sf calls give the displacements
in slow-to-fast order
Any of the destination pointers may be NULL for getting the beam
center. For setting the beam axis, either the indices of the center
must not be NULL.
The indices are non-negative for beam centers within the detector
surface, but the center for an axis with a negative increment will be
negative for a beam center within the detector surface.
For cbf_set_beam_center if the diffrn_data_frame category exists with
a row for the corresponding element id, the values will be set for
_diffrn_data_frame.center_fast and _diffrn_data_frame.center_slow in
millimetres and the value of _diffrn_data_frame.center_units will be
set to 'mm'.
For cbf_set_reference_beam_center if the diffrn_detector_element
category exists with a row for the corresponding element id, the
values will be set for _diffrn_detector_element.reference_center_fast
and _diffrn_detector_element.reference_center_slow in millimetres and
the value of _diffrn_detector_element.reference_units will be set to
'mm'.
ARGUMENTS
detector Detector handle. indexfast Pointer to the destination
fast index. indexslow Pointer to the destination slow index.
centerfast Pointer to the destination displacement along the fast
axis. centerslow Pointer to the destination displacement along the
slow axis.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")set_reference_beam_center_fs;
void set_reference_beam_center_fs(double *indexfast, double *indexslow,
double *centerfast,double *centerslow){
cbf_failnez(cbf_set_reference_beam_center_fs(self, indexfast, indexslow,
centerfast, centerslow));
}
%feature("autodoc", "
Returns : double index1,double index2,double center1,double center2
*args :
C prototype: int cbf_get_beam_center (cbf_detector detector,
double *indexslow, double *indexfast, double *centerslow,
double *centerfast);
CBFLib documentation:
DESCRIPTION
cbf_get_beam_center sets *centerfast and *centerslow to the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector and *indexfast and
*indexslow to the corresponding indices. cbf_set_beam_center sets the
offsets in the axis category for the detector element axis with
precedence 1 to place the beam center at the position given in mm by
*centerfast and *centerslow as the displacements in mm along the
detector axes from pixel (0, 0) to the point at which the beam
intersects the detector at the indices given *indexfast and
*indexslow. cbf_set_reference_beam_center sets the displacments in
the array_structure_list_axis category to place the beam center at
the position given in mm by *centerfast and *centerslow as the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector at the indices given
by *indexfast and *indexslow. In order to achieve consistent results,
a reference detector should be used for detector to have all axes at
their reference settings.
Note that the precedence 1 axis is the fastest axis, so that
*centerfast and *indexfast are the fast axis components of the center
and *centerslow and *indexslow are the slow axis components of the
center.
The _fs calls give the displacments in a fast-to-slow order. The
calls with no suffix and the calls _sf calls give the displacements
in slow-to-fast order
Any of the destination pointers may be NULL for getting the beam
center. For setting the beam axis, either the indices of the center
must not be NULL.
The indices are non-negative for beam centers within the detector
surface, but the center for an axis with a negative increment will be
negative for a beam center within the detector surface.
For cbf_set_beam_center if the diffrn_data_frame category exists with
a row for the corresponding element id, the values will be set for
_diffrn_data_frame.center_fast and _diffrn_data_frame.center_slow in
millimetres and the value of _diffrn_data_frame.center_units will be
set to 'mm'.
For cbf_set_reference_beam_center if the diffrn_detector_element
category exists with a row for the corresponding element id, the
values will be set for _diffrn_detector_element.reference_center_fast
and _diffrn_detector_element.reference_center_slow in millimetres and
the value of _diffrn_detector_element.reference_units will be set to
'mm'.
ARGUMENTS
detector Detector handle. indexfast Pointer to the destination
fast index. indexslow Pointer to the destination slow index.
centerfast Pointer to the destination displacement along the fast
axis. centerslow Pointer to the destination displacement along the
slow axis.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_beam_center;
%apply double *OUTPUT {double *index1, double *index2,
double *center1,double *center2};
void get_beam_center(double *index1, double *index2,
double *center1,double *center2){
cbf_failnez(cbf_get_beam_center(self, index1, index2,
center1, center2));
}
%feature("autodoc", "
Returns : double coordinate1,double coordinate2,double coordinate3
*args : double indexfast,double indexslow
C prototype: int cbf_get_pixel_coordinates_fs (cbf_detector detector,
double indexfast, double indexslow, double *coordinate1,
double *coordinate2, double *coordinate3);
CBFLib documentation:
DESCRIPTION
cbf_get_pixel_coordinates, cbf_get_pixel_coordinates_fs and
cbf_get_pixel_coordinates_sf ses *coordinate1, *coordinate2, and
*coordinate3 to the vector position of pixel (indexfast, indexslow)
on the detector surface. If indexslow and indexfast are integers then
the coordinates correspond to the center of a pixel.
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. indexslow Slow index. indexfast
Fast index. coordinate1 Pointer to the destination x component.
coordinate2 Pointer to the destination y component. coordinate3
Pointer to the destination z component.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_pixel_coordinates_fs;
%apply double *OUTPUT {double *coordinate1,
double *coordinate2, double *coordinate3};
void get_pixel_coordinates_fs(double indexfast, double indexslow,
double *coordinate1,
double *coordinate2,
double *coordinate3){
cbf_failnez(cbf_get_pixel_coordinates_fs(self, indexfast, indexslow, coordinate1, coordinate2, coordinate3));
}
%feature("autodoc", "
Returns : Float pixel size
*args : Int axis_number
C prototype: int cbf_get_inferred_pixel_size (cbf_detector detector,
int axis_number, double *psize);
CBFLib documentation:
DESCRIPTION
cbf_get_inferred_pixel_size, cbf_get_inferred_pixel_size_sf set
*psize to point to the double value in millimeters of the pixel size
for the axis axis_number value. The slow index is treated as axis 1
and the next faster index is treated as axis 2.
cbf_get_inferred_pixel_size_fs sets *psize to point to the double
value in millimeters of the pixel size for the axis axis_number
value. The fast index is treated as axis 1 and the next slower index
is treated as axis 2.
If the axis number is negative, the axes are used in the reverse
order so that an axis_number of -1 indicates the fast axes in a call
to cbf_get_inferred_pixel_size or cbf_get_inferred_pixel_size_sf and
indicates the fast axis in a call to cbf_get_inferred_pixel_size_fs.
ARGUMENTS
detector Detector handle. axis_number The number of the axis.
psize Pointer to the destination pizel size in mm.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_inferred_pixel_size;
%apply double *OUTPUT { double *psize } get_inferred_pixel_size;
void get_inferred_pixel_size(unsigned int axis_number, double* psize){
cbf_failnez(cbf_get_inferred_pixel_size(self, axis_number, psize));
}
%feature("autodoc", "
Returns : double area,double projected_area
*args : double index1,double index2
C prototype: int cbf_get_pixel_area (cbf_detector detector, double indexslow,
double indexfast, double *area, double *projected_area);
CBFLib documentation:
DESCRIPTION
cbf_get_pixel_area, cbf_get_pixel_area_fs and cbf_get_pixel_area_sf
set *area to the area of the pixel at (indexfast, indexslow) on the
detector surface and *projected_area to the apparent area of the
pixel as viewed from the sample position, with indexslow being the
slow axis and indexfast being the fast axis.
Either of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. indexfast Fast index.
indexslow Slow index. area Pointer to the
destination area in mm2. projected_area Pointer to the destination
apparent area in mm2.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_pixel_area;
%apply double *OUTPUT{double *area,double *projected_area};
void get_pixel_area(double index1, double index2,
double *area,double *projected_area){
cbf_failnez(cbf_get_pixel_area (self,
index1, index2, area,projected_area));
}
%feature("autodoc", "
Returns : double normal1,double normal2,double normal3
*args : double indexfast,double indexslow
C prototype: int cbf_get_pixel_normal_fs (cbf_detector detector,
double indexfast, double indexslow, double *normal1,
double *normal2, double *normal3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_normal, cbf_get_pixel_normal_fs and
cbf_get_pixel_normal_sf set *normal1, *normal2, and *normal3 to the 3
components of the of the normal vector to the pixel at (indexfast,
indexslow). The vector is normalized.
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. indexslow Slow index. indexfast Fast
index. normal1 Pointer to the destination x component of the
normal vector. normal2 Pointer to the destination y component of
the normal vector. normal3 Pointer to the destination z component
of the normal vector.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_pixel_normal_fs;
%apply double *OUTPUT {double *normal1, double *normal2, double *normal3};
void get_pixel_normal_fs ( double indexfast, double indexslow,
double *normal1, double *normal2, double *normal3){
cbf_failnez(cbf_get_pixel_normal_fs(self,
indexfast,indexslow,normal1,normal2,normal3));
}
%feature("autodoc", "
Returns : String
*args : Integer index
C prototype: int cbf_get_detector_surface_axes(cbf_detector detector,
const char * * axis_id1, const char * * axis_id2);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_axis_slow sets *slowaxis1, *slowaxis2, and
*slowaxis3 to the 3 components of the slow axis of the specified
detector at the current settings of all axes.
cbf_get_detector_axis_slow sets *fastaxis1, *fastaxis2, and
*fastaxis3 to the 3 components of the fast axis of the specified
detector at the current settings of all axes. cbf_get_detector_axes,
cbf_get_detector_axes_fs and int cbf_get_detector_axes_sf set
*slowaxis1, *slowaxis2, and *slowaxis3 to the 3 components of the
slow axis and *fastaxis1, *fastaxis2, and *fastaxis3 to the 3
components of the fast axis of the specified detector at the current
settings of all axes. cbf_get_detector_surface_axes sets *axis_id1
and *axis_id2 to the names of the two surface axes of the detector or
\". \",
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. slowaxis1 Pointer to the destination x
component of the slow axis vector. slowaxis2 Pointer to the
destination y component of the slow axis vector. slowaxis3 Pointer
to the destination z component of the slow axis vector. fastaxis1
Pointer to the destination x component of the fast axis vector.
fastaxis2 Pointer to the destination y component of the fast axis
vector. fastaxis3 Pointer to the destination z component of the
fast axis vector. axis_id1 Pointer to the destination first
surface axis name. axis_id2 Pointer to the destination second
surface axis name. axis_id3 Pointer to the destination third
surface axis name.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")cbf_get_detector_surface_axes;
const char * get_detector_surface_axes (int index ){
const char * axis_id1;
const char * axis_id2;
cbf_failnez(cbf_get_detector_surface_axes(self,
&axis_id1, &axis_id2));
if (index == 0) return axis_id1;
if (index == 1) return axis_id2;
return ".";
}
%feature("autodoc", "
Returns : double slowaxis1,double slowaxis2,double slowaxis3,double fastaxis1,
double fastaxis2,double fastaxis3
*args :
C prototype: int cbf_get_detector_axes (cbf_detector detector,
double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_axis_slow sets *slowaxis1, *slowaxis2, and
*slowaxis3 to the 3 components of the slow axis of the specified
detector at the current settings of all axes.
cbf_get_detector_axis_slow sets *fastaxis1, *fastaxis2, and
*fastaxis3 to the 3 components of the fast axis of the specified
detector at the current settings of all axes. cbf_get_detector_axes,
cbf_get_detector_axes_fs and int cbf_get_detector_axes_sf set
*slowaxis1, *slowaxis2, and *slowaxis3 to the 3 components of the
slow axis and *fastaxis1, *fastaxis2, and *fastaxis3 to the 3
components of the fast axis of the specified detector at the current
settings of all axes. cbf_get_detector_surface_axes sets *axis_id1
and *axis_id2 to the names of the two surface axes of the detector or
\". \",
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. slowaxis1 Pointer to the destination x
component of the slow axis vector. slowaxis2 Pointer to the
destination y component of the slow axis vector. slowaxis3 Pointer
to the destination z component of the slow axis vector. fastaxis1
Pointer to the destination x component of the fast axis vector.
fastaxis2 Pointer to the destination y component of the fast axis
vector. fastaxis3 Pointer to the destination z component of the
fast axis vector. axis_id1 Pointer to the destination first
surface axis name. axis_id2 Pointer to the destination second
surface axis name. axis_id3 Pointer to the destination third
surface axis name.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_axes;
%apply double *OUTPUT {double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3};
void get_detector_axes ( double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3){
cbf_failnez(cbf_get_detector_axes(self,
slowaxis1,slowaxis2,slowaxis3,
fastaxis1,fastaxis2,fastaxis3));
}
%feature("autodoc", "
Returns :
*args : double indexslow,double indexfast,double centerslow,double centerfast
C prototype: int cbf_set_reference_beam_center (cbf_detector detector,
double *indexslow, double *indexfast, double *centerslow,
double *centerfast);
CBFLib documentation:
DESCRIPTION
cbf_get_beam_center sets *centerfast and *centerslow to the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector and *indexfast and
*indexslow to the corresponding indices. cbf_set_beam_center sets the
offsets in the axis category for the detector element axis with
precedence 1 to place the beam center at the position given in mm by
*centerfast and *centerslow as the displacements in mm along the
detector axes from pixel (0, 0) to the point at which the beam
intersects the detector at the indices given *indexfast and
*indexslow. cbf_set_reference_beam_center sets the displacments in
the array_structure_list_axis category to place the beam center at
the position given in mm by *centerfast and *centerslow as the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector at the indices given
by *indexfast and *indexslow. In order to achieve consistent results,
a reference detector should be used for detector to have all axes at
their reference settings.
Note that the precedence 1 axis is the fastest axis, so that
*centerfast and *indexfast are the fast axis components of the center
and *centerslow and *indexslow are the slow axis components of the
center.
The _fs calls give the displacments in a fast-to-slow order. The
calls with no suffix and the calls _sf calls give the displacements
in slow-to-fast order
Any of the destination pointers may be NULL for getting the beam
center. For setting the beam axis, either the indices of the center
must not be NULL.
The indices are non-negative for beam centers within the detector
surface, but the center for an axis with a negative increment will be
negative for a beam center within the detector surface.
For cbf_set_beam_center if the diffrn_data_frame category exists with
a row for the corresponding element id, the values will be set for
_diffrn_data_frame.center_fast and _diffrn_data_frame.center_slow in
millimetres and the value of _diffrn_data_frame.center_units will be
set to 'mm'.
For cbf_set_reference_beam_center if the diffrn_detector_element
category exists with a row for the corresponding element id, the
values will be set for _diffrn_detector_element.reference_center_fast
and _diffrn_detector_element.reference_center_slow in millimetres and
the value of _diffrn_detector_element.reference_units will be set to
'mm'.
ARGUMENTS
detector Detector handle. indexfast Pointer to the destination
fast index. indexslow Pointer to the destination slow index.
centerfast Pointer to the destination displacement along the fast
axis. centerslow Pointer to the destination displacement along the
slow axis.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")set_reference_beam_center;
void set_reference_beam_center(double *indexslow, double *indexfast,
double *centerslow,double *centerfast){
cbf_failnez(cbf_set_reference_beam_center(self, indexslow, indexfast,
centerslow, centerfast));
}
%feature("autodoc", "
Returns : double slowaxis1,double slowaxis2,double slowaxis3
*args :
C prototype: int cbf_get_detector_axis_slow (cbf_detector detector,
double *slowaxis1, double *slowaxis2, double *slowaxis3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_axis_slow sets *slowaxis1, *slowaxis2, and
*slowaxis3 to the 3 components of the slow axis of the specified
detector at the current settings of all axes.
cbf_get_detector_axis_slow sets *fastaxis1, *fastaxis2, and
*fastaxis3 to the 3 components of the fast axis of the specified
detector at the current settings of all axes. cbf_get_detector_axes,
cbf_get_detector_axes_fs and int cbf_get_detector_axes_sf set
*slowaxis1, *slowaxis2, and *slowaxis3 to the 3 components of the
slow axis and *fastaxis1, *fastaxis2, and *fastaxis3 to the 3
components of the fast axis of the specified detector at the current
settings of all axes. cbf_get_detector_surface_axes sets *axis_id1
and *axis_id2 to the names of the two surface axes of the detector or
\". \",
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. slowaxis1 Pointer to the destination x
component of the slow axis vector. slowaxis2 Pointer to the
destination y component of the slow axis vector. slowaxis3 Pointer
to the destination z component of the slow axis vector. fastaxis1
Pointer to the destination x component of the fast axis vector.
fastaxis2 Pointer to the destination y component of the fast axis
vector. fastaxis3 Pointer to the destination z component of the
fast axis vector. axis_id1 Pointer to the destination first
surface axis name. axis_id2 Pointer to the destination second
surface axis name. axis_id3 Pointer to the destination third
surface axis name.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_axis_slow;
%apply double *OUTPUT {double *slowaxis1, double *slowaxis2, double *slowaxis3};
void get_detector_axis_slow ( double *slowaxis1, double *slowaxis2, double *slowaxis3){
cbf_failnez(cbf_get_detector_axis_slow(self,
slowaxis1,slowaxis2,slowaxis3));
}
%feature("autodoc", "
Returns : double distance
*args :
C prototype: int cbf_get_detector_distance (cbf_detector detector,
double *distance);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_distance sets *distance to the nearest distance from
the sample position to the detector plane.
ARGUMENTS
detector Detector handle. distance Pointer to the destination
distance.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_distance;
%apply double *OUTPUT {double *distance};
void get_detector_distance (double *distance){
cbf_failnez(cbf_get_detector_distance(self,distance));
}
%feature("autodoc", "
Returns : Float pixel size
*args : Int axis_number
C prototype: int cbf_get_inferred_pixel_size_fs(cbf_detector detector,
int axis_number, double *psize);
CBFLib documentation:
DESCRIPTION
cbf_get_inferred_pixel_size, cbf_get_inferred_pixel_size_sf set
*psize to point to the double value in millimeters of the pixel size
for the axis axis_number value. The slow index is treated as axis 1
and the next faster index is treated as axis 2.
cbf_get_inferred_pixel_size_fs sets *psize to point to the double
value in millimeters of the pixel size for the axis axis_number
value. The fast index is treated as axis 1 and the next slower index
is treated as axis 2.
If the axis number is negative, the axes are used in the reverse
order so that an axis_number of -1 indicates the fast axes in a call
to cbf_get_inferred_pixel_size or cbf_get_inferred_pixel_size_sf and
indicates the fast axis in a call to cbf_get_inferred_pixel_size_fs.
ARGUMENTS
detector Detector handle. axis_number The number of the axis.
psize Pointer to the destination pizel size in mm.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_inferred_pixel_size_fs;
%apply double *OUTPUT { double *psize } get_inferred_pixel_size;
void get_inferred_pixel_size_fs(unsigned int axis_number, double* psize){
cbf_failnez(cbf_get_inferred_pixel_size_fs(self, axis_number, psize));
}
%feature("autodoc", "
Returns : double normal1,double normal2,double normal3
*args :
C prototype: int cbf_get_detector_normal (cbf_detector detector,
double *normal1, double *normal2, double *normal3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_normal sets *normal1, *normal2, and *normal3 to the
3 components of the of the normal vector to the detector plane. The
vector is normalized.
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. normal1 Pointer to the destination x
component of the normal vector. normal2 Pointer to the destination
y component of the normal vector. normal3 Pointer to the
destination z component of the normal vector.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_normal;
%apply double *OUTPUT {double *normal1, double *normal2, double *normal3};
void get_detector_normal(double *normal1,
double *normal2,
double *normal3){
cbf_failnez(cbf_get_detector_normal(self,
normal1, normal2, normal3));
}
%feature("autodoc", "
Returns : double fastaxis1,double fastaxis2,double fastaxis3
*args :
C prototype: int cbf_get_detector_axis_fast (cbf_detector detector,
double *fastaxis1, double *fastaxis2, double *fastaxis3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_axis_slow sets *slowaxis1, *slowaxis2, and
*slowaxis3 to the 3 components of the slow axis of the specified
detector at the current settings of all axes.
cbf_get_detector_axis_slow sets *fastaxis1, *fastaxis2, and
*fastaxis3 to the 3 components of the fast axis of the specified
detector at the current settings of all axes. cbf_get_detector_axes,
cbf_get_detector_axes_fs and int cbf_get_detector_axes_sf set
*slowaxis1, *slowaxis2, and *slowaxis3 to the 3 components of the
slow axis and *fastaxis1, *fastaxis2, and *fastaxis3 to the 3
components of the fast axis of the specified detector at the current
settings of all axes. cbf_get_detector_surface_axes sets *axis_id1
and *axis_id2 to the names of the two surface axes of the detector or
\". \",
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. slowaxis1 Pointer to the destination x
component of the slow axis vector. slowaxis2 Pointer to the
destination y component of the slow axis vector. slowaxis3 Pointer
to the destination z component of the slow axis vector. fastaxis1
Pointer to the destination x component of the fast axis vector.
fastaxis2 Pointer to the destination y component of the fast axis
vector. fastaxis3 Pointer to the destination z component of the
fast axis vector. axis_id1 Pointer to the destination first
surface axis name. axis_id2 Pointer to the destination second
surface axis name. axis_id3 Pointer to the destination third
surface axis name.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_axis_fast;
%apply double *OUTPUT {double *fastaxis1, double *fastaxis2, double *fastaxis3};
void get_detector_axis_fast ( double *fastaxis1, double *fastaxis2, double *fastaxis3){
cbf_failnez(cbf_get_detector_axis_fast(self,
fastaxis1,fastaxis2,fastaxis3));
}
%feature("autodoc", "
Returns : double fastaxis1,double fastaxis2,double fastaxis3,double slowaxis1,
double slowaxis2,double slowaxis3
*args :
C prototype: int cbf_get_detector_axes_fs (cbf_detector detector,
double *fastaxis1, double *fastaxis2, double *fastaxis3,
double *slowaxis1, double *slowaxis2, double *slowaxis3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_axis_slow sets *slowaxis1, *slowaxis2, and
*slowaxis3 to the 3 components of the slow axis of the specified
detector at the current settings of all axes.
cbf_get_detector_axis_slow sets *fastaxis1, *fastaxis2, and
*fastaxis3 to the 3 components of the fast axis of the specified
detector at the current settings of all axes. cbf_get_detector_axes,
cbf_get_detector_axes_fs and int cbf_get_detector_axes_sf set
*slowaxis1, *slowaxis2, and *slowaxis3 to the 3 components of the
slow axis and *fastaxis1, *fastaxis2, and *fastaxis3 to the 3
components of the fast axis of the specified detector at the current
settings of all axes. cbf_get_detector_surface_axes sets *axis_id1
and *axis_id2 to the names of the two surface axes of the detector or
\". \",
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. slowaxis1 Pointer to the destination x
component of the slow axis vector. slowaxis2 Pointer to the
destination y component of the slow axis vector. slowaxis3 Pointer
to the destination z component of the slow axis vector. fastaxis1
Pointer to the destination x component of the fast axis vector.
fastaxis2 Pointer to the destination y component of the fast axis
vector. fastaxis3 Pointer to the destination z component of the
fast axis vector. axis_id1 Pointer to the destination first
surface axis name. axis_id2 Pointer to the destination second
surface axis name. axis_id3 Pointer to the destination third
surface axis name.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_axes;
%apply double *OUTPUT {double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3};
void get_detector_axes_fs ( double *fastaxis1, double *fastaxis2, double *fastaxis3,
double *slowaxis1, double *slowaxis2, double *slowaxis3){
cbf_failnez(cbf_get_detector_axes(self,
slowaxis1,slowaxis2,slowaxis3,
fastaxis1,fastaxis2,fastaxis3));
}
%feature("autodoc", "
Returns : double slowaxis1,double slowaxis2,double slowaxis3,double fastaxis1,
double fastaxis2,double fastaxis3
*args :
C prototype: int cbf_get_detector_axes_sf (cbf_detector detector,
double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3);
CBFLib documentation:
DESCRIPTION
cbf_get_detector_axis_slow sets *slowaxis1, *slowaxis2, and
*slowaxis3 to the 3 components of the slow axis of the specified
detector at the current settings of all axes.
cbf_get_detector_axis_slow sets *fastaxis1, *fastaxis2, and
*fastaxis3 to the 3 components of the fast axis of the specified
detector at the current settings of all axes. cbf_get_detector_axes,
cbf_get_detector_axes_fs and int cbf_get_detector_axes_sf set
*slowaxis1, *slowaxis2, and *slowaxis3 to the 3 components of the
slow axis and *fastaxis1, *fastaxis2, and *fastaxis3 to the 3
components of the fast axis of the specified detector at the current
settings of all axes. cbf_get_detector_surface_axes sets *axis_id1
and *axis_id2 to the names of the two surface axes of the detector or
\". \",
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. slowaxis1 Pointer to the destination x
component of the slow axis vector. slowaxis2 Pointer to the
destination y component of the slow axis vector. slowaxis3 Pointer
to the destination z component of the slow axis vector. fastaxis1
Pointer to the destination x component of the fast axis vector.
fastaxis2 Pointer to the destination y component of the fast axis
vector. fastaxis3 Pointer to the destination z component of the
fast axis vector. axis_id1 Pointer to the destination first
surface axis name. axis_id2 Pointer to the destination second
surface axis name. axis_id3 Pointer to the destination third
surface axis name.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_detector_axes_sf;
%apply double *OUTPUT {double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3};
void get_detector_axes_sf ( double *slowaxis1, double *slowaxis2, double *slowaxis3,
double *fastaxis1, double *fastaxis2, double *fastaxis3){
cbf_failnez(cbf_get_detector_axes(self,
slowaxis1,slowaxis2,slowaxis3,
fastaxis1,fastaxis2,fastaxis3));
}
%feature("autodoc", "
Returns : double coordinate1,double coordinate2,double coordinate3
*args : double indexslow,double indexfast
C prototype: int cbf_get_pixel_coordinates_sf (cbf_detector detector,
double indexslow, double indexfast, double *coordinate1,
double *coordinate2, double *coordinate3);
CBFLib documentation:
DESCRIPTION
cbf_get_pixel_coordinates, cbf_get_pixel_coordinates_fs and
cbf_get_pixel_coordinates_sf ses *coordinate1, *coordinate2, and
*coordinate3 to the vector position of pixel (indexfast, indexslow)
on the detector surface. If indexslow and indexfast are integers then
the coordinates correspond to the center of a pixel.
Any of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. indexslow Slow index. indexfast
Fast index. coordinate1 Pointer to the destination x component.
coordinate2 Pointer to the destination y component. coordinate3
Pointer to the destination z component.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_pixel_coordinates_sf;
%apply double *OUTPUT {double *coordinate1,
double *coordinate2, double *coordinate3};
void get_pixel_coordinates_sf(double indexslow, double indexfast,
double *coordinate1,
double *coordinate2,
double *coordinate3){
cbf_failnez(cbf_get_pixel_coordinates_sf(self, indexslow, indexfast, coordinate1, coordinate2, coordinate3));
}
%feature("autodoc", "
Returns :
*args : double indexslow,double indexfast,double centerslow,double centerfast
C prototype: int cbf_set_beam_center (cbf_detector detector,
double *indexslow, double *indexfast, double *centerslow,
double *centerfast);
CBFLib documentation:
DESCRIPTION
cbf_get_beam_center sets *centerfast and *centerslow to the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector and *indexfast and
*indexslow to the corresponding indices. cbf_set_beam_center sets the
offsets in the axis category for the detector element axis with
precedence 1 to place the beam center at the position given in mm by
*centerfast and *centerslow as the displacements in mm along the
detector axes from pixel (0, 0) to the point at which the beam
intersects the detector at the indices given *indexfast and
*indexslow. cbf_set_reference_beam_center sets the displacments in
the array_structure_list_axis category to place the beam center at
the position given in mm by *centerfast and *centerslow as the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector at the indices given
by *indexfast and *indexslow. In order to achieve consistent results,
a reference detector should be used for detector to have all axes at
their reference settings.
Note that the precedence 1 axis is the fastest axis, so that
*centerfast and *indexfast are the fast axis components of the center
and *centerslow and *indexslow are the slow axis components of the
center.
The _fs calls give the displacments in a fast-to-slow order. The
calls with no suffix and the calls _sf calls give the displacements
in slow-to-fast order
Any of the destination pointers may be NULL for getting the beam
center. For setting the beam axis, either the indices of the center
must not be NULL.
The indices are non-negative for beam centers within the detector
surface, but the center for an axis with a negative increment will be
negative for a beam center within the detector surface.
For cbf_set_beam_center if the diffrn_data_frame category exists with
a row for the corresponding element id, the values will be set for
_diffrn_data_frame.center_fast and _diffrn_data_frame.center_slow in
millimetres and the value of _diffrn_data_frame.center_units will be
set to 'mm'.
For cbf_set_reference_beam_center if the diffrn_detector_element
category exists with a row for the corresponding element id, the
values will be set for _diffrn_detector_element.reference_center_fast
and _diffrn_detector_element.reference_center_slow in millimetres and
the value of _diffrn_detector_element.reference_units will be set to
'mm'.
ARGUMENTS
detector Detector handle. indexfast Pointer to the destination
fast index. indexslow Pointer to the destination slow index.
centerfast Pointer to the destination displacement along the fast
axis. centerslow Pointer to the destination displacement along the
slow axis.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")set_beam_center;
void set_beam_center(double *indexslow, double *indexfast,
double *centerslow,double *centerfast){
cbf_failnez(cbf_set_beam_center(self, indexslow, indexfast,
centerslow, centerfast));
}
%feature("autodoc", "
Returns : double area,double projected_area
*args : double indexfast,double indexslow
C prototype: int cbf_get_pixel_area_fs(cbf_detector detector,
double indexfast, double indexslow, double *area,
double *projected_area);
CBFLib documentation:
DESCRIPTION
cbf_get_pixel_area, cbf_get_pixel_area_fs and cbf_get_pixel_area_sf
set *area to the area of the pixel at (indexfast, indexslow) on the
detector surface and *projected_area to the apparent area of the
pixel as viewed from the sample position, with indexslow being the
slow axis and indexfast being the fast axis.
Either of the destination pointers may be NULL.
ARGUMENTS
detector Detector handle. indexfast Fast index.
indexslow Slow index. area Pointer to the
destination area in mm2. projected_area Pointer to the destination
apparent area in mm2.
RETURN VALUE
Returns an error code on failure or 0 for success.
----------------------------------------------------------------------
")get_pixel_area_fs;
%apply double *OUTPUT{double *area,double *projected_area};
void get_pixel_area_fs(double indexfast, double indexslow,
double *area,double *projected_area){
cbf_failnez(cbf_get_pixel_area_fs (self,
indexfast, indexslow, area,projected_area));
}
%feature("autodoc", "
Returns : double indexfast,double indexslow,double centerfast,double centerslow
*args :
C prototype: int cbf_get_beam_center_fs (cbf_detector detector,
double *indexfast, double *indexslow, double *centerfast,
double *centerslow);
CBFLib documentation:
DESCRIPTION
cbf_get_beam_center sets *centerfast and *centerslow to the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector and *indexfast and
*indexslow to the corresponding indices. cbf_set_beam_center sets the
offsets in the axis category for the detector element axis with
precedence 1 to place the beam center at the position given in mm by
*centerfast and *centerslow as the displacements in mm along the
detector axes from pixel (0, 0) to the point at which the beam
intersects the detector at the indices given *indexfast and
*indexslow. cbf_set_reference_beam_center sets the displacments in
the array_structure_list_axis category to place the beam center at
the position given in mm by *centerfast and *centerslow as the
displacements in mm along the detector axes from pixel (0, 0) to the
point at which the beam intersects the detector at the indices given
by *indexfast and *indexslow. In order to achieve consistent results,
a reference detector should be used for detector to have all axes at
their reference settings.
Note that the precedence 1 axis is the fastest axis, so that
*centerfast and *indexfast are the fast axis components of the center
and *centerslow and *indexslow are the slow axis components of the
center.
The _fs calls give the displacments in a fast-to-slow order. The
calls with no suffix and the calls _sf calls give the displacements
in slow-to-fast order
Any of the destination pointers may be NULL for getting the beam
center. For setting the beam axis, either the indices of the center
must not be NULL.
The indices are non-negative for beam centers within the detector
surface, but the center for an axis with a negative increment will be
negative for a beam center within the detector surface.
For cbf_set_beam_center if the diffrn_data_frame category exists with
a row for the corresponding element id, the values will be set for
_diffrn_data_frame.center_fast and _diffrn_data_frame.center_slow in
millimetres and the value of _diffrn_data_frame.center_units will be
set to 'mm'.
For cbf_set_reference_beam_center if the diffrn_detector_element
category exists with a row for the corresponding element id, the
values will be set for _diffrn_detector_element.reference_center_fast
and _diffrn_detector_element.reference_center_slow in millimetres and
the value of _diffrn_detector_element.reference_units will be set to
'mm'.
ARGUMENTS
detector Detector handle. indexfast Pointer to the destination