Debian Codegraph @

doc/cif_img_1.6.4_2Jul11.html

raw
1 <HTML>
2 <HEAD>
3 <TITLE>cif_img.dic v1.6.4</TITLE>
4 </HEAD>
5 <body bgcolor="#FAFAFF" text="#0808A0"
6 BACKGROUND="../html_graphics/cbflibbackground.jpg">
7 <font color="#0808A0">
8 <H1>
9 # <a href="http://www.iucr.org/iucr-top/welcome.html">
10 <img alt="[IUCr Home Page]" src="../html_graphics/iucrhome.jpg" ALIGN=MIDDLE></a>
11 <a href="http://www.iucr.org/iucr-top/cif/home.html">
12 <img alt="[CIF Home Page]" src="../html_graphics/cifhome.jpg" ALIGN=MIDDLE></a>
13 <a href="cbf_definition_rev.html"><IMG SRC="../html_graphics/CBFbutton.jpg"
14 ALT="[CBF/imgCIF]" ALIGN=MIDDLE></a>
15 <a href="CBFlib.html"><IMG SRC="../html_graphics/cbflibbutton.jpg"
16 ALT="[CBFlib]" ALIGN=MIDDLE></a> #
17 </H1>
18 <H1 ALIGN=CENTER>
19 # <IMG SRC="../html_graphics/CBFbig.jpg" ALIGN=MIDDLE ALT="imgCIF/CBF"> #
20 </H1>
21 <H1 ALIGN=CENTER># Extensions Dictionary #</H1>
22 </font><font color="#000000">
23
24 <PRE>
25 data_cif_img.dic
26
27 _datablock.id cif_img.dic
28 _datablock.description
29 ;
30 ##############################################################################
31 # #
32 # Image CIF Dictionary (imgCIF) #
33 # and Crystallographic Binary File Dictionary (CBF) #
34 # Extending the Macromolecular CIF Dictionary (mmCIF) #
35 # #
36 # Version 1.6.4 #
37 # of 2011-07-02 #
38 # ################################################################### #
39 # # *** WARNING *** THIS IS A DRAFT FOR DISCUSSSION *** WARNING *** # #
40 # # SUBJECT TO CHANGE WITHOUT NOTICE # #
41 # # SEND COMMENTS TO [email protected] CITING THE VERSION # #
42 # ################################################################### #
43 # This draft edited by H. J. Bernstein #
44 # #
45 # by Andrew P. Hammersley, Herbert J. Bernstein and John D. Westbrook #
46 # #
47 # This dictionary was adapted from format discussed at the imgCIF Workshop, #
48 # held at BNL Oct 1997 and the Crystallographic Binary File Format Draft #
49 # Proposal by Andrew Hammersley. The first DDL 2.1 Version was created by #
50 # John Westbrook. This version was drafted by Herbert J. Bernstein and #
51 # incorporates comments by I. David Brown, John Westbrook, Brian McMahon, #
52 # Bob Sweet, Paul Ellis, Harry Powell, Wilfred Li, Gotzon Madariaga, #
53 # Frances C. Bernstein, Chris Nielsen, Nicola Ashcroft and others. #
54 ##############################################################################
55
56 ##############################################################################
57 # CONTENTS
58 #
59 # <a href="#CATEGORY_GROUP_LIST">CATEGORY_GROUP_LIST</a>
60 # <a href="#SUB_CATEGORY">SUB_CATEGORY</a>
61 #
62 # category <a href="#ARRAY_DATA">ARRAY_DATA</a>
63 #
64 # <a href="#_array_data.array_id" >_array_data.array_id</a>
65 # <a href="#_array_data.binary_id" >_array_data.binary_id</a>
66 # <a href="#_array_data.data" >_array_data.data</a>
67 # <a href="#_array_data.header_contents" >_array_data.header_contents</a>
68 # <a href="#_array_data.header_convention" >_array_data.header_convention</a>
69 # <a href="#_array_data.variant" >_array_data.variant</a>
70 #
71 # category <a href="#ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a>
72 #
73 # <a href="#_array_element_size.array_id" >_array_element_size.array_id</a>
74 # <a href="#_array_element_size.index" >_array_element_size.index</a>
75 # <a href="#_array_element_size.size" >_array_element_size.size</a>
76 # <a href="#_array_element_size.variant" >_array_element_size.variant</a>
77 #
78 # category <a href="#ARRAY_INTENSITIES">ARRAY_INTENSITIES</a>
79 #
80 # <a href="#_array_intensities.array_id" >_array_intensities.array_id</a>
81 # <a href="#_array_intensities.binary_id" >_array_intensities.binary_id</a>
82 # <a href="#_array_intensities.gain" >_array_intensities.gain</a>
83 # <a href="#_array_intensities.gain_esd" >_array_intensities.gain_esd</a>
84 # <a href="#_array_intensities.linearity" >_array_intensities.linearity</a>
85 # <a href="#_array_intensities.offset" >_array_intensities.offset</a>
86 # <a href="#_array_intensities.scaling" >_array_intensities.scaling</a>
87 # <a href="#_array_intensities.overload" >_array_intensities.overload</a>
88 # <a href="#_array_intensities.undefined_value" >_array_intensities.undefined_value</a>
89 # <a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>
90 # <a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a>
91 # <a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>
92 # <a href="#_array_intensities.variant" >_array_intensities.variant</a>
93 #
94 # category <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a>
95 #
96 # <a href="#_array_structure.byte_order" >_array_structure.byte_order</a>
97 # <a href="#_array_structure.compression_type" >_array_structure.compression_type</a>
98 # <a href="#_array_structure.compression_type_flag" >_array_structure.compression_type_flag</a>
99 # <a href="#_array_structure.encoding_type" >_array_structure.encoding_type</a>
100 # <a href="#_array_structure.id" >_array_structure.id</a>
101 # <a href="#_array_structure.variant" >_array_structure.variant</a>
102 #
103 # category <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a>
104 #
105 # <a href="#_array_structure_list.axis_set_id" >_array_structure_list.axis_set_id</a>
106 # <a href="#_array_structure_list.array_id" >_array_structure_list.array_id</a>
107 # <a href="#_array_structure_list.dimension" >_array_structure_list.dimension</a>
108 # <a href="#_array_structure_list.direction" >_array_structure_list.direction</a>
109 # <a href="#_array_structure_list.index" >_array_structure_list.index</a>
110 # <a href="#_array_structure_list.precedence" >_array_structure_list.precedence</a>
111 # <a href="#_array_structure_list.variant" >_array_structure_list.variant</a>
112 #
113 # category <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a>
114 #
115 # <a href="#_array_structure_list_axis.axis_id" >_array_structure_list_axis.axis_id</a>
116 # <a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>
117 # <a href="#_array_structure_list_axis.angle" >_array_structure_list_axis.angle</a>
118 # <a href="#_array_structure_list_axis.angle_increment" >_array_structure_list_axis.angle_increment</a>
119 # <a href="#_array_structure_list_axis.displacement" >_array_structure_list_axis.displacement</a>
120 # <a href="#_array_structure_list_axis.fract_displacement" >_array_structure_list_axis.fract_displacement</a>
121 # <a href="#_array_structure_list_axis.displacement_increment" >_array_structure_list_axis.displacement_increment</a>
122 # <a href="#_array_structure_list_axis.fract_displacement_increment" >_array_structure_list_axis.fract_displacement_increment</a>
123 # <a href="#_array_structure_list_axis.angular_pitch" >_array_structure_list_axis.angular_pitch</a>
124 # <a href="#_array_structure_list_axis.radial_pitch" >_array_structure_list_axis.radial_pitch</a>
125 # <a href="#_array_structure_list_axis.reference_angle" >_array_structure_list_axis.reference_angle</a>
126 # <a href="#_array_structure_list_axis.reference_displacement" >_array_structure_list_axis.reference_displacement</a>
127 # <a href="#_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a>
128 #
129 # category <a href="#AXIS">AXIS</a>
130 #
131 # <a href="#_axis.depends_on" >_axis.depends_on</a>
132 # <a href="#_axis.equipment" >_axis.equipment</a>
133 # <a href="#_axis.id" >_axis.id</a></a>
134 # <a href="#_axis.offset[1]" >_axis.offset[1]</a>
135 # <a href="#_axis.offset[2]" >_axis.offset[2]</a>
136 # <a href="#_axis.offset[3]" >_axis.offset[3]</a>
137 # <a href="#_axis.type" >_axis.type</a>
138 # <a href="#_axis.system" >_axis.system</a>
139 # <a href="#_axis.vector[1]" >_axis.vector[1]</a>
140 # <a href="#_axis.vector[2]" >_axis.vector[2]</a>
141 # <a href="#_axis.vector[3]" >_axis.vector[3]</a>
142 # <a href="#_axis.variant" >_axis.variant</a>
143 #
144 # category <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a>
145 #
146 # <a href="#_diffrn_data_frame.array_id" >_diffrn_data_frame.array_id</a>
147 # <a href="#_diffrn_data_frame.binary_id" >_diffrn_data_frame.binary_id</a>
148 # <a href="#_diffrn_data_frame.center_fast" >_diffrn_data_frame.center_fast</a>
149 # <a href="#_diffrn_data_frame.center_slow" >_diffrn_data_frame.center_slow</a>
150 # <a href="#_diffrn_data_frame.center_units" >_diffrn_data_frame.center_units</a>
151 # <a href="#_diffrn_data_frame.detector_element_id" >_diffrn_data_frame.detector_element_id</a>
152 # <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>
153 # <a href="#_diffrn_data_frame.details">_diffrn_data_frame.details</a>
154 # <a href="#_diffrn_data_frame.variant">_diffrn_data_frame.variant</a>
155 #
156 # category <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a>
157 #
158 # <a href="#_diffrn_detector.details" >_diffrn_detector.details</a>
159 # <a href="#_diffrn_detector.detector" >_diffrn_detector.detector</a>
160 # <a href="#_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a>
161 # <a href="#_diffrn_detector.dtime" >_diffrn_detector.dtime</a>
162 # <a href="#_diffrn_detector.id" >_diffrn_detector.id</a>
163 # <a href="#_diffrn_detector.number_of_axes" >_diffrn_detector.number_of_axes</a>
164 # <a href="#_diffrn_detector.type" >_diffrn_detector.type</a>
165 # <a href="#_diffrn_detector.variant" >_diffrn_detector.variant</a>
166 #
167 # category <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a>
168 #
169 # <a href="#_diffrn_detector_axis.axis_id" >_diffrn_detector_axis.axis_id</a>
170 # <a href="#_diffrn_detector_axis.detector_id" >_diffrn_detector_axis.detector_id</a>
171 # <a href="#_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a>
172 #
173 # category <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a>
174 #
175 # <a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a>
176 # <a href="#_diffrn_detector_element.detector_id" >_diffrn_detector_element.detector_id</a>
177 # <a href="#_diffrn_detector_element.reference_center_fast" >_diffrn_detector_element.reference_center_fast</a>
178 # <a href="#_diffrn_detector_element.reference_center_slow" >_diffrn_detector_element.reference_center_slow</a>
179 # <a href="#_diffrn_detector_element.reference_center_units" >_diffrn_detector_element.reference_center_units</a>
180 # <a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>
181 #
182 # category <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a>
183 #
184 # <a href="#_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a>
185 # <a href="#_diffrn_measurement.details" >_diffrn_measurement.details</a>
186 # <a href="#_diffrn_measurement.device" >_diffrn_measurement.device</a>
187 # <a href="#_diffrn_measurement.device_details" >_diffrn_measurement.device_details</a>
188 # <a href="#_diffrn_measurement.device_type" >_diffrn_measurement.device_type</a>
189 # <a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a>
190 # <a href="#_diffrn_measurement.method" >_diffrn_measurement.method</a>
191 # <a href="#_diffrn_measurement.number_of_axes" >_diffrn_measurement.number_of_axes</a>
192 # <a href="#_diffrn_measurement.sample_detector_distance" >_diffrn_measurement.sample_detector_distance</a>
193 # <a href="#_diffrn_measurement.sample_detector_voffset" >_diffrn_measurement.sample_detector_voffset</a>
194 # <a href="#_diffrn_measurement.specimen_support" >_diffrn_measurement.specimen_support</a>
195 # <a href="#_diffrn_measurement.variant" >_diffrn_measurement.variant</a>
196 #
197 # category <a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a>
198 #
199 # <a href="#_diffrn_measurement_axis.id" >_diffrn_measurement_axis.axis_id</a>
200 # <a href="#_diffrn_measurement_axis.measurement_device" >_diffrn_measurement_axis.measurement_device</a>
201 # <a href="#_diffrn_measurement_axis.measurement_id" >_diffrn_measurement_axis.measurement_id</a>
202 # <a href="#_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a>
203 #
204 # category <a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a>
205 #
206 # <a href="#_diffrn_radiation.collimation">_diffrn_radiation.collimation</a>
207 # <a href="#_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a>
208 # <a href="#_diffrn_radiation.div_x_source" >_diffrn_radiation.div_x_source</a>
209 # <a href="#_diffrn_radiation.div_y_source" >_diffrn_radiation.div_y_source</a>
210 # <a href="#_diffrn_radiation.div_x_y_source" >_diffrn_radiation.div_x_y_source</a>
211 # <a href="#_diffrn_radiation.filter_edge">_diffrn_radiation.filter_edge</a>'
212 # <a href="#_diffrn_radiation.inhomogeneity">_diffrn_radiation.inhomogeneity</a>
213 # <a href="#_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a>
214 # <a href="#_diffrn_radiation.polarisn_norm">_diffrn_radiation.polarisn_norm</a>
215 # <a href="#_diffrn_radiation.polarisn_ratio">_diffrn_radiation.polarisn_ratio</a>
216 # <a href="#_diffrn_radiation.polarizn_source_norm" >_diffrn_radiation.polarizn_source_norm</a>
217 # <a href="#_diffrn_radiation.polarizn_source_ratio" >_diffrn_radiation.polarizn_source_ratio</a>
218 # <a href="#_diffrn_radiation.probe">_diffrn_radiation.probe</a>
219 # <a href="#_diffrn_radiation.type">_diffrn_radiation.type</a>
220 # <a href="#_diffrn_radiation.xray_symbol">_diffrn_radiation.xray_symbol</a>
221 # <a href="#_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a>
222 # <a href="#_diffrn_radiation.variant">_diffrn_radiation.variant</a>
223 #
224 # category <a href="#DIFFRN_REFLN">DIFFRN_REFLN</a>
225 #
226 # <a href="#_diffrn_refln.frame_id" >_diffrn_refln.frame_id</a>
227 # <a href="#_diffrn_refln.variant" >_diffrn_refln.variant</a>
228 #
229 # category <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a>
230 #
231 # <a href="#_diffrn_scan.id" >_diffrn_scan.id</a>
232 # <a href="#_diffrn_scan.date_end" >_diffrn_scan.date_end</a>
233 # <a href="#_diffrn_scan.date_start" >_diffrn_scan.date_start</a>
234 # <a href="#_diffrn_scan.integration_time" >_diffrn_scan.integration_time</a>
235 # <a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>
236 # <a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>
237 # <a href="#_diffrn_scan.frames" >_diffrn_scan.frames</a>
238 # <a href="#_diffrn_scan.time_period" >_diffrn_scan.time_period</a>
239 # <a href="#_diffrn_scan.time_rstrt_incr" >_diffrn_scan.time_rstrt_incr</a>
240 # <a href="#_diffrn_scan.variant" >_diffrn_scan.variant</a>
241 #
242 # category <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>
243 #
244 # <a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>
245 # <a href="#_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>
246 # <a href="#_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>
247 # <a href="#_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>
248 # <a href="#_diffrn_scan_axis.angle_rstrt_incr" >_diffrn_scan_axis.angle_rstrt_incr</a>
249 # <a href="#_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>
250 # <a href="#_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>
251 # <a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>
252 # <a href="#_diffrn_scan_axis.displacement_rstrt_incr" >_diffrn_scan_axis.displacement_rstrt_incr</a>
253 # <a href="#_diffrn_scan_axis.reference_angle" >_diffrn_scan_axis.reference_angle</a>
254 # <a href="#_diffrn_scan_axis.reference_displacement" >_diffrn_scan_axis.reference_displacement</a>
255 # <a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>
256 # <a href="#_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a>
257 #
258 # category <a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a>
259 #
260 # <a href="#_diffrn_scan_frame.date" >_diffrn_scan_frame.date</a>
261 # <a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>
262 # <a href="#_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a>
263 # <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
264 # <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
265 # <a href="#_diffrn_scan_frame.time_period" >_diffrn_scan_frame.time_period</a>
266 # <a href="#_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame.time_rstrt_incr</a>
267 # <a href="#_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a>
268 #
269 # category <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a>
270 #
271 # <a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>
272 # <a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>
273 # <a href="#_diffrn_scan_frame_axis.angle_increment" >_diffrn_scan_frame_axis.angle_increment</a>
274 # <a href="#_diffrn_scan_frame_axis.angle_rstrt_incr" >_diffrn_scan_frame_axis.angle_rstrt_incr</a>
275 # <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
276 # <a href="#_diffrn_scan_frame_axis.displacement_increment" >_diffrn_scan_frame_axis.displacement_increment</a>
277 # <a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr" >_diffrn_scan_frame_axis.displacement_rstrt_incr</a>
278 # <a href="#_diffrn_scan_frame_axis.reference_angle" >_diffrn_scan_frame_axis.reference_angle</a>
279 # <a href="#_diffrn_scan_frame_axis.reference_displacement" >_diffrn_scan_frame_axis.reference_displacement</a>
280 # <a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>
281 # <a href="#_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a>
282 #
283 # category <a href="#DIFFRN_SCAN_FRAME_MONITOR">DIFFRN_SCAN_FRAME_MONITOR</a>
284 #
285 # <a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>
286 # <a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>
287 # <a href="#_diffrn_scan_frame_monitor.scan_id" >_diffrn_scan_frame_monitor.scan_id</a>
288 # <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_data_frame_monitor.frame_id</a>
289 # <a href="#_diffrn_scan_frame_monitor.integration_time" >_diffrn_data_frame_monitor.integration_time</a>
290 # <a href="#_diffrn_scan_frame_monitor.monitor_value" >_diffrn_data_frame_monitor.monitor_value</a>
291 # <a href="#_diffrn_scan_frame.variant" >_diffrn_data_frame_monitor.variant</a>
292 #
293 # category <a href="#MAP">MAP</a>
294 #
295 # <a href="#_map.details" >_map.details</a>
296 # <a href="#_map.diffrn_id" >_map.diffrn_id</a>
297 # <a href="#_map.entry_id" >_map.entry_id</a>
298 # <a name="#_map.id" >_map.id</a>
299 # <a name="#_map.variant" >_map.variant</a>
300 #
301 # category <a href="#MAP_SEGMENT">MAP_SEGMENT</a>
302 #
303 # <a href="#_map_segment.array_id" >_map_segment.array_id</a>
304 # <a href="#_map_segment.binary_id" >_map_segment.binary_id</a>
305 # <a href="#_map_segment.mask_array_id" >_map_segment.mask_array_id</a>
306 # <a href="#_map_segment.mask_binary_id" >_map_segment.mask_binary_id</a>
307 # <a href="#_map_segment.id" >_map_segment.id</a>
308 # <a href="#_map_segment.map_id" >_map_segment.map_id</a>
309 # <a href="#_map_segment.details" >_map_segment.details</a>
310 # <a href="#_map_segment.variant" >_map_segment.variant</a>
311 #
312 # category <a href="#VARIANT">VARIANT</a>
313 #
314 # <a href="#_variant.details" >_variant.details</a>
315 # <a href="#_variant.role" >_variant.role</a>
316 # <a href="#_variant.timestamp" >_variant.timestamp</a>
317 # <a href="#_variant.variant" >_variant.variant</a>
318 # <a href="#_variant.variant_of" >_variant.variant_of</a>
319 #
320 # ***DEPRECATED*** data items
321 #
322 # <a href="#_diffrn_detector_axis.id" >_diffrn_detector_axis.id</a>
323 # <a href="#_diffrn_detector_element.center[1]" >_diffrn_detector_element.center[1]</a>
324 # <a href="#_diffrn_detector_element.center[2]" >_diffrn_detector_element.center[2]</a>
325 # <a href="#_diffrn_measurement_axis.id" >_diffrn_measurement_axis.id</a>
326 #
327 # ***DEPRECATED*** category <a href="#DIFFRN_FRAME_DATA">DIFFRN_FRAME_DATA</a>
328 #
329 # <a href="#_diffrn_frame_data.array_id" >_diffrn_frame_data.array_id</a>
330 # <a href="#_diffrn_frame_data.binary_id" >_diffrn_frame_data.binary_id</a>
331 # <a href="#_diffrn_frame_data.detector_element_id" >_diffrn_frame_data.detector_element_id</a>
332 # <a href="#_diffrn_frame_data.id" >_diffrn_frame_data.id</a>
333 # <a href="#_diffrn_frame_data.details">_diffrn_frame_data.details</a>
334 #
335 #
336 # <a href="#ITEM_TYPE_LIST">ITEM_TYPE_LIST</a>
337 # <a href="#ITEM_UNITS_LIST">ITEM_UNITS_LIST</a>
338 # <a href="#DICTIONARY_HISTORY">DICTIONARY_HISTORY</a>
339 #
340 ##############################################################################
341
342 <font size="-1" color="black">
343 <table border=2>
344 <tr>
345 <td valign="top" rowspan=2>ARRAY_DATA_GROUP</td>
346 <td>Categories that describe array data.</td>
347 </tr>
348 <tr>
349 <td>
350 <table border=2>
351 <tr>
352 <td valign="top"><a href="#ARRAY_DATA">ARRAY_DATA</a></td>
353 <td>Data items in the <a href="#ARRAY_DATA">ARRAY_DATA</a> category are the containers for
354 the array data items described in the category <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a>.
355 <p>
356 It is recognized that the data in this category needs to be used in
357 two distinct ways. During a data collection the lack of ancillary
358 data and timing constraints in processing data may dictate the
359 need to make a 'miniCBF' nothing more than an essential minimum
360 of information to record the results of the data collection. In that
361 case it is proper to use the <a href="#ARRAY_DATA">ARRAY_DATA</a> category as a
362 container for just a single image and a compacted, beam-line
363 dependent list of data collection parameter values. In such
364 a case, only the tags '<a href="#_array_data.header_convention">_array_data.header_convention</a>',
365 '<a href="#_array_data.header_contents">_array_data.header_contents</a>' and '<a href="#_array_data.data">_array_data.data</a>' need be
366 populated.
367 <p>
368 For full processing and archiving, most of the tags in this
369 dictionary will need to be populated.
370 </td>
371 </tr>
372 <tr>
373 <td valign="top"><a href="#ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a></td>
374 <td>
375 Data items in the <a href="#ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a> category record the physical
376 size of array elements along each array dimension.
377 </td>
378 </tr>
379 <tr>
380 <td valign="top"><a href="#ARRAY_INTENSITIES">ARRAY_INTENSITIES</a></td>
381 <td>Data items in the <a href="#ARRAY_INTENSITIES">ARRAY_INTENSITIES</a> category record the
382 information required to recover the intensity data from
383 the set of data values stored in the <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
384 <p>
385 The detector may have a complex relationship
386 between the raw intensity values and the number of
387 incident photons. In most cases, the number stored
388 in the final array will have a simple linear relationship
389 to the actual number of incident photons, given by
390 <a href="#_array_intensities.gain">_array_intensities.gain</a>. If raw, uncorrected values
391 are presented (e.g. for calibration experiments), the
392 value of <a href="#_array_intensities.linearity">_array_intensities.linearity</a> will be 'raw'
393 and <a href="#_array_intensities.gain">_array_intensities.gain</a> will not be used.
394 </td>
395 </tr>
396
397 <tr>
398 <td valign="top"><a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a></td>
399 <td>
400 Data items in the <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category record the organization and
401 encoding of array data that may be stored in the <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
402 </td>
403 </tr>
404 <tr>
405 <td colspan=2>
406 <table border=2>
407 <tr>
408 <td rowspan=2 bgcolor=cyan>&nbsp;</td>
409 <td valign="top"><a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a></td>
410 <td>
411 Data items in the <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> category record the size
412 and organization of each array dimension.
413 <p>
414 The relationship to physical axes may be given.
415 </td>
416 </tr>
417 <tr>
418 <td colspan=2>
419 <table border=2>
420 <tr>
421 <td rowspan=1 bgcolor=cyan>&nbsp;</td>
422 <td valign="top"><a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a></td>
423 <td>
424 Data items in the <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a> category describe
425 the physical settings of sets of axes for the centres of pixels that
426 correspond to data points described in the
427 <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> category.
428 <p>
429 In the simplest cases, the physical increments of a single axis correspond
430 to the increments of a single array index. More complex organizations,
431 e.g. spiral scans, may require coupled motions along multiple axes.
432 <p>
433 Note that a spiral scan uses two coupled axes: one for the angular
434 direction and one for the radial direction. This differs from a
435 cylindrical scan for which the two axes are not coupled into one
436 set.
437 </td>
438 </tr>
439 </table>
440 <tr>
441 </tr>
442 </table>
443 </td>
444 </tr>
445 </table>
446 <tr>
447 <td valign="top" rowspan=2>AXIS_GROUP</td>
448 <td>Categories that describe axes.</td>
449 </tr>
450 <tr>
451 <td>
452 <table border=2>
453 <tr>
454 <td valign="top"><a href="#AXIS">AXIS</a></td>
455 <td>
456 Data items in the <a href="#AXIS">AXIS</a> category record the information required
457 to describe the various goniometer, detector, source and other
458 axes needed to specify a data collection or the axes defining the
459 coordinate system of an image.
460 <p>
461 The location of each axis is specified by two vectors: the axis
462 itself, given by a unit vector in the direction of the axis, and
463 an offset to the base of the unit vector.
464 <p>
465 The vectors defining an axis are referenced to an appropriate
466 coordinate system. The axis vector, itself, is a dimensionless
467 unit vector. Where meaningful, the offset vector is given in
468 millimetres. In coordinate systems not measured in metres,
469 the offset is not specified and is taken as zero.
470 <p>
471 The available coordinate systems are:
472 <p>
473 The imgCIF standard laboratory coordinate system<br />
474 The direct lattice (fractional atomic coordinates)<br />
475 The orthogonal Cartesian coordinate system (real space)<br />
476 The reciprocal lattice<br />
477 An abstract orthogonal Cartesian coordinate frame</br >
478
479 <p>
480 </td>
481 </tr>
482 </table>
483 <tr>
484 <td valign="top" rowspan=2>DIFFRN_GROUP</td>
485 <td>Categories that describe details of the diffraction experiment.</td>
486 </tr>
487 <tr>
488 <td>
489 <table border=2>
490 <tr>
491 <td valign="top"><a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME<a/></td>
492 <td>Data items in the <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category record
493 the details about each frame of data.
494 <p>
495 The items in this category were previously in a
496 DIFFRN_FRAME_DATA category, which is now deprecated.
497 The items from the old category are provided
498 as aliases but should not be used for new work.
499 </td>
500 </tr>
501 <tr>
502 <td valign="top"><a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a></td>
503 <td>Data items in the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category describe the
504 detector used to measure the scattered radiation, including
505 any analyser and post-sample collimation.
506 </td>
507 </tr>
508 <tr>
509 <td colspan=2>
510 <table border=2>
511 <tr>
512 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
513 <td valign="top"><a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a></td>
514 <td>Data items in the <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a> category associate
515 axes with detectors.
516 </td>
517 </tr>
518 </table>
519 </td>
520 </tr>
521 <tr>
522 <td colspan=2>
523 <table border=2>
524 <tr>
525 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
526 <td valign="top"><a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a></td>
527 <td>
528 Data items in the <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a> category record
529 the details about spatial layout and other characteristics
530 of each element of a detector which may have multiple elements.
531 <p>
532 In most cases, giving more detailed information
533 in <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> and <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a>
534 is preferable to simply providing the centre of the
535 detector element.
536 </td>
537 </tr>
538 </table>
539 </td>
540 </tr>
541 <tr>
542 <td valign="top"><a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a></td>
543 <td> Data items in the <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> category record details
544 about the device used to orient and/or position the crystal
545 during data measurement and the manner in which the
546 diffraction data were measured.
547 </td>
548 </tr>
549 <tr>
550 <td colspan=2>
551 <table border=2>
552 <tr>
553 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
554 <td valign="top"><a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a></td>
555 <td>
556 Data items in the <a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a> category associate
557 axes with goniometers.
558 </td>
559 </tr>
560 </table>
561 </td>
562 </tr>
563 <tr>
564 <td valign="top"><a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a></td>
565 <td> Data items in the <a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a> category describe
566 the radiation used for measuring diffraction intensities,
567 its collimation and monochromatization before the sample.
568 <p>
569 Post-sample treatment of the beam is described by data
570 items in the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category.
571 </td>
572 </tr>
573
574 <tr>
575 <td valign="top"><a href="#DIFFRN_REFLN">DIFFRN_REFLN</a></td>
576 <td> This category redefinition has been added to extend the key of
577 the standard <a href="#DIFFRN_REFLN">DIFFRN_REFLN</a> category.
578 <p>
579 Data items in the DIFFRN_REFLN category record details about
580 the intensities in the diffraction data set
581 identified by _diffrn_refln.diffrn_id.
582 <p>
583 The DIFFRN_REFLN data items refer to individual intensity
584 measurements and must be included in looped lists.
585 <p>
586 The DIFFRN_REFLNS data items specify the parameters that apply
587 to all intensity measurements in the particular diffraction
588 data set identified by _diffrn_reflns.diffrn_id and
589 _diffrn_refln.frame_id
590 </td>
591 </tr>
592
593 <tr>
594 <td valign="top"><a href="#DIFFRN_SCAN">DIFFRN_SCAN</a></td>
595 <td> Data items in the <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a> category describe the parameters of one
596 or more scans, relating axis positions to frames.
597 </td>
598 </tr>
599
600 <tr>
601 <td colspan=2>
602 <table border=2>
603 <tr>
604 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
605 <td valign="top"><a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a></td>
606 <td>
607 Data items in the <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a> category describe the settings of
608 axes for particular scans. Unspecified axes are assumed to be at
609 their zero points.
610 </td>
611 </tr>
612 </table>
613 </td>
614 </tr>
615
616 <tr>
617 <td colspan=2>
618 <table border=2>
619 <tr>
620 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
621 <td valign="top"><a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a></td>
622 <td>
623 Data items in the <a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a> category describe
624 the relationships of particular frames to scans.
625 </td>
626 </tr>
627 </table>
628 </td>
629 </tr>
630 <tr>
631 <td colspan=2>
632 <table border=2>
633 <tr>
634 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
635 <td colspan=2>
636 <table border=2>
637 <tr>
638 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
639 <td valign="top"><a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a></td>
640 <td>
641 Data items in the <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a> category describe the
642 settings of axes for particular frames. Unspecified axes are
643 assumed to be at their zero points. If, for any given frame,
644 nonzero values apply for any of the data items in this category,
645 those values should be given explicitly in this category and not
646 simply inferred from values in <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>.
647 </td>
648 </tr>
649 </table>
650 </td>
651 </tr>
652
653 <tr>
654 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
655 <td colspan=2>
656 <table border=2>
657 <tr>
658 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
659 <td valign="top"><a href="#DIFFRN_SCAN_FRAME_MONITOR">DIFFRN_SCAN_FRAME_MONITOR</a></td>
660 <td>
661 Data items in the <a href="#DIFFRN_SCAN_FRAME_MONITOR">DIFFRN_SCAN_FRAME_MONITOR</a> category record
662 the values and details about each monitor for each frame of data
663 during a scan.
664 <p>
665 Each monitor value is uniquely identified by the combination of
666 the scan_id given by <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
667 the frame_id given by <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a>,
668 the monitor's detector_id given by
669 <a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.monitor_id</a>,
670 and a 1-based ordinal given by <a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>.
671 <p>
672 If there is only one frame for the scan, the value of
673 <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a> may be
674 omitted.
675 <p>
676 A single frame may have more than one monitor value, and each
677 monitor value may be the result of integration over the entire
678 frame integration time given by the value of
679 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
680 or many monitor values may be reported over shorter times given
681 by the value of _diffrn_scan_frame_monitor.integration_time. If
682 only one monitor value for a given monitor is collected during
683 the integration time of the frame, the value of
684 <a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a> may be
685 omitted.
686 </td>
687 </tr>
688 </table>
689 </td>
690 </tr>
691
692 </table>
693 </td>
694 </tr>
695
696
697
698
699
700 </table>
701 <tr>
702 <td valign="top" rowspan=2>MAP_GROUP</td>
703 <td>Categories that describe maps.</td>
704 </tr>
705 <tr>
706 <td>
707 <table border=2>
708 <tr>
709 <td valign="top"><a href="#MAP">MAP</a></td>
710 <td>
711 Data items in the <a href="#MAP">MAP</a> category record
712 the details of a maps. Maps record values of parameters,
713 such as density, that are functions of position within
714 a cell or are functions of orthogonal coordinates in
715 three space.
716 <p>
717 A map may is composed of one or more map segments
718 specified in the MAP_SEGMENT category.
719 <p>
720 Examples are given in the MAP_SEGMENT category.
721 </td>
722 </tr>
723 <tr>
724 <td colspan=2>
725 <table border=2>
726 <td rowspan=1 bgcolor="cyan">&nbsp;</td>
727 <td valign="top"><a href="#MAP_SEGMENT">MAP_SEGMENT</a></td>
728 <td>Data items in the <a href="#MAP_SEGMENT">MAP_SEGMENT</a> category record
729 the details about each segment (section or brick) of a map.
730 </td>
731 </table>
732 </td>
733 </tr>
734 </table>
735 <tr>
736 <td valign="top" rowspan=2>VARIANT_GROUP</td>
737 <td>Categories that describe variants</td>
738 </tr>
739 <tr>
740 <td>
741 <table border=2>
742 <tr>
743 <td valign="top"><a href="#VARIANT">VARIANT</a></td>
744 <td>
745 Data items in the <a href="#VARIANT">VARIANT</a> category record
746 the details about sets of variants of data items.
747 <p>
748 There is sometimes a need to allow for multiple versions of the
749 same data items in order to allow for refinements and corrections
750 to earlier assumptions, observations and calculations. In order
751 to allow data sets to contain more than one variant of the same
752 information, an optional ...variant data item as a pointer to
753 _variant.variant has been added to the key of every category,
754 as an implicit data item with a null (empty) default value.
755 <p>
756 All rows in a category with the same variant value are considered
757 to be related to one another and to all rows in other categories
758 with the same variant value. For a given variant, all such rows
759 are also considered to be related to all rows with a null variant
760 value, except that a row with a null variant value is for which
761 all other components of its key are identical to those entries
762 in another row with a non-null variant value is not related the
763 the rows with that non-null variant value. This behavior is
764 similar to the convention for identifying alternate conformers
765 in an atom list.
766 <p>
767 An optional role may be specified for a variant as the value of
768 _variant.role. Possible roles are null, "preferred",
769 "raw data", "unsuccessful trial".
770 <p>
771 Variants may carry an optional timestamp as the value of
772 _variant.timestamp.
773 <p>
774 Variants may be related to other variants from which they were
775 derived by the value of _variant.variant_of
776 <p>
777 Further details about the variant may be specified as the value
778 of _variant.details.
779 <p>
780 In order to allow variant information from multiple datasets to
781 be combined, _variant.diffrn_id and/or _variant.entry_id may
782 be used.
783 </td>
784 </tr>
785
786 </table>
787
788 </td>
789 </tr>
790 </table>
791 </font>
792
793 ;
794
795
796 _dictionary.title cif_img.dic
797 _dictionary.version 1.6.4
798 _dictionary.datablock_id cif_img.dic
799
800
801
802 #########################
803 ## <a name="CATEGORY_GROUP_LIST">CATEGORY_GROUP_LIST</a> ##
804 #########################
805
806 loop_
807 _category_group_list.id
808 _category_group_list.parent_id
809 _category_group_list.description
810 'inclusive_group' .
811 ; Categories that belong to the dictionary extension.
812 ;
813 'array_data_group'
814 'inclusive_group'
815 ; Categories that describe array data.
816 ;
817 'axis_group'
818 'inclusive_group'
819 ; Categories that describe axes.
820 ;
821 'diffrn_group'
822 'inclusive_group'
823 ; Categories that describe details of the diffraction experiment.
824 ;
825 'map_group'
826 'inclusive_group'
827 ; Categories that describe details of map data.
828 ;
829 'variant_group'
830 'inclusive_group'
831 ; Categories that describe details of map data.
832 ;
833
834
835 ##################
836 ## <a name="SUB_CATEGORY">SUB_CATEGORY</a> ##
837 ##################
838
839 loop_
840 _sub_category.id
841 _sub_category.description
842 'matrix'
843 ; The collection of elements of a matrix.
844 ;
845 'vector'
846 ; The collection of elements of a vector.
847 ;
848
849
850
851
852 ##############
853 # <a name="ARRAY_DATA">ARRAY_DATA</a> #
854 ##############
855
856
857 save_ARRAY_DATA
858 _category.description
859 ; Data items in the <a href="#ARRAY_DATA">ARRAY_DATA</a> category are the containers for
860 the array data items described in the category <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a>.
861
862 It is recognized that the data in this category needs to be used in
863 two distinct ways. During a data collection the lack of ancillary
864 data and timing constraints in processing data may dictate the
865 need to make a 'miniCBF' nothing more than an essential minimum
866 of information to record the results of the data collection. In that
867 case it is proper to use the <a href="#ARRAY_DATA">ARRAY_DATA</a> category as a
868 container for just a single image and a compacted, beam-line
869 dependent list of data collection parameter values. In such
870 a case, only the tags '<a href="#_array_data.header_convention">_array_data.header_convention</a>',
871 '<a href="#_array_data.header_contents">_array_data.header_contents</a>' and '<a href="#_array_data.data">_array_data.data</a>' need be
872 populated.
873
874 For full processing and archiving, most of the tags in this
875 dictionary will need to be populated.
876
877 ;
878 _category.id array_data
879 _category.mandatory_code no
880 loop_
881 _category_key.name '<a href="#_array_data.array_id" >_array_data.array_id</a>'
882 '<a href="#_array_data.binary_id" >_array_data.binary_id</a>'
883 '<a href="#_array_data.variant" >_array_data.variant</a>'
884 loop_
885 _category_group.id 'inclusive_group'
886 'array_data_group'
887 loop_
888 _category_examples.detail
889 _category_examples.case
890 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
891 ;
892 Example 1 -
893
894 This example shows two binary data blocks. The first one
895 was compressed by the CBF_CANONICAL compression algorithm and is
896 presented as hexadecimal data. The first character 'H' on the
897 data lines means hexadecimal. It could have been 'O' for octal
898 or 'D' for decimal. The second character on the line shows
899 the number of bytes in each word (in this case '4'), which then
900 requires eight hexadecimal digits per word. The third character
901 gives the order of octets within a word, in this case '&lt;'
902 for the ordering 4321 (i.e. 'big-endian'). Alternatively, the
903 character '&gt;' could have been used for the ordering 1234
904 (i.e. 'little-endian'). The block has a 'message digest'
905 to check the integrity of the data.
906
907 The second block is similar, but uses CBF_PACKED compression
908 and BASE64 encoding. Note that the size and the digest are
909 different.
910 ;
911 ;
912
913 loop_
914 <a href="#_array_data.array_id" >_array_data.array_id</a>
915 <a href="#_array_data.binary_id" >_array_data.binary_id</a>
916 <a href="#_array_data.data" >_array_data.data</a>
917 image_1 1
918 ;
919 --CIF-BINARY-FORMAT-SECTION--
920 Content-Type: application/octet-stream;
921 conversions=&quot;<b>X</b>-CBF_CANONICAL&quot;
922 Content-Transfer-Encoding: <b>X</b>-BASE16
923 X-Binary-Size: 3927126
924 X-Binary-ID: 1
925 Content-MD5: u2sTJEovAHkmkDjPi+gWsg==
926
927 # Hexadecimal encoding, byte 0, byte order ...21
928 #
929 H4&lt; 0050B810 00000000 00000000 00000000 000F423F 00000000 00000000 ...
930 ....
931 --CIF-BINARY-FORMAT-SECTION----
932 ;
933 image_2 2
934 ;
935 --CIF-BINARY-FORMAT-SECTION--
936 Content-Type: application/octet-stream;
937 conversions=&quot;X-CBF-PACKED&quot;
938 Content-Transfer-Encoding: BASE64
939 X-Binary-Size: 3745758
940 X-Binary-ID: 2
941 Content-MD5: 1zsJjWPfol2GYl2V+QSXrw==
942
943 ELhQAAAAAAAA...
944 ...
945 --CIF-BINARY-FORMAT-SECTION----
946 ;
947 ;
948 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
949 ;
950 Example 2 -
951
952 This example shows a single image in a miniCBF, provided by
953 E. Eikenberry. The entire CBF consists of one data block
954 containing one category and three tags. The CBFlib
955 program convert_miniCBF and a suitable template file
956 can be used to convert this miniCBF to a full imgCIF
957 file.
958 ;
959 ;
960 ###CBF: VERSION 1.5
961 # CBF file written by CBFlib v0.7.8
962
963 data_insulin_pilatus6m
964
965 <a href="#_array_data.header_convention">_array_data.header_convention</a> SLS_1.0
966 <a href="#_array_data.header_contents">_array_data.header_contents</a>
967 ;
968 # Detector: PILATUS 6M SN: 60-0001
969 # 2007/Jun/17 15:12:36.928
970 # Pixel_size 172e-6 m x 172e-6 m
971 # Silicon sensor, thickness 0.000320 m
972 # Exposure_time 0.995000 s
973 # Exposure_period 1.000000 s
974 # Tau = 194.0e-09 s
975 # Count_cutoff 1048575 counts
976 # Threshold_setting 5000 eV
977 # Wavelength 1.2398 A
978 # Energy_range (0, 0) eV
979 # Detector_distance 0.15500 m
980 # Detector_Voffset -0.01003 m
981 # Beam_xy (1231.00, 1277.00) pixels
982 # Flux 22487563295 ph/s
983 # Filter_transmission 0.0008
984 # Start_angle 13.0000 deg.
985 # Angle_increment 1.0000 deg.
986 # Detector_2theta 0.0000 deg.
987 # Polarization 0.990
988 # Alpha 0.0000 deg.
989 # Kappa 0.0000 deg.
990 # Phi 0.0000 deg.
991 # Chi 0.0000 deg.
992 # Oscillation_axis X, CW
993 # N_oscillations 1
994 ;
995
996 <a href="#_array_data.data">_array_data.data</a>
997 ;
998 --CIF-BINARY-FORMAT-SECTION--
999 Content-Type: application/octet-stream;
1000 conversions="x-CBF_BYTE_OFFSET"
1001 Content-Transfer-Encoding: BINARY
1002 X-Binary-Size: 6247567
1003 X-Binary-ID: 1
1004 X-Binary-Element-Type: "signed 32-bit integer"
1005 X-Binary-Element-Byte-Order: LITTLE_ENDIAN
1006 Content-MD5: 8wO6i2+899lf5iO8QPdgrw==
1007 X-Binary-Number-of-Elements: 6224001
1008 X-Binary-Size-Fastest-Dimension: 2463
1009 X-Binary-Size-Second-Dimension: 2527
1010 X-Binary-Size-Padding: 4095
1011
1012 ...
1013
1014 --CIF-BINARY-FORMAT-SECTION----
1015 ;
1016 ;
1017 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1018
1019 save_
1020
1021
1022 save_<a name="_array_data.array_id" >_array_data.array_id</a>
1023 _item_description.description
1024 ; This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
1025 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
1026
1027 If not given, it defaults to 1.
1028
1029 ;
1030 _item.name '<a href="#_array_data.array_id" >_array_data.array_id</a>'
1031 _item.category_id array_data
1032 _item.mandatory_code implicit
1033 _item_default.value 1
1034 _item_type.code code
1035 save_
1036
1037
1038 save_<a name="_array_data.binary_id" >_array_data.binary_id</a>
1039 _item_description.description
1040 ; This item is an integer identifier which, along with
1041 <a href="#_array_data.array_id" >_array_data.array_id</a>, should uniquely identify the
1042 particular block of array data.
1043
1044 If <a href="#_array_data.binary_id" >_array_data.binary_id</a> is not explicitly given,
1045 it defaults to 1.
1046
1047 The value of <a href="#_array_data.binary_id" >_array_data.binary_id</a> distinguishes
1048 among multiple sets of data with the same array
1049 structure.
1050
1051 If the MIME header of the data array specifies a
1052 value for X-Binary-ID, the value of <a href="#_array_data.binary_id" >_array_data.binary_id</a>
1053 should be equal to the value given for X-Binary-ID.
1054 ;
1055 loop_
1056 _item.name
1057 _item.category_id
1058 _item.mandatory_code
1059 '<a href="#_array_data.binary_id" >_array_data.binary_id</a>' array_data
1060 implicit
1061 '<a href="#_diffrn_data_frame.binary_id" >_diffrn_data_frame.binary_id</a>' diffrn_data_frame
1062 implicit
1063 '<a href="#_array_intensities.binary_id" >_array_intensities.binary_id</a>' array_intensities
1064 implicit
1065 loop_
1066 _item_linked.child_name
1067 _item_linked.parent_name
1068 '<a href="#_diffrn_data_frame.binary_id" >_diffrn_data_frame.binary_id</a>' '<a href="#_array_data.binary_id" >_array_data.binary_id</a>'
1069 '<a href="#_array_intensities.binary_id" >_array_intensities.binary_id</a>' '<a href="#_array_data.binary_id" >_array_data.binary_id</a>'
1070
1071 _item_default.value 1
1072 _item_type.code int
1073 loop_
1074 _item_range.maximum
1075 _item_range.minimum
1076 1 1
1077 . 1
1078 save_
1079
1080
1081 save_<a name="_array_data.data" >_array_data.data</a>
1082 _item_description.description
1083 ; The value of <a href="#_array_data.data" >_array_data.data</a> contains the array data
1084 encapsulated in a STAR string.
1085
1086 The representation used is a variant on the
1087 Multipurpose Internet Mail Extensions (MIME) specified
1088 in RFC 2045-2049 by N. Freed et al. The boundary
1089 delimiter used in writing an imgCIF or CBF is
1090 '\n--CIF-BINARY-FORMAT-SECTION--' (including the
1091 required initial '\n--').
1092
1093 The Content-Type may be any of the discrete types permitted
1094 in RFC 2045; 'application/octet-stream' is recommended
1095 for diffraction images in the ARRAY_DATA category.
1096 Note: When appropriate in other categories, e.g. for
1097 photographs of crystals, more precise types, such as
1098 'image/jpeg', 'image/tiff', 'image/png', etc. should be used.
1099
1100 If an octet stream was compressed, the compression should
1101 be specified by the parameter
1102 'conversions=&quot;X-CBF_PACKED&quot;'
1103 or the parameter
1104 'conversions=&quot;X-CBF_CANONICAL&quot;'
1105 or the parameter
1106 'conversions=&quot;X-CBF_BYTE_OFFSET&quot;'
1107 or the parameter
1108 'conversions=&quot;X-CBF_BACKGROUND_OFFSET_DELTA&quot;'
1109
1110 If the parameter
1111 'conversions=&quot;X-CBF_PACKED&quot;'
1112 is given it may be further modified with the parameters
1113 '&quot;uncorrelated_sections&quot;'
1114 or
1115 '&quot;flat&quot;'
1116
1117 If the '&quot;uncorrelated_sections&quot;' parameter is
1118 given, each section will be compressed without using
1119 the prior section for averaging.
1120
1121 If the '&quot;flat&quot;' parameter is given, each the
1122 image will be treated as one long row.
1123
1124 Note that the X-CBF_CANONICAL and X-CBF_PACKED are
1125 slower but more efficient compressions that the others.
1126 The X-CBF_BYTE_OFFSET compression is a good compromise
1127 between speed and efficiency for ordinary diffraction
1128 images. The X-CBF_BACKGROUND_OFFSET_DELTA compression
1129 is oriented towards sparse data, such as masks and
1130 tables of replacement pixel values for images with
1131 overloaded spots.
1132
1133 The Content-Transfer-Encoding may be 'BASE64',
1134 'Quoted-Printable', 'X-BASE8', 'X-BASE10',
1135 'X-BASE16' or 'X-BASE32K', for an imgCIF or 'BINARY'
1136 for a CBF. The octal, decimal and hexadecimal transfer
1137 encodings are provided for convenience in debugging and
1138 are not recommended for archiving and data interchange.
1139
1140 In a CIF, one of the parameters 'charset=us-ascii',
1141 'charset=utf-8' or 'charset=utf-16' may be used on the
1142 Content-Transfer-Encoding to specify the character set
1143 used for the external presentation of the encoded data.
1144 If no charset parameter is given, the character set of
1145 the enclosing CIF is assumed. In any case, if a BOM
1146 flag is detected (FE FF for big-endian UTF-16, FF FE for
1147 little-endian UTF-16 or EF BB BF for UTF-8) is detected,
1148 the indicated charset will be assumed until the end of the
1149 encoded data or the detection of a different BOM. The
1150 charset of the Content-Transfer-Encoding is not the character
1151 set of the encoded data, only the character set of the
1152 presentation of the encoded data and should be respecified
1153 for each distinct STAR string.
1154
1155 In an imgCIF file, the encoded binary data begins after
1156 the empty line terminating the header. In an imgCIF file,
1157 the encoded binary data ends with the terminating boundary
1158 delimiter '\n--CIF-BINARY-FORMAT-SECTION----'
1159 in the currently effective charset or with the '\n; '
1160 that terminates the STAR string.
1161
1162 In a CBF, the raw binary data begins after an empty line
1163 terminating the header and after the sequence:
1164
1165 Octet Hex Decimal Purpose
1166 0 0C 12 (ctrl-L) Page break
1167 1 1A 26 (ctrl-Z) Stop listings in MS-DOS
1168 2 04 04 (Ctrl-D) Stop listings in UNIX
1169 3 D5 213 Binary section begins
1170
1171 None of these octets are included in the calculation of
1172 the message size or in the calculation of the
1173 message digest.
1174
1175 The X-Binary-Size header specifies the size of the
1176 equivalent binary data in octets. If compression was
1177 used, this size is the size after compression, including
1178 any book-keeping fields. An adjustment is made for
1179 the deprecated binary formats in which eight bytes of binary
1180 header are used for the compression type. In this case,
1181 the eight bytes used for the compression type are subtracted
1182 from the size, so that the same size will be reported
1183 if the compression type is supplied in the MIME header.
1184 Use of the MIME header is the recommended way to
1185 supply the compression type. In general, no portion of
1186 the binary header is included in the calculation of the size.
1187
1188 The X-Binary-Element-Type header specifies the type of
1189 binary data in the octets, using the same descriptive
1190 phrases as in <a href="#_array_structure.encoding_type">_array_structure.encoding_type</a>. The default
1191 value is 'unsigned 32-bit integer'.
1192
1193 An MD5 message digest may, optionally, be used. The 'RSA Data
1194 Security, Inc. MD5 Message-Digest Algorithm' should be used.
1195 No portion of the header is included in the calculation of the
1196 message digest.
1197
1198 If the Transfer Encoding is 'X-BASE8', 'X-BASE10' or
1199 'X-BASE16', the data are presented as octal, decimal or
1200 hexadecimal data organized into lines or words. Each word
1201 is created by composing octets of data in fixed groups of
1202 2, 3, 4, 6 or 8 octets, either in the order ...4321 ('big-
1203 endian') or 1234... ('little-endian'). If there are fewer
1204 than the specified number of octets to fill the last word,
1205 then the missing octets are presented as '==' for each
1206 missing octet. Exactly two equal signs are used for each
1207 missing octet even for octal and decimal encoding.
1208 The format of lines is:
1209
1210 rnd xxxxxx xxxxxx xxxxxx
1211
1212 where r is 'H', 'O' or 'D' for hexadecimal, octal or
1213 decimal, n is the number of octets per word and d is '&lt;'
1214 or '&gt;' for the '...4321' and '1234...' octet orderings,
1215 respectively. The '==' padding for the last word should
1216 be on the appropriate side to correspond to the missing
1217 octets, e.g.
1218
1219 H4&lt; FFFFFFFF FFFFFFFF 07FFFFFF ====0000
1220
1221 or
1222
1223 H3&gt; FF0700 00====
1224
1225 For these hexadecimal, octal and decimal formats only,
1226 comments beginning with '#' are permitted to improve
1227 readability.
1228
1229 BASE64 encoding follows MIME conventions. Octets are
1230 in groups of three: c1, c2, c3. The resulting 24 bits
1231 are broken into four six-bit quantities, starting with
1232 the high-order six bits (c1 &gt;&gt; 2) of the first octet, then
1233 the low-order two bits of the first octet followed by the
1234 high-order four bits of the second octet [(c1 &amp; 3)&lt;&lt;4 | (c2&gt;&gt;4)],
1235 then the bottom four bits of the second octet followed by the
1236 high-order two bits of the last octet [(c2 &amp; 15)&lt;&lt;2 | (c3&gt;&gt;6)],
1237 then the bottom six bits of the last octet (c3 &amp; 63). Each
1238 of these four quantities is translated into an ASCII character
1239 using the mapping:
1240
1241 1 2 3 4 5 6
1242 0123456789012345678901234567890123456789012345678901234567890123
1243 | | | | | | |
1244 ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/
1245
1246 With short groups of octets padded on the right with one '='
1247 if c3 is missing, and with '==' if both c2 and c3 are missing.
1248
1249 X-BASE32K encoding is similar to BASE64 encoding, except that
1250 sets of 15 octets are encoded as sets of 8 16-bit unicode
1251 characters, by breaking the 120 bits into 8 15-bit quantities.
1252 256 is added to each 15 bit quantity to bring it into a
1253 printable uncode range. When encoding, zero padding is used
1254 to fill out the last 15 bit quantity. If 8 or more bits of
1255 padding are used, a single equals sign (hexadecimal 003D) is
1256 appended. Embedded whitespace and newlines are introduced
1257 to produce lines of no more than 80 characters each. On
1258 decoding, all printable ascii characters and ascii whitespace
1259 characters are ignored except for any trailing equals signs.
1260 The number of trailing equals signs indicated the number of
1261 trailing octets to be trimmed from the end of the decoded data.
1262 (see Georgi Darakev, Vassil Litchev, Kostadin Z. Mitev, Herbert
1263 J. Bernstein, 'Efficient Support of Binary Data in the XML
1264 Implementation of the NeXus File Format',absract W0165,
1265 ACA Summer Meeting, Honolulu, HI, July 2006).
1266
1267 QUOTED-PRINTABLE encoding also follows MIME conventions, copying
1268 octets without translation if their ASCII values are 32...38,
1269 42, 48...57, 59, 60, 62, 64...126 and the octet is not a ';'
1270 in column 1. All other characters are translated to =nn, where
1271 nn is the hexadecimal encoding of the octet. All lines are
1272 'wrapped' with a terminating '=' (i.e. the MIME conventions
1273 for an implicit line terminator are never used).
1274
1275 The &quot;X-Binary-Element-Byte-Order&quot; can specify either
1276 '&quot;BIG_ENDIAN&quot;' or '&quot;LITTLE_ENDIAN&quot;' byte order of the imaage
1277 data. Only LITTLE_ENDIAN is recommended. Processors
1278 may treat BIG_ENDIAN as a warning of data that can
1279 only be processed by special software.
1280
1281 The &quot;X-Binary-Number-of-Elements&quot; specifies the number of
1282 elements (not the number of octets) in the decompressed, decoded
1283 image.
1284
1285 The optional &quot;X-Binary-Size-Fastest-Dimension&quot; specifies the
1286 number of elements (not the number of octets) in one row of the
1287 fastest changing dimension of the binary data array. This
1288 information must be in the MIME header for proper operation of
1289 some of the decompression algorithms.
1290
1291 The optional &quot;X-Binary-Size-Second-Dimension&quot; specifies the
1292 number of elements (not the number of octets) in one column of
1293 the second-fastest changing dimension of the binary data array.
1294 This information must be in the MIME header for proper operation
1295 of some of the decompression algorithms.
1296
1297 The optional &quot;X-Binary-Size-Third-Dimension&quot; specifies the
1298 number of sections for the third-fastest changing dimension of
1299 the binary data array.
1300
1301 The optional &quot;X-Binary-Size-Padding&quot; specifies the size in
1302 octets of an optional padding after the binary array data and
1303 before the closing flags for a binary section.
1304 ;
1305 _item.name '<a href="#_array_data.data" >_array_data.data</a>'
1306 _item.category_id array_data
1307 _item.mandatory_code yes
1308 _item_type.code binary
1309 save_
1310
1311
1312 save_<a name="_array_data.header_contents" >_array_data.header_contents</a>
1313 _item_description.description
1314 ; This item is an text field for use in minimal CBF files to carry
1315 essential header information to be kept with image data
1316 in _array_data.data when the tags that normally carry the
1317 structured metadata for the image have not been populated.
1318
1319 Normally this data item should not appear when the full set
1320 of tags have been populated and _diffrn_data_frame.details
1321 appears.
1322 ;
1323 _item.name '<a href="#_array_data.header_contents" >_array_data.header_contents</a>'
1324 _item.category_id <a href="#ARRAY_DATA">array_data</a>
1325 _item.mandatory_code no
1326 _item_type.code text
1327 save_
1328
1329
1330
1331 save_<a name="_array_data.header_convention" >_array_data.header_convention</a>
1332 _item_description.description
1333 ; This item is an identifier for the convention followed in
1334 constructing the contents of <a href="#_array_data.header_contents" >_array_data.header_contents</a>
1335
1336 The permitted values are of the of an image creator identifier
1337 followed by an underscore and a version string. To avoid
1338 confusion about conventions, all creator identifiers
1339 should be registered with the IUCr and the conventions
1340 for all identifiers and versions should be posted on
1341 the MEDSBIO.org web site.
1342 ;
1343 _item.name '<a href="#_array_data.header_convention" >_array_data.header_convention</a>'
1344 _item.category_id <a href="#ARRAY_DATA">array_data</a>
1345 _item.mandatory_code no
1346 _item_type.code code
1347 save_
1348
1349 save_<a name="_array_data.variant" >_array_data.variant</a>
1350 _item_description.description
1351 ; The value of <a href="#_array_data.variant" >_array_data.variant</a> gives the variant
1352 to which the given array_data row is related.
1353
1354 If this value is not given, the variant is assumed to the default
1355 null variant.
1356
1357 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
1358 <a href="#VARIANT">VARIANT</a> category.
1359 ;
1360 _item.name '<a href="#_array_data.variant" >_array_data.variant</a>'
1361 _item.category_id array_data
1362 _item.mandatory_code no
1363 _item_type.code code
1364 save_
1365
1366
1367
1368 ######################
1369 # <a name="ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a> #
1370 ######################
1371
1372
1373 save_ARRAY_ELEMENT_SIZE
1374 _category.description
1375 ; Data items in the <a href="#ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a> category record the physical
1376 size of array elements along each array dimension.
1377 ;
1378 _category.id array_element_size
1379 _category.mandatory_code no
1380 loop_
1381 _category_key.name '<a href="#_array_element_size.array_id" >_array_element_size.array_id</a>'
1382 '<a href="#_array_element_size.index" >_array_element_size.index</a>'
1383 '<a href="#_array_element_size.variant" >_array_element_size.variant</a>'
1384 loop_
1385 _category_group.id 'inclusive_group'
1386 'array_data_group'
1387 loop_
1388 _category_examples.detail
1389 _category_examples.case
1390 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1391 ; Example 1 - A regular 2D array with a uniform element dimension
1392 of 1220 nanometres.
1393 ;
1394 ;
1395 loop_
1396 <a href="#_array_element_size.array_id" >_array_element_size.array_id</a>
1397 <a href="#_array_element_size.index" >_array_element_size.index</a>
1398 <a href="#_array_element_size.size" >_array_element_size.size</a>
1399 image_1 1 1.22e-6
1400 image_1 2 1.22e-6
1401 ;
1402 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1403 save_
1404
1405
1406 save_<a name="_array_element_size.array_id" >_array_element_size.array_id</a>
1407 _item_description.description
1408 ; This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
1409 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
1410 ;
1411 _item.name '<a href="#_array_element_size.array_id" >_array_element_size.array_id</a>'
1412 _item.category_id array_element_size
1413 _item.mandatory_code implicit
1414 _item_type.code code
1415 save_
1416
1417
1418 save_<a name="_array_element_size.index" >_array_element_size.index</a>
1419 _item_description.description
1420 ; This item is a pointer to <a href="#_array_structure_list.index" >_array_structure_list.index</a> in
1421 the ARRAY_STRUCTURE_LIST category.
1422 ;
1423 _item.name '<a href="#_array_element_size.index" >_array_element_size.index</a>'
1424 _item.category_id array_element_size
1425 _item.mandatory_code yes
1426 _item_type.code code
1427 save_
1428
1429
1430 save_<a name="_array_element_size.size" >_array_element_size.size</a>
1431 _item_description.description
1432 ; The size in metres of an image element in this
1433 dimension. This supposes that the elements are arranged
1434 on a regular grid.
1435 ;
1436 _item.name '<a href="#_array_element_size.size" >_array_element_size.size</a>'
1437 _item.category_id array_element_size
1438 _item.mandatory_code yes
1439 _item_type.code float
1440 _item_units.code 'metres'
1441 loop_
1442 _item_range.maximum
1443 _item_range.minimum
1444 . 0.0
1445 save_
1446
1447 save_<a name="_array_element_size.variant" >_array_element_size.variant</a>
1448 _item_description.description
1449 ; The value of <a href="#_array_element_size.variant" >_array_element_size.variant</a> gives the variant
1450 to which the given array_element_size row is related.
1451
1452 If this value is not given, the variant is assumed to the default
1453 null variant.
1454
1455 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
1456 <a href="#VARIANT">VARIANT</a> category.
1457 ;
1458 _item.name '<a href="#_array_element_size.variant" >_array_element_size.variant</a>'
1459 _item.category_id array_element_size
1460 _item.mandatory_code no
1461 _item_type.code code
1462 save_
1463
1464
1465 #####################
1466 # <a name="ARRAY_INTENSITIES">ARRAY_INTENSITIES</a> #
1467 #####################
1468
1469
1470 save_ARRAY_INTENSITIES
1471 _category.description
1472 ; Data items in the <a href="#ARRAY_INTENSITIES">ARRAY_INTENSITIES</a> category record the
1473 information required to recover the intensity data from
1474 the set of data values stored in the <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
1475
1476 The detector may have a complex relationship
1477 between the raw intensity values and the number of
1478 incident photons. In most cases, the number stored
1479 in the final array will have a simple linear relationship
1480 to the actual number of incident photons, given by
1481 <a href="#_array_intensities.gain">_array_intensities.gain</a>. If raw, uncorrected values
1482 are presented (e.g. for calibration experiments), the
1483 value of <a href="#_array_intensities.linearity">_array_intensities.linearity</a> will be 'raw'
1484 and <a href="#_array_intensities.gain">_array_intensities.gain</a> will not be used.
1485
1486 ;
1487 _category.id array_intensities
1488 _category.mandatory_code no
1489 loop_
1490 _category_key.name '<a href="#_array_intensities.array_id" >_array_intensities.array_id</a>'
1491 '<a href="#_array_intensities.binary_id" >_array_intensities.binary_id</a>'
1492 '<a href="#_array_intensities.variant" >_array_intensities.variant</a>'
1493 loop_
1494 _category_group.id 'inclusive_group'
1495 'array_data_group'
1496 loop_
1497 _category_examples.detail
1498 _category_examples.case
1499 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1500 ;
1501 Example 1
1502 ;
1503 ;
1504 loop_
1505 <a href="#_array_intensities.array_id" >_array_intensities.array_id</a>
1506 <a href="#_array_intensities.linearity" >_array_intensities.linearity</a>
1507 <a href="#_array_intensities.gain" >_array_intensities.gain</a>
1508 <a href="#_array_intensities.overload" >_array_intensities.overload</a>
1509 <a href="#_array_intensities.undefined_value" >_array_intensities.undefined_value</a>
1510 <a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>
1511 <a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a>
1512 <a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>
1513 image_1 linear 1.2 655535 0 2 2 hardware
1514 ;
1515 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1516 save_
1517
1518
1519 save_<a name="_array_intensities.array_id" >_array_intensities.array_id</a>
1520 _item_description.description
1521 ; This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
1522 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
1523 ;
1524 _item.name '<a href="#_array_intensities.array_id" >_array_intensities.array_id</a>'
1525 _item.category_id array_intensities
1526 _item.mandatory_code implicit
1527 _item_type.code code
1528 save_
1529
1530
1531 save_<a name="_array_intensities.binary_id" >_array_intensities.binary_id</a>
1532 _item_description.description
1533 ; This item is a pointer to <a href="#_array_data.binary_id" >_array_data.binary_id</a> in the
1534 <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
1535 ;
1536 _item.name '<a href="#_array_intensities.binary_id" >_array_intensities.binary_id</a>'
1537 _item.category_id array_intensities
1538 _item.mandatory_code implicit
1539 _item_type.code int
1540 save_
1541
1542
1543 save_<a name="_array_intensities.gain" >_array_intensities.gain</a>
1544 _item_description.description
1545 ; Detector 'gain'. The factor by which linearized
1546 intensity count values should be divided to produce
1547 true photon counts.
1548 ;
1549 _item.name '<a href="#_array_intensities.gain" >_array_intensities.gain</a>'
1550 _item.category_id array_intensities
1551 _item.mandatory_code yes
1552 _item_type.code float
1553 loop_
1554 _item_range.maximum
1555 _item_range.minimum
1556 . 0.0
1557 _item_units.code 'counts_per_photon'
1558 loop_
1559 _item_related.related_name
1560 _item_related.function_code '<a href="#_array_intensities.gain_esd" >_array_intensities.gain_esd</a>'
1561 'associated_value'
1562 save_
1563
1564
1565 save_<a name="_array_intensities.gain_esd" >_array_intensities.gain_esd</a>
1566 _item_description.description
1567 ; The estimated standard deviation in detector 'gain'.
1568 ;
1569 _item.name '<a href="#_array_intensities.gain_esd" >_array_intensities.gain_esd</a>'
1570 _item.category_id array_intensities
1571 _item.mandatory_code yes
1572 _item_type.code float
1573 loop_
1574 _item_range.maximum
1575 _item_range.minimum
1576 . 0.0
1577
1578 _item_units.code 'counts_per_photon'
1579 loop_
1580 _item_related.related_name
1581 _item_related.function_code '<a href="#_array_intensities.gain" >_array_intensities.gain</a>'
1582 'associated_esd'
1583 save_
1584
1585
1586 save_<a name="_array_intensities.linearity" >_array_intensities.linearity</a>
1587 _item_description.description
1588 ; The intensity linearity scaling method used to convert
1589 from the raw intensity to the stored element value:
1590
1591 'linear' is linear.
1592
1593 'offset' means that the value defined by
1594 <a href="#_array_intensities.offset" >_array_intensities.offset</a> should be added to each
1595 element value.
1596
1597 'scaling' means that the value defined by
1598 <a href="#_array_intensities.scaling">_array_intensities.scaling</a> should be multiplied with each
1599 element value.
1600
1601 'scaling_offset' is the combination of the two previous cases,
1602 with the scale factor applied before the offset value.
1603
1604 'sqrt_scaled' means that the square root of raw
1605 intensities multiplied by <a href="#_array_intensities.scaling">_array_intensities.scaling</a> is
1606 calculated and stored, perhaps rounded to the nearest
1607 integer. Thus, linearization involves dividing the stored
1608 values by <a href="#_array_intensities.scaling">_array_intensities.scaling</a> and squaring the
1609 result.
1610
1611 'logarithmic_scaled' means that the logarithm base 10 of
1612 raw intensities multiplied by <a href="#_array_intensities.scaling">_array_intensities.scaling</a>
1613 is calculated and stored, perhaps rounded to the nearest
1614 integer. Thus, linearization involves dividing the stored
1615 values by <a href="#_array_intensities.scaling">_array_intensities.scaling</a> and calculating 10
1616 to the power of this number.
1617
1618 'raw' means that the data are a set of raw values straight
1619 from the detector.
1620 ;
1621
1622 _item.name '<a href="#_array_intensities.linearity" >_array_intensities.linearity</a>'
1623 _item.category_id array_intensities
1624 _item.mandatory_code yes
1625 _item_type.code code
1626 loop_
1627 _item_enumeration.value
1628 _item_enumeration.detail
1629 'linear' .
1630 'offset'
1631 ; The value defined by <a href="#_array_intensities.offset" >_array_intensities.offset</a> should
1632 be added to each element value.
1633 ;
1634 'scaling'
1635 ; The value defined by <a href="#_array_intensities.scaling">_array_intensities.scaling</a> should be
1636 multiplied with each element value.
1637 ;
1638 'scaling_offset'
1639 ; The combination of the scaling and offset
1640 with the scale factor applied before the offset value.
1641 ;
1642 'sqrt_scaled'
1643 ; The square root of raw intensities multiplied by
1644 <a href="#_array_intensities.scaling">_array_intensities.scaling</a> is calculated and stored,
1645 perhaps rounded to the nearest integer. Thus,
1646 linearization involves dividing the stored
1647 values by <a href="#_array_intensities.scaling">_array_intensities.scaling</a> and squaring the
1648 result.
1649 ;
1650 'logarithmic_scaled'
1651 ; The logarithm base 10 of raw intensities multiplied by
1652 <a href="#_array_intensities.scaling">_array_intensities.scaling</a> is calculated and stored,
1653 perhaps rounded to the nearest integer. Thus,
1654 linearization involves dividing the stored values by
1655 <a href="#_array_intensities.scaling">_array_intensities.scaling</a> and calculating 10 to the
1656 power of this number.
1657 ;
1658 'raw'
1659 ; The array consists of raw values to which no corrections have
1660 been applied. While the handling of the data is similar to
1661 that given for 'linear' data with no offset, the meaning of
1662 the data differs in that the number of incident photons is
1663 not necessarily linearly related to the number of counts
1664 reported. This value is intended for use either in
1665 calibration experiments or to allow for handling more
1666 complex data-fitting algorithms than are allowed for by
1667 this data item.
1668 ;
1669
1670 save_
1671
1672
1673 save_<a name="_array_intensities.offset" >_array_intensities.offset</a>
1674 _item_description.description
1675 ; Offset value to add to array element values in the manner
1676 described by the item <a href="#_array_intensities.linearity" >_array_intensities.linearity</a>.
1677 ;
1678 _item.name '<a href="#_array_intensities.offset" >_array_intensities.offset</a>'
1679 _item.category_id array_intensities
1680 _item.mandatory_code no
1681 _item_type.code float
1682 save_
1683
1684
1685 save_<a name="_array_intensities.overload" >_array_intensities.overload</a>
1686 _item_description.description
1687 ; The saturation intensity level for this data array.
1688 ;
1689 _item.name '<a href="#_array_intensities.overload" >_array_intensities.overload</a>'
1690 _item.category_id array_intensities
1691 _item.mandatory_code no
1692 _item_type.code float
1693 _item_units.code 'counts'
1694 save_
1695
1696
1697 save_<a name="_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>
1698 _item_description.description
1699 ; The value of <a href=#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a> specifies
1700 the number of pixels that compose one element in the direction
1701 of the most rapidly varying array dimension.
1702
1703 Typical values are 1, 2, 4 or 8. When there is 1 pixel per
1704 array element in both directions, the value given for
1705 <a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a> normally should be
1706 'none'.
1707
1708 It is specified as a float to allow for binning algorithms that
1709 create array elements that are not integer multiples of the
1710 detector pixel size.
1711 ;
1712 _item.name '<a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>'
1713 _item.category_id array_intensities
1714 _item.mandatory_code implicit
1715 _item_type.code float
1716 _item_default.value 1.
1717 loop_
1718 _item_range.maximum
1719 _item_range.minimum
1720 . 0.0
1721 _item_units.code 'pixels_per_element'
1722 save_
1723
1724
1725 save_<a name="_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a>
1726 _item_description.description
1727 ; The value of <a href=#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a> specifies
1728 the number of pixels that compose one element in the direction
1729 of the second most rapidly varying array dimension.
1730
1731 Typical values are 1, 2, 4 or 8. When there is 1 pixel per
1732 array element in both directions, the value given for
1733 <a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a> normally should be
1734 'none'.
1735
1736 It is specified as a float to allow for binning algorithms that
1737 create array elements that are not integer multiples of the
1738 detector pixel size.
1739 ;
1740 _item.name '<a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a>'
1741 _item.category_id array_intensities
1742 _item.mandatory_code implicit
1743 _item_type.code float
1744 _item_default.value 1.
1745 loop_
1746 _item_range.maximum
1747 _item_range.minimum
1748 . 0.0
1749 _item_units.code 'pixels_per_element'
1750 save_
1751
1752
1753 save_<a name="_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>
1754 _item_description.description
1755 ; The value of <a href="#_array_intensities.pixel_binning_method">_array_intensities.pixel_binning_method</a> specifies
1756 the method used to derive array elements from multiple pixels.
1757 ;
1758 _item.name '<a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>'
1759 _item.category_id array_intensities
1760 _item.mandatory_code implicit
1761 _item_type.code code
1762 loop_
1763 _item_enumeration.value
1764 _item_enumeration.detail
1765 'hardware'
1766 ; The element intensities were derived from the raw data of one
1767 or more pixels by used of hardware in the detector, e.g. by use
1768 of shift registers in a CCD to combine pixels into super-pixels.
1769 ;
1770 'software'
1771 ; The element intensities were derived from the raw data of more
1772 than one pixel by use of software.
1773 ;
1774 'combined'
1775 ; The element intensities were derived from the raw data of more
1776 than one pixel by use of both hardware and software, as when
1777 hardware binning is used in one direction and software in the
1778 other.
1779 ;
1780 'none'
1781 ; In the both directions, the data has not been binned. The
1782 number of pixels is equal to the number of elements.
1783
1784 When the value of <a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a> is
1785 'none' the values of <a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>
1786 and <a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a> both must be 1.
1787 ;
1788 'unspecified'
1789 ; The method used to derive element intensities is not specified.
1790 ;
1791 _item_default.value 'unspecified'
1792 save_
1793
1794 save_<a name="_array_intensities.scaling" >_array_intensities.scaling</a>
1795 _item_description.description
1796 ; Multiplicative scaling value to be applied to array data
1797 in the manner described by item
1798 <a href="#_array_intensities.linearity" >_array_intensities.linearity</a>.
1799 ;
1800 _item.name '<a href="#_array_intensities.scaling" >_array_intensities.scaling</a>'
1801 _item.category_id array_intensities
1802 _item.mandatory_code no
1803 _item_type.code float
1804 save_
1805
1806
1807
1808 save_<a name="_array_intensities.undefined_value" >_array_intensities.undefined_value</a>
1809 _item_description.description
1810 ; A value to be substituted for undefined values in
1811 the data array.
1812 ;
1813 _item.name '<a href="#_array_intensities.undefined_value" >_array_intensities.undefined_value</a>'
1814 _item.category_id array_intensities
1815 _item.mandatory_code no
1816 _item_type.code float
1817 save_
1818
1819 save_<a name="_array_intensities.variant" >_array_intensities.variant</a>
1820 _item_description.description
1821 ; The value of <a href="#_array_intensities.variant" >_array_intensities.variant</a> gives the variant
1822 to which the given array_intensities row is related.
1823
1824 If this value is not given, the variant is assumed to the default
1825 null variant.
1826
1827 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
1828 <a href="#VARIANT">VARIANT</a> category.
1829 ;
1830 _item.name '<a href="#_array_intensities.variant" >_array_intensities.variant</a>'
1831 _item.category_id array_intensities
1832 _item.mandatory_code no
1833 _item_type.code code
1834 save_
1835
1836
1837 ###################
1838 # <a name="ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> #
1839 ###################
1840
1841
1842 save_ARRAY_STRUCTURE
1843 _category.description
1844 ; Data items in the <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category record the organization and
1845 encoding of array data that may be stored in the <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
1846 ;
1847 _category.id array_structure
1848 _category.mandatory_code no
1849 loop_
1850 _category_key.name '<a href="#_array_structure.id" >_array_structure.id</a>'
1851 '<a href="#_array_structure.variant" >_array_structure.variant</a>'
1852 loop_
1853 _category_group.id 'inclusive_group'
1854 'array_data_group'
1855 loop_
1856 _category_examples.detail
1857 _category_examples.case
1858 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1859 ; Example 1 -
1860 ;
1861 ;
1862 loop_
1863 _array_structure.id
1864 _array_structure.encoding_type
1865 _array_structure.compression_type
1866 _array_structure.byte_order
1867 image_1 "unsigned 16-bit integer" none little_endian
1868 ;
1869 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1870 save_
1871
1872
1873 save_<a name="_array_structure.byte_order" >_array_structure.byte_order</a>
1874 _item_description.description
1875 ; The order of bytes for integer values which require more
1876 than 1 byte.
1877
1878 (IBM-PC's and compatibles and DEC VAXs use low-byte-first
1879 ordered integers, whereas Hewlett Packard 700
1880 series, Sun-4 and Silicon Graphics use high-byte-first
1881 ordered integers. DEC Alphas can produce/use either
1882 depending on a compiler switch.)
1883 ;
1884
1885 _item.name '<a href="#_array_structure.byte_order" >_array_structure.byte_order</a>'
1886 _item.category_id array_structure
1887 _item.mandatory_code yes
1888 _item_type.code ucode
1889 loop_
1890 _item_enumeration.value
1891 _item_enumeration.detail
1892 'big_endian'
1893 ; The first byte in the byte stream of the bytes which make up an
1894 integer value is the most significant byte of an integer.
1895 ;
1896 'little_endian'
1897 ; The last byte in the byte stream of the bytes which make up an
1898 integer value is the most significant byte of an integer.
1899 ;
1900 save_
1901
1902
1903 save_<a name="_array_structure.compression_type" >_array_structure.compression_type</a>
1904 _item_description.description
1905 ; Type of data-compression method used to compress the array
1906 data.
1907 ;
1908 _item.name '<a href="#_array_structure.compression_type" >_array_structure.compression_type</a>'
1909 _item.category_id array_structure
1910 _item.mandatory_code no
1911 _item_type.code ucode
1912 _item_default.value 'none'
1913 loop_
1914 _item_enumeration.value
1915 _item_enumeration.detail
1916 'byte_offset'
1917 ; Using the 'byte_offset' compression scheme as per A. Hammersley
1918 and the CBFlib manual, section 3.3.3
1919 ;
1920 'canonical'
1921 ; Using the 'canonical' compression scheme (International Tables
1922 for Crystallography Volume G, Section 5.6.3.1) and CBFlib
1923 manual section 3.3.1
1924 ;
1925 'none'
1926 ; Data are stored in normal format as defined by
1927 <a href="#_array_structure.encoding_type" >_array_structure.encoding_type</a> and
1928 <a href="#_array_structure.byte_order" >_array_structure.byte_order</a>.
1929 ;
1930 'packed'
1931 ; Using the 'packed' compression scheme, a CCP4-style packing
1932 as per J. P. Abrahams pack_c.c and CBFlib manual, section 3.3.2.
1933 ;
1934 'packed_v2'
1935 ; Using the 'packed' compression scheme, version 2, as per
1936 J. P. Abrahams pack_c.c and CBFlib manual, section 3.3.2.
1937 ;
1938 save_
1939
1940 save_<a name="_array_structure.compression_type_flag" >_array_structure.compression_type_flag</a>
1941 _item_description.description
1942 ; Flags modifying the type of data-compression method used to
1943 compress the arraydata.
1944 ;
1945 _item.name '<a href="#_array_structure.compression_type_flag" >_array_structure.compression_type_flag</a>'
1946 _item.category_id array_structure
1947 _item.mandatory_code no
1948 _item_type.code ucode
1949 loop_
1950 _item_enumeration.value
1951 _item_enumeration.detail
1952 'uncorrelated_sections'
1953 ; When applying packed or packed_v2 compression on an array with
1954 uncorrelated sections, do not average in points from the prior
1955 section.
1956 ;
1957 'flat'
1958 ; When applying packed or packed_v2 compression on an array with
1959 treat the entire image as a single line set the maximum number
1960 of bits for an offset to 65 bits.
1961
1962 The flag is included for compatibility with software prior to
1963 CBFlib_0.7.7, and should not be used for new data sets.
1964
1965 ;
1966
1967 save_
1968
1969 save_<a name="_array_structure.encoding_type" >_array_structure.encoding_type</a>
1970 _item_description.description
1971 ; Data encoding of a single element of array data.
1972
1973 The type 'unsigned 1-bit integer' is used for
1974 packed Booleans arrays for masks. Each element
1975 of the array corresponds to a single bit
1976 packed in unsigned 8-bit data.
1977
1978 In several cases, the IEEE format is referenced.
1979 See IEEE Standard 754-1985 (IEEE, 1985).
1980
1981 Ref: IEEE (1985). IEEE Standard for Binary Floating-Point
1982 Arithmetic. ANSI/IEEE Std 754-1985. New York: Institute of
1983 Electrical and Electronics Engineers.
1984 ;
1985
1986 _item.name '<a href="#_array_structure.encoding_type" >_array_structure.encoding_type</a>'
1987 _item.category_id array_structure
1988 _item.mandatory_code yes
1989 _item_type.code uline
1990 loop_
1991 _item_enumeration.value
1992 'unsigned 1-bit integer'
1993 'unsigned 8-bit integer'
1994 'signed 8-bit integer'
1995 'unsigned 16-bit integer'
1996 'signed 16-bit integer'
1997 'unsigned 32-bit integer'
1998 'signed 32-bit integer'
1999 'signed 32-bit real IEEE'
2000 'signed 64-bit real IEEE'
2001 'signed 32-bit complex IEEE'
2002 save_
2003
2004
2005 save_<a name="_array_structure.id" >_array_structure.id</a>
2006 _item_description.description
2007 ; The value of <a href="#_array_structure.id" >_array_structure.id</a> must uniquely identify
2008 each item of array data.
2009
2010 This item has been made implicit and given a default value of 1
2011 as a convenience in writing miniCBF files. Normally an
2012 explicit name with useful content should be used.
2013 ;
2014 loop_
2015 _item.name
2016 _item.category_id
2017 _item.mandatory_code
2018 '<a href="#_array_structure.id" >_array_structure.id</a>' array_structure implicit
2019 '<a href="#_array_data.array_id" >_array_data.array_id</a>' array_data implicit
2020 '<a href="#_array_structure_list.array_id" >_array_structure_list.array_id</a>' array_structure_list implicit
2021 '<a href="#_array_intensities.array_id" >_array_intensities.array_id</a>' array_intensities implicit
2022 '<a href="#_diffrn_data_frame.array_id" >_diffrn_data_frame.array_id</a>' diffrn_data_frame implicit
2023
2024
2025 _item_default.value 1
2026 _item_type.code code
2027 loop_
2028 _item_linked.child_name
2029 _item_linked.parent_name
2030 '<a href="#_array_data.array_id" >_array_data.array_id</a>' '<a href="#_array_structure.id" >_array_structure.id</a>'
2031 '<a href="#_array_structure_list.array_id" >_array_structure_list.array_id</a>' '<a href="#_array_structure.id" >_array_structure.id</a>'
2032 '<a href="#_array_intensities.array_id" >_array_intensities.array_id</a>' '<a href="#_array_structure.id" >_array_structure.id</a>'
2033 '<a href="#_diffrn_data_frame.array_id" >_diffrn_data_frame.array_id</a>' '<a href="#_array_structure.id" >_array_structure.id</a>'
2034
2035 save_
2036
2037 save_<a name="_array_structure.variant" >_array_structure.variant</a>
2038 _item_description.description
2039 ; The value of <a href="#_array_structure.variant" >_array_structure.variant</a> gives the variant
2040 to which the given array_structure row is related.
2041
2042 If this value is not given, the variant is assumed to the default
2043 null variant.
2044
2045 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
2046 <a href="#VARIANT">VARIANT</a> category.
2047 ;
2048 _item.name '<a href="#_array_structure.variant" >_array_structure.variant</a>'
2049 _item.category_id array_structure
2050 _item.mandatory_code no
2051 _item_type.code code
2052 save_
2053
2054
2055 ########################
2056 # <a name="ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> #
2057 ########################
2058
2059
2060 save_ARRAY_STRUCTURE_LIST
2061 _category.description
2062 ; Data items in the <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> category record the size
2063 and organization of each array dimension.
2064
2065 The relationship to physical axes may be given.
2066 ;
2067 _category.id array_structure_list
2068 _category.mandatory_code no
2069 loop_
2070 _category_key.name '<a href="#_array_structure_list.array_id" >_array_structure_list.array_id</a>'
2071 '<a href="#_array_structure_list.index" >_array_structure_list.index</a>'
2072 '<a href="#_array_structure_list.variant" >_array_structure_list.variant</a>'
2073 loop_
2074 _category_group.id 'inclusive_group'
2075 'array_data_group'
2076 loop_
2077 _category_examples.detail
2078 _category_examples.case
2079 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2080 ; Example 1 - An image array of 1300 x 1200 elements. The raster
2081 order of the image is left to right (increasing) in the
2082 first dimension and bottom to top (decreasing) in
2083 the second dimension.
2084 ;
2085 ;
2086 loop_
2087 <a href="#_array_structure_list.array_id" >_array_structure_list.array_id</a>
2088 <a href="#_array_structure_list.index" >_array_structure_list.index</a>
2089 <a href="#_array_structure_list.dimension" >_array_structure_list.dimension</a>
2090 <a href="#_array_structure_list.precedence" >_array_structure_list.precedence</a>
2091 <a href="#_array_structure_list.direction" >_array_structure_list.direction</a>
2092 <a href="#_array_structure_list.axis_id" >_array_structure_list.axis_set_id</a>
2093 image_1 1 1300 1 increasing ELEMENT_X
2094 image_1 2 1200 2 decreasing ELEMENY_Y
2095 ;
2096 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2097 save_
2098
2099
2100 save_<a name="_array_structure_list.array_id" >_array_structure_list.array_id</a>
2101 _item_description.description
2102 ; This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
2103 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
2104 ;
2105 _item.name '<a href="#_array_structure_list.array_id" >_array_structure_list.array_id</a>'
2106 _item.category_id array_structure_list
2107 _item.mandatory_code implicit
2108 _item_type.code code
2109 save_
2110
2111
2112 save_<a name="_array_structure_list.axis_set_id" >_array_structure_list.axis_set_id</a>
2113 _item_description.description
2114 ; This is a descriptor for the physical axis or set of axes
2115 corresponding to an array index.
2116
2117 This data item is related to the axes of the detector
2118 itself given in <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a>, but usually differs
2119 in that the axes in this category are the axes of the
2120 coordinate system of reported data points, while the axes in
2121 <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a> are the physical axes
2122 of the detector describing the 'poise' of the detector as an
2123 overall physical object.
2124
2125 If there is only one axis in the set, the identifier of
2126 that axis should be used as the identifier of the set.
2127 ;
2128 loop_
2129 _item.name
2130 _item.category_id
2131 _item.mandatory_code
2132 '<a href="#_array_structure_list.axis_set_id" >_array_structure_list.axis_set_id</a>'
2133 array_structure_list yes
2134 '<a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>'
2135 array_structure_list_axis implicit
2136 _item_type.code code
2137 loop_
2138 _item_linked.child_name
2139 _item_linked.parent_name
2140 '<a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>'
2141 '<a href="#_array_structure_list.axis_set_id" >_array_structure_list.axis_set_id</a>'
2142
2143
2144 save_
2145
2146
2147 save_<a name="_array_structure_list.dimension" >_array_structure_list.dimension</a>
2148 _item_description.description
2149 ; The number of elements stored in the array structure in
2150 this dimension.
2151 ;
2152 _item.name '<a href="#_array_structure_list.dimension" >_array_structure_list.dimension</a>'
2153 _item.category_id array_structure_list
2154 _item.mandatory_code yes
2155 _item_type.code int
2156 loop_
2157 _item_range.maximum
2158 _item_range.minimum
2159 1 1
2160 . 1
2161 save_
2162
2163
2164 save_<a name="_array_structure_list.direction" >_array_structure_list.direction</a>
2165 _item_description.description
2166 ; Identifies the direction in which this array index changes.
2167 ;
2168 _item.name '<a href="#_array_structure_list.direction" >_array_structure_list.direction</a>'
2169 _item.category_id array_structure_list
2170 _item.mandatory_code yes
2171 _item_type.code code
2172 loop_
2173 _item_enumeration.value
2174 _item_enumeration.detail
2175
2176 'increasing'
2177 ; Indicates the index changes from 1 to the maximum dimension.
2178 ;
2179 'decreasing'
2180 ; Indicates the index changes from the maximum dimension to 1.
2181 ;
2182 save_
2183
2184
2185 save_<a name="_array_structure_list.index" >_array_structure_list.index</a>
2186 _item_description.description
2187 ; Identifies the one-based index of the row or column in the
2188 array structure.
2189 ;
2190 loop_
2191 _item.name
2192 _item.category_id
2193 _item.mandatory_code
2194 '<a href="#_array_structure_list.index" >_array_structure_list.index</a>' array_structure_list yes
2195 '<a href="#_array_structure_list.precedence" >_array_structure_list.precedence</a>' array_structure_list yes
2196 '<a href="#_array_element_size.index" >_array_element_size.index</a>' array_element_size yes
2197
2198 _item_type.code int
2199
2200 loop_
2201 _item_linked.child_name
2202 _item_linked.parent_name
2203 '<a href="#_array_element_size.index" >_array_element_size.index</a>' '<a href="#_array_structure_list.index" >_array_structure_list.index</a>'
2204 loop_
2205 _item_range.maximum
2206 _item_range.minimum
2207 1 1
2208 . 1
2209 save_
2210
2211
2212 save_<a name="_array_structure_list.precedence" >_array_structure_list.precedence</a>
2213 _item_description.description
2214 ; Identifies the rank order in which this array index changes
2215 with respect to other array indices. The precedence of 1
2216 indicates the index which changes fastest.
2217 ;
2218 _item.name '<a href="#_array_structure_list.precedence" >_array_structure_list.precedence</a>'
2219 _item.category_id array_structure_list
2220 _item.mandatory_code yes
2221 _item_type.code int
2222 loop_
2223 _item_range.maximum
2224 _item_range.minimum
2225 1 1
2226 . 1
2227 save_
2228
2229 save_<a name="_array_structure_list.variant" >_array_structure_list.variant</a>
2230 _item_description.description
2231 ; The value of <a href="#_array_structure_list.variant" >_array_structure_list.variant</a> gives the variant
2232 to which the given array_structure_list row is related.
2233
2234 If this value is not given, the variant is assumed to the default
2235 null variant.
2236
2237 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
2238 <a href="#VARIANT">VARIANT</a> category.
2239 ;
2240 _item.name '<a href="#_array_structure_list.variant" >_array_structure_list.variant</a>'
2241 _item.category_id array_structure_list
2242 _item.mandatory_code no
2243 _item_type.code code
2244 save_
2245
2246
2247
2248 #############################
2249 # <a name="ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a> #
2250 #############################
2251
2252 save_ARRAY_STRUCTURE_LIST_AXIS
2253 _category.description
2254 ; Data items in the <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a> category describe
2255 the physical settings of sets of axes for the centres of pixels that
2256 correspond to data points described in the
2257 <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> category.
2258
2259 In the simplest cases, the physical increments of a single axis correspond
2260 to the increments of a single array index. More complex organizations,
2261 e.g. spiral scans, may require coupled motions along multiple axes.
2262
2263 Note that a spiral scan uses two coupled axes: one for the angular
2264 direction and one for the radial direction. This differs from a
2265 cylindrical scan for which the two axes are not coupled into one
2266 set.
2267 ;
2268 _category.id array_structure_list_axis
2269 _category.mandatory_code no
2270 loop_
2271 _category_key.name
2272 '<a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>'
2273 '<a href="#_array_structure_list_axis.axis_id" >_array_structure_list_axis.axis_id</a>'
2274 '<a href="#_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a>'
2275 loop_
2276 _category_group.id 'inclusive_group'
2277 'array_data_group'
2278 save_
2279
2280
2281 save_<a name="_array_structure_list_axis.axis_id" >_array_structure_list_axis.axis_id</a>
2282 _item_description.description
2283 ; The value of this data item is the identifier of one of
2284 the axes in the set of axes for which settings are being
2285 specified.
2286
2287 Multiple axes may be specified for the same value of
2288 <a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>.
2289
2290 This item is a pointer to <a href="#_axis.id" >_axis.id</a> in the
2291 <a href="#AXIS">AXIS</a> category.
2292 ;
2293 _item.name '<a href="#_array_structure_list_axis.axis_id" >_array_structure_list_axis.axis_id</a>'
2294 _item.category_id array_structure_list_axis
2295 _item.mandatory_code yes
2296 _item_type.code code
2297 save_
2298
2299
2300 save_<a name="_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>
2301 _item_description.description
2302 ; The value of this data item is the identifier of the
2303 set of axes for which axis settings are being specified.
2304
2305 Multiple axes may be specified for the same value of
2306 <a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>.
2307
2308 This item is a pointer to
2309 <a href="#_array_structure_list.axis_set_id" >_array_structure_list.axis_set_id</a>
2310 in the <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> category.
2311
2312 If this item is not specified, it defaults to the corresponding
2313 axis identifier.
2314 ;
2315 _item.name '<a href="#_array_structure_list_axis.axis_set_id" >_array_structure_list_axis.axis_set_id</a>'
2316 _item.category_id array_structure_list_axis
2317 _item.mandatory_code implicit
2318 _item_type.code code
2319 save_
2320
2321
2322 save_<a name="_array_structure_list_axis.angle" >_array_structure_list_axis.angle</a>
2323 _item_description.description
2324 ; The setting of the specified axis in degrees for the first
2325 data point of the array index with the corresponding value
2326 of <a href="#_array_structure_list.axis_set_id">_array_structure_list.axis_set_id</a>. If the index is
2327 specified as 'increasing', this will be the centre of the
2328 pixel with index value 1. If the index is specified as
2329 'decreasing', this will be the centre of the pixel with
2330 maximum index value.
2331 ;
2332 _item.name '<a href="#_array_structure_list_axis.angle" >_array_structure_list_axis.angle</a>'
2333 _item.category_id array_structure_list_axis
2334 _item.mandatory_code no
2335 _item_default.value 0.0
2336 _item_type.code float
2337 _item_units.code 'degrees'
2338 save_
2339
2340
2341 save_<a name="_array_structure_list_axis.angle_increment">_array_structure_list_axis.angle_increment</a>
2342 _item_description.description
2343 ; The pixel-centre-to-pixel-centre increment in the angular
2344 setting of the specified axis in degrees. This is not
2345 meaningful in the case of 'constant velocity' spiral scans
2346 and should not be specified for this case.
2347
2348 See <a href="#_array_structure_list_axis.angular_pitch">_array_structure_list_axis.angular_pitch</a>.
2349
2350 ;
2351 _item.name '<a href="#_array_structure_list_axis.angle_increment">_array_structure_list_axis.angle_increment</a>'
2352 _item.category_id array_structure_list_axis
2353 _item.mandatory_code no
2354 _item_default.value 0.0
2355 _item_type.code float
2356 _item_units.code 'degrees'
2357 save_
2358
2359
2360 save_<a name="_array_structure_list_axis.displacement" >_array_structure_list_axis.displacement</a>
2361 _item_description.description
2362 ; The setting of the specified axis in millimetres for the first
2363 data point of the array index with the corresponding value
2364 of <a href="#_array_structure_list.axis_set_id">_array_structure_list.axis_set_id</a>. If the index is
2365 specified as 'increasing', this will be the centre of the
2366 pixel with index value 1. If the index is specified as
2367 'decreasing', this will be the centre of the pixel with
2368 maximum index value.
2369 ;
2370 _item.name '<a href="#_array_structure_list_axis.displacement" >_array_structure_list_axis.displacement</a>'
2371 _item.category_id array_structure_list_axis
2372 _item.mandatory_code no
2373 _item_default.value 0.0
2374 _item_type.code float
2375 _item_units.code 'millimetres'
2376 save_
2377
2378 save_<a name="_array_structure_list_axis.fract_displacement" >_array_structure_list_axis.fract_displacement</a>
2379 _item_description.description
2380 ; The setting of the specified axis as a decimal fraction of
2381 the axis unit vector for the first data point of the array
2382 index with the corresponding value of
2383 <a href="#_array_structure_list.axis_set_id">_array_structure_list.axis_set_id</a>.
2384 If the index is specified as 'increasing', this will be the
2385 centre of the pixel with index value 1. If the index is
2386 specified as 'decreasing', this will be the centre of the
2387 pixel with maximum index value.
2388 ;
2389 _item.name '<a href="#_array_structure_list_axis.fract_displacement" >_array_structure_list_axis.fract_displacement</a>'
2390 _item.category_id array_structure_list_axis
2391 _item.mandatory_code no
2392 _item_default.value 0.0
2393 _item_type.code float
2394 save_
2395
2396 save_<a name="_array_structure_list_axis.displacement_increment">_array_structure_list_axis.displacement_increment</a>
2397 _item_description.description
2398 ; The pixel-centre-to-pixel-centre increment for the displacement
2399 setting of the specified axis in millimetres.
2400 ;
2401 _item.name
2402 '<a href="#_array_structure_list_axis.displacement_increment">_array_structure_list_axis.displacement_increment</a>'
2403 _item.category_id array_structure_list_axis
2404 _item.mandatory_code no
2405 _item_default.value 0.0
2406 _item_type.code float
2407 _item_units.code 'millimetres'
2408 save_
2409
2410 save_<a name="_array_structure_list_axis.fract_displacement_increment">_array_structure_list_axis.fract_displacement_increment</a>
2411 _item_description.description
2412 ; The pixel-centre-to-pixel-centre increment for the displacement
2413 setting of the specified axis as a decimal fraction of the
2414 axis unit vector.
2415 ;
2416 _item.name
2417 '<a href="#_array_structure_list_axis.fract_displacement_increment">_array_structure_list_axis.fract_displacement_increment</a>'
2418 _item.category_id array_structure_list_axis
2419 _item.mandatory_code no
2420 _item_default.value 0.0
2421 _item_type.code float
2422 _item_units.code 'millimetres'
2423 save_
2424
2425
2426 save_<a name="_array_structure_list_axis.angular_pitch">_array_structure_list_axis.angular_pitch</a>
2427 _item_description.description
2428 ; The pixel-centre-to-pixel-centre distance for a one-step
2429 change in the setting of the specified axis in millimetres.
2430
2431 This is meaningful only for 'constant velocity' spiral scans
2432 or for uncoupled angular scans at a constant radius
2433 (cylindrical scans) and should not be specified for cases
2434 in which the angle between pixels (rather than the distance
2435 between pixels) is uniform.
2436
2437 See <a href="#_array_structure_list_axis.angle_increment">_array_structure_list_axis.angle_increment</a>.
2438 ;
2439 _item.name '<a href="#_array_structure_list_axis.angular_pitch">_array_structure_list_axis.angular_pitch</a>'
2440 _item.category_id array_structure_list_axis
2441 _item.mandatory_code no
2442 _item_default.value 0.0
2443 _item_type.code float
2444 _item_units.code 'millimetres'
2445 save_
2446
2447
2448 save_<a name="_array_structure_list_axis.radial_pitch">_array_structure_list_axis.radial_pitch</a>
2449 _item_description.description
2450 ; The radial distance from one 'cylinder' of pixels to the
2451 next in millimetres. If the scan is a 'constant velocity'
2452 scan with differing angular displacements between pixels,
2453 the value of this item may differ significantly from the
2454 value of <a href="#_array_structure_list_axis.displacement_increment">_array_structure_list_axis.displacement_increment</a>.
2455 ;
2456 _item.name '<a href="#_array_structure_list_axis.radial_pitch">_array_structure_list_axis.radial_pitch</a>'
2457 _item.category_id array_structure_list_axis
2458 _item.mandatory_code no
2459 _item_default.value 0.0
2460 _item_type.code float
2461 _item_units.code 'millimetres'
2462 save_
2463
2464
2465 save_<a name="_array_structure_list_axis.reference_angle">_array_structure_list_axis.reference_angle</a>
2466 _item_description.description
2467 ; The value of _array_structure_list_axis.reference_angle
2468 specifies the setting of the angle of this axis used for
2469 determining a reference beam center and a reference detector
2470 distance. It is normally expected to be identical to the
2471 value of _array_structure_list.angle.
2472
2473 ;
2474 _item.name '<a href="#_array_structure_list_axis.reference_angle">_array_structure_list_axis.reference_angle</a>'
2475 _item.category_id array_structure_list_axis
2476 _item.mandatory_code implicit
2477 _item_type.code float
2478 _item_units.code 'degrees'
2479 save_
2480
2481
2482 save_<a name="_array_structure_list_axis.reference_displacement">_array_structure_list_axis.reference_displacement</a>
2483 _item_description.description
2484 ; The value of _array_structure_list_axis.reference_displacement
2485 specifies the setting of the displacement of this axis used
2486 for determining a reference beam center and a reference detector
2487 distance. It is normally expected to be identical to the value
2488 of _array_structure_list.displacement.
2489
2490 ;
2491 _item.name '<a href="#_array_structure_list_axis.reference_displacement">_array_structure_list_axis.reference_displacement</a>'
2492 _item.category_id array_structure_list_axis
2493 _item.mandatory_code implicit
2494 _item_type.code float
2495 _item_units.code 'millimetres'
2496 save_
2497
2498 save_<a name="_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a>
2499 _item_description.description
2500 ; The value of <a href="#_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a> gives the variant
2501 to which the given array_structure_list_axis row is related.
2502
2503 If this value is not given, the variant is assumed to the default
2504 null variant.
2505
2506 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
2507 <a href="#VARIANT">VARIANT</a> category.
2508 ;
2509 _item.name '<a href="#_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a>'
2510 _item.category_id array_structure_list_axis
2511 _item.mandatory_code no
2512 _item_type.code code
2513 save_
2514
2515
2516
2517 ########
2518 # <a name="AXIS">AXIS</a> #
2519 ########
2520
2521 save_AXIS
2522 _category.description
2523 ; Data items in the <a href="#AXIS">AXIS</a> category record the information required
2524 to describe the various goniometer, detector, source and other
2525 axes needed to specify a data collection or the axes defining the
2526 coordinate system of an image.
2527
2528 The location of each axis is specified by two vectors: the axis
2529 itself, given by a unit vector in the direction of the axis, and
2530 an offset to the base of the unit vector.
2531
2532 The vectors defining an axis are referenced to an appropriate
2533 coordinate system. The axis vector, itself, is a dimensionless
2534 unit vector. Where meaningful, the offset vector is given in
2535 millimetres. In coordinate systems not measured in metres,
2536 the offset is not specified and is taken as zero.
2537
2538 The available coordinate systems are:
2539
2540 The imgCIF standard laboratory coordinate system
2541 The direct lattice (fractional atomic coordinates)
2542 The orthogonal Cartesian coordinate system (real space)
2543 The reciprocal lattice
2544 An abstract orthogonal Cartesian coordinate frame
2545
2546 For consistency in this discussion, we call the three coordinate
2547 system axes <b>X</b>, <b>Y</b> and <b>Z</b>. This is appropriate for the imgCIF
2548 standard laboratory coordinate system, and last two Cartesian
2549 coordinate systems, but for the direct lattice, <b>X</b> corresponds
2550 to <b>a</b>, <b>Y</b> to <b>b</b> and <b>Z</b> to <b>c</b>, while for the reciprocal lattice,
2551 <b><b>X</b></b> corresponds to <b>a*</b>, <b>Y</b> to <b>b*</b> and <b>Z</b> to <b>c*</b>.
2552
2553 For purposes of visualization, all the coordinate systems are
2554 taken as right-handed, i.e., using the convention that the extended
2555 thumb of a right hand could point along the first (<b>X</b>) axis, the
2556 straightened pointer finger could point along the second (<b>Y</b>) axis
2557 and the middle finger folded inward could point along the third (<b>Z</b>)
2558 axis.
2559
2560 <b>THE IMGCIF STANDARD LABORATORY COORDINATE SYSTEM</b>
2561
2562 The imgCIF standard laboratory coordinate system is a right-handed
2563 orthogonal coordinate similar to the MOSFLM coordinate system,
2564 but imgCIF puts Z along the X-ray beam, rather than putting X along the
2565 X-ray beam as in MOSFLM.
2566
2567 The vectors for the imgCIF standard laboratory coordinate system
2568 form a right-handed Cartesian coordinate system with its origin
2569 in the sample or specimen. The origin of the axis system should,
2570 if possible, be defined in terms of mechanically stable axes to be
2571 be both in the sample and in the beam. If the sample goniometer or other
2572 sample positioner has two axes the intersection of which defines a
2573 unique point at which the sample should be mounted to be bathed
2574 by the beam, that will be the origin of the axis system. If no such
2575 point is defined, then the midpoint of the line of intersection
2576 between the sample and the center of the beam will define the origin.
2577 For this definition the sample positioning system will be set at
2578 its initial reference position for the experiment.
2579
2580
2581 | <b>Y</b> (to complete right-handed system)
2582 |
2583 |
2584 |
2585 |
2586 |
2587 |________________<b><b>X</b></b>
2588 / principal goniometer axis
2589 /
2590 /
2591 /
2592 /
2593 /<b>Z</b> (to source)
2594
2595
2596
2597
2598 Axis 1 (<b>X</b>): The <b>X</b>-axis is aligned to the mechanical axis pointing from
2599 the sample or specimen along the principal axis of the goniometer or
2600 sample positioning system if the sample positioning system has an axis
2601 that intersects the origin and which form an angle of more than 22.5
2602 degrees with the beam axis.
2603
2604 Axis 2 (<b>Y</b>): The <b>Y</b>-axis completes an orthogonal right-handed system
2605 defined by the <b><b>X</b></b>-axis and the <b>Z</b>-axis (see below).
2606
2607 Axis 3 (<b>Z</b>): The <b>Z</b>-axis is derived from the source axis which goes from
2608 the sample to the source. The <b>Z</b>-axis is the component of the source axis
2609 in the direction of the source orthogonal to the <b>X</b>-axis in the plane
2610 defined by the <b>X</b>-axis and the source axis.
2611
2612 If the conditions for the <b>X</b>-axis can be met, the coordinate system
2613 will be based on the goniometer or other sample positioning system
2614 and the beam and not on the orientation of the detector, gravity etc.
2615 The vectors necessary to specify all other axes are given by sets of
2616 three components in the order (<b>X</b>, <b>Y</b>, <b>Z</b>).
2617 If the axis involved is a rotation axis, it is right-handed, i.e. as
2618 one views the object to be rotated from the origin (the tail) of the
2619 unit vector, the rotation is clockwise. If a translation axis is
2620 specified, the direction of the unit vector specifies the sense of
2621 positive translation.
2622
2623 Note: This choice of coordinate system is similar to but significantly
2624 different from the choice in MOSFLM (Leslie &amp; Powell, 2004). In MOSFLM,
2625 <b>X</b> is along the X-ray beam (the CBF/imgCIF <b>Z</b> axis) and <b>Z</b> is along the
2626 rotation axis.
2627
2628 In some experimental techniques, there is no goniometer or the principal
2629 axis of the goniometer is at a small acute angle with respect to
2630 the source axis. In such cases, other reference axes are needed
2631 to define a useful coordinate system. The order of priority in
2632 defining directions in such cases is to use the detector, then
2633 gravity, then north.
2634
2635
2636 If the <b>X</b>-axis cannot be defined as above, then the
2637 direction (not the origin) of the X-axis should be parallel to the axis
2638 of the primary detector element corresponding to the most rapidly
2639 varying dimension of that detector element's data array, with its
2640 positive sense corresponding to increasing values of the index for
2641 that dimension. If the detector is such that such a direction cannot
2642 be defined (as with a point detector) or that direction forms an
2643 angle of less than 22.5 degrees with respect to the source axis, then
2644 the <b>X</b>-axis should be chosen so that if the <b>Y</b>-axis is chosen
2645 in the direction of gravity, and the <b>Z</b>-axis is chosen to be along
2646 the source axis, a right-handed orthogonal coordinate system is chosen.
2647 In the case of a vertical source axis, as a last resort, the
2648 <b>X</b>-axis should be chosen to point North.
2649
2650 All rotations are given in degrees and all translations are given in mm.
2651
2652 Axes may be dependent on one another. The <b>X</b>-axis is the only goniometer
2653 axis the direction of which is strictly connected to the hardware. All
2654 other axes are specified by the positions they would assume when the
2655 axes upon which they depend are at their zero points.
2656
2657 When specifying detector axes, the axis is given to the beam centre.
2658 The location of the beam centre on the detector should be given in the
2659 <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category in distortion-corrected millimetres from
2660 the (0,0) corner of the detector.
2661
2662 It should be noted that many different origins arise in the definition
2663 of an experiment. In particular, as noted above, it is necessary to
2664 specify the location of the beam centre on the detector in terms
2665 of the origin of the detector, which is, of course, not coincident
2666 with the centre of the sample.
2667
2668 The unit cell, reciprocal cell and crystallographic orthogonal
2669 Cartesian coordinate system are defined by the CELL and the matrices
2670 in the ATOM_SITES category.
2671
2672 <b>THE DIRECT LATTICE (FRACTIONAL COORDINATES)</b>
2673
2674 The direct lattice coordinate system is a system of fractional
2675 coordinates aligned to the crystal, rather than to the laboratory.
2676 This is a natural coordinate system for maps and atomic coordinates.
2677 It is the simplest coordinate system in which to apply symmetry.
2678 The axes are determined by the cell edges, and are not necessarily
2679 othogonal. This coordinate system is not uniquely defined and
2680 depends on the cell parameters in the CELL category and the
2681 settings chosen to index the crystal.
2682
2683 Molecules in a crystal studied by X-ray diffracraction are organized
2684 into a repeating regular array of unit cells. Each unit cell is defined
2685 by three vectors, <b>a</b>, <b>b</b> and <b>c</b>. To quote from Drenth,
2686
2687
2688 "The choice of the unit cell is not unique and therefore, guidelines
2689 have been established for selecting the standard basis vectors and
2690 the origin. They are based on symmetry and metric considerations:
2691
2692 "(1) The axial system should be right handed.
2693 (2) The basis vectors should coincide as much as possible with
2694 directions of highest symmetry."
2695 (3) The cell taken should be the smallest one that satisfies
2696 condition (2)
2697 (4) Of all the lattice vectors, none is shorter than <b>a</b>.
2698 (5) Of those not directed along <b>a</b>, none is shorter than <b>b</b>.
2699 (6) Of those not lying in the <b>ab</b> plane, none is shorter than c.
2700 (7) The three angles between the basis vectors <b>a</b>, <b>b</b> and <b>c</b> are
2701 either all acute (&lt;90\%) or all obtuse (&ge;90\%)."
2702
2703 These rules do not produce a unique result that is stable under
2704 the assumption of experimental errors, and the the resulting cell
2705 may not be primitive.
2706
2707 In this coordinate system, the vector (.5, .5, .5) is in the middle
2708 of the given unit cell.
2709
2710 Grid coordinates are an important variation on fractional coordinates
2711 used when working with maps. In imgCIF, the conversion from
2712 fractional to grid coordinates is implicit in the array indexing
2713 specified by _array_structure_list.dimension. Note that this
2714 implicit grid-coordinate scheme is 1-based, not zero-based, i.e.
2715 the origin of the cell for axes along the cell edges with no
2716 specified _array_structure_list_axis.displacement will have
2717 grid coordinates of (1,1,1), i.e. array indices of (1,1,1).
2718
2719 <b>THE ORTHOGONAL CARTESIAN COORDINATE SYSTEM (REAL SPACE)</b>
2720
2721 The orthogonal Cartesian coordinate system is a transformation of
2722 the direct lattice to the actual physical coordinates of atoms in
2723 space. It is similar to the laboratory coordinate system, but
2724 is anchored to and moves with the crystal, rather than being
2725 schored to the laboratory. The transformation from fractional
2726 to orthogonal cartesian coordinates is given by the
2727 _atom_sites.Cartn_transf_matrix[i][j] and
2728 _atom_sites.Cartn_transf_vector[i]
2729 tags. A common choice for the matrix of the transformation is
2730 given in the 1992 PDB format document
2731
2732 | a b cos(\g) c cos(\b) |
2733 | 0 b sin(\g) c (cos(\a) - cos(\b)cos(\g))/sin(\g) |
2734 | 0 0 V/(a b sin(\g)) |
2735
2736 This is a convenient coordinate system in which to do fitting
2737 of models to maps and in which to understand the chemistry of
2738 a molecule.
2739
2740 <b>THE RECIPROCAL LATTICE</b>
2741
2742 The reciprocal lattice coordinate system is used for diffraction
2743 intensitities. It is based on the reciprocal cell, the dual of the cell,
2744 in which reciprocal cell edges are derived from direct cell faces:
2745
2746 a* = bc sin(\a)/V b* = ac sin(\b)/V c* = ab sin(\g)/V
2747 cos(\a*) = (cos(\b) cos(\g) - cos(\a))/(sin(\b) sin(\g))
2748 cos(\b*) = (cos(\a) cos(\g) - cos(\b))/(sin(\a) sin(\g))
2749 cos(\g*) = (cos(\a) cos(\b) - cos(\g))/(sin(\a) sin(\b))
2750 V = abc SQRT(1 - cos(\a)^<sup>2</sup>^
2751 - cos(\b)^<sup>2</sup>^
2752 - cos(\g)^<sup>2</sup>^
2753 + 2 cos(\a) cos(\b) cos(\g) )
2754
2755 In this form the dimensions of the reciprocal lattice are in reciprocal
2756 \%Angstroms (\%A^<sup>-1</sup>^). A dimensionless form can be obtained by
2757 multiplying by the wavelength. Reflections are commonly indexed against
2758 this coordinate system as (h, k, l) triples.
2759
2760
2761 References:
2762
2763 Drenth, J., "Introduction to basic crystallography." chapter
2764 2.1 in Rossmann, M. G. and Arnold, E. "Crystallography of
2765 biological macromolecules", Volume F of the IUCr's "International
2766 tables for crystallography", Kluwer, Dordrecht 2001, pp 44 -- 63
2767
2768 Leslie, A. G. W. and Powell, H. (2004). MOSFLM v6.11.
2769 MRC Laboratory of Molecular Biology, Hills Road, Cambridge, England.
2770 http://www.CCP4.ac.uk/dist/<b>X</b>-windows/Mosflm/.
2771
2772 Stout, G. H. and Jensen, L. H., "X-ray structure determination",
2773 2nd ed., Wiley, New York, 1989, 453 pp.
2774
2775 __, "PROTEIN DATA BANK ATOMIC COORDINATE AND BIBLIOGRAPHIC ENTRY
2776 FORMAT DESCRIPTION," Brookhaven National Laboratory, February 1992.
2777 ;
2778 _category.id axis
2779 _category.mandatory_code no
2780 loop_
2781 _category_key.name '<a href="#_axis.id" >_axis.id</a>'
2782 '<a href="#_axis.equipment">_axis.equipment</a>'
2783 '<a href="#_axis.variant">_axis.variant</a>'
2784 loop_
2785 _category_group.id 'inclusive_group'
2786 'axis_group'
2787 'diffrn_group'
2788 loop_
2789 _category_examples.detail
2790 _category_examples.case
2791 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2792 ; Example 1 -
2793
2794 This example shows the axis specification of the axes of a kappa-
2795 geometry goniometer [see Stout, G. H. &amp; Jensen, L. H. (1989). X-ray
2796 structure determination. A practical
2797 guide, 2nd ed. p. 134. New York: Wiley Interscience].
2798
2799 There are three axes specified, and no offsets. The outermost axis,
2800 omega, is pointed along the <b>X</b> axis. The next innermost axis, kappa,
2801 is at a 50 degree angle to the <b>X</b> axis, pointed away from the source.
2802 The innermost axis, phi, aligns with the <b>X</b> axis when omega and
2803 phi are at their zero points. If T-omega, T-kappa and T-phi
2804 are the transformation matrices derived from the axis settings,
2805 the complete transformation would be:
2806 <b>X</b>' = (T-omega) (T-kappa) (T-phi) <b>X</b>
2807 ;
2808 ;
2809 loop_
2810 <a href="#_axis.id" >_axis.id</a>
2811 <a href="#_axis.type" >_axis.type</a>
2812 <a href="#_axis.equipment" >_axis.equipment</a>
2813 <a href="#_axis.depends_on" >_axis.depends_on</a>
2814 <a href="#_axis.vector[1]" >_axis.vector[1]</a> <a href="#_axis.vector[2]" >_axis.vector[2]</a> <a href="#_axis.vector[3]" >_axis.vector[3]</a>
2815 omega rotation goniometer . 1 0 0
2816 kappa rotation goniometer omega -.64279 0 -.76604
2817 phi rotation goniometer kappa 1 0 0
2818 ;
2819 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2820 ; Example 2 -
2821
2822 This example shows the axis specification of the axes of a
2823 detector, source and gravity. The order has been changed as a
2824 reminder that the ordering of presentation of tokens is not
2825 significant. The centre of rotation of the detector has been taken
2826 to be 68 millimetres in the direction away from the source.
2827 ;
2828 ;
2829 loop_
2830 <a href="#_axis.id" >_axis.id</a>
2831 <a href="#_axis.type" >_axis.type</a>
2832 <a href="#_axis.equipment" >_axis.equipment</a>
2833 <a href="#_axis.depends_on" >_axis.depends_on</a>
2834 <a href="#_axis.vector[1]" >_axis.vector[1]</a> <a href="#_axis.vector[2]" >_axis.vector[2]</a> <a href="#_axis.vector[3]" >_axis.vector[3]</a>
2835 <a href="#_axis.offset[1]">_axis.offset[1]</a> <a href="#_axis.offset[2]">_axis.offset[2]</a> <a href="#_axis.offset[3]">_axis.offset[3]</a>
2836 source . source . 0 0 1 . . .
2837 gravity . gravity . 0 -1 0 . . .
2838 tranz translation detector rotz 0 0 1 0 0 -68
2839 twotheta rotation detector . 1 0 0 . . .
2840 roty rotation detector twotheta 0 1 0 0 0 -68
2841 rotz rotation detector roty 0 0 1 0 0 -68
2842 ;
2843 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2844 ; Example 3 -
2845
2846 This example show the axis specification of the axes for a map,
2847 using fractional coordinates. Each cell edge has been divided
2848 into a grid of 50 divisions in the ARRAY_STRUCTURE_LIST_AXIS
2849 category. The map is using only the first octant of the grid
2850 in the ARRAY_STRUCTURE_LIST category.
2851
2852 The fastest changing axis is the gris along A, then along B,
2853 and the slowest is along C.
2854
2855 The map sampling is being done in the middle of each grid
2856 division
2857
2858 ;
2859 ;
2860 loop_
2861 <a href="#_axis.id" >_axis.id</a>
2862 <a href="#_axis.system">_axis.system</a>
2863 <a href="#_axis.vector[1]" >_axis.vector[1]</a> <a href="#_axis.vector[2]" >_axis.vector[2]</a> <a href="#_axis.vector[3]" >_axis.vector[3]</a>
2864 CELL_A_AXIS fractional 1 0 0
2865 CELL_B_AXIS fractional 0 1 0
2866 CELL_C_AXIS fractional 0 0 1
2867
2868 loop_
2869 _array_structure_list.array_id
2870 _array_structure_list.index
2871 _array_structure_list.dimension
2872 _array_structure_list.precedence
2873 _array_structure_list.direction
2874 _array_structure_list.axis_id
2875 MAP 1 25 1 increasing CELL_A_AXIS
2876 MAP 1 25 2 increasing CELL_B_AXIS
2877 MAP 1 25 3 increasing CELL_C_AXIS
2878
2879 loop_
2880 _array_structure_list_axis.axis_id
2881 _array_structure_list_axis.fract_displacement
2882 _array_structure_list_axis.fract_displacement_increment
2883 CELL_A_AXIS 0.01 0.02
2884 CELL_B_AXIS 0.01 0.02
2885 CELL_C_AXIS 0.01 0.02
2886
2887
2888
2889 ;
2890 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2891 ; Example 4 -
2892
2893 This example show the axis specification of the axes for a map,
2894 this time as orthogonal \%Angstroms, using the same coordinate system
2895 as for the atomic coordinates. The map is sampling every 1.5
2896 \%Angstroms (1.5e-7 millimeters) in a map segment 37.5 \%Angstroms on
2897 a side.
2898
2899 ;
2900 ;
2901 loop_
2902 <a href="#_axis.id" >_axis.id</a>
2903 <a href="#_axis.system">_axis.system</a>
2904 <a href="#_axis.vector[1]" >_axis.vector[1]</a> <a href="#_axis.vector[2]" >_axis.vector[2]</a> <a href="#_axis.vector[3]" >_axis.vector[3]</a>
2905 X orthogonal 1 0 0
2906 Y orthogonal 0 1 0
2907 Z orthogonal 0 0 1
2908
2909 loop_
2910 _array_structure_list.array_id
2911 _array_structure_list.index
2912 _array_structure_list.dimension
2913 _array_structure_list.precedence
2914 _array_structure_list.direction
2915 _array_structure_list.axis_id
2916 MAP 1 25 1 increasing X
2917 MAP 2 25 2 increasing Y
2918 MAP 3 25 3 increasing Z
2919
2920 loop_
2921 _array_structure_list_axis.axis_id
2922 _array_structure_list_axis.displacement
2923 _array_structure_list_axis.displacement_increment
2924 X 7.5e-8 1.5e-7
2925 Y 7.5e-8 1.5e-7
2926 Z 7.5e-8 1.5e-7
2927
2928
2929 ;
2930 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2931 save_
2932
2933
2934 save_<a name="_axis.depends_on" >_axis.depends_on</a>
2935 _item_description.description
2936 ; The value of <a href="#_axis.depends_on" >_axis.depends_on</a> specifies the next outermost
2937 axis upon which this axis depends.
2938
2939 This item is a pointer to <a href="#_axis.id">_axis.id</a> in the same category.
2940 ;
2941 _item.name '<a href="#_axis.depends_on">_axis.depends_on</a>'
2942 _item.category_id axis
2943 _item.mandatory_code no
2944
2945 save_
2946
2947
2948 save_<a name="_axis.equipment" >_axis.equipment</a>
2949 _item_description.description
2950 ; The value of <a href="#_axis.equipment" >_axis.equipment</a> specifies the type of
2951 equipment using the axis: 'goniometer', 'detector',
2952 'gravity', 'source' or 'general'.
2953 ;
2954 _item.name '<a href="#_axis.equipment">_axis.equipment</a>'
2955 _item.category_id axis
2956 _item.mandatory_code no
2957 _item_type.code ucode
2958 _item_default.value general
2959 loop_
2960 _item_enumeration.value
2961 _item_enumeration.detail goniometer
2962 'equipment used to orient or position samples'
2963 detector
2964 'equipment used to detect reflections'
2965 general
2966 'equipment used for general purposes'
2967 gravity
2968 'axis specifying the downward direction'
2969 source
2970 'axis specifying the direction sample to source'
2971
2972 save_
2973
2974
2975 save_<a name="_axis.offset[1]" >_axis.offset[1]</a>
2976 _item_description.description
2977 ; The [1] element of the three-element vector used to specify
2978 the offset to the base of a rotation or translation axis.
2979
2980 The vector is specified in millimetres.
2981 ;
2982 _item.name '<a href="#_axis.offset[1]">_axis.offset[1]</a>'
2983 _item.category_id axis
2984 _item.mandatory_code no
2985 _item_default.value 0.0
2986 _item_sub_category.id vector
2987 _item_type.code float
2988 _item_units.code millimetres
2989 save_
2990
2991
2992 save_<a name="_axis.offset[2]" >_axis.offset[2]</a>
2993 _item_description.description
2994 ; The [2] element of the three-element vector used to specify
2995 the offset to the base of a rotation or translation axis.
2996
2997 The vector is specified in millimetres.
2998 ;
2999 _item.name '<a href="#_axis.offset[2]">_axis.offset[2]</a>'
3000 _item.category_id axis
3001 _item.mandatory_code no
3002 _item_default.value 0.0
3003 _item_sub_category.id vector
3004 _item_type.code float
3005 _item_units.code millimetres
3006 save_
3007
3008
3009 save_<a name="_axis.offset[3]" >_axis.offset[3]</a>
3010 _item_description.description
3011 ; The [3] element of the three-element vector used to specify
3012 the offset to the base of a rotation or translation axis.
3013
3014 The vector is specified in millimetres.
3015 ;
3016 _item.name '<a href="#_axis.offset[3]">_axis.offset[3]</a>'
3017 _item.category_id axis
3018 _item.mandatory_code no
3019 _item_default.value 0.0
3020 _item_sub_category.id vector
3021 _item_type.code float
3022 _item_units.code millimetres
3023 save_
3024
3025
3026 save_<a name="_axis.id" >_axis.id</a></a>
3027 _item_description.description
3028 ; The value of <a href="#_axis.id" >_axis.id</a> must uniquely identify
3029 each axis relevant to the experiment. Note that multiple
3030 pieces of equipment may share the same axis (e.g. a twotheta
3031 arm), so the category key for <a href="#AXIS">AXIS</a> also includes the
3032 equipment.
3033 ;
3034 loop_
3035 _item.name
3036 _item.category_id
3037 _item.mandatory_code
3038 '<a href="#_axis.id" >_axis.id</a>' axis yes
3039 '<a href="#_array_structure_list_axis.axis_id" >_array_structure_list_axis.axis_id</a>'
3040 array_structure_list_axis
3041 yes
3042 '<a href="#_diffrn_detector_axis.axis_id" >_diffrn_detector_axis.axis_id</a>' diffrn_detector_axis yes
3043 '<a href="#_diffrn_measurement_axis.axis_id" >_diffrn_measurement_axis.axis_id</a>' diffrn_measurement_axis yes
3044 '<a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>' diffrn_scan_axis yes
3045 '<a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>' diffrn_scan_frame_axis yes
3046
3047 _item_type.code code
3048 loop_
3049 _item_linked.child_name
3050 _item_linked.parent_name
3051 '<a href="#_axis.depends_on" >_axis.depends_on</a>' '<a href="#_axis.id" >_axis.id</a>'
3052 '<a href="#_array_structure_list_axis.axis_id" >_array_structure_list_axis.axis_id</a>' '<a href="#_axis.id" >_axis.id</a>'
3053 '<a href="#_diffrn_detector_axis.axis_id" >_diffrn_detector_axis.axis_id</a>' '<a href="#_axis.id" >_axis.id</a>'
3054 '<a href="#_diffrn_measurement_axis.axis_id" >_diffrn_measurement_axis.axis_id</a>' '<a href="#_axis.id" >_axis.id</a>'
3055 '<a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>' '<a href="#_axis.id" >_axis.id</a>'
3056 '<a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>' '<a href="#_axis.id" >_axis.id</a>'
3057
3058 save_
3059
3060 save_<a name="_axis.system" >_axis.system</a>
3061 _item_description.description
3062 ; The value of <a href="#_axis.system" >_axis.system</a> specifies the coordinate
3063 system used to define the axis: 'laboratory', 'direct',
3064 'orthogonal', 'reciprocal' or 'abstract'.
3065 ;
3066 _item.name '<a href="#_axis.system">_axis.system</a>'
3067 _item.category_id axis
3068 _item.mandatory_code no
3069 _item_type.code ucode
3070 _item_default.value laboratory
3071 loop_
3072 _item_enumeration.value
3073 _item_enumeration.detail
3074
3075 laboratory
3076 ; the axis is referenced to the imgCIF standard laboratory Cartesian
3077 coordinate system
3078 ;
3079
3080 direct
3081 ; the axis is referenced to the direct lattice
3082 ;
3083
3084 orthogonal
3085 ; the axis is referenced to the cell Cartesian orthogonal coordinates
3086 ;
3087
3088 reciprocal
3089 ; the axis is referenced to the reciprocal lattice
3090 ;
3091
3092 abstract
3093 ; the axis is referenced to abstract Cartesian cooridinate system
3094 ;
3095
3096 save_
3097
3098
3099 save_<a name="_axis.type" >_axis.type</a>
3100 _item_description.description
3101 ; The value of <a href="#_axis.type" >_axis.type</a> specifies the type of
3102 axis: 'rotation' or 'translation' (or 'general' when
3103 the type is not relevant, as for gravity).
3104 ;
3105 _item.name '<a href="#_axis.type">_axis.type</a>'
3106 _item.category_id axis
3107 _item.mandatory_code no
3108 _item_type.code ucode
3109 _item_default.value general
3110 loop_
3111 _item_enumeration.value
3112 _item_enumeration.detail rotation
3113 'right-handed axis of rotation'
3114 translation
3115 'translation in the direction of the axis'
3116 general
3117 'axis for which the type is not relevant'
3118
3119 save_
3120
3121
3122 save_<a name="_axis.vector[1]" >_axis.vector[1]</a>
3123 _item_description.description
3124 ; The [1] element of the three-element vector used to specify
3125 the direction of a rotation or translation axis.
3126 The vector should be normalized to be a unit vector and
3127 is dimensionless.
3128 ;
3129 _item.name '<a href="#_axis.vector[1]" >_axis.vector[1]</a>'
3130 _item.category_id axis
3131 _item.mandatory_code no
3132 _item_default.value 0.0
3133 _item_sub_category.id vector
3134 _item_type.code float
3135 save_
3136
3137 save_<a name="_axis.vector[2]" >_axis.vector[2]</a>
3138 _item_description.description
3139 ; The [2] element of the three-element vector used to specify
3140 the direction of a rotation or translation axis.
3141 The vector should be normalized to be a unit vector and
3142 is dimensionless.
3143 ;
3144 _item.name '<a href="#_axis.vector[2]" >_axis.vector[2]</a>'
3145 _item.category_id axis
3146 _item.mandatory_code no
3147 _item_default.value 0.0
3148 _item_sub_category.id vector
3149 _item_type.code float
3150 save_
3151
3152 save_<a name="_axis.vector[3]" >_axis.vector[3]</a>
3153 _item_description.description
3154 ; The [3] element of the three-element vector used to specify
3155 the direction of a rotation or translation axis.
3156 The vector should be normalized to be a unit vector and
3157 is dimensionless.
3158 ;
3159 _item.name '<a href="#_axis.vector[3]" >_axis.vector[3]</a>'
3160 _item.category_id axis
3161 _item.mandatory_code no
3162 _item_default.value 0.0
3163 _item_sub_category.id vector
3164 _item_type.code float
3165 save_
3166
3167 save_<a name="_axis.variant" >_axis.variant</a>
3168 _item_description.description
3169 ; The value of <a href="#_axis.variant" >_axis.variant</a> gives the variant
3170 to which the given axis row is related.
3171
3172 If this value is not given, the variant is assumed to the default
3173 null variant.
3174
3175 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
3176 <a href="#VARIANT">VARIANT</a> category.
3177 ;
3178 _item.name '<a href="#_axis.variant" >_axis.variant</a>'
3179 _item.category_id axis
3180 _item.mandatory_code no
3181 _item_type.code code
3182 save_
3183
3184
3185
3186 #####################
3187 # <a name="DIFFRN_DATA_FRAME" >DIFFRN_DATA_FRAME</a> #
3188 #####################
3189
3190
3191 save_DIFFRN_DATA_FRAME
3192 _category.description
3193 ; Data items in the <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category record
3194 the details about each frame of data.
3195
3196 The items in this category were previously in a
3197 DIFFRN_FRAME_DATA category, which is now deprecated.
3198 The items from the old category are provided
3199 as aliases but should not be used for new work.
3200 ;
3201 _category.id diffrn_data_frame
3202 _category.mandatory_code no
3203 loop_
3204 _category_key.name '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3205 '<a href="#_diffrn_data_frame.detector_element_id" >_diffrn_data_frame.detector_element_id</a>'
3206 '<a href="#_diffrn_data_frame.variant" >_diffrn_data_frame.variant</a>'
3207 loop_
3208 _category_group.id 'inclusive_group'
3209 'array_data_group'
3210 'diffrn_group'
3211 loop_
3212 _category_examples.detail
3213 _category_examples.case
3214 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3215 ; Example 1 - A frame containing data from 4 frame elements.
3216 Each frame element has a common array configuration
3217 'array_1' described in <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> and related
3218 categories. The data for each detector element are
3219 stored in four groups of binary data in the
3220 <a href="#ARRAY_DATA">ARRAY_DATA</a> category, linked by the array_id and
3221 binary_id.
3222 ;
3223 ;
3224 loop_
3225 <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>
3226 <a href="#_diffrn_data_frame.detector_element_id" >_diffrn_data_frame.detector_element_id</a>
3227 <a href="#_diffrn_data_frame.array_id" >_diffrn_data_frame.array_id</a>
3228 <a href="#_diffrn_data_frame.binary_id" >_diffrn_data_frame.binary_id</a>
3229 frame_1 d1_ccd_1 array_1 1
3230 frame_1 d1_ccd_2 array_1 2
3231 frame_1 d1_ccd_3 array_1 3
3232 frame_1 d1_ccd_4 array_1 4
3233 ;
3234 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3235 save_
3236
3237
3238 save_<a name="_diffrn_data_frame.array_id" >_diffrn_data_frame.array_id</a>
3239 _item_description.description
3240 ; This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
3241 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
3242 ;
3243 _item.name '<a href="#_diffrn_data_frame.array_id" >_diffrn_data_frame.array_id</a>'
3244 _item.category_id diffrn_data_frame
3245 _item.mandatory_code implicit
3246 _item_aliases.alias_name '_diffrn_frame_data.array_id'
3247 _item_aliases.dictionary cif_img.dic
3248 _item_aliases.version 1.0
3249 _item_type.code code
3250 save_
3251
3252
3253 save_<a name="_diffrn_data_frame.binary_id" >_diffrn_data_frame.binary_id</a>
3254 _item_description.description
3255 ; This item is a pointer to <a href="#_array_data.binary_id" >_array_data.binary_id</a> in the
3256 <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
3257 ;
3258 _item.name '<a href="#_diffrn_data_frame.binary_id" >_diffrn_data_frame.binary_id</a>'
3259 _item.category_id diffrn_data_frame
3260 _item.mandatory_code implicit
3261 _item_aliases.alias_name '_diffrn_frame_data.binary_id'
3262 _item_aliases.dictionary cif_img.dic
3263 _item_aliases.version 1.0
3264 _item_type.code int
3265 save_
3266
3267
3268 save_<a name="_diffrn_data_frame.center_fast">_diffrn_data_frame.center_fast</a>
3269 _item_description.description
3270 ; The value of <a href="#_diffrn_data_frame.center_fast">_diffrn_data_frame.center_fast</a> is
3271 the fast index axis beam center position relative to the detector
3272 element face in the units specified in the data item
3273 '<a href="#_diffrn_data_frame.center_units">_diffrn_data_frame.center_units</a>' along the fast
3274 axis of the detector from the center of the first pixel to
3275 the point at which the Z-axis (which should be colinear with the
3276 beam) intersects the face of the detector, if in fact is does.
3277 At the time of the measurement the current setting of detector
3278 positioner given frame are used.
3279
3280 It is important to note that for measurements in millimetres,
3281 the sense of the axis is used, rather than the sign of the
3282 pixel-to-pixel increments.
3283
3284 ;
3285 _item.name '<a href="#_diffrn_data_frame.center_fast">_diffrn_data_frame.center_fast</a>'
3286 _item.category_id diffrn_data_frame
3287 _item.mandatory_code no
3288 _item_type.code float
3289
3290 save_
3291
3292
3293 save_<a name="_diffrn_data_frame.center_slow">_diffrn_data_frame.center_slow</a>
3294 _item_description.description
3295 ; The value of <a href="#_diffrn_data_frame.center_slow">_diffrn_data_frame.center_slow</a> is
3296 the slow index axis beam center position relative to the detector
3297 element face in the units specified in the data item
3298 '<a href="#_diffrn_data_frame.center_units">_diffrn_data_frame.center_units</a>' along the slow
3299 axis of the detector from the center of the first pixel to
3300 the point at which the Z-axis (which should be colinear with the
3301 beam) intersects the face of the detector, if in fact is does.
3302 At the time of the measurement the current setting of detector
3303 positioner given frame are used.
3304
3305 It is important to note that the sense of the axis is used,
3306 rather than the sign of the pixel-to-pixel increments.
3307
3308 ;
3309 _item.name '<a href="#_diffrn_data_frame.center_slow">_diffrn_data_frame.center_slow</a>'
3310 _item.category_id diffrn_data_frame
3311 _item.mandatory_code no
3312 _item_type.code float
3313
3314 save_
3315
3316
3317 save_<a name="_diffrn_data_frame.center_units">_diffrn_data_frame.center_units</a>
3318 _item_description.description
3319 ; The value of <a href="#_diffrn_data_frame.center_units">_diffrn_data_frame.center_units</a>
3320 specifies the units in which the values of
3321 '<a href="#_diffrn_data_frame.center_fast">_diffrn_data_frame.center_fast</a>' and
3322 '<a href="#_diffrn_data_frame.center_slow">_diffrn_data_frame.center_slow</a>'
3323 are presented. The default is 'mm' for millimetres. The
3324 alternatives are 'pixels' and 'bins'. In all cases the
3325 center distances are measured from the center of the
3326 first pixel, i.e. in a 2x2 binning, the measuring origin
3327 is offset from the centers of the bins by one half pixel
3328 towards the first pixel.
3329
3330 If 'bins' is specified, the data in
3331 '<a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>',
3332 '<a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a>', and
3333 '<a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>'
3334 is used to define the binning scheme.
3335
3336
3337 ;
3338 _item.name '<a href="#_diffrn_data_frame.center_units">_diffrn_data_frame.center_units</a>'
3339 _item.category_id diffrn_data_frame
3340 _item.mandatory_code no
3341 _item_type.code code
3342 loop_
3343 _item_enumeration.value
3344 _item_enumeration.detail
3345 mm 'millimetres'
3346 pixels 'detector pixels'
3347 bins 'detector bins'
3348
3349 save_
3350
3351
3352
3353
3354 save_<a name="_diffrn_data_frame.detector_element_id" >_diffrn_data_frame.detector_element_id</a>
3355 _item_description.description
3356 ; This item is a pointer to <a href="#_diffrn_detector_element.id">_diffrn_detector_element.id</a>
3357 in the <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a> category.
3358 ;
3359 _item.name '<a href="#_diffrn_data_frame.detector_element_id" >_diffrn_data_frame.detector_element_id</a>'
3360 _item.category_id diffrn_data_frame
3361 _item.mandatory_code yes
3362 _item_aliases.alias_name '_diffrn_frame_data.detector_element_id'
3363 _item_aliases.dictionary cif_img.dic
3364 _item_aliases.version 1.0
3365 _item_type.code code
3366 save_
3367
3368
3369 save_<a name="_diffrn_data_frame.id" >_diffrn_data_frame.id</a>
3370 _item_description.description
3371 ; The value of <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a> must uniquely identify
3372 each complete frame of data.
3373 ;
3374 loop_
3375 _item.name
3376 _item.category_id
3377 _item.mandatory_code
3378 '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>' diffrn_data_frame yes
3379 '<a href="#_diffrn_refln.frame_id" >_diffrn_refln.frame_id</a>' diffrn_refln yes
3380 '<a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>' diffrn_scan yes
3381 '<a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>' diffrn_scan yes
3382 '<a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>' diffrn_scan_frame yes
3383 '<a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>'
3384 diffrn_scan_frame_axis
3385 yes
3386 '<a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a>'
3387 diffrn_scan_frame_monitor
3388 implicit
3389 _item_aliases.alias_name '_diffrn_frame_data.id'
3390 _item_aliases.dictionary cif_img.dic
3391 _item_aliases.version 1.0
3392 _item_type.code code
3393 loop_
3394 _item_linked.child_name
3395 _item_linked.parent_name
3396 '<a href="#_diffrn_refln.frame_id" >_diffrn_refln.frame_id</a>' '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3397 '<a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>' '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3398 '<a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>' '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3399 '<a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>' '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3400 '<a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>'
3401 '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3402 '<a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a>'
3403 '<a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>'
3404 save_
3405
3406
3407 save_<a name="_diffrn_data_frame.details" >_diffrn_data_frame.details</a>
3408 _item_description.description
3409 ; The value of <a href="#_diffrn_data_frame.details" >_diffrn_data_frame.details</a> should give a
3410 description of special aspects of each frame of data.
3411
3412 This is an appropriate location in which to record
3413 information from vendor headers as presented in those
3414 headers, but it should never be used as a substitute
3415 for providing the fully parsed information within
3416 the appropriate imgCIF/CBF categories.
3417
3418 Normally, when a conversion from a miniCBF has been done
3419 the data from '<a href="#_array_data.header_convention">_array_data.header_convention</a>'
3420 should be transferred to this data item and
3421 '<a href="#_array_data.header_convention">_array_data.header_convention</a>'
3422 should be removed.
3423 ;
3424 _item.name '<a name="_diffrn_data_frame.details" >_diffrn_data_frame.details</a>'
3425 _item.category_id diffrn_data_frame
3426 _item.mandatory_code no
3427 _item_aliases.alias_name '_diffrn_frame_data.details'
3428 _item_aliases.dictionary cif_img.dic
3429 _item_aliases.version 1.4
3430 _item_type.code text
3431 loop_
3432 _item_examples.case
3433 _item_examples.detail
3434 ;
3435 HEADER_BYTES = 512;
3436 DIM = 2;
3437 BYTE_ORDER = big_endian;
3438 TYPE = unsigned_short;
3439 SIZE1 = 3072;
3440 SIZE2 = 3072;
3441 PIXEL_SIZE = 0.102588;
3442 BIN = 2x2;
3443 DETECTOR_SN = 901;
3444 TIME = 29.945155;
3445 DISTANCE = 200.000000;
3446 PHI = 85.000000;
3447 OSC_START = 85.000000;
3448 OSC_RANGE = 1.000000;
3449 WAVELENGTH = 0.979381;
3450 BEAM_CENTER_X = 157.500000;
3451 BEAM_CENTER_Y = 157.500000;
3452 PIXEL SIZE = 0.102588;
3453 OSCILLATION RANGE = 1;
3454 EXPOSURE TIME = 29.9452;
3455 TWO THETA = 0;
3456 BEAM CENTRE = 157.5 157.5;
3457 ;
3458 ; Example of header information extracted from an ADSC Quantum
3459 315 detector header by CBFlib_0.7.6. Image provided by Chris
3460 Nielsen of ADSC from a data collection at SSRL beamline 1-5.
3461 ;
3462 save_
3463
3464 save_<a name="_diffrn_data_frame.variant" >_diffrn_data_frame.variant</a>
3465 _item_description.description
3466 ; The value of <a href="#_diffrn_data_frame.variant" >_diffrn_data_frame.variant</a> gives the variant
3467 to which the given diffrn_data_frame row is related.
3468
3469 If this value is not given, the variant is assumed to the default
3470 null variant.
3471
3472 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
3473 <a href="#VARIANT">VARIANT</a> category.
3474 ;
3475 _item.name '<a href="#_diffrn_data_frame.variant" >_diffrn_data_frame.variant</a>'
3476 _item.category_id diffrn_data_frame
3477 _item.mandatory_code no
3478 _item_type.code code
3479 save_
3480
3481
3482
3483 ##########################################################################
3484 # The following is a restatement of the mmCIF <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a>, #
3485 # <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> and <a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a> categories, modified for #
3486 # the CBF/imgCIF extensions #
3487 ##########################################################################
3488
3489 ###################
3490 # <a name="DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> #
3491 ###################
3492
3493
3494 save_DIFFRN_DETECTOR
3495 _category.description
3496 ; Data items in the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category describe the
3497 detector used to measure the scattered radiation, including
3498 any analyser and post-sample collimation.
3499 ;
3500 _category.id diffrn_detector
3501 _category.mandatory_code no
3502 loop_
3503 _category_key.name '<a href="#_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a>'
3504 '<a href="#_diffrn_detector.id" >_diffrn_detector.id</a>'
3505 '<a href="#_diffrn_detector.variant" >_diffrn_detector.variant</a>'
3506 loop_
3507 _category_group.id 'inclusive_group'
3508 'diffrn_group'
3509 loop_
3510 _category_examples.detail
3511 _category_examples.case
3512 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3513 ; Example 1 - based on PDB entry 5HVP and laboratory records for the
3514 structure corresponding to PDB entry 5HVP.
3515 ;
3516 ;
3517 <a href="#_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a> 'd1'
3518 <a href="#_diffrn_detector.detector" >_diffrn_detector.detector</a> 'multiwire'
3519 <a href="#_diffrn_detector.type" >_diffrn_detector.type</a> 'Siemens'
3520 ;
3521 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3522 save_
3523
3524
3525 save_<a name="_diffrn_detector.details" >_diffrn_detector.details</a>
3526 _item_description.description
3527 ; A description of special aspects of the radiation detector.
3528 ;
3529 _item.name '<a href="#_diffrn_detector.details" >_diffrn_detector.details</a>'
3530 _item.category_id diffrn_detector
3531 _item.mandatory_code no
3532 _item_aliases.alias_name '_diffrn_detector_details'
3533 _item_aliases.dictionary cif_core.dic
3534 _item_aliases.version 2.0.1
3535 _item_type.code text
3536 _item_examples.case 'slow mode'
3537 save_
3538
3539
3540 save_<a name="_diffrn_detector.detector" >_diffrn_detector.detector</a>
3541 _item_description.description
3542 ; The general class of the radiation detector.
3543 ;
3544 _item.name '<a href="#_diffrn_detector.detector" >_diffrn_detector.detector</a>'
3545 _item.category_id diffrn_detector
3546 _item.mandatory_code no
3547 loop_
3548 _item_aliases.alias_name
3549 _item_aliases.dictionary
3550 _item_aliases.version '_diffrn_radiation_detector'
3551 cifdic.c91
3552 1.0
3553 '_diffrn_detector'
3554 cif_core.dic
3555 2.0
3556 _item_type.code text
3557 loop_
3558 _item_examples.case 'photographic film'
3559 'scintillation counter'
3560 'CCD plate'
3561 'BF~3~ counter'
3562 save_
3563
3564
3565 save_<a name="_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a>
3566 _item_description.description
3567 ; This data item is a pointer to <a href="#_diffrn.id">_diffrn.id</a> in the DIFFRN
3568 category.
3569
3570 The value of <a href="#_diffrn.id">_diffrn.id</a> uniquely defines a set of
3571 diffraction data.
3572 ;
3573 _item.name '<a href="#_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a>'
3574 _item.mandatory_code yes
3575 _item_type.code code
3576 save_
3577
3578
3579 save_<a name="_diffrn_detector.dtime" >_diffrn_detector.dtime</a>
3580 _item_description.description
3581 ; The deadtime in microseconds of the detector(s) used to
3582 measure the diffraction intensities.
3583 ;
3584 _item.name '<a href="#_diffrn_detector.dtime" >_diffrn_detector.dtime</a>'
3585 _item.category_id diffrn_detector
3586 _item.mandatory_code no
3587 loop_
3588 _item_aliases.alias_name
3589 _item_aliases.dictionary
3590 _item_aliases.version '_diffrn_radiation_detector_dtime'
3591 cifdic.c91
3592 1.0
3593 '_diffrn_detector_dtime'
3594 cif_core.dic
3595 2.0
3596 loop_
3597 _item_range.maximum
3598 _item_range.minimum . 0.0
3599 0.0 0.0
3600 _item_type.code float
3601 _item_units.code microseconds
3602 save_
3603
3604
3605 save_<a name="_diffrn_detector.id" >_diffrn_detector.id</a>
3606 _item_description.description
3607 ; The value of <a href="#_diffrn_detector.id" >_diffrn_detector.id</a> must uniquely identify
3608 each detector used to collect each diffraction data set.
3609
3610 If the value of <a href="#_diffrn_detector.id" >_diffrn_detector.id</a> is not given, it is
3611 implicitly equal to the value of
3612 <a href="#_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a>.
3613 ;
3614 loop_
3615 _item.name
3616 _item.category_id
3617 _item.mandatory_code
3618 '<a href="#_diffrn_detector.id" >_diffrn_detector.id</a>' diffrn_detector implicit
3619 '<a href="#_diffrn_detector_axis.detector_id" >_diffrn_detector_axis.detector_id</a>'
3620 diffrn_detector_axis yes
3621 '<a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>'
3622 diffrn_scan_frame_monitor yes
3623 loop_
3624 _item_linked.child_name
3625 _item_linked.parent_name
3626 '<a href="#_diffrn_detector_axis.detector_id" >_diffrn_detector_axis.detector_id</a>'
3627 '_diffrn_detector.id'
3628 '<a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>'
3629 '_diffrn_detector.id'
3630
3631 _item_type.code code
3632 save_
3633
3634
3635 save_<a name="_diffrn_detector.number_of_axes" >_diffrn_detector.number_of_axes</a>
3636 _item_description.description
3637 ; The value of <a href="#_diffrn_detector.number_of_axes" >_diffrn_detector.number_of_axes</a> gives the
3638 number of axes of the positioner for the detector identified
3639 by <a href="#_diffrn_detector.id" >_diffrn_detector.id</a>.
3640
3641 The word 'positioner' is a general term used in
3642 instrumentation design for devices that are used to change
3643 the positions of portions of apparatus by linear
3644 translation, rotation or combinations of such motions.
3645
3646 Axes which are used to provide a coordinate system for the
3647 face of an area detetctor should not be counted for this
3648 data item.
3649
3650 The description of each axis should be provided by entries
3651 in <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a>.
3652 ;
3653 _item.name '<a href="#_diffrn_detector.number_of_axes" >_diffrn_detector.number_of_axes</a>'
3654 _item.category_id diffrn_detector
3655 _item.mandatory_code no
3656 loop_
3657 _item_range.maximum
3658 _item_range.minimum . 1
3659 1 1
3660 _item_type.code int
3661 save_
3662
3663
3664 save_<a name="_diffrn_detector.type" >_diffrn_detector.type</a>
3665 _item_description.description
3666 ; The make, model or name of the detector device used.
3667 ;
3668 _item.name '<a href="#_diffrn_detector.type" >_diffrn_detector.type</a>'
3669 _item.category_id diffrn_detector
3670 _item.mandatory_code no
3671 _item_aliases.alias_name '_diffrn_detector_type'
3672 _item_aliases.dictionary cif_core.dic
3673 _item_aliases.version 2.0.1
3674 _item_type.code text
3675 save_
3676
3677 save_<a name="_diffrn_detector.variant" >_diffrn_detector.variant</a>
3678 _item_description.description
3679 ; The value of <a href="#_diffrn_detector.variant" >_diffrn_detector.variant</a> gives the variant
3680 to which the given diffrn_detector row is related.
3681
3682 If this value is not given, the variant is assumed to the default
3683 null variant.
3684
3685 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
3686 <a href="#VARIANT">VARIANT</a> category.
3687 ;
3688 _item.name '<a href="#_diffrn_detector.variant" >_diffrn_detector.variant</a>'
3689 _item.category_id diffrn_detector
3690 _item.mandatory_code no
3691 _item_type.code code
3692 save_
3693
3694
3695 ########################
3696 # <a name="DIFFRN_DETECTOR_AXIS" >DIFFRN_DETECTOR_AXIS</a> #
3697 ########################
3698
3699
3700 save_DIFFRN_DETECTOR_AXIS
3701 _category.description
3702 ; Data items in the <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a> category associate
3703 axes with detectors.
3704 ;
3705 _category.id diffrn_detector_axis
3706 _category.mandatory_code no
3707 loop_
3708 _category_key.name '<a href="#_diffrn_detector_axis.detector_id" >_diffrn_detector_axis.detector_id</a>'
3709 '<a href="#_diffrn_detector_axis.axis_id" >_diffrn_detector_axis.axis_id</a>'
3710 '<a href="#_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a>'
3711 loop_
3712 _category_group.id 'inclusive_group'
3713 'diffrn_group'
3714 save_
3715
3716
3717 save_<a name="_diffrn_detector_axis.axis_id" >_diffrn_detector_axis.axis_id</a>
3718 _item_description.description
3719 ; This data item is a pointer to <a href="#_axis.id" >_axis.id</a> in
3720 the AXIS category.
3721 ;
3722 _item.name '<a href="#_diffrn_detector_axis.axis_id">_diffrn_detector_axis.axis_id</a>'
3723 _item.category_id diffrn_detector_axis
3724 _item.mandatory_code yes
3725 _item_type.code code
3726 save_
3727
3728
3729 save_<a name="_diffrn_detector_axis.detector_id" >_diffrn_detector_axis.detector_id</a>
3730 _item_description.description
3731 ; This data item is a pointer to <a href="#_diffrn_detector.id" >_diffrn_detector.id</a> in
3732 the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category.
3733
3734 This item was previously named _diffrn_detector_axis.id
3735 which is now a deprecated name. The old name is
3736 provided as an alias but should not be used for new work.
3737 ;
3738 _item.name '<a href="#_diffrn_detector_axis.detector_id" >_diffrn_detector_axis.detector_id</a>'
3739 _item.category_id diffrn_detector_axis
3740 _item.mandatory_code yes
3741 _item_aliases.alias_name '_diffrn_detector_axis.id'
3742 _item_aliases.dictionary cif_img.dic
3743 _item_aliases.version 1.0
3744 _item_type.code code
3745 save_
3746
3747 save_<a name="_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a>
3748 _item_description.description
3749 ; The value of <a href="#_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a> gives the variant
3750 to which the given diffrn_detector_axis row is related.
3751
3752 If this value is not given, the variant is assumed to the default
3753 null variant.
3754
3755 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
3756 <a href="#VARIANT">VARIANT</a> category.
3757 ;
3758 _item.name '<a href="#_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a>'
3759 _item.category_id diffrn_detector_axis
3760 _item.mandatory_code no
3761 _item_type.code code
3762 save_
3763
3764
3765
3766 ###########################
3767 # <a name="DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a> #
3768 ###########################
3769
3770
3771 save_DIFFRN_DETECTOR_ELEMENT
3772 _category.description
3773 ; Data items in the <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a> category record
3774 the details about spatial layout and other characteristics
3775 of each element of a detector which may have multiple elements.
3776
3777 In most cases, giving more detailed information
3778 in <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a> and <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a>
3779 is preferable to simply providing the centre of the
3780 detector element.
3781 ;
3782 _category.id diffrn_detector_element
3783 _category.mandatory_code no
3784 loop_
3785 _category_key.name '<a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a>'
3786 '<a href="#_diffrn_detector_element.detector_id" >_diffrn_detector_element.detector_id</a>'
3787 '<a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>'
3788 loop_
3789 _category_group.id 'inclusive_group'
3790 'array_data_group'
3791 'diffrn_group'
3792 loop_
3793 _category_examples.detail
3794 _category_examples.case
3795 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3796 ; Example 1 - Detector d1 is composed of four CCD detector elements,
3797 each 200 mm by 200 mm, arranged in a square, in the pattern
3798
3799 1 2
3800 *
3801 3 4
3802
3803 Note that the beam centre is slightly displaced from each of the
3804 detector elements, just beyond the lower right corner of 1,
3805 the lower left corner of 2, the upper right corner of 3 and
3806 the upper left corner of 4. For each element, the detector
3807 face coordiate system, is assumed to have the fast axis
3808 running from left to right and the slow axis running from
3809 top to bottom with the origin at the top left corner.
3810 ;
3811 ;
3812 loop_
3813 <a href="#_diffrn_detector_element.detector_id" >_diffrn_detector_element.detector_id</a>
3814 <a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a>
3815 <a href="#_diffrn_detector_elelemt.reference_center_fast" >_diffrn_detector_element.reference_center_fast</a>
3816 <a href="#_diffrn_detector_element.reference_center_slow" >_diffrn_detector_element.reference_center_slow</a>
3817 <a href="#_diffrn_detector_element.reference_center_units" >_diffrn_detector_element.reference_center_units</a>
3818 d1 d1_ccd_1 201.5 201.5 mm
3819 d1 d1_ccd_2 -1.8 201.5 mm
3820 d1 d1_ccd_3 201.6 -1.4 mm
3821 d1 d1_ccd_4 -1.7 -1.5 mm
3822 ;
3823 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3824 save_
3825
3826
3827
3828 save_<a name="_diffrn_detector_element.id" >_diffrn_detector_element.id</a>
3829 _item_description.description
3830 ; The value of <a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a> must uniquely
3831 identify each element of a detector.
3832 ;
3833 loop_
3834 _item.name
3835 _item.category_id
3836 _item.mandatory_code
3837 '<a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a>'
3838 diffrn_detector_element
3839 yes
3840 _item_type.code code
3841 loop_
3842 _item_linked.child_name
3843 _item_linked.parent_name
3844 '<a href="#_diffrn_data_frame.detector_element_id" >_diffrn_data_frame.detector_element_id</a>'
3845 '<a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a>'
3846
3847 save_
3848
3849
3850 save_<a name="_diffrn_detector_element.detector_id" >_diffrn_detector_element.detector_id</a>
3851 _item_description.description
3852 ; This item is a pointer to <a href="#_diffrn_detector.id" >_diffrn_detector.id</a>
3853 in the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category.
3854 ;
3855 _item.name '<a href="#_diffrn_detector_element.detector_id" >_diffrn_detector_element.detector_id</a>'
3856 _item.category_id diffrn_detector_element
3857 _item.mandatory_code yes
3858 _item_type.code code
3859 save_
3860
3861 save_<a name="_diffrn_detector_element.reference_center_fast">_diffrn_detector_element.reference_center_fast</a>
3862 _item_description.description
3863 ; The value of <a href="#_diffrn_detector_element.reference_center_fast">_diffrn_detector_element.reference_center_fast</a> is
3864 the fast index axis beam center position relative to the detector
3865 element face in the units specified in the data item
3866 '<a href="#_diffrn_detector_element.reference_center_units">_diffrn_detector_element.reference_center_units</a>' along the fast
3867 axis of the detector from the center of the first pixel to
3868 the point at which the Z-axis (which should be colinear with the
3869 beam) intersects the face of the detector, if in fact is does.
3870 At the time of the measurement all settings of the detector
3871 positioner should be at their reference settings. If more than
3872 one reference setting has been used the value given whould be
3873 representive of the beam center as determined from the ensemble
3874 of settings.
3875
3876 It is important to note that for measurements in millimetres,
3877 the sense of the axis is used, rather than the sign of the
3878 pixel-to-pixel increments.
3879
3880 ;
3881 _item.name '<a href="#_diffrn_detector_element.reference_center_fast">_diffrn_detector_element.reference_center_fast</a>'
3882 _item.category_id diffrn_detector_element
3883 _item.mandatory_code no
3884 _item_type.code float
3885
3886 save_
3887
3888
3889 save_<a name="_diffrn_detector_element.reference_center_slow">_diffrn_detector_element.reference_center_slow</a>
3890 _item_description.description
3891 ; The value of <a href="#_diffrn_detector_element.reference_center_slow">_diffrn_detector_element.reference_center_slow</a> is
3892 the slow index axis beam center position relative to the detector
3893 element face in the units specified in the data item
3894 '<a href="#_diffrn_detector_element.reference_center_units">_diffrn_detector_element.reference_center_units</a>' along the slow
3895 axis of the detector from the center of the first pixel to
3896 the point at which the Z-axis (which should be colinear with the
3897 beam) intersects the face of the detector, if in fact is does.
3898 At the time of the measurement all settings of the detector
3899 positioner should be at their reference settings. If more than
3900 one reference setting has been used the value givien whould be
3901 representive of the beam center as determined from the ensemble
3902 of settings.
3903
3904 It is important to note that the sense of the axis is used,
3905 rather than the sign of the pixel-to-pixel increments.
3906
3907 ;
3908 _item.name '<a href="#_diffrn_detector_element.reference_center_slow">_diffrn_detector_element.reference_center_slow</a>'
3909 _item.category_id diffrn_detector_element
3910 _item.mandatory_code no
3911 _item_type.code float
3912
3913 save_
3914
3915
3916 save_<a name="_diffrn_detector_element.reference_center_units">_diffrn_detector_element.reference_center_units</a>
3917 _item_description.description
3918 ; The value of <a href="#_diffrn_detector_element.reference_center_units">_diffrn_detector_element.reference_center_units</a>
3919 specifies the units in which the values of
3920 '<a href="#_diffrn_detector_element.reference_center_fast">_diffrn_detector_element.reference_center_fast</a>' and
3921 '<a href="#_diffrn_detector_element.reference_center_slow">_diffrn_detector_element.reference_center_slow</a>'
3922 are presented. The default is 'mm' for millimetres. The
3923 alternatives are 'pixels' and 'bins'. In all cases the
3924 center distances are measured from the center of the
3925 first pixel, i.e. in a 2x2 binning, the measuring origin
3926 is offset from the centers of the bins by one half pixel
3927 towards the first pixel.
3928
3929 If 'bins' is specified, the data in
3930 '<a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>',
3931 '<a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a>', and
3932 '<a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>'
3933 is used to define the binning scheme.
3934
3935
3936 ;
3937 _item.name '<a href="#_diffrn_detector_element.reference_center_units">_diffrn_detector_element.reference_center_units</a>'
3938 _item.category_id diffrn_detector_element
3939 _item.mandatory_code no
3940 _item_type.code code
3941 loop_
3942 _item_enumeration.value
3943 _item_enumeration.detail
3944 mm 'millimetres'
3945 pixels 'detector pixels'
3946 bins 'detector bins'
3947
3948 save_
3949
3950 save_<a name="_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>
3951 _item_description.description
3952 ; The value of <a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a> gives the variant
3953 to which the given diffrn_detector_element row is related.
3954
3955 If this value is not given, the variant is assumed to the default
3956 null variant.
3957
3958 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
3959 <a href="#VARIANT">VARIANT</a> category.
3960 ;
3961 _item.name '<a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>'
3962 _item.category_id diffrn_detector_element
3963 _item.mandatory_code no
3964 _item_type.code code
3965 save_
3966
3967
3968 ########################
3969 ## <a name="DIFFRN_MEASUREMENT" >DIFFRN_MEASUREMENT</a> ##
3970 ########################
3971
3972
3973 save_DIFFRN_MEASUREMENT
3974 _category.description
3975 ; Data items in the <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> category record details
3976 about the device used to orient and/or position the crystal
3977 during data measurement and the manner in which the
3978 diffraction data were measured.
3979 ;
3980 _category.id diffrn_measurement
3981 _category.mandatory_code no
3982 loop_
3983 _category_key.name '<a href="#_diffrn_measurement.device" >_diffrn_measurement.device</a>'
3984 '<a href="#_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a>'
3985 '<a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a>'
3986 '<a href="#_diffrn_measurement.variant" >_diffrn_measurement.variant</a>'
3987 loop_
3988 _category_group.id 'inclusive_group'
3989 'diffrn_group'
3990 loop_
3991 _category_examples.detail
3992 _category_examples.case
3993 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3994 ; Example 1 - based on PDB entry 5HVP and laboratory records for the
3995 structure corresponding to PDB entry 5HVP
3996 ;
3997 ;
3998 <a href="#_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a> 'd1'
3999 <a href="#_diffrn_measurement.device" >_diffrn_measurement.device</a> '3-circle camera'
4000 <a href="#_diffrn_measurement.device_type" >_diffrn_measurement.device_type</a> 'Supper model <b>X</b>'
4001 <a href="#_diffrn_measurement.device_details" >_diffrn_measurement.device_details</a> 'none'
4002 <a href="#_diffrn_measurement.method" >_diffrn_measurement.method</a> 'omega scan'
4003 <a href="#_diffrn_measurement.details" >_diffrn_measurement.details</a>
4004 ; 440 frames, 0.20 degrees, 150 sec, detector distance 12 cm, detector
4005 angle 22.5 degrees
4006 ;
4007 ;
4008 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4009 ; Example 2 - based on data set TOZ of Willis, Beckwith &amp; Tozer
4010 [Acta Cryst. (1991), C47, 2276-2277].
4011 ;
4012 ;
4013 <a href="#_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a> 's1'
4014 <a href="#_diffrn_measurement.device_type" >_diffrn_measurement.device_type</a> 'Philips PW1100/20 diffractometer'
4015 <a href="#_diffrn_measurement.method" >_diffrn_measurement.method</a> 'theta/2theta (\q/2\q)'
4016 ;
4017 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4018 save_
4019
4020
4021 save_<a name="_diffrn_measurement.device" >_diffrn_measurement.device</a>
4022 _item_description.description
4023 ; The general class of goniometer or device used to support
4024 and orient the specimen.
4025
4026 If the value of <a href="#_diffrn_measurement.device">_diffrn_measurement.device</a> is not given,
4027 it is implicitly equal to the value of
4028 <a href="#_diffrn_measurement.diffrn_id">_diffrn_measurement.diffrn_id</a>.
4029
4030 Either <a href="#_diffrn_measurement.device">_diffrn_measurement.device</a> or
4031 <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a> may be used to link to other
4032 categories. If the experimental setup admits multiple
4033 devices, then <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a> is used to provide
4034 a unique link.
4035 ;
4036 loop_
4037 _item.name
4038 _item.category_id
4039 _item.mandatory_code
4040 '<a href="#_diffrn_measurement.device">_diffrn_measurement.device</a>' diffrn_measurement implicit
4041 '<a href="#_diffrn_measurement_axis.measurement_device">_diffrn_measurement_axis.measurement_device</a>'
4042 diffrn_measurement_axis implicit
4043 loop_
4044 _item_linked.child_name
4045 _item_linked.parent_name
4046 '<a href="#_diffrn_measurement_axis.measurement_device">_diffrn_measurement_axis.measurement_device</a>'
4047 '_diffrn_measurement.device'
4048 _item_aliases.alias_name '_diffrn_measurement_device'
4049 _item_aliases.dictionary cif_core.dic
4050 _item_aliases.version 2.0.1
4051 _item_type.code text
4052 loop_
4053 _item_examples.case '3-circle camera'
4054 '4-circle camera'
4055 'kappa-geometry camera'
4056 'oscillation camera'
4057 'precession camera'
4058 save_
4059
4060
4061 save_<a name="_diffrn_measurement.device_details" >_diffrn_measurement.device_details</a>
4062 _item_description.description
4063 ; A description of special aspects of the device used to
4064 measure the diffraction intensities.
4065 ;
4066 _item.name '<a href="#_diffrn_measurement.device_details" >_diffrn_measurement.device_details</a>'
4067 _item.category_id diffrn_measurement
4068 _item.mandatory_code no
4069 _item_aliases.alias_name '_diffrn_measurement_device_details'
4070 _item_aliases.dictionary cif_core.dic
4071 _item_aliases.version 2.0.1
4072 _item_type.code text
4073 _item_examples.case
4074 ; commercial goniometer modified locally to
4075 allow for 90\% \t arc
4076 ;
4077 save_
4078
4079
4080 save_<a name="_diffrn_measurement.device_type" >_diffrn_measurement.device_type</a>
4081 _item_description.description
4082 ; The make, model or name of the measurement device
4083 (goniometer) used.
4084 ;
4085 _item.name '<a href="#_diffrn_measurement.device_type" >_diffrn_measurement.device_type</a>'
4086 _item.category_id diffrn_measurement
4087 _item.mandatory_code no
4088 _item_aliases.alias_name '_diffrn_measurement_device_type'
4089 _item_aliases.dictionary cif_core.dic
4090 _item_aliases.version 2.0.1
4091 _item_type.code text
4092 loop_
4093 _item_examples.case 'Supper model q'
4094 'Huber model r'
4095 'Enraf-Nonius model s'
4096 'home-made'
4097 save_
4098
4099
4100 save_<a name="_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a>
4101 _item_description.description
4102 ; This data item is a pointer to <a href="#_diffrn.id">_diffrn.id</a> in the DIFFRN
4103 category.
4104 ;
4105 _item.name '<a href="#_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a>'
4106 _item.mandatory_code yes
4107 _item_type.code code
4108 save_
4109
4110
4111 save_<a name="_diffrn_measurement.details" >_diffrn_measurement.details</a>
4112 _item_description.description
4113 ; A description of special aspects of the intensity
4114 measurement.
4115 ;
4116 _item.name '<a href="#_diffrn_measurement.details" >_diffrn_measurement.details</a>'
4117 _item.category_id diffrn_measurement
4118 _item.mandatory_code no
4119 _item_aliases.alias_name '_diffrn_measurement_details'
4120 _item_aliases.dictionary cif_core.dic
4121 _item_aliases.version 2.0.1
4122 _item_type.code text
4123 _item_examples.case
4124 ; 440 frames, 0.20 degrees, 150 sec, detector
4125 distance 12 cm, detector angle 22.5 degrees
4126 ;
4127 save_
4128
4129
4130 save_<a name="_diffrn_measurement.id" >_diffrn_measurement.id</a>
4131 _item_description.description
4132 ; The value of <a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a> must uniquely identify
4133 the set of mechanical characteristics of the device used to
4134 orient and/or position the sample used during the collection
4135 of each diffraction data set.
4136
4137 If the value of <a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a> is not given, it is
4138 implicitly equal to the value of
4139 <a href="#_diffrn_measurement.diffrn_id" >_diffrn_measurement.diffrn_id</a>.
4140
4141 Either <a href="#_diffrn_measurement.device">_diffrn_measurement.device</a> or
4142 <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a> may be used to link to other
4143 categories. If the experimental setup admits multiple
4144 devices, then <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a> is used to provide
4145 a unique link.
4146 ;
4147 loop_
4148 _item.name
4149 _item.category_id
4150 _item.mandatory_code
4151 '<a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a>' diffrn_measurement implicit
4152 '<a href="#_diffrn_measurement_axis.measurement_id" >_diffrn_measurement_axis.measurement_id</a>'
4153 diffrn_measurement_axis implicit
4154 loop_
4155 _item_linked.child_name
4156 _item_linked.parent_name
4157 '<a href="#_diffrn_measurement_axis.measurement_id" >_diffrn_measurement_axis.measurement_id</a>'
4158 '<a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a>'
4159
4160 _item_type.code code
4161 save_
4162
4163
4164 save_<a name="_diffrn_measurement.method" >_diffrn_measurement.method</a>
4165 _item_description.description
4166 ; Method used to measure intensities.
4167 ;
4168 _item.name '<a href="#_diffrn_measurement.method" >_diffrn_measurement.method</a>'
4169 _item.category_id diffrn_measurement
4170 _item.mandatory_code no
4171 _item_aliases.alias_name '_diffrn_measurement_method'
4172 _item_aliases.dictionary cif_core.dic
4173 _item_aliases.version 2.0.1
4174 _item_type.code text
4175 _item_examples.case
4176 'profile data from theta/2theta (\q/2\q) scans'
4177 save_
4178
4179
4180 save_<a name="_diffrn_measurement.number_of_axes" >_diffrn_measurement.number_of_axes</a>
4181 _item_description.description
4182 ; The value of <a href="#_diffrn_measurement.number_of_axes" >_diffrn_measurement.number_of_axes</a> gives the
4183 number of axes of the positioner for the goniometer or
4184 other sample orientation or positioning device identified
4185 by <a href="#_diffrn_measurement.id" >_diffrn_measurement.id</a>.
4186
4187 The description of the axes should be provided by entries in
4188 <a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a>.
4189 ;
4190 _item.name '<a href="#_diffrn_measurement.number_of_axes" >_diffrn_measurement.number_of_axes</a>'
4191 _item.category_id diffrn_measurement
4192 _item.mandatory_code no
4193 loop_
4194 _item_range.maximum
4195 _item_range.minimum . 1
4196 1 1
4197 _item_type.code int
4198 save_
4199
4200
4201 # <a href="#_diffrn_measurement.sample_detector_distance" >_diffrn_measurement.sample_detector_distance</a>
4202 # <a href="#_diffrn_measurement.sample_detector_voffset" >_diffrn_measurement.sample_detector_voffset</a>
4203
4204 save_<a name="_diffrn_measurement.sample_detector_distance" >_diffrn_measurement.sample_detector_distance</a>
4205 _item_description.description
4206 ; The value of <a href="#_diffrn_measurement.sample_detector_distance" >_diffrn_measurement.sample_detector_distance</a> gives
4207 the unsigned distance in millimetres from the sample to the
4208 detector along the beam.
4209 ;
4210 _item.name '<a href="#_diffrn_measurement.sample_detector_distance" >_diffrn_measurement.sample_detector_distance</a>'
4211 _item.category_id diffrn_measurement
4212 _item.mandatory_code no
4213 loop_
4214 _item_range.maximum
4215 _item_range.minimum . 0.0
4216 _item_type.code float
4217 _item_units.code mm
4218 save_
4219
4220 save_<a name="_diffrn_measurement.sample_detector_voffset" >_diffrn_measurement.sample_detector_voffset</a>
4221 _item_description.description
4222 ; The value of <a href="#_diffrn_measurement.sample_detector_voffset" >_diffrn_measurement.sample_detector_voffset</a> gives
4223 the signed distance in millimetres in the vertical
4224 direction (positive for up) from the center of
4225 the beam to the center of the detector.
4226 ;
4227 _item.name '<a href="#_diffrn_measurement.sample_detector_voffset" >_diffrn_measurement.sample_detector_voffset</a>'
4228 _item.category_id diffrn_measurement
4229 _item.mandatory_code no
4230 loop_
4231 _item_range.maximum
4232 _item_range.minimum . .
4233 . .
4234 _item_type.code float
4235 _item_units.code mm
4236 save_
4237
4238
4239 save_<a name="_diffrn_measurement.specimen_support" >_diffrn_measurement.specimen_support</a>
4240 _item_description.description
4241 ; The physical device used to support the crystal during data
4242 collection.
4243 ;
4244 _item.name '<a href="#_diffrn_measurement.specimen_support" >_diffrn_measurement.specimen_support</a>'
4245 _item.category_id diffrn_measurement
4246 _item.mandatory_code no
4247 _item_aliases.alias_name '_diffrn_measurement_specimen_support'
4248 _item_aliases.dictionary cif_core.dic
4249 _item_aliases.version 2.0.1
4250 _item_type.code text
4251 loop_
4252 _item_examples.case 'glass capillary'
4253 'quartz capillary'
4254 'fiber'
4255 'metal loop'
4256 save_
4257
4258 save_<a name="_diffrn_measurement.variant" >_diffrn_measurement.variant</a>
4259 _item_description.description
4260 ; The value of <a href="#_diffrn_measurement.variant" >_diffrn_measurement.variant</a> gives the variant
4261 to which the given diffrn_measurement row is related.
4262
4263 If this value is not given, the variant is assumed to the default
4264 null variant.
4265
4266 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
4267 <a href="#VARIANT">VARIANT</a> category.
4268 ;
4269 _item.name '<a href="#_diffrn_measurement.variant" >_diffrn_measurement.variant</a>'
4270 _item.category_id diffrn_measurement
4271 _item.mandatory_code no
4272 _item_type.code code
4273 save_
4274
4275
4276
4277
4278 ###########################
4279 # <a name="DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a> #
4280 ###########################
4281
4282
4283 save_DIFFRN_MEASUREMENT_AXIS
4284 _category.description
4285 ; Data items in the <a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a> category associate
4286 axes with goniometers.
4287 ;
4288 _category.id diffrn_measurement_axis
4289 _category.mandatory_code no
4290 loop_
4291 _category_key.name
4292 '<a href="#_diffrn_measurement_axis.measurement_device" >_diffrn_measurement_axis.measurement_device</a>'
4293 '<a href="#_diffrn_measurement_axis.measurement_id" >_diffrn_measurement_axis.measurement_id</a>'
4294 '<a href="#_diffrn_measurement_axis.axis_id" >_diffrn_measurement_axis.axis_id</a>'
4295 '<a href="#_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a>'
4296 loop_
4297 _category_group.id 'inclusive_group'
4298 'diffrn_group'
4299 save_
4300
4301
4302 save_<a name="_diffrn_measurement_axis.axis_id" >_diffrn_measurement_axis.axis_id</a>
4303 _item_description.description
4304 ; This data item is a pointer to <a href="#_axis.id" >_axis.id</a> in
4305 the <a href="#AXIS">AXIS</a> category.
4306 ;
4307 _item.name '<a href="#_diffrn_measurement_axis.axis_id" >_diffrn_measurement_axis.axis_id</a>'
4308 _item.category_id diffrn_measurement_axis
4309 _item.mandatory_code yes
4310 _item_type.code code
4311 save_
4312
4313
4314 save_<A name="_diffrn_measurement_axis.measurement_device">_diffrn_measurement_axis.measurement_device</a>
4315 _item_description.description
4316 ; This data item is a pointer to <a href="#_diffrn_measurement.device">_diffrn_measurement.device</a>
4317 in the <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> category.
4318 ;
4319 _item.name
4320 '<a href="#_diffrn_measurement_axis.measurement_device">_diffrn_measurement_axis.measurement_device</a>'
4321 _item.category_id diffrn_measurement_axis
4322 _item.mandatory_code implicit
4323 _item_type.code text
4324 save_
4325
4326
4327 save_<a name="_diffrn_measurement_axis.measurement_id">_diffrn_measurement_axis.measurement_id</a>
4328 _item_description.description
4329 ; This data item is a pointer to <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a> in
4330 the <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> category.
4331
4332 This item was previously named _diffrn_measurement_axis.id,
4333 which is now a deprecated name. The old name is
4334 provided as an alias but should not be used for new work.
4335 ;
4336 _item.name '<a href="#_diffrn_measurement_axis.measurement_id">_diffrn_measurement_axis.measurement_id</a>'
4337 _item.category_id diffrn_measurement_axis
4338 _item.mandatory_code implicit
4339 _item_aliases.alias_name '_diffrn_measurement_axis.id'
4340 _item_aliases.dictionary cif_img.dic
4341 _item_aliases.version 1.0
4342 _item_type.code code
4343 save_
4344
4345 save_<a name="_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a>
4346 _item_description.description
4347 ; The value of <a href="#_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a> gives the variant
4348 to which the given diffrn_measurement_axis row is related.
4349
4350 If this value is not given, the variant is assumed to the default
4351 null variant.
4352
4353 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
4354 <a href="#VARIANT">VARIANT</a> category.
4355 ;
4356 _item.name '<a href="#_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a>'
4357 _item.category_id diffrn_measurement_axis
4358 _item.mandatory_code no
4359 _item_type.code code
4360 save_
4361
4362
4363
4364 ####################
4365 # <a name="DIFFRN_RADIATION">DIFFRN_RADIATION</a> #
4366 ####################
4367
4368
4369 save_DIFFRN_RADIATION
4370 _category.description
4371 ; Data items in the <a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a> category describe
4372 the radiation used for measuring diffraction intensities,
4373 its collimation and monochromatization before the sample.
4374
4375 Post-sample treatment of the beam is described by data
4376 items in the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category.
4377 ;
4378 _category.id diffrn_radiation
4379 _category.mandatory_code no
4380 loop_
4381 _category_key.name '<a href="#_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a>'
4382 '<a href="#_diffrn_radiation.variant">_diffrn_radiation.variant</a>'
4383 loop_
4384 _category_group.id 'inclusive_group'
4385 'diffrn_group'
4386 loop_
4387 _category_examples.detail
4388 _category_examples.case
4389 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4390 ; Example 1 - based on PDB entry 5HVP and laboratory records for the
4391 structure corresponding to PDB entry 5HVP
4392 ;
4393 ;
4394 <a href="#_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a> 'set1'
4395
4396 <a href="#_diffrn_radiation.collimation">_diffrn_radiation.collimation</a> '0.3 mm double pinhole'
4397 <a href="#_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a> 'graphite'
4398 <a href="#_diffrn_radiation.type">_diffrn_radiation.type</a> 'Cu K\a'
4399 <a href="#_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a> 1
4400 ;
4401 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4402 ; Example 2 - based on data set TOZ of Willis, Beckwith &amp; Tozer
4403 [Acta Cryst. (1991), C47, 2276-2277].
4404 ;
4405 ;
4406 <a href="#_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a> 1
4407 <a href="#_diffrn_radiation.type">_diffrn_radiation.type</a> 'Cu K\a'
4408 <a href="#_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a> 'graphite'
4409 ;
4410 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4411 save_
4412
4413 save_<A name="_diffrn_radiation.collimation">_diffrn_radiation.collimation</a>
4414 _item_description.description
4415 ; The collimation or focusing applied to the radiation.
4416 ;
4417 _item.name '<a href="#_diffrn_radiation.collimation">_diffrn_radiation.collimation</a>'
4418 _item.category_id diffrn_radiation
4419 _item.mandatory_code no
4420 _item_aliases.alias_name '_diffrn_radiation_collimation'
4421 _item_aliases.dictionary cif_core.dic
4422 _item_aliases.version 2.0.1
4423 _item_type.code text
4424 loop_
4425 _item_examples.case '0.3 mm double-pinhole'
4426 '0.5 mm'
4427 'focusing mirrors'
4428 save_
4429
4430
4431 save_<A name="_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a>
4432 _item_description.description
4433 ; This data item is a pointer to <a href="#_diffrn.id">_diffrn.id</a> in the DIFFRN
4434 category.
4435 ;
4436 _item.name '<a href="#_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a>'
4437 _item.mandatory_code yes
4438 _item_type.code code
4439 save_
4440
4441
4442
4443 save_<a name="_diffrn_radiation.div_x_source">_diffrn_radiation.div_x_source</a>
4444 _item_description.description
4445 ; Beam crossfire in degrees parallel to the laboratory <b>X</b> axis
4446 (see <a href="#AXIS">AXIS</a> category).
4447
4448 This is a characteristic of the X-ray beam as it illuminates
4449 the sample (or specimen) after all monochromation and
4450 collimation.
4451
4452 This is the standard uncertainty (e.s.d.) of the directions of
4453 photons in the XZ plane around the mean source beam
4454 direction.
4455
4456 Note that for some synchrotrons this value is specified
4457 in milliradians, in which case a conversion is needed.
4458 To convert a value in milliradians to a value in degrees,
4459 multiply by 0.180 and divide by \p.
4460 ;
4461 _item.name '<a href="#_diffrn_radiation.div_x_source">_diffrn_radiation.div_x_source</a>'
4462 _item.category_id diffrn_radiation
4463 _item.mandatory_code no
4464 _item_type.code float
4465 _item_units.code degrees
4466 save_
4467
4468
4469 save_<A name="_diffrn_radiation.div_y_source">_diffrn_radiation.div_y_source</a>
4470 _item_description.description
4471 ; Beam crossfire in degrees parallel to the laboratory <b>Y</b> axis
4472 (see <a href="#AXIS">AXIS</a> category).
4473
4474 This is a characteristic of the X-ray beam as it illuminates
4475 the sample (or specimen) after all monochromation and
4476 collimation.
4477
4478 This is the standard uncertainty (e.s.d.) of the directions
4479 of photons in the YZ plane around the mean source beam
4480 direction.
4481
4482 Note that for some synchrotrons this value is specified
4483 in milliradians, in which case a conversion is needed.
4484 To convert a value in milliradians to a value in degrees,
4485 multiply by 0.180 and divide by \p.
4486 ;
4487 _item.name '<a href="#_diffrn_radiation.div_y_source">_diffrn_radiation.div_y_source</a>'
4488 _item.category_id diffrn_radiation
4489 _item.mandatory_code no
4490 _item_type.code float
4491 _item_units.code degrees
4492 _item_default.value 0.0
4493 save_
4494
4495
4496 save_<A name="_diffrn_radiation.div_x_y_source">_diffrn_radiation.div_x_y_source</a>
4497 _item_description.description
4498 ; Beam crossfire correlation degrees^<sup>2</sup>^ between the
4499 crossfire laboratory <b>X</b>-axis component and the crossfire
4500 laboratory <b>Y</b>-axis component (see <a href="#AXIS">AXIS</a> category).
4501
4502 This is a characteristic of the X-ray beam as it illuminates
4503 the sample (or specimen) after all monochromation and
4504 collimation.
4505
4506 This is the mean of the products of the deviations of the
4507 direction of each photon in XZ plane times the deviations
4508 of the direction of the same photon in the YZ plane
4509 around the mean source beam direction. This will be zero
4510 for uncorrelated crossfire.
4511
4512 Note that some synchrotrons, this value is specified in
4513 milliradians^<sup>2</sup>^, in which case a conversion would be needed.
4514 To go from a value in milliradians^<sup>2</sup>^ to a value in
4515 degrees^<sup>2</sup>^, multiply by 0.180^<sup>2</sup>^ and divide by \p^<sup>2</sup>^.
4516
4517 ;
4518 _item.name '<a href="#_diffrn_radiation.div_x_y_source">_diffrn_radiation.div_x_y_source</a>'
4519 _item.category_id diffrn_radiation
4520 _item.mandatory_code no
4521 _item_type.code float
4522 _item_units.code degrees_squared
4523 _item_default.value 0.0
4524 save_
4525
4526 save_<A name="_diffrn_radiation.filter_edge">_diffrn_radiation.filter_edge</a>
4527 _item_description.description
4528 ; Absorption edge in \%Angstroms of the radiation filter used.
4529 ;
4530 _item.name '<a href="#_diffrn_radiation.filter_edge">_diffrn_radiation.filter_edge</a>'
4531 _item.category_id diffrn_radiation
4532 _item.mandatory_code no
4533 _item_aliases.alias_name '_diffrn_radiation_filter_edge'
4534 _item_aliases.dictionary cif_core.dic
4535 _item_aliases.version 2.0.1
4536 loop_
4537 _item_range.maximum
4538 _item_range.minimum . 0.0
4539 0.0 0.0
4540 _item_type.code float
4541 _item_units.code angstroms
4542 save_
4543
4544 save_<A name="_diffrn_radiation.inhomogeneity">_diffrn_radiation.inhomogeneity</a>
4545 _item_description.description
4546 ; Half-width in millimetres of the incident beam in the
4547 direction perpendicular to the diffraction plane.
4548 ;
4549 _item.name '<a href="#_diffrn_radiation.inhomogeneity">_diffrn_radiation.inhomogeneity</a>'
4550 _item.category_id diffrn_radiation
4551 _item.mandatory_code no
4552 _item_aliases.alias_name '_diffrn_radiation_inhomogeneity'
4553 _item_aliases.dictionary cif_core.dic
4554 _item_aliases.version 2.0.1
4555 loop_
4556 _item_range.maximum
4557 _item_range.minimum . 0.0
4558 0.0 0.0
4559 _item_type.code float
4560 _item_units.code millimetres
4561 save_
4562
4563 save_<A name="_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a>
4564 _item_description.description
4565 ; The method used to obtain monochromatic radiation. If a
4566 monochromator crystal is used, the material and the
4567 indices of the Bragg reflection are specified.
4568 ;
4569 _item.name '<a href="#_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a>'
4570 _item.category_id diffrn_radiation
4571 _item.mandatory_code no
4572 _item_aliases.alias_name '_diffrn_radiation_monochromator'
4573 _item_aliases.dictionary cif_core.dic
4574 _item_aliases.version 2.0.1
4575 _item_type.code text
4576 loop_
4577 _item_examples.case 'Zr filter'
4578 'Ge 220'
4579 'none'
4580 'equatorial mounted graphite'
4581 save_
4582
4583 save_<A name="_diffrn_radiation.polarisn_norm">_diffrn_radiation.polarisn_norm</a>
4584 _item_description.description
4585 ; The angle in degrees, as viewed from the specimen, between the
4586 perpendicular component of the polarization and the diffraction
4587 plane. See _diffrn_radiation_polarisn_ratio.
4588 ;
4589 _item.name '<a href="#_diffrn_radiation.polarisn_norm">_diffrn_radiation.polarisn_norm</a>'
4590 _item.category_id diffrn_radiation
4591 _item.mandatory_code no
4592 _item_aliases.alias_name '_diffrn_radiation_polarisn_norm'
4593 _item_aliases.dictionary cif_core.dic
4594 _item_aliases.version 2.0.1
4595 loop_
4596 _item_range.maximum
4597 _item_range.minimum 90.0 90.0
4598 90.0 -90.0
4599 -90.0 -90.0
4600 _item_type.code float
4601 _item_units.code degrees
4602 save_
4603
4604 save_<A name="_diffrn_radiation.polarisn_ratio">_diffrn_radiation.polarisn_ratio</a>
4605 _item_description.description
4606 ; Polarization ratio of the diffraction beam incident on the
4607 crystal. This is the ratio of the perpendicularly polarized to
4608 the parallel polarized component of the radiation. The
4609 perpendicular component forms an angle of
4610 <a href="#_diffrn_radiation.polarisn_norm">_diffrn_radiation.polarisn_norm</a> to the normal to the
4611 diffraction plane of the sample (i.e. the plane containing
4612 the incident and reflected beams).
4613 ;
4614 _item.name '<a href="#_diffrn_radiation.polarisn_ratio">_diffrn_radiation.polarisn_ratio</a>'
4615 _item.category_id diffrn_radiation
4616 _item.mandatory_code no
4617 _item_aliases.alias_name '_diffrn_radiation_polarisn_ratio'
4618 _item_aliases.dictionary cif_core.dic
4619 _item_aliases.version 2.0.1
4620 loop_
4621 _item_range.maximum
4622 _item_range.minimum . 0.0
4623 0.0 0.0
4624 _item_type.code float
4625 save_
4626
4627
4628
4629 save_<a name="_diffrn_radiation.polarizn_source_norm">_diffrn_radiation.polarizn_source_norm</a>
4630 _item_description.description
4631 ; The angle in degrees, as viewed from the specimen, between
4632 the normal to the polarization plane and the laboratory <b>Y</b>
4633 axis as defined in the <a href="#AXIS">AXIS</a> category.
4634
4635 Note that this is the angle of polarization of the source
4636 photons, either directly from a synchrotron beamline or
4637 from a monochromater.
4638
4639 This differs from the value of
4640 <a href="#_diffrn_radiation.polarisn_norm">_diffrn_radiation.polarisn_norm</a>
4641 in that <a href="#_diffrn_radiation.polarisn_norm">_diffrn_radiation.polarisn_norm</a> refers to
4642 polarization relative to the diffraction plane rather than
4643 to the laboratory axis system.
4644
4645 In the case of an unpolarized beam, or a beam with true
4646 circular polarization, in which no single plane of
4647 polarization can be determined, the plane should be taken
4648 as the XZ plane and the angle as 0.
4649
4650 See <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>.
4651 ;
4652 _item.name '<a href="#_diffrn_radiation.polarizn_source_norm">_diffrn_radiation.polarizn_source_norm</a>'
4653 _item.category_id diffrn_radiation
4654 _item.mandatory_code no
4655 loop_
4656 _item_range.maximum
4657 _item_range.minimum 90.0 90.0
4658 90.0 -90.0
4659 -90.0 -90.0
4660 _item_type.code float
4661 _item_units.code degrees
4662 _item_default.value 0.0
4663 save_
4664
4665
4666 save_<a name="_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>
4667 _item_description.description
4668 ; (Ip-In)/(Ip+In), where Ip is the intensity
4669 (amplitude squared) of the electric vector in the plane of
4670 polarization and In is the intensity (amplitude squared)
4671 of the electric vector in the plane of the normal to the
4672 plane of polarization.
4673
4674 In the case of an unpolarized beam, or a beam with true
4675 circular polarization, in which no single plane of
4676 polarization can be determined, the plane is to be taken
4677 as the XZ plane and the normal is parallel to the <b>Y</b> axis.
4678
4679 Thus, if there was complete polarization in the plane of
4680 polarization, the value of
4681 <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a> would be 1, and
4682 for an unpolarized beam
4683 <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a> would have a
4684 value of 0.
4685
4686 If the <b>X</b> axis has been chosen to lie in the plane of
4687 polarization, this definition will agree with the definition
4688 of 'MONOCHROMATOR' in the Denzo glossary, and values of near
4689 1 should be expected for a bending-magnet source. However,
4690 if the <b>X</b> axis were perpendicular to the polarization plane
4691 (not a common choice), then the Denzo value would be the
4692 negative of <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>.
4693
4694 See <a href="http://www.hkl-xray.com">http://www.hkl-xray.com</a> for information on Denzo and
4695 Otwinowski &amp; Minor (1997).
4696
4697 This differs both in the choice of ratio and choice of
4698 orientation from <a href="#_diffrn_radiation.polarisn_ratio">_diffrn_radiation.polarisn_ratio</a>, which,
4699 unlike <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>, is
4700 unbounded.
4701
4702 Reference: Otwinowski, Z. &amp; Minor, W. (1997). 'Processing of
4703 X-ray diffraction data collected in oscillation mode.' Methods
4704 Enzymol. 276, 307-326.
4705 ;
4706 _item.name '<a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>'
4707 _item.category_id diffrn_radiation
4708 _item.mandatory_code no
4709 loop_
4710 _item_range.maximum
4711 _item_range.minimum 1.0 1.0
4712 1.0 -1.0
4713 -1.0 -1.0
4714 _item_type.code float
4715 save_
4716
4717
4718 save_<A name="_diffrn_radiation.probe">_diffrn_radiation.probe</a>
4719 _item_description.description
4720 ; Name of the type of radiation used. It is strongly
4721 recommended that this be given so that the
4722 probe radiation is clearly specified.
4723 ;
4724 _item.name '<a href="#_diffrn_radiation.probe">_diffrn_radiation.probe</a>'
4725 _item.category_id diffrn_radiation
4726 _item.mandatory_code no
4727 _item_aliases.alias_name '_diffrn_radiation_probe'
4728 _item_aliases.dictionary cif_core.dic
4729 _item_aliases.version 2.0.1
4730 _item_type.code line
4731 loop_
4732 _item_enumeration.value 'X-ray'
4733 'neutron'
4734 'electron'
4735 'gamma'
4736 save_
4737
4738 save_<A name="_diffrn_radiation.type">_diffrn_radiation.type</a>
4739 _item_description.description
4740 ; The nature of the radiation. This is typically a description
4741 of the X-ray wavelength in Siegbahn notation.
4742 ;
4743 _item.name '<a href="#_diffrn_radiation.type">_diffrn_radiation.type</a>'
4744 _item.category_id diffrn_radiation
4745 _item.mandatory_code no
4746 _item_aliases.alias_name '_diffrn_radiation_type'
4747 _item_aliases.dictionary cif_core.dic
4748 _item_aliases.version 2.0.1
4749 _item_type.code line
4750 loop_
4751 _item_examples.case 'CuK\a'
4752 'Cu K\a~1~'
4753 'Cu K-L~2,3~'
4754 'white-beam'
4755
4756 save_
4757
4758 save_<A name="_diffrn_radiation.xray_symbol">_diffrn_radiation.xray_symbol</a>
4759 _item_description.description
4760 ; The IUPAC symbol for the X-ray wavelength for the probe
4761 radiation.
4762 ;
4763 _item.name '<a href="#_diffrn_radiation.xray_symbol">_diffrn_radiation.xray_symbol</a>'
4764 _item.category_id diffrn_radiation
4765 _item.mandatory_code no
4766 _item_aliases.alias_name '_diffrn_radiation_xray_symbol'
4767 _item_aliases.dictionary cif_core.dic
4768 _item_aliases.version 2.0.1
4769 _item_type.code line
4770 loop_
4771 _item_enumeration.value
4772 _item_enumeration.detail 'K-L~3~'
4773 'K\a~1~ in older Siegbahn notation'
4774 'K-L~2~'
4775 'K\a~2~ in older Siegbahn notation'
4776 'K-M~3~'
4777 'K\b~1~ in older Siegbahn notation'
4778 'K-L~2,3~'
4779 'use where K-L~3~ and K-L~2~ are not resolved'
4780 save_
4781
4782 save_<A name="_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a>
4783 _item_description.description
4784 ; This data item is a pointer to
4785 <a href="#_diffrn_radiation_wavelength.id">_diffrn_radiation_wavelength.id</a> in the
4786 DIFFRN_RADIATION_WAVELENGTH category.
4787 ;
4788 _item.name '<a href="#_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a>'
4789 _item.category_id diffrn_radiation
4790 _item.mandatory_code yes
4791 _item_type.code code
4792 save_
4793
4794
4795 save_<a name="_diffrn_radiation.variant" >_diffrn_radiation.variant</a>
4796 _item_description.description
4797 ; The value of <a href="#_diffrn_radiation.variant" >_diffrn_radiation.variant</a> gives the variant
4798 to which the given diffrn_radiation row is related.
4799
4800 If this value is not given, the variant is assumed to the default
4801 null variant.
4802
4803 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
4804 <a href="#VARIANT">VARIANT</a> category.
4805 ;
4806 _item.name '<a href="#_diffrn_radiation.variant" >_diffrn_radiation.variant</a>'
4807 _item.category_id diffrn_radiation
4808 _item.mandatory_code no
4809 _item_type.code code
4810 save_
4811
4812
4813
4814 ################
4815 # <a name="DIFFRN_REFLN">DIFFRN_REFLN</a> #
4816 ################
4817
4818
4819 save_DIFFRN_REFLN
4820 _category.description
4821 ; This category redefinition has been added to extend the key of
4822 the standard <a href="#DIFFRN_REFLN">DIFFRN_REFLN</a> category.
4823
4824 Data items in the DIFFRN_REFLN category record details about
4825 the intensities in the diffraction data set
4826 identified by _diffrn_refln.diffrn_id.
4827
4828 The DIFFRN_REFLN data items refer to individual intensity
4829 measurements and must be included in looped lists.
4830
4831 The DIFFRN_REFLNS data items specify the parameters that apply
4832 to all intensity measurements in the particular diffraction
4833 data set identified by _diffrn_reflns.diffrn_id and
4834 _diffrn_refln.frame_id
4835 ;
4836 _category.id diffrn_refln
4837 _category.mandatory_code no
4838 loop_
4839 _category_key.name '_diffrn_refln.diffrn_id'
4840 '_diffrn_refln.id'
4841 '<a href="#_diffrn_refln.frame_id" >_diffrn_refln.frame_id</a>'
4842 '<a href="#_diffrn_refln.variant" >_diffrn_refln.variant</a>'
4843 loop_
4844 _category_group.id 'inclusive_group'
4845 'diffrn_group'
4846 save_
4847
4848
4849 save_<a name="_diffrn_refln.frame_id" >_diffrn_refln.frame_id</a>
4850 _item_description.description
4851 ; This item is a pointer to <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>
4852 in the <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
4853 ;
4854 _item.name '<a href="#_diffrn_refln.frame_id" >_diffrn_refln.frame_id</a>'
4855 _item.category_id diffrn_refln
4856 _item.mandatory_code yes
4857 _item_type.code code
4858 save_
4859
4860 save_<a name="_diffrn_refln.variant" >_diffrn_refln.variant</a>
4861 _item_description.description
4862 ; The value of <a href="#_diffrn_refln.variant" >_diffrn_refln.variant</a> gives the variant
4863 to which the given diffrn_refln row is related.
4864
4865 If this value is not given, the variant is assumed to the default
4866 null variant.
4867
4868 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
4869 <a href="#VARIANT">VARIANT</a> category.
4870 ;
4871 _item.name '<a href="#_diffrn_refln.variant" >_diffrn_refln.variant</a>'
4872 _item.category_id diffrn_refln
4873 _item.mandatory_code no
4874 _item_type.code code
4875 save_
4876
4877
4878 ###############
4879 # <a name="DIFFRN_SCAN">DIFFRN_SCAN</a> #
4880 ###############
4881
4882 save_DIFFRN_SCAN
4883 _category.description
4884 ; Data items in the <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a> category describe the parameters of one
4885 or more scans, relating axis positions to frames.
4886
4887 ;
4888 _category.id diffrn_scan
4889 _category.mandatory_code no
4890 loop_
4891 _category_key.name '<a href="#_diffrn_scan.id" >_diffrn_scan.id</a>'
4892 '<a href="#_diffrn_scan.variant" >_diffrn_scan.variant</a>'
4893 loop_
4894 _category_group.id 'inclusive_group'
4895 'diffrn_group'
4896 loop_
4897 _category_examples.detail
4898 _category_examples.case
4899 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4900 ; Example 1 - derived from a suggestion by R. M. Sweet.
4901
4902 The vector of each axis is not given here, because it is provided in
4903 the <a href="#AXIS">AXIS</a> category. By making <a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a> and
4904 <a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a> keys of the <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a> category,
4905 an arbitrary number of scanning and fixed axes can be specified for a
4906 scan. In this example, three rotation axes and one translation axis
4907 at nonzero values are specified, with one axis stepping. There is no
4908 reason why more axes could not have been specified to step. Range
4909 information has been specified, but note that it can be calculated from
4910 the number of frames and the increment, so the data item
4911 <a href="#_diffrn_scan_axis.angle_range">_diffrn_scan_axis.angle_range</a> could be dropped.
4912
4913 Both the sweep data and the data for a single frame are specified.
4914
4915 Note that the information on how the axes are stepped is given twice,
4916 once in terms of the overall averages in the value of
4917 <a href="#_diffrn_scan.integration_time" >_diffrn_scan.integration_time</a> and the values for <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>,
4918 and precisely for the given frame in the value for
4919 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a> and the values for
4920 <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a>. If dose-related adjustments are made to
4921 scan times and nonlinear stepping is done, these values may differ.
4922 Therefore, in interpreting the data for a particular frame it is
4923 important to use the frame-specific data.
4924 ;
4925 ;
4926 <a href="#_diffrn_scan.id">_diffrn_scan.id</a> 1
4927 <a href="#_diffrn_scan.date_start" >_diffrn_scan.date_start</a> '2001-11-18T03:26:42'
4928 <a href="#_diffrn_scan.date_end" >_diffrn_scan.date_end</a> '2001-11-18T03:36:45'
4929 <a href="#_diffrn_scan.integration_time" >_diffrn_scan.integration_time</a> 3.0
4930 <a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a> mad_L2_000
4931 <a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a> mad_L2_200
4932 <a href="#_diffrn_scan.frames" >_diffrn_scan.frames</a> 201
4933
4934 loop_
4935 <a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>
4936 <a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>
4937 <a href="#_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>
4938 <a href="#_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>
4939 <a href="#_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>
4940 <a href="#_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>
4941 <a href="#_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>
4942 <a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>
4943
4944 1 omega 200.0 20.0 0.1 . . .
4945 1 kappa -40.0 0.0 0.0 . . .
4946 1 phi 127.5 0.0 0.0 . . .
4947 1 tranz . . . 2.3 0.0 0.0
4948
4949 <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a> 1
4950 <a href="#_diffrn_scan_frame.date" >_diffrn_scan_frame.date</a> '2001-11-18T03:27:33'
4951 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a> 3.0
4952 <a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a> mad_L2_018
4953 <a href="#_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a> 18
4954
4955 loop_
4956 <a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>
4957 <a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>
4958 <a href="#_diffrn_scan_frame_axis.angle">_diffrn_scan_frame_axis.angle</a>
4959 <a href="#_diffrn_scan_frame_axis.angle_increment" >_diffrn_scan_frame_axis.angle_increment</a>
4960 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
4961 <a href="#_diffrn_scan_frame_axis.displacement_increment" >_diffrn_scan_frame_axis.displacement_increment</a>
4962
4963 mad_L2_018 omega 201.8 0.1 . .
4964 mad_L2_018 kappa -40.0 0.0 . .
4965 mad_L2_018 phi 127.5 0.0 . .
4966 mad_L2_018 tranz . . 2.3 0.0
4967 ;
4968
4969 ; Example 2 - a more extensive example (R. M. Sweet, P. J. Ellis &amp;
4970 H. J. Bernstein).
4971
4972 A detector is placed 240 mm along the <b>Z</b> axis from the goniometer.
4973 This leads to a choice: either the axes of
4974 the detector are defined at the origin, and then a Z setting of -240
4975 is entered, or the axes are defined with the necessary Z offset.
4976 In this case, the setting is used and the offset is left as zero.
4977 This axis is called DETECTOR_Z.
4978
4979 The axis for positioning the detector in the <b>Y</b> direction depends
4980 on the detector <b>Z</b> axis. This axis is called DETECTOR_Y.
4981
4982 The axis for positioning the detector in the <b>X</b> direction depends
4983 on the detector <b>Y</b> axis (and therefore on the detector <b>Z</b> axis).
4984 This axis is called DETECTOR_X.
4985
4986 This detector may be rotated around the <b>Y</b> axis. This rotation axis
4987 depends on the three translation axes. It is called DETECTOR_PITCH.
4988
4989 A coordinate system is defined on the face of the detector in terms of
4990 2300 0.150 mm pixels in each direction. The ELEMENT_X axis is used to
4991 index the first array index of the data array and the ELEMENT_Y
4992 axis is used to index the second array index. Because the pixels
4993 are 0.150mm <b>X</b> 0.150mm, the centre of the first pixel is at (0.075,
4994 0.075) in this coordinate system.
4995 ;
4996
4997 ; ###CBF: VERSION 1.1
4998
4999 data_image_1
5000
5001 # category DIFFRN
5002 _diffrn.id P6MB
5003 _diffrn.crystal_id P6MB_CRYSTAL7
5004
5005 # category DIFFRN_SOURCE
5006 loop_
5007 _diffrn_source.diffrn_id
5008 _diffrn_source.source
5009 _diffrn_source.type
5010 P6MB synchrotron 'SSRL beamline 9-1'
5011
5012 # category <a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a>
5013 loop_
5014 <a href="#_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a>
5015 <a href="#_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a>
5016 <a href="#_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a>
5017 <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>
5018 <a href="#_diffrn_radiation.polarizn_source_norm">_diffrn_radiation.polarizn_source_norm</a>
5019 <a href="#_diffrn_radiation.div_x_source">_diffrn_radiation.div_x_source</a>
5020 <a href="#_diffrn_radiation.div_y_source">_diffrn_radiation.div_y_source</a>
5021 <a href="#_diffrn_radiation.div_x_y_source">_diffrn_radiation.div_x_y_source</a>
5022 P6MB WAVELENGTH1 'Si 111' 0.8 0.0 0.08
5023 0.01 0.00
5024
5025 # category DIFFRN_RADIATION_WAVELENGTH
5026 loop_
5027 _diffrn_radiation_wavelength.id
5028 _diffrn_radiation_wavelength.wavelength
5029 _diffrn_radiation_wavelength.wt
5030 WAVELENGTH1 0.98 1.0
5031
5032 # category <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a>
5033 loop_
5034 <a href="#_diffrn_detector.diffrn_id">_diffrn_detector.diffrn_id</a>
5035 <a href="#_diffrn_detector.id">_diffrn_detector.id</a>
5036 <a href="#_diffrn_detector.type">_diffrn_detector.type</a>
5037 <a href="#_diffrn_detector.number_of_axes">_diffrn_detector.number_of_axes</a>
5038 P6MB MAR345-SN26 'MAR 345' 4
5039
5040 # category <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a>
5041 loop_
5042 <a href="#_diffrn_detector_axis.detector_id">_diffrn_detector_axis.detector_id</a>
5043 <a href="#_diffrn_detector_axis.axis_id">_diffrn_detector_axis.axis_id</a>
5044 MAR345-SN26 DETECTOR_X
5045 MAR345-SN26 DETECTOR_Y
5046 MAR345-SN26 DETECTOR_Z
5047 MAR345-SN26 DETECTOR_PITCH
5048
5049 # category <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a>
5050 loop_
5051 <a href="#_diffrn_detector_element.id">_diffrn_detector_element.id</a>
5052 <a href="#_diffrn_detector_element.detector_id#">_diffrn_detector_element.detector_id</a>
5053 ELEMENT1 MAR345-SN26
5054
5055 # category <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a>
5056 loop_
5057 <a href="#_diffrn_data_frame.id">_diffrn_data_frame.id</a>
5058 <a href="#_diffrn_data_frame.detector_element_id">_diffrn_data_frame.detector_element_id</a>
5059 <a href="#_diffrn_data_frame.array_id">_diffrn_data_frame.array_id</a>
5060 <a href="#_diffrn_data_frame.binary_id">_diffrn_data_frame.binary_id</a>
5061 FRAME1 ELEMENT1 ARRAY1 1
5062
5063 # category <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a>
5064 loop_
5065 <a href="#_diffrn_measurement.diffrn_id">_diffrn_measurement.diffrn_id</a>
5066 <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a>
5067 <a href="#_diffrn_measurement.number_of_axes">_diffrn_measurement.number_of_axes</a>
5068 <a href="#_diffrn_measurement.method">_diffrn_measurement.method</a>
5069 P6MB GONIOMETER 3 rotation
5070
5071 # category <a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a>
5072 loop_
5073 <a href="#_diffrn_measurement_axis.measurement_id">_diffrn_measurement_axis.measurement_id</a>
5074 <a href="#_diffrn_measurement_axis.axis_id">_diffrn_measurement_axis.axis_id</a>
5075 GONIOMETER GONIOMETER_PHI
5076 GONIOMETER GONIOMETER_KAPPA
5077 GONIOMETER GONIOMETER_OMEGA
5078
5079 # category <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a>
5080 loop_
5081 <a href="#_diffrn_scan.id" >_diffrn_scan.id</a>
5082 <a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>
5083 <a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>
5084 <a href="#_diffrn_scan.frames" >_diffrn_scan.frames</a>
5085 SCAN1 FRAME1 FRAME1 1
5086
5087 # category <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>
5088 loop_
5089 <a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>
5090 <a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>
5091 <a href="#_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>
5092 <a href="#_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>
5093 <a href="#_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>
5094 <a href="#_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>
5095 <a href="#_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>
5096 <a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>
5097 SCAN1 GONIOMETER_OMEGA 12.0 1.0 1.0 0.0 0.0 0.0
5098 SCAN1 GONIOMETER_KAPPA 23.3 0.0 0.0 0.0 0.0 0.0
5099 SCAN1 GONIOMETER_PHI -165.8 0.0 0.0 0.0 0.0 0.0
5100 SCAN1 DETECTOR_Z 0.0 0.0 0.0 -240.0 0.0 0.0
5101 SCAN1 DETECTOR_Y 0.0 0.0 0.0 0.6 0.0 0.0
5102 SCAN1 DETECTOR_X 0.0 0.0 0.0 -0.5 0.0 0.0
5103 SCAN1 DETECTOR_PITCH 0.0 0.0 0.0 0.0 0.0 0.0
5104
5105 # category <a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a>
5106 loop_
5107 <a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>
5108 <a href="#_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a>
5109 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
5110 <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
5111 <a href="#_diffrn_scan_frame.date" >_diffrn_scan_frame.date</a>
5112 FRAME1 1 20.0 SCAN1 1997-12-04T10:23:48
5113
5114 # category <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a>
5115 loop_
5116 <a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>
5117 <a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>
5118 <a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>
5119 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
5120 FRAME1 GONIOMETER_OMEGA 12.0 0.0
5121 FRAME1 GONIOMETER_KAPPA 23.3 0.0
5122 FRAME1 GONIOMETER_PHI -165.8 0.0
5123 FRAME1 DETECTOR_Z 0.0 -240.0
5124 FRAME1 DETECTOR_Y 0.0 0.6
5125 FRAME1 DETECTOR_X 0.0 -0.5
5126 FRAME1 DETECTOR_PITCH 0.0 0.0
5127
5128 # category <a href="#AXIS">AXIS</a>
5129 loop_
5130 <a href="#_axis.id">_axis.id</a>
5131 <a href="#_axis.type">_axis.type</a>
5132 <a href="#_axis.equipment">_axis.equipment</a>
5133 <a href="#_axis.depends_on">_axis.depends_on</a>
5134 <a href="#_axis.vector[1]">_axis.vector[1]</a> <a href="#_axis.vector[2]">_axis.vector[2]</a> <a href="#_axis.vector[3]">_axis.vector[3]</a>
5135 <a href="#_axis.offset[1]">_axis.offset[1]</a> <a href="#_axis.offset[2]">_axis.offset[2]</a> <a href="#_axis.offset[3]">_axis.offset[3]</a>
5136 GONIOMETER_OMEGA rotation goniometer . 1 0 0 . . .
5137 GONIOMETER_KAPPA rotation goniometer GONIOMETER_OMEGA 0.64279
5138 0 0.76604 . . .
5139 GONIOMETER_PHI rotation goniometer GONIOMETER_KAPPA 1 0 0
5140 . . .
5141 SOURCE general source . 0 0 1 . . .
5142 GRAVITY general gravity . 0 -1 0 . . .
5143 DETECTOR_Z translation detector . 0 0 1 0 0 0
5144 DETECTOR_Y translation detector DETECTOR_Z 0 1 0 0 0 0
5145 DETECTOR_X translation detector DETECTOR_Y 1 0 0 0 0 0
5146 DETECTOR_PITCH rotation detector DETECTOR_X 0 1 0 0 0 0
5147 ELEMENT_X translation detector DETECTOR_PITCH
5148 1 0 0 172.43 -172.43 0
5149 ELEMENT_Y translation detector ELEMENT_X
5150 0 1 0 0 0 0
5151
5152 # category <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a>
5153 loop_
5154 <a href="#_array_structure_list.array_id">_array_structure_list.array_id</a>
5155 <a href="#_array_structure_list.index">_array_structure_list.index</a>
5156 <a href="#_array_structure_list.dimension">_array_structure_list.dimension</a>
5157 <a href="#_array_structure_list.precedence">_array_structure_list.precedence</a>
5158 <a href="#_array_structure_list.direction">_array_structure_list.direction</a>
5159 <a href="#_array_structure_list.axis_set_id">_array_structure_list.axis_set_id</a>
5160 ARRAY1 1 2300 1 increasing ELEMENT_X
5161 ARRAY1 2 2300 2 increasing ELEMENT_Y
5162
5163 # category <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a>
5164 loop_
5165 <a href="#_array_structure_list_axis.axis_set_id">_array_structure_list_axis.axis_set_id</a>
5166 <a href="#_array_structure_list_axis.axis_id">_array_structure_list_axis.axis_id</a>
5167 <a href="#_array_structure_list_axis.displacement">_array_structure_list_axis.displacement</a>
5168 <a href="#_array_structure_list_axis.displacement_increment">_array_structure_list_axis.displacement_increment</a>
5169 ELEMENT_X ELEMENT_X 0.075 0.150
5170 ELEMENT_Y ELEMENT_Y 0.075 0.150
5171
5172 # category <a href="#ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a>
5173 loop_
5174 <a href="#_array_element_size.array_id">_array_element_size.array_id</a>
5175 <a href="#_array_element_size.index">_array_element_size.index</a>
5176 <a href="#_array_element_size.index">_array_element_size.size</a>
5177 ARRAY1 1 150e-6
5178 ARRAY1 2 150e-6
5179
5180 # category <a href="#ARRAY_INTENSITIES">ARRAY_INTENSITIES</a>
5181 loop_
5182 <a href="#_array_intensities.array_id">_array_intensities.array_id</a>
5183 <a href="#_array_intensities.binary_id">_array_intensities.binary_id</a>
5184 <a href="#_array_intensities.linearity">_array_intensities.linearity</a>
5185 <a href="#_array_intensities.gain">_array_intensities.gain</a>
5186 <a href="#_array_intensities.gain_esd">_array_intensities.gain_esd</a>
5187 <a href="#_array_intensities.overload">_array_intensities.overload</a>
5188 <a href="#_array_intensities.undefined_value">_array_intensities.undefined_value</a>
5189 ARRAY1 1 linear 1.15 0.2 240000 0
5190
5191 # category <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a>
5192 loop_
5193 <a href="#_array_structure.id">_array_structure.id</a>
5194 <a href="#_array_structure.encoding_type">_array_structure.encoding_type</a>
5195 <a href="#_array_structure.compression_type">_array_structure.compression_type</a>
5196 <a href="#_array_structure.byte_order">_array_structure.byte_order</a>
5197 ARRAY1 "signed 32-bit integer" packed little_endian
5198
5199 # category <a href="#ARRAY_DATA">ARRAY_DATA</a>
5200 loop_
5201 <a href="#_array_data.array_id">_array_data.array_id</a>
5202 <a href="#_array_data.binary_id">_array_data.binary_id</a>
5203 <a href="#_array_data.data">_array_data.data</a>
5204 ARRAY1 1
5205 ;
5206 --CIF-BINARY-FORMAT-SECTION--
5207 Content-Type: application/octet-stream;
5208 conversions="<b>X</b>-CBF_PACKED"
5209 Content-Transfer-Encoding: BASE64
5210 <b>X</b>-Binary-Size: 3801324
5211 <b>X</b>-Binary-ID: 1
5212 <b>X</b>-Binary-Element-Type: "signed 32-bit integer"
5213 Content-MD5: 07lZFvF+aOcW85IN7usl8A==
5214
5215 AABRAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZBQSr1sKNBOeOe9HITdMdDUnbq7bg
5216 ...
5217 8REo6TtBrxJ1vKqAvx9YDMD6J18Qg83OMr/tgssjMIJMXATDsZobL90AEXc4KigE
5218
5219 --CIF-BINARY-FORMAT-SECTION----
5220 ;
5221 ;
5222
5223 ; Example 3 - Example 2 revised for a spiral scan (R. M. Sweet,
5224 P. J. Ellis &amp; H. J. Bernstein).
5225
5226 A detector is placed 240 mm along the <b>Z</b> axis from the
5227 goniometer, as in Example 2 above, but in this example the
5228 image plate is scanned in a spiral pattern from the outside edge in.
5229
5230 The axis for positioning the detector in the <b>Y</b> direction depends
5231 on the detector <b>Z</b> axis. This axis is called DETECTOR_Y.
5232
5233 The axis for positioning the detector in the <b>X</b> direction depends
5234 on the detector <b>Y</b> axis (and therefore on the detector <b>Z</b> axis).
5235 This axis is called DETECTOR_X.
5236
5237 This detector may be rotated around the <b>Y</b> axis. This rotation axis
5238 depends on the three translation axes. It is called DETECTOR_PITCH.
5239
5240 A coordinate system is defined on the face of the detector in
5241 terms of a coupled rotation axis and radial scan axis to form
5242 a spiral scan. The rotation axis is called ELEMENT_ROT and the
5243 radial axis is called ELEMENT_RAD. A 150 micrometre radial pitch
5244 and a 75 micrometre 'constant velocity' angular pitch are assumed.
5245
5246 Indexing is carried out first on the rotation axis and the radial axis
5247 is made to be dependent on it.
5248
5249 The two axes are coupled to form an axis set ELEMENT_SPIRAL.
5250 ;
5251 ; ###CBF: VERSION 1.1
5252
5253 data_image_1
5254
5255 # category DIFFRN
5256 _diffrn.id P6MB
5257 _diffrn.crystal_id P6MB_CRYSTAL7
5258
5259 # category DIFFRN_SOURCE
5260 loop_
5261 _diffrn_source.diffrn_id
5262 _diffrn_source.source
5263 _diffrn_source.type
5264 P6MB synchrotron 'SSRL beamline 9-1'
5265
5266 # category <a href="#DIFFRN_RADIATION">DIFFRN_RADIATION</a>
5267 loop_
5268 <a href="#_diffrn_radiation.diffrn_id">_diffrn_radiation.diffrn_id</a>
5269 <a href="#_diffrn_radiation.wavelength_id">_diffrn_radiation.wavelength_id</a>
5270 <a href="#_diffrn_radiation.monochromator">_diffrn_radiation.monochromator</a>
5271 <a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>
5272 <a href="#_diffrn_radiation.polarizn_source_norm">_diffrn_radiation.polarizn_source_norm</a>
5273 <a href="#_diffrn_radiation.div_x_source">_diffrn_radiation.div_x_source</a>
5274 <a href="#_diffrn_radiation.div_y_source">_diffrn_radiation.div_y_source</a>
5275 <a href="#_diffrn_radiation.div_x_y_source">_diffrn_radiation.div_x_y_source</a>
5276 P6MB WAVELENGTH1 'Si 111' 0.8 0.0 0.08
5277 0.01 0.00
5278
5279 # category DIFFRN_RADIATION_WAVELENGTH
5280 loop_
5281 _diffrn_radiation_wavelength.id
5282 _diffrn_radiation_wavelength.wavelength
5283 _diffrn_radiation_wavelength.wt
5284 WAVELENGTH1 0.98 1.0
5285
5286 # category <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a>
5287 loop_
5288 <a href="#_diffrn_detector.diffrn_id">_diffrn_detector.diffrn_id</a>
5289 <a href="#_diffrn_detector.id">_diffrn_detector.id</a>
5290 <a href="#_diffrn_detector.type">_diffrn_detector.type</a>
5291 <a href="#_diffrn_detector.number_of_axes">_diffrn_detector.number_of_axes</a>
5292 P6MB MAR345-SN26 'MAR 345' 4
5293
5294 # category <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a>
5295 loop_
5296 <a href="#_diffrn_detector_axis.detector_id">_diffrn_detector_axis.detector_id</a>
5297 <a href="#_diffrn_detector_axis.axis_id">_diffrn_detector_axis.axis_id</a>
5298 MAR345-SN26 DETECTOR_X
5299 MAR345-SN26 DETECTOR_Y
5300 MAR345-SN26 DETECTOR_Z
5301 MAR345-SN26 DETECTOR_PITCH
5302
5303 # category <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a>
5304 loop_
5305 <a href="#_diffrn_detector_element.id">_diffrn_detector_element.id</a>
5306 <a href="#_diffrn_detector_element.detector_id#">_diffrn_detector_element.detector_id</a>
5307 ELEMENT1 MAR345-SN26
5308
5309 # category <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a>
5310 loop_
5311 <a href="#_diffrn_data_frame.id">_diffrn_data_frame.id</a>
5312 <a href="#_diffrn_data_frame.detector_element_id">_diffrn_data_frame.detector_element_id</a>
5313 <a href="#_diffrn_data_frame.array_id">_diffrn_data_frame.array_id</a>
5314 <a href="#_diffrn_data_frame.binary_id">_diffrn_data_frame.binary_id</a>
5315 FRAME1 ELEMENT1 ARRAY1 1
5316
5317 # category <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a>
5318 loop_
5319 <a href="#_diffrn_measurement.diffrn_id">_diffrn_measurement.diffrn_id</a>
5320 <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a>
5321 <a href="#_diffrn_measurement.number_of_axes">_diffrn_measurement.number_of_axes</a>
5322 <a href="#_diffrn_measurement.method">_diffrn_measurement.method</a>
5323 P6MB GONIOMETER 3 rotation
5324
5325 # category <a href="#DIFFRN_MEASUREMENT_AXIS">DIFFRN_MEASUREMENT_AXIS</a>
5326 loop_
5327 <a href="#_diffrn_measurement_axis.measurement_id">_diffrn_measurement_axis.measurement_id</a>
5328 <a href="#_diffrn_measurement_axis.axis_id">_diffrn_measurement_axis.axis_id</a>
5329 GONIOMETER GONIOMETER_PHI
5330 GONIOMETER GONIOMETER_KAPPA
5331 GONIOMETER GONIOMETER_OMEGA
5332
5333 # category <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a>
5334 loop_
5335 <a href="#_diffrn_scan.id" >_diffrn_scan.id</a>
5336 <a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>
5337 <a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>
5338 <a href="#_diffrn_scan.frames" >_diffrn_scan.frames</a>
5339 SCAN1 FRAME1 FRAME1 1
5340
5341 # category <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>
5342 loop_
5343 <a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>
5344 <a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>
5345 <a href="#_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>
5346 <a href="#_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>
5347 <a href="#_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>
5348 <a href="#_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>
5349 <a href="#_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>
5350 <a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>
5351 SCAN1 GONIOMETER_OMEGA 12.0 1.0 1.0 0.0 0.0 0.0
5352 SCAN1 GONIOMETER_KAPPA 23.3 0.0 0.0 0.0 0.0 0.0
5353 SCAN1 GONIOMETER_PHI -165.8 0.0 0.0 0.0 0.0 0.0
5354 SCAN1 DETECTOR_Z 0.0 0.0 0.0 -240.0 0.0 0.0
5355 SCAN1 DETECTOR_Y 0.0 0.0 0.0 0.6 0.0 0.0
5356 SCAN1 DETECTOR_X 0.0 0.0 0.0 -0.5 0.0 0.0
5357 SCAN1 DETECTOR_PITCH 0.0 0.0 0.0 0.0 0.0 0.0
5358
5359 # category <a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a>
5360 loop_
5361 <a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>
5362 <a href="#_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a>
5363 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
5364 <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
5365 <a href="#_diffrn_scan_frame.date" >_diffrn_scan_frame.date</a>
5366 FRAME1 1 20.0 SCAN1 1997-12-04T10:23:48
5367
5368 # category <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a>
5369 loop_
5370 <a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>
5371 <a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>
5372 <a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>
5373 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
5374 FRAME1 GONIOMETER_OMEGA 12.0 0.0
5375 FRAME1 GONIOMETER_KAPPA 23.3 0.0
5376 FRAME1 GONIOMETER_PHI -165.8 0.0
5377 FRAME1 DETECTOR_Z 0.0 -240.0
5378 FRAME1 DETECTOR_Y 0.0 0.6
5379 FRAME1 DETECTOR_X 0.0 -0.5
5380 FRAME1 DETECTOR_PITCH 0.0 0.0
5381
5382 # category <a href="#AXIS">AXIS</a>
5383 loop_
5384 <a href="#_axis.id">_axis.id</a>
5385 <a href="#_axis.type">_axis.type</a>
5386 <a href="#_axis.equipment">_axis.equipment</a>
5387 <a href="#_axis.depends_on">_axis.depends_on</a>
5388 <a href="#_axis.vector[1]">_axis.vector[1]</a> <a href="#_axis.vector[2]">_axis.vector[2]</a> <a href="#_axis.vector[3]">_axis.vector[3]</a>
5389 <a href="#_axis.offset[1]">_axis.offset[1]</a> <a href="#_axis.offset[2]">_axis.offset[2]</a> <a href="#_axis.offset[3]">_axis.offset[3]</a>
5390 GONIOMETER_OMEGA rotation goniometer . 1 0 0 . . .
5391 GONIOMETER_KAPPA rotation goniometer GONIOMETER_OMEGA 0.64279
5392 0 0.76604 . . .
5393 GONIOMETER_PHI rotation goniometer GONIOMETER_KAPPA 1 0 0
5394 . . .
5395 SOURCE general source . 0 0 1 . . .
5396 GRAVITY general gravity . 0 -1 0 . . .
5397 DETECTOR_Z translation detector . 0 0 1 0 0 0
5398 DETECTOR_Y translation detector DETECTOR_Z 0 1 0 0 0 0
5399 DETECTOR_X translation detector DETECTOR_Y 1 0 0 0 0 0
5400 DETECTOR_PITCH rotation detector DETECTOR_X 0 1 0 0 0 0
5401 ELEMENT_ROT translation detector DETECTOR_PITCH 0 0 1 0 0 0
5402 ELEMENT_RAD translation detector ELEMENT_ROT 0 1 0 0 0 0
5403
5404 # category <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a>
5405 loop_
5406 <a href="#_array_structure_list.array_id">_array_structure_list.array_id</a>
5407 <a href="#_array_structure_list.index">_array_structure_list.index</a>
5408 <a href="#_array_structure_list.dimension">_array_structure_list.dimension</a>
5409 <a href="#_array_structure_list.precedence">_array_structure_list.precedence</a>
5410 <a href="#_array_structure_list.direction">_array_structure_list.direction</a>
5411 <a href="#_array_structure_list.axis_set_id">_array_structure_list.axis_set_id</a>
5412 ARRAY1 1 8309900 1 increasing ELEMENT_SPIRAL
5413
5414 # category <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a>
5415 loop_
5416 <a href="#_array_structure_list_axis.axis_set_id">_array_structure_list_axis.axis_set_id</a>
5417 <a href="#_array_structure_list_axis.axis_id">_array_structure_list_axis.axis_id</a>
5418 <a href="#_array_structure_list_axis.angle">_array_structure_list_axis.angle</a>
5419 <a href="#_array_structure_list_axis.displacement">_array_structure_list_axis.displacement</a>
5420 <a href="#_array_structure_list_axis.angular_pitch">_array_structure_list_axis.angular_pitch</a>
5421 <a href="#_array_structure_list_axis.radial_pitch">_array_structure_list_axis.radial_pitch</a>
5422 ELEMENT_SPIRAL ELEMENT_ROT 0 . 0.075 .
5423 ELEMENT_SPIRAL ELEMENT_RAD . 172.5 . -0.150
5424
5425 # category <a href="#ARRAY_ELEMENT_SIZE">ARRAY_ELEMENT_SIZE</a>
5426 # the actual pixels are 0.075 by 0.150 mm
5427 # We give the coarser dimension here.
5428 loop_
5429 <a href="#_array_element_size.array_id">_array_element_size.array_id</a>
5430 <a href="#_array_element_size.index">_array_element_size.index</a>
5431 <a href="#_array_element_size.index">_array_element_size.size</a>
5432 ARRAY1 1 150e-6
5433
5434 # category <a href="#ARRAY_INTENSITIES">ARRAY_INTENSITIES</a>
5435 loop_
5436 <a href="#_array_intensities.array_id">_array_intensities.array_id</a>
5437 <a href="#_array_intensities.binary_id">_array_intensities.binary_id</a>
5438 <a href="#_array_intensities.linearity">_array_intensities.linearity</a>
5439 <a href="#_array_intensities.gain">_array_intensities.gain</a>
5440 <a href="#_array_intensities.gain_esd">_array_intensities.gain_esd</a>
5441 <a href="#_array_intensities.overload">_array_intensities.overload</a>
5442 <a href="#_array_intensities.undefined_value">_array_intensities.undefined_value</a>
5443 ARRAY1 1 linear 1.15 0.2 240000 0
5444
5445 # category <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a>
5446 loop_
5447 <a href="#_array_structure.id">_array_structure.id</a>
5448 <a href="#_array_structure.encoding_type">_array_structure.encoding_type</a>
5449 <a href="#_array_structure.compression_type">_array_structure.compression_type</a>
5450 <a href="#_array_structure.byte_order">_array_structure.byte_order</a>
5451 ARRAY1 "signed 32-bit integer" packed little_endian
5452
5453 # category <a href="#ARRAY_DATA">ARRAY_DATA</a>
5454 loop_
5455 <a href="#_array_data.array_id">_array_data.array_id</a>
5456 <a href="#_array_data.binary_id">_array_data.binary_id</a>
5457 <a href="#_array_data.data">_array_data.data</a>
5458 ARRAY1 1
5459 ;
5460 --CIF-BINARY-FORMAT-SECTION--
5461 Content-Type: application/octet-stream;
5462 conversions="<b>X</b>-CBF_PACKED"
5463 Content-Transfer-Encoding: BASE64
5464 <b>X</b>-Binary-Size: 3801324
5465 <b>X</b>-Binary-ID: 1
5466 <b>X</b>-Binary-Element-Type: "signed 32-bit integer"
5467 Content-MD5: 07lZFvF+aOcW85IN7usl8A==
5468
5469 AABRAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZBQSr1sKNBOeOe9HITdMdDUnbq7bg
5470 ...
5471 8REo6TtBrxJ1vKqAvx9YDMD6J18Qg83OMr/tgssjMIJMXATDsZobL90AEXc4KigE
5472
5473 --CIF-BINARY-FORMAT-SECTION----
5474 ;
5475 ;
5476 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
5477 save_
5478
5479
5480 save_<a name="_diffrn_scan.id" >_diffrn_scan.id</a>
5481 _item_description.description
5482 ; The value of <a href="#_diffrn_scan.id" >_diffrn_scan.id</a> uniquely identifies each
5483 scan. The identifier is used to tie together all the
5484 information about the scan.
5485 ;
5486 loop_
5487 _item.name
5488 _item.category_id
5489 _item.mandatory_code
5490 '<a href="#_diffrn_scan.id" >_diffrn_scan.id</a>' diffrn_scan yes
5491 '<a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>' diffrn_scan_axis yes
5492 '<a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>' diffrn_scan_frame yes
5493 _item_type.code code
5494 loop_
5495 _item_linked.child_name
5496 _item_linked.parent_name
5497 '<a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>' '<a href="#_diffrn_scan.id" >_diffrn_scan.id</a>'
5498 '<a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>' '<a href="#_diffrn_scan.id" >_diffrn_scan.id</a>'
5499 save_
5500
5501
5502 save_<a name="_diffrn_scan.date_end">_diffrn_scan.date_end</a>
5503 _item_description.description
5504 ; The date and time of the end of the scan. Note that this
5505 may be an estimate generated during the scan, before the
5506 precise time of the end of the scan is known.
5507 ;
5508 _item.name '<a href="#_diffrn_scan.date_end">_diffrn_scan.date_end</a>'
5509 _item.category_id diffrn_scan
5510 _item.mandatory_code no
5511 _item_type.code yyyy-mm-dd
5512 save_
5513
5514
5515 save_<a name="_diffrn_scan.date_start">_diffrn_scan.date_start</a>
5516 _item_description.description
5517 ; The date and time of the start of the scan.
5518 ;
5519 _item.name '<a href="#_diffrn_scan.date_start">_diffrn_scan.date_start</a>'
5520 _item.category_id diffrn_scan
5521 _item.mandatory_code no
5522 _item_type.code yyyy-mm-dd
5523 save_
5524
5525
5526 save_<a name="_diffrn_scan.integration_time" >_diffrn_scan.integration_time</a>
5527 _item_description.description
5528 ; Approximate average time in seconds to integrate each
5529 step of the scan. The precise time for integration
5530 of each particular step must be provided in
5531 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>, even
5532 if all steps have the same integration time.
5533 ;
5534 _item.name '<a href="#_diffrn_scan.integration_time" >_diffrn_scan.integration_time</a>'
5535 _item.category_id diffrn_scan
5536 _item.mandatory_code no
5537 _item_type.code float
5538 _item_units.code 'seconds'
5539 loop_
5540 _item_range.maximum
5541 _item_range.minimum
5542 . 0.0
5543 save_
5544
5545
5546 save_<a name="_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>
5547 _item_description.description
5548 ; The value of this data item is the identifier of the
5549 first frame in the scan.
5550
5551 This item is a pointer to <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a> in the
5552 <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
5553 ;
5554 _item.name '<a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>'
5555 _item.category_id diffrn_scan
5556 _item.mandatory_code yes
5557 _item_type.code code
5558 save_
5559
5560
5561 save_<a name="_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>
5562 _item_description.description
5563 ; The value of this data item is the identifier of the
5564 last frame in the scan.
5565
5566 This item is a pointer to <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a> in the
5567 <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
5568 ;
5569 _item.name '<a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>'
5570 _item.category_id diffrn_scan
5571 _item.mandatory_code yes
5572 _item_type.code code
5573 save_
5574
5575
5576 save_<a name="_diffrn_scan.frames" >_diffrn_scan.frames</a>
5577 _item_description.description
5578 ; The value of this data item is the number of frames in
5579 the scan.
5580 ;
5581 _item.name '<a href="#_diffrn_scan.frames" >_diffrn_scan.frames</a>'
5582 _item.category_id diffrn_scan
5583 _item.mandatory_code no
5584 _item_type.code int
5585 loop_
5586 _item_range.maximum
5587 _item_range.minimum
5588 . 1
5589 1 1
5590 save_
5591
5592 save_<a name="_diffrn_scan.time_period" >_diffrn_scan.time_period</a>
5593 _item_description.description
5594 ; Approximate average time in seconds between the start
5595 of each step of the scan. The precise start-to-start
5596 time increment of each particular step may be provided in
5597 <a href="#_diffrn_scan_frame.time_period" >_diffrn_scan_frame.time_period</a>.
5598 ;
5599 _item.name '<a href="#_diffrn_scan.time_period" >_diffrn_scan.time_period</a>'
5600 _item.category_id diffrn_scan
5601 _item.mandatory_code no
5602 _item_type.code float
5603 _item_units.code 'seconds'
5604 loop_
5605 _item_range.maximum
5606 _item_range.minimum
5607 . 0.0
5608 save_
5609
5610
5611 save_<a name="_diffrn_scan.time_rstrt_incr" >_diffrn_scan.time_rstrt_incr</a>
5612 _item_description.description
5613 ; Approximate average time in seconds between the end
5614 of integration of each step of the scan than the start
5615 of integration of the next step.
5616
5617 In general, this will agree with
5618 <a href="#_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame.time_rstrt_incr</a>. The
5619 sum of the values of <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
5620 and <a href="#_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame.time_rstrt_incr</a> is the
5621 time from the start of integration of one frame and the start of
5622 integration for the next frame and should equal the value of
5623 <a href="#_diffrn_scan_frame.time_period" >_diffrn_scan_frame.time_period</a> for this
5624 frame. If the individual frame values vary, then the value of
5625 <a href="#_diffrn_scan.time_rstrt_incr" >_diffrn_scan.time_rstrt_incr</a> will be
5626 representative of the ensemble of values of
5627 <a href="#_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame_axis.time_rstrt_incr</a> (e.g.
5628 the mean).
5629 ;
5630 _item.name '<a href="#_diffrn_scan.time_period" >_diffrn_scan.time_period</a>'
5631 _item.category_id diffrn_scan
5632 _item.mandatory_code no
5633 _item_type.code float
5634 _item_units.code 'seconds'
5635 loop_
5636 _item_range.maximum
5637 _item_range.minimum
5638 . 0.0
5639 save_
5640
5641
5642 save_<a name="_diffrn_scan.variant" >_diffrn_scan.variant</a>
5643 _item_description.description
5644 ; The value of <a href="#_diffrn_scan.variant" >_diffrn_scan.variant</a> gives the variant
5645 to which the given diffrn_scan row is related.
5646
5647 If this value is not given, the variant is assumed to the default
5648 null variant.
5649
5650
5651 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
5652 <a href="#VARIANT">VARIANT</a> category.
5653 ;
5654 _item.name '<a href="#_diffrn_scan.variant" >_diffrn_scan.variant</a>'
5655 _item.category_id diffrn_scan
5656 _item.mandatory_code no
5657 _item_type.code code
5658 save_
5659
5660
5661 ####################
5662 # <a name="DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a> #
5663 ####################
5664
5665 save_DIFFRN_SCAN_AXIS
5666 _category.description
5667 ; Data items in the <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a> category describe the settings of
5668 axes for particular scans. Unspecified axes are assumed to be at
5669 their zero points.
5670 ;
5671 _category.id diffrn_scan_axis
5672 _category.mandatory_code no
5673 loop_
5674 _category_key.name
5675 '<a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>'
5676 '<a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>'
5677 '<a href="#_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a>'
5678 loop_
5679 _category_group.id 'inclusive_group'
5680 'diffrn_group'
5681 save_
5682
5683
5684 save_<a name="_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>
5685 _item_description.description
5686 ; The value of this data item is the identifier of the
5687 scan for which axis settings are being specified.
5688
5689 Multiple axes may be specified for the same value of
5690 <a href="#_diffrn_scan.id" >_diffrn_scan.id</a>.
5691
5692 This item is a pointer to <a href="#_diffrn_scan.id" >_diffrn_scan.id</a> in the
5693 <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a> category.
5694 ;
5695 _item.name '<a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>'
5696 _item.category_id diffrn_scan_axis
5697 _item.mandatory_code yes
5698 _item_type.code code
5699 save_
5700
5701
5702 save_<a name="_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>
5703 _item_description.description
5704 ; The value of this data item is the identifier of one of
5705 the axes for the scan for which settings are being specified.
5706
5707 Multiple axes may be specified for the same value of
5708 <a href="#_diffrn_scan.id" >_diffrn_scan.id</a>.
5709
5710 This item is a pointer to <a href="#_axis.id" >_axis.id</a> in the
5711 AXIS category.
5712 ;
5713 _item.name '<a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>'
5714 _item.category_id diffrn_scan_axis
5715 _item.mandatory_code yes
5716 _item_type.code code
5717 save_
5718
5719
5720 save_<a name="_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>
5721 _item_description.description
5722 ; The starting position for the specified axis in degrees.
5723 ;
5724 _item.name '<a href="#_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>'
5725 _item.category_id diffrn_scan_axis
5726 _item.mandatory_code no
5727 _item_default.value 0.0
5728 _item_type.code float
5729 _item_units.code 'degrees'
5730 save_
5731
5732
5733 save_<a name="_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>
5734 _item_description.description
5735 ; The range from the starting position for the specified axis
5736 in degrees.
5737 ;
5738 _item.name '<a href="#_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>'
5739 _item.category_id diffrn_scan_axis
5740 _item.mandatory_code no
5741 _item_default.value 0.0
5742 _item_type.code float
5743 _item_units.code 'degrees'
5744 save_
5745
5746
5747 save_<a name="_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>
5748 _item_description.description
5749 ; The increment for each step for the specified axis
5750 in degrees. In general, this will agree with
5751 <a href="#_diffrn_scan_frame_axis.angle_increment" >_diffrn_scan_frame_axis.angle_increment</a>. The
5752 sum of the values of <a href="#_diffrn_scan_frame_axis.angle">_diffrn_scan_frame_axis.angle</a> and
5753 <a href="#_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a> is the
5754 angular setting of the axis at the end of the integration
5755 time for a given frame. If the individual frame values
5756 vary, then the value of
5757 <a href="#_diffrn_scan_axis.angle_increment">_diffrn_scan_axis.angle_increment</a> will be
5758 representative
5759 of the ensemble of values of
5760 <a href="#_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a> (e.g.
5761 the mean).
5762 ;
5763 _item.name '<a href="#_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>'
5764 _item.category_id diffrn_scan_axis
5765 _item.mandatory_code no
5766 _item_default.value 0.0
5767 _item_type.code float
5768 _item_units.code 'degrees'
5769 save_
5770
5771
5772 save_<a name="_diffrn_scan_axis.angle_rstrt_incr">_diffrn_scan_axis.angle_rstrt_incr</a>
5773 _item_description.description
5774 ; The increment after each step for the specified axis
5775 in degrees. In general, this will agree with
5776 <a href="#_diffrn_scan_frame_axis.angle_rstrt_incr" >_diffrn_scan_frame_axis.angle_rstrt_incr</a>. The
5777 sum of the values of <a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>,
5778 <a href="#_diffrn_scan_frame_axis.angle_increment" >_diffrn_scan_frame_axis.angle_increment</a>
5779 and <a href="#_diffrn_scan_frame_axis.angle_rstrt_incr" >_diffrn_scan_frame_axis.angle_rstrt_incr</a> is the
5780 angular setting of the axis at the start of the integration
5781 time for the next frame relative to a given frame and
5782 should equal <a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a> for this
5783 next frame. If the individual frame values
5784 vary, then the value of
5785 <a href="#_diffrn_scan_axis.angle_rstrt_incr" >_diffrn_scan_axis.angle_rstrt_incr</a> will be
5786 representative
5787 of the ensemble of values of
5788 <a href="#_diffrn_scan_frame_axis.angle_rstrt_incr" >_diffrn_scan_frame_axis.angle_rstrt_incr</a> (e.g.
5789 the mean).
5790 ;
5791 _item.name '<a href="#_diffrn_scan_axis.angle_rstrt_incr">_diffrn_scan_axis.angle_rstrt_incr</a>'
5792 _item.category_id diffrn_scan_axis
5793 _item.mandatory_code no
5794 _item_default.value 0.0
5795 _item_type.code float
5796 _item_units.code 'degrees'
5797 save_
5798
5799
5800 save_<a name="_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>
5801 _item_description.description
5802 ; The starting position for the specified axis in millimetres.
5803 ;
5804 _item.name '<a href="#_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>'
5805 _item.category_id diffrn_scan_axis
5806 _item.mandatory_code no
5807 _item_default.value 0.0
5808 _item_type.code float
5809 _item_units.code 'millimetres'
5810 save_
5811
5812
5813 save_<a name="_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>
5814 _item_description.description
5815 ; The range from the starting position for the specified axis
5816 in millimetres.
5817 ;
5818 _item.name '<a href="#_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>'
5819 _item.category_id diffrn_scan_axis
5820 _item.mandatory_code no
5821 _item_default.value 0.0
5822 _item_type.code float
5823 _item_units.code 'millimetres'
5824 save_
5825
5826
5827 save_<a name="_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>
5828 _item_description.description
5829 ; The increment for each step for the specified axis
5830 in millimetres. In general, this will agree with
5831 <a href="#_diffrn_scan_frame_axis.displacement_increment">_diffrn_scan_frame_axis.displacement_increment</a>.
5832 The sum of the values of
5833 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a> and
5834 <a href="#_diffrn_scan_frame_axis.displacement_increment" >_diffrn_scan_frame_axis.displacement_increment</a> is the
5835 angular setting of the axis at the end of the integration
5836 time for a given frame. If the individual frame values
5837 vary, then the value of
5838 <a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a> will be
5839 representative
5840 of the ensemble of values of
5841 <a href="#_diffrn_scan_frame_axis.displacement_increment" >_diffrn_scan_frame_axis.displacement_increment</a> (e.g.
5842 the mean).
5843 ;
5844 _item.name '<a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>'
5845 _item.category_id diffrn_scan_axis
5846 _item.mandatory_code no
5847 _item_default.value 0.0
5848 _item_type.code float
5849 _item_units.code 'millimetres'
5850 save_
5851
5852
5853 save_<a name="_diffrn_scan_axis.displacement_rstrt_incr">_diffrn_scan_axis.displacement_rstrt_incr</a>
5854 _item_description.description
5855 ; The increment for each step for the specified axis
5856 in millimetres. In general, this will agree with
5857 <a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr">_diffrn_scan_frame_axis.displacement_rstrt_incr</a>.
5858 The sum of the values of
5859 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>,
5860 <a href="#_diffrn_scan_frame_axis.displacement_increment" >_diffrn_scan_frame_axis.displacement_increment</a> and
5861 <a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr" >_diffrn_scan_frame_axis.displacement_rstrt_incr</a> is the
5862 angular setting of the axis at the start of the integration
5863 time for the next frame relative to a given frame and
5864 should equal <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
5865 for this next frame. If the individual frame values
5866 vary, then the value of
5867 <a href="#_diffrn_scan_axis.displacement_rstrt_incr" >_diffrn_scan_axis.displacement_rstrt_incr</a> will be
5868 representative
5869 of the ensemble of values of
5870 <a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr" >_diffrn_scan_frame_axis.displacement_rstrt_incr</a> (e.g.
5871 the mean).
5872 ;
5873 _item.name '<a href="#_diffrn_scan_axis.displacement_rstrt_incr">_diffrn_scan_axis.displacement_rstrt_incr</a>'
5874 _item.category_id diffrn_scan_axis
5875 _item.mandatory_code no
5876 _item_default.value 0.0
5877 _item_type.code float
5878 _item_units.code 'millimetres'
5879 save_
5880
5881 save_<a name="_diffrn_scan_axis.reference_angle">_diffrn_scan_axis.reference_angle</a>
5882 _item_description.description
5883 ; The setting of the specified axis in degrees
5884 against which measurements of the reference beam center
5885 and reference detector distance should be made.
5886
5887 In general, this will agree with
5888 <a href="#_diffrn_scan_frame_axis.reference_angle">_diffrn_scan_frame_axis.reference_angle</a>.
5889
5890 If the individual frame values vary, then the value of
5891 <a href="#_diffrn_scan_axis.reference_angle">_diffrn_scan_axis.reference_angle</a> will be
5892 representative of the ensemble of values of
5893 <a href="#_diffrn_scan_frame_axis.reference_angle">_diffrn_scan_frame_axis.reference_angle</a> (e.g.
5894 the mean).
5895
5896 If not specified, the value defaults to zero.
5897 ;
5898 _item.name '<a href="#_diffrn_scan_axis.reference_angle">_diffrn_scan_axis.reference_angle</a>'
5899 _item.category_id diffrn_scan_axis
5900 _item.mandatory_code implicit
5901 _item_default.value 0.0
5902 _item_type.code float
5903 _item_units.code 'degrees'
5904 save_
5905
5906
5907 save_<a name="_diffrn_scan_axis.reference_displacement">_diffrn_scan_axis.reference_displacement</a>
5908 _item_description.description
5909 ; The setting of the specified axis in millimetres
5910 against which measurements of the reference beam center
5911 and reference detector distance should be made.
5912
5913 In general, this will agree with
5914 <a href="#_diffrn_scan_frame_axis.reference_displacement">_diffrn_scan_frame_axis.reference_displacement</a>.
5915
5916 If the individual frame values vary, then the value of
5917 <a href="#_diffrn_scan_axis.reference_displacement">_diffrn_scan_axis.reference_displacement</a> will be
5918 representative of the ensemble of values of
5919 <a href="#_diffrn_scan_frame_axis.reference_displacement">_diffrn_scan_frame_axis.reference_displacement</a> (e.g.
5920 the mean).
5921
5922 If not specified, the value defaults to to the value of
5923 <a href="#">_diffrn_scan_axis.displacement</a>.
5924 ;
5925 _item.name '<a href="#_diffrn_scan_axis.reference_displacement">_diffrn_scan_axis.reference_displacement</a>'
5926 _item.category_id diffrn_scan_axis
5927 _item.mandatory_code implicit
5928 _item_type.code float
5929 _item_units.code 'millimetres'
5930 save_
5931
5932 save_<a name="_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a>
5933 _item_description.description
5934 ; The value of <a href="#_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a> gives the variant
5935 to which the given diffrn_scan_axis row is related.
5936
5937 If this value is not given, the variant is assumed to the default
5938 null variant.
5939
5940 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
5941 <a href="#VARIANT">VARIANT</a> category.
5942 ;
5943 _item.name '<a href="#_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a>'
5944 _item.category_id diffrn_scan_axis
5945 _item.mandatory_code no
5946 _item_type.code code
5947 save_
5948
5949
5950
5951 #####################
5952 # <a name="DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a> #
5953 #####################
5954
5955 save_DIFFRN_SCAN_FRAME
5956 _category.description
5957 ; Data items in the <a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a> category describe
5958 the relationships of particular frames to scans.
5959 ;
5960 _category.id diffrn_scan_frame
5961 _category.mandatory_code no
5962 loop_
5963 _category_key.name
5964 '<a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>'
5965 '<a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>'
5966 '<a href="#_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a>'
5967 loop_
5968 _category_group.id 'inclusive_group'
5969 'diffrn_group'
5970 save_
5971
5972
5973 save_<a name="_diffrn_scan_frame.date">_diffrn_scan_frame.date</a>
5974 _item_description.description
5975 ; The date and time of the start of the frame being scanned.
5976 ;
5977 _item.name '<a href="#_diffrn_scan_frame.date">_diffrn_scan_frame.date</a>'
5978 _item.category_id diffrn_scan_frame
5979 _item.mandatory_code no
5980 _item_type.code yyyy-mm-dd
5981 save_
5982
5983
5984 save_<a name="_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>
5985 _item_description.description
5986 ; The value of this data item is the identifier of the
5987 frame being examined.
5988
5989 This item is a pointer to <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a> in the
5990 <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
5991 ;
5992 _item.name '<a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>'
5993 _item.category_id diffrn_scan_frame
5994 _item.mandatory_code yes
5995 _item_type.code code
5996 save_
5997
5998
5999 save_<a name="_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a>
6000 _item_description.description
6001 ; The value of this data item is the number of the frame
6002 within the scan, starting with 1. It is not necessarily
6003 the same as the value of <a href="#_diffrn_scan_frame.frame_id">_diffrn_scan_frame.frame_id</a>,
6004 but it may be.
6005
6006 ;
6007 _item.name '<a href="#_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a>'
6008 _item.category_id diffrn_scan_frame
6009 _item.mandatory_code no
6010 _item_type.code int
6011 loop_
6012 _item_range.maximum
6013 _item_range.minimum
6014 . 0
6015 0 0
6016 save_
6017
6018
6019 save_<a name="_diffrn_scan_frame.integration_time">_diffrn_scan_frame.integration_time</a>
6020 _item_description.description
6021 ; The time in seconds to integrate this step of the scan.
6022 This should be the precise time of integration of each
6023 particular frame. The value of this data item should
6024 be given explicitly for each frame and not inferred
6025 from the value of <a href="#_diffrn_scan.integration_time" >_diffrn_scan.integration_time</a>.
6026 ;
6027 _item.name '<a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>'
6028 _item.category_id diffrn_scan_frame
6029 _item.mandatory_code yes
6030 _item_type.code float
6031 _item_units.code 'seconds'
6032 loop_
6033 _item_range.maximum
6034 _item_range.minimum
6035 . 0.0
6036 save_
6037
6038
6039 save_<a name="_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
6040 _item_description.description
6041 ; The value of <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a> identifies the scan
6042 containing this frame.
6043
6044 This item is a pointer to <a href="#_diffrn_scan.id" >_diffrn_scan.id</a> in the
6045 <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a> category.
6046 ;
6047 _item.name '<a href="#_diffrn_scan_frame.scan_id">_diffrn_scan_frame.scan_id</a>'
6048 _item.category_id diffrn_scan_frame
6049 _item.mandatory_code yes
6050 _item_type.code code
6051 save_
6052
6053
6054 save_<a name="_diffrn_scan_frame.time_period" >_diffrn_scan_frame.time_period</a>
6055 _item_description.description
6056 ; The time in seconds between the start of this frame and the
6057 start of the next frame, if any. If there is no next frame,
6058 a null value should be given.
6059 ;
6060 _item.name '<a href="#_diffrn_scan_frame.time_period" >_diffrn_scan_frame.time_period</a>'
6061 _item.category_id diffrn_scan_frame
6062 _item.mandatory_code no
6063 _item_type.code float
6064 _item_units.code 'seconds'
6065 loop_
6066 _item_range.maximum
6067 _item_range.minimum
6068 . 0.0
6069 save_
6070
6071
6072 save_<a name="_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame.time_rstrt_incr</a>
6073 _item_description.description
6074 ; The time in seconds between the end of integration of this step of the scan
6075 and the start of integration of the next step.
6076
6077 The sum of the values of <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
6078 and <a href="#_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame.time_rstrt_incr</a> is the
6079 time from the start of integration of one frame and the start of
6080 integration for the next frame and should equal the value of
6081 <a href="#_diffrn_scan_frame.time_period" >_diffrn_scan_frame.time_period</a> for this
6082 frame. The value of <a href="#_diffrn_scan.time_rstrt_incr" >_diffrn_scan.time_rstrt_incr</a> will be
6083 representative of the ensemble of values of
6084 <a href="#_diffrn_scan_frame.time_rstrt_incr" >_diffrn_scan_frame_axis.time_rstrt_incr</a> (e.g.
6085 the mean).
6086
6087 If there is no next frame, a null value should be given.
6088 ;
6089 _item.name '<a href="#_diffrn_scan.time_period" >_diffrn_scan.time_period</a>'
6090 _item.category_id diffrn_scan
6091 _item.mandatory_code no
6092 _item_type.code float
6093 _item_units.code 'seconds'
6094 loop_
6095 _item_range.maximum
6096 _item_range.minimum
6097 . 0.0
6098 save_
6099
6100
6101 save_<a name="_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a>
6102 _item_description.description
6103 ; The value of <a href="#_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a> gives the variant
6104 to which the given diffrn_scan_frame row is related.
6105
6106 If this value is not given, the variant is assumed to the default
6107 null variant.
6108
6109 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
6110 <a href="#VARIANT">VARIANT</a> category.
6111 ;
6112 _item.name '<a href="#_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a>'
6113 _item.category_id diffrn_scan_frame
6114 _item.mandatory_code no
6115 _item_type.code code
6116 save_
6117
6118
6119 ##########################
6120 # <a name="DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a> #
6121 ##########################
6122
6123 save_DIFFRN_SCAN_FRAME_AXIS
6124 _category.description
6125 ; Data items in the <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a> category describe the
6126 settings of axes for particular frames. Unspecified axes are
6127 assumed to be at their zero points. If, for any given frame,
6128 nonzero values apply for any of the data items in this category,
6129 those values should be given explicitly in this category and not
6130 simply inferred from values in <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>.
6131 ;
6132 _category.id diffrn_scan_frame_axis
6133 _category.mandatory_code no
6134 loop_
6135 _category_key.name
6136 '<a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>'
6137 '<a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>'
6138 '<a href="#_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a>'
6139 loop_
6140 _category_group.id 'inclusive_group'
6141 'diffrn_group'
6142 save_
6143
6144
6145 save_<a name="_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>
6146 _item_description.description
6147 ; The value of this data item is the identifier of one of
6148 the axes for the frame for which settings are being specified.
6149
6150 Multiple axes may be specified for the same value of
6151 <a href="#_diffrn_scan_frame.id" >_diffrn_scan_frame.frame_id</a>.
6152
6153 This item is a pointer to <a href="#_axis.id" >_axis.id</a> in the
6154 <a href="#AXIS">AXIS</a> category.
6155 ;
6156 _item.name '<a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>'
6157 _item.category_id diffrn_scan_frame_axis
6158 _item.mandatory_code yes
6159 _item_type.code code
6160 save_
6161
6162
6163 save_<a name="_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>
6164 _item_description.description
6165 ; The setting of the specified axis in degrees for this frame.
6166 This is the setting at the start of the integration time.
6167 ;
6168 _item.name '<a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>'
6169 _item.category_id diffrn_scan_frame_axis
6170 _item.mandatory_code no
6171 _item_default.value 0.0
6172 _item_type.code float
6173 _item_units.code 'degrees'
6174 save_
6175
6176
6177 save_<a name="_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a>
6178 _item_description.description
6179 ; The increment for this frame for the angular setting of
6180 the specified axis in degrees. The sum of the values
6181 of <a href="#_diffrn_scan_frame_axis.angle">_diffrn_scan_frame_axis.angle</a> and
6182 <a href="#_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a> is the
6183 angular setting of the axis at the end of the integration
6184 time for this frame.
6185 ;
6186 _item.name '<a href="#_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a>'
6187 _item.category_id diffrn_scan_frame_axis
6188 _item.mandatory_code no
6189 _item_default.value 0.0
6190 _item_type.code float
6191 _item_units.code 'degrees'
6192 save_
6193
6194
6195 save_<a name="_diffrn_scan_frame_axis.angle_rstrt_incr">_diffrn_scan_frame_axis.angle_rstrt_incr</a>
6196 _item_description.description
6197 ; The increment after this frame for the angular setting of
6198 the specified axis in degrees. The sum of the values
6199 of <a href="#_diffrn_scan_frame_axis.angle">_diffrn_scan_frame_axis.angle</a>,
6200 <a href="#_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a> and
6201 <a href="#_diffrn_scan_frame_axis.angle_rstrt_incr">_diffrn_scan_frame_axis.angle_rstrt_incr</a> is the
6202 angular setting of the axis at the start of the integration
6203 time for the next frame and should equal
6204 <a href="#_diffrn_scan_frame_axis.angle">_diffrn_scan_frame_axis.angle</a> for this next frame.
6205 ;
6206 _item.name '<a href="#_diffrn_scan_frame_axis.angle_rstrt_incr">_diffrn_scan_frame_axis.angle_rstrt_incr</a>'
6207 _item.category_id diffrn_scan_frame_axis
6208 _item.mandatory_code no
6209 _item_default.value 0.0
6210 _item_type.code float
6211 _item_units.code 'degrees'
6212 save_
6213
6214
6215 save_<a name="_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
6216 _item_description.description
6217 ; The setting of the specified axis in millimetres for this
6218 frame. This is the setting at the start of the integration
6219 time.
6220 ;
6221 _item.name '<a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>'
6222 _item.category_id diffrn_scan_frame_axis
6223 _item.mandatory_code no
6224 _item_default.value 0.0
6225 _item_type.code float
6226 _item_units.code 'millimetres'
6227 save_
6228
6229
6230 save_<a name="_diffrn_scan_frame_axis.displacement_increment">_diffrn_scan_frame_axis.displacement_increment</a>
6231 _item_description.description
6232 ; The increment for this frame for the displacement setting of
6233 the specified axis in millimetres. The sum of the values
6234 of <a href="#_diffrn_scan_frame_axis.displacement">_diffrn_scan_frame_axis.displacement</a> and
6235 <a href="#_diffrn_scan_frame_axis.displacement_increment">_diffrn_scan_frame_axis.displacement_increment</a> is the
6236 angular setting of the axis at the end of the integration
6237 time for this frame.
6238 ;
6239 _item.name '<a href="#_diffrn_scan_frame_axis.displacement_increment">_diffrn_scan_frame_axis.displacement_increment</a>'
6240 _item.category_id diffrn_scan_frame_axis
6241 _item.mandatory_code no
6242 _item_default.value 0.0
6243 _item_type.code float
6244 _item_units.code 'millimetres'
6245 save_
6246
6247
6248 save_<a name="_diffrn_scan_frame_axis.displacement_rstrt_incr">_diffrn_scan_frame_axis.displacement_rstrt_incr</a>
6249 _item_description.description
6250 ; The increment for this frame for the displacement setting of
6251 the specified axis in millimetres. The sum of the values
6252 of <a href="#_diffrn_scan_frame_axis.displacement">_diffrn_scan_frame_axis.displacement</a>,
6253 <a href="#_diffrn_scan_frame_axis.displacement_increment">_diffrn_scan_frame_axis.displacement_increment</a> and
6254 <a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr">_diffrn_scan_frame_axis.displacement_rstrt_incr</a> is the
6255 angular setting of the axis at the start of the integration
6256 time for the next frame and should equal
6257 <a href="#_diffrn_scan_frame_axis.displacement">_diffrn_scan_frame_axis.displacement</a> for this next frame.
6258 ;
6259 _item.name '<a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr">_diffrn_scan_frame_axis.displacement_rstrt_incr</a>'
6260 _item.category_id diffrn_scan_frame_axis
6261 _item.mandatory_code no
6262 _item_default.value 0.0
6263 _item_type.code float
6264 _item_units.code 'millimetres'
6265 save_
6266
6267 save_<a name="_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>
6268 _item_description.description
6269 ; The value of this data item is the identifier of the
6270 frame for which axis settings are being specified.
6271
6272 Multiple axes may be specified for the same value of
6273 <a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>.
6274
6275 This item is a pointer to <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a> in the
6276 <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
6277 ;
6278 _item.name '<a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>'
6279 _item.category_id diffrn_scan_frame_axis
6280 _item.mandatory_code yes
6281 _item_type.code code
6282 save_
6283
6284 save_<a name="_diffrn_scan_frame_axis.reference_angle" >_diffrn_scan_frame_axis.reference_angle</a>
6285 _item_description.description
6286 ; The setting of the specified axis in degrees
6287 against which measurements of the reference beam center
6288 and reference detector distance should be made.
6289
6290 This is normally the same for all frames, but the
6291 option is provided here of making changes when
6292 needed.
6293
6294 If not provided, it is assumed to be zero.
6295 ;
6296 _item.name '<a href="#_diffrn_scan_frame_axis.reference_angle">_diffrn_scan_frame_axis.reference_angle</a>'
6297 _item.category_id diffrn_scan_frame_axis
6298 _item.mandatory_code implicit
6299 _item_default.value 0.0
6300 _item_type.code float
6301 _item_units.code 'degrees'
6302 save_
6303
6304
6305 save_<a name="_diffrn_scan_frame_axis.reference_displacement">_diffrn_scan_frame_axis.reference_displacement</a>
6306 _item_description.description
6307 ; The setting of the specified axis in millimetres for this
6308 frame against which measurements of the reference beam center
6309 and reference detector distance should be made.
6310
6311 This is normally the same for all frames, but the
6312 option is provided here of making changes when
6313 needed.
6314
6315 If not provided, it is assumed to be equal to
6316 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>.
6317 ;
6318 _item.name '<a href="#_diffrn_scan_frame_axis.reference_displacement">_diffrn_scan_frame_axis.reference_displacement</a>'
6319 _item.category_id diffrn_scan_frame_axis
6320 _item.mandatory_code implicit
6321 _item_type.code float
6322 _item_units.code 'millimetres'
6323 save_
6324
6325 save_<a name="_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a>
6326 _item_description.description
6327 ; The value of <a href="#_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a> gives the variant
6328 to which the given diffrn_scan_frame_axis row is related.
6329
6330 If this value is not given, the variant is assumed to the default
6331 null variant.
6332
6333 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
6334 <a href="#VARIANT">VARIANT</a> category.
6335 ;
6336 _item.name '<a href="#_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a>'
6337 _item.category_id diffrn_scan_frame_axis
6338 _item.mandatory_code no
6339 _item_type.code code
6340 save_
6341
6342
6343 #############################
6344 # <a name="DIFFRN_SCAN_FRAME_MONITOR" >DIFFRN_SCAN_FRAME_MONITOR</a> #
6345 #############################
6346
6347
6348 save_DIFFRN_SCAN_FRAME_MONITOR
6349 _category.description
6350 ; Data items in the <a href="#DIFFRN_SCAN_FRAME_MONITOR">DIFFRN_SCAN_FRAME_MONITOR</a> category record
6351 the values and details about each monitor for each frame of data
6352 during a scan.
6353
6354 Each monitor value is uniquely identified by the combination of
6355 the scan_id given by <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
6356 the frame_id given by <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a>,
6357 the monitor's detector_id given by
6358 <a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.monitor_id</a>,
6359 and a 1-based ordinal given by <a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>.
6360
6361 If there is only one frame for the scan, the value of
6362 <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a> may be
6363 omitted.
6364
6365 A single frame may have more than one monitor value, and each
6366 monitor value may be the result of integration over the entire
6367 frame integration time given by the value of
6368 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
6369 or many monitor values may be reported over shorter times given
6370 by the value of _diffrn_scan_frame_monitor.integration_time. If
6371 only one monitor value for a given monitor is collected during
6372 the integration time of the frame, the value of
6373 <a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a> may be
6374 omitted.
6375
6376 ;
6377 _category.id diffrn_data_frame_monitor
6378 _category.mandatory_code no
6379 loop_
6380 _category_key.name '<a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>'
6381 '<a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>'
6382 '<a href="#_diffrn_scan_frame_monitor.scan_id" >_diffrn_scan_frame_monitor.scan_id</a>'
6383 '<a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_data_frame_monitor.frame_id</a>'
6384 '<a href="#_diffrn_scan_frame.variant" >_diffrn_data_frame_monitor.variant</a>'
6385 loop_
6386 _category_group.id 'inclusive_group'
6387 'diffrn_group'
6388 loop_
6389 _category_examples.detail
6390 _category_examples.case
6391 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6392 ; Example 1 - The beam intensity for frame FRAME1 is being tracked
6393 by a beamstop monitor detector BSM01, made from metal foil and
6394 a PIN diode, locate 20 mm in front of a MAR345 detector and being
6395 sampled every 2 seconds in a 20 second scan.
6396
6397 ;
6398 ;
6399
6400 # category <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a>
6401 loop_
6402 <a href="#_diffrn_detector.diffrn_id">_diffrn_detector.diffrn_id</a>
6403 <a href="#_diffrn_detector.id">_diffrn_detector.id</a>
6404 <a href="#_diffrn_detector.type">_diffrn_detector.type</a>
6405 <a href="#_diffrn_detector.number_of_axes">_diffrn_detector.number_of_axes</a>
6406 P6MB MAR345-SN26 'MAR 345' 4
6407 P6MB BSM01 'metal foil and PIN diode' 1
6408
6409 # category <a href="#DIFFRN_DETECTOR_AXIS">DIFFRN_DETECTOR_AXIS</a>
6410 loop_
6411 <a href="#_diffrn_detector_axis.detector_id">_diffrn_detector_axis.detector_id</a>
6412 <a href="#_diffrn_detector_axis.axis_id">_diffrn_detector_axis.axis_id</a>
6413 MAR345-SN26 DETECTOR_X
6414 MAR345-SN26 DETECTOR_Y
6415 MAR345-SN26 DETECTOR_Z
6416 MAR345-SN26 DETECTOR_PITCH
6417 BSM01 MONITOR_Z
6418
6419
6420 # category <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a>
6421 loop_
6422 <a href="#_diffrn_data_frame.id">_diffrn_data_frame.id</a>
6423 <a href="#_diffrn_data_frame.detector_element_id">_diffrn_data_frame.detector_element_id</a>
6424 <a href="#_diffrn_data_frame.array_id">_diffrn_data_frame.array_id</a>
6425 <a href="#_diffrn_data_frame.binary_id">_diffrn_data_frame.binary_id</a>
6426 FRAME1 ELEMENT1 ARRAY1 1
6427
6428
6429 # category <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a>
6430 loop_
6431 <a href="#_diffrn_scan.id" >_diffrn_scan.id</a>
6432 <a href="#_diffrn_scan.frame_id_start" >_diffrn_scan.frame_id_start</a>
6433 <a href="#_diffrn_scan.frame_id_end" >_diffrn_scan.frame_id_end</a>
6434 <a href="#_diffrn_scan.frames" >_diffrn_scan.frames</a>
6435 SCAN1 FRAME1 FRAME1 1
6436
6437 # category <a href="#DIFFRN_SCAN_AXIS">DIFFRN_SCAN_AXIS</a>
6438 loop_
6439 <a href="#_diffrn_scan_axis.scan_id" >_diffrn_scan_axis.scan_id</a>
6440 <a href="#_diffrn_scan_axis.axis_id" >_diffrn_scan_axis.axis_id</a>
6441 <a href="#_diffrn_scan_axis.angle_start" >_diffrn_scan_axis.angle_start</a>
6442 <a href="#_diffrn_scan_axis.angle_range" >_diffrn_scan_axis.angle_range</a>
6443 <a href="#_diffrn_scan_axis.angle_increment" >_diffrn_scan_axis.angle_increment</a>
6444 <a href="#_diffrn_scan_axis.displacement_start" >_diffrn_scan_axis.displacement_start</a>
6445 <a href="#_diffrn_scan_axis.displacement_range" >_diffrn_scan_axis.displacement_range</a>
6446 <a href="#_diffrn_scan_axis.displacement_increment" >_diffrn_scan_axis.displacement_increment</a>
6447 SCAN1 GONIOMETER_OMEGA 12.0 1.0 1.0 0.0 0.0 0.0
6448 SCAN1 GONIOMETER_KAPPA 23.3 0.0 0.0 0.0 0.0 0.0
6449 SCAN1 GONIOMETER_PHI -165.8 0.0 0.0 0.0 0.0 0.0
6450 SCAN1 DETECTOR_Z 0.0 0.0 0.0 -240.0 0.0 0.0
6451 SCAN1 DETECTOR_Y 0.0 0.0 0.0 0.6 0.0 0.0
6452 SCAN1 DETECTOR_X 0.0 0.0 0.0 -0.5 0.0 0.0
6453 SCAN1 DETECTOR_PITCH 0.0 0.0 0.0 0.0 0.0 0.0
6454 SCAN1 MONITOR_Z 0.0 0.0 0.0 -220.0 0.0 0.0
6455
6456 # category <a href="#DIFFRN_SCAN_FRAME">DIFFRN_SCAN_FRAME</a>
6457 loop_
6458 <a href="#_diffrn_scan_frame.frame_id" >_diffrn_scan_frame.frame_id</a>
6459 <a href="#_diffrn_scan_frame.frame_number" >_diffrn_scan_frame.frame_number</a>
6460 <a href="#_diffrn_scan_frame.integration_time" >_diffrn_scan_frame.integration_time</a>
6461 <a href="#_diffrn_scan_frame.scan_id" >_diffrn_scan_frame.scan_id</a>
6462 <a href="#_diffrn_scan_frame.date" >_diffrn_scan_frame.date</a>
6463 FRAME1 1 20.0 SCAN1 1997-12-04T10:23:48
6464
6465 # category <a href="#DIFFRN_SCAN_FRAME_MONITOR">DIFFRN_SCAN_FRAME_MONITOR</a>
6466 loop_
6467 <a href="#_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>
6468 <a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>
6469 <a href="#_diffrn_scan_frame_monitor.scan_id" >_diffrn_scan_frame_monitor.scan_id</a>
6470 <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_data_frame_monitor.frame_id</a>
6471 <a href="#_diffrn_scan_frame_monitor.integration_time" >_diffrn_data_frame_monitor.integration_time</a>
6472 <a href="#_diffrn_scan_frame_monitor.monitor_value" >_diffrn_data_frame_monitor.monitor_value</a>
6473 1 BSM01 SCAN1 FRAME1 2.0 23838345642
6474 2 BSM01 SCAN1 FRAME1 2.0 23843170669
6475 3 BSM01 SCAN1 FRAME1 2.0 23839478690
6476 4 BSM01 SCAN1 FRAME1 2.0 23856642085
6477 5 BSM01 SCAN1 FRAME1 2.0 23781717656
6478 6 BSM01 SCAN1 FRAME1 2.0 23788850775
6479 7 BSM01 SCAN1 FRAME1 2.0 23815576677
6480 8 BSM01 SCAN1 FRAME1 2.0 23789299964
6481 9 BSM01 SCAN1 FRAME1 2.0 23830195536
6482 10 BSM01 SCAN1 FRAME1 2.0 23673082270
6483
6484 # category <a href="#DIFFRN_SCAN_FRAME_AXIS">DIFFRN_SCAN_FRAME_AXIS</a>
6485 loop_
6486 <a href="#_diffrn_scan_frame_axis.frame_id" >_diffrn_scan_frame_axis.frame_id</a>
6487 <a href="#_diffrn_scan_frame_axis.axis_id" >_diffrn_scan_frame_axis.axis_id</a>
6488 <a href="#_diffrn_scan_frame_axis.angle" >_diffrn_scan_frame_axis.angle</a>
6489 <a href="#_diffrn_scan_frame_axis.displacement" >_diffrn_scan_frame_axis.displacement</a>
6490 FRAME1 GONIOMETER_OMEGA 12.0 0.0
6491 FRAME1 GONIOMETER_KAPPA 23.3 0.0
6492 FRAME1 GONIOMETER_PHI -165.8 0.0
6493 FRAME1 DETECTOR_Z 0.0 -240.0
6494 FRAME1 DETECTOR_Y 0.0 0.6
6495 FRAME1 DETECTOR_X 0.0 -0.5
6496 FRAME1 DETECTOR_PITCH 0.0 0.0
6497 FRAME1 MONITOR_Z 0.0 -220.0
6498
6499 # category <a href="#AXIS">AXIS</a>
6500 loop_
6501 <a href="#_axis.id">_axis.id</a>
6502 <a href="#_axis.type">_axis.type</a>
6503 <a href="#_axis.equipment">_axis.equipment</a>
6504 <a href="#_axis.depends_on">_axis.depends_on</a>
6505 <a href="#_axis.vector[1]">_axis.vector[1]</a> <a href="#_axis.vector[2]">_axis.vector[2]</a> <a href="#_axis.vector[3]">_axis.vector[3]</a>
6506 <a href="#_axis.offset[1]">_axis.offset[1]</a> <a href="#_axis.offset[2]">_axis.offset[2]</a> <a href="#_axis.offset[3]">_axis.offset[3]</a>
6507 GONIOMETER_OMEGA rotation goniometer . 1 0 0 . . .
6508 GONIOMETER_KAPPA rotation goniometer GONIOMETER_OMEGA 0.64279
6509 0 0.76604 . . .
6510 GONIOMETER_PHI rotation goniometer GONIOMETER_KAPPA 1 0 0
6511 . . .
6512 SOURCE general source . 0 0 1 . . .
6513 GRAVITY general gravity . 0 -1 0 . . .
6514 DETECTOR_Z translation detector . 0 0 1 0 0 0
6515 DETECTOR_Y translation detector DETECTOR_Z 0 1 0 0 0 0
6516 DETECTOR_X translation detector DETECTOR_Y 1 0 0 0 0 0
6517 DETECTOR_PITCH rotation detector DETECTOR_X 0 1 0 0 0 0
6518 ELEMENT_X translation detector DETECTOR_PITCH
6519 1 0 0 172.43 -172.43 0
6520 ELEMENT_Y translation detector ELEMENT_X
6521 0 1 0 0 0 0
6522 MONITOR_Z translation detector . 0 0 1 0 0 0
6523
6524 ;
6525 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6526 save_
6527
6528
6529 save_<a name="_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>
6530 _item_description.description
6531 ; This item is an integer identifier which, along with
6532 <a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>,
6533 <a href="#_diffrn_scan_frame_monitor.scan_id" >_diffrn_scan_frame_monitor.scan_id</a>, and
6534 <a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_data_frame_monitor.frame_id</a>
6535 should uniquely identify the monitor value being recorded
6536
6537 If <a href="#_array_data.binary_id" >_array_data.binary_id</a> is not explicitly given,
6538 it defaults to 1.
6539 ;
6540 loop_
6541 _item.name '<a name="_diffrn_scan_frame_monitor.id" >_diffrn_scan_frame_monitor.id</a>'
6542 _item.category_id diffrn_scan_frame_monitor
6543 _item.mandatory_code implicit
6544 _item_default.value 1
6545 _item_type.code int
6546 loop_
6547 _item_range.maximum
6548 _item_range.minimum
6549 1 1
6550 . 1
6551 save_
6552
6553 save_<a name="_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>
6554 _item_description.description
6555 ; This data item is a pointer to <a href="#_diffrn_detector.id" >_diffrn_detector.id</a> in
6556 the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category.
6557
6558 ;
6559 _item.name '<a href="#_diffrn_scan_frame_monitor.detector_id" >_diffrn_scan_frame_monitor.detector_id</a>'
6560 _item.category_id diffrn_scan_frame_monitor
6561 _item.mandatory_code yes
6562 _item_type.code code
6563 save_
6564
6565 save_<a name="_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a>
6566 _item_description.description
6567 ; This item is a pointer to <a href="#_diffrn_data_frame.id" >_diffrn_data_frame.id</a>
6568 in the <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
6569 ;
6570 _item.name '<a href="#_diffrn_scan_frame_monitor.frame_id" >_diffrn_scan_frame_monitor.frame_id</a>'
6571 _item.category_id diffrn_scan_frame_monitor
6572 _item.mandatory_code yes
6573 _item_type.code code
6574 save_
6575
6576 save_<a name="_diffrn_scan_frame_monitor.integration_time" >_diffrn_scan_frame_monitor.integration_time</a>
6577 _item_description.description
6578 ; The precise time for integration of the monitor value given in
6579 <a href="#_diffrn_scan_frame_monitor.value" >_diffrn_scan_frame_monitor.value</a>
6580 must be given in <a name="_diffrn_scan_frame_monitor.integration_time" >_diffrn_scan_frame_monitor.integration_time</a>.
6581 ;
6582 _item.name '<a href="#_diffrn_scan_frame_monitor.integration_time" >_diffrn_scan_frame_monitor.integration_time</a>'
6583 _item.category_id diffrn_scan
6584 _item.mandatory_code no
6585 _item_type.code float
6586 _item_units.code 'seconds'
6587 loop_
6588 _item_range.maximum
6589 _item_range.minimum
6590 . 0.0
6591 save_
6592
6593 save_<a name="_diffrn_scan_frame_monitor.value" >_diffrn_scan_frame_monitor.value</a>
6594 _item_description.description
6595 ; The value reported by the monitor detector should be given in
6596 <a href="#_diffrn_scan_frame_monitor.value" >_diffrn_scan_frame_monitor.value</a>.
6597
6598 The value is typed as float to allow of monitors for very intense beams
6599 that cannot report all digits, but when available, all digits of the
6600 monitor should be recorded.
6601 ;
6602 _item.name '<a href="#_diffrn_scan_frame_monitor.value" >_diffrn_scan_frame_monitor.value</a>'
6603 _item.category_id diffrn_scan
6604 _item.mandatory_code no
6605 _item_type.code float
6606 _item_units.code 'seconds'
6607 loop_
6608 _item_range.maximum
6609 _item_range.minimum
6610 . 0.0
6611 save_
6612
6613 save_<a name="_diffrn_scan_frame_monitor.variant" >_diffrn_scan_frame_monitor.variant</a>
6614 _item_description.description
6615 ; The value of <a href="#_diffrn_scan_frame_monitor.variant" >_diffrn_scan_frame_monitor.variant</a> gives the variant
6616 to which the given diffrn_scan_frame_monitor row is related.
6617
6618 If this value is not given, the variant is assumed to the default
6619 null variant.
6620
6621 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
6622 <a href="#VARIANT">VARIANT</a> category.
6623 ;
6624 _item.name '<a href="#_diffrn_scan_frame_monitor.variant" >_diffrn_scan_frame_monitor.variant</a>'
6625 _item.category_id diffrn_scan_frame_monitor
6626 _item.mandatory_code no
6627 _item_type.code code
6628 save_
6629
6630
6631
6632 #######
6633 # <a name="MAP">MAP</a> #
6634 #######
6635
6636 save_MAP
6637 _category.description
6638 ; Data items in the <a href="#MAP">MAP</a> category record
6639 the details of a maps. Maps record values of parameters,
6640 such as density, that are functions of position within
6641 a cell or are functions of orthogonal coordinates in
6642 three space.
6643
6644 A map may is composed of one or more map segments
6645 specified in the MAP_SEGMENT category.
6646
6647 Examples are given in the MAP_SEGMENT category.
6648 ;
6649 _category.id map
6650 _category.mandatory_code no
6651 loop_
6652 _category_key.name '<a href="#_map.id" >_map.id</a>'
6653 '<a href="#_map.diffrn_id" >_map.diffrn_id</a>'
6654 '<a href="#_map.entry_id" >_map.entry_id</a>'
6655 '<a href="#_map.variant" >_map.variant</a>'
6656 loop_
6657 _category_group.id 'inclusive_group'
6658 'array_data_group'
6659 'map_group'
6660 loop_
6661 _category_examples.detail
6662 _category_examples.case
6663 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6664 ; Example 1 - Identifying an observed density map
6665 and a calculated density map
6666 ;
6667 ;
6668
6669 loop_
6670 <a href="#_map.id" >_map.id</a>
6671 <a href="#_map.details" >_map.details</a>
6672
6673 rho_calc
6674 ;
6675 density calculated from F_calc derived from the ATOM_SITE list
6676 ;
6677 rho_obs
6678 ;
6679 density combining the observed structure factors with the
6680 calculated phases
6681 ;
6682 ;
6683
6684 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6685 save_
6686
6687
6688 save_<a name="_map.details" >_map.details</a>
6689 _item_description.description
6690 ; The value of <a href="#_map.details" >_map.details</a> should give a
6691 description of special aspects of each map.
6692
6693 ;
6694 _item.name '<a name="_map.details" >_map.details</a>'
6695 _item.category_id map
6696 _item.mandatory_code no
6697 _item_type.code text
6698 loop_
6699 _item_examples.case
6700 _item_examples.detail
6701 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6702 ; Example 1 - Identifying an observed density map
6703 and a calculated density map
6704 ;
6705 ;
6706
6707 loop_
6708 <a href="#_map.id" >_map.id</a>
6709 <a href="#_map.details" >_map.details</a>
6710
6711 rho_calc
6712 ;
6713 density calculated from F_calc derived from the ATOM_SITE list
6714 ;
6715 rho_obs
6716 ;
6717 density combining the observed structure factors with the
6718 calculated phases
6719 ;
6720 ;
6721
6722 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6723 save_
6724
6725 save_<a name="_map.diffrn_id" >_map.diffrn_id</a>
6726 _item_description.description
6727 ; This item is a pointer to <a href="#_diffrn.id" >_diffrn.id</a> in the
6728 <a href="#DIFFRN">DIFFRN</a> category.
6729 ;
6730 _item.name '<a href="#_map.diffrn_id" >_map.diffrn_id</a>'
6731 _item.category_id map
6732 _item.mandatory_code implicit
6733 _item_type.code code
6734 save_
6735
6736 save_<a name="_map.entry_id" >_map.entry_id</a>
6737 _item_description.description
6738 ; This item is a pointer to <a href="#_entry.id" >_entry.id</a> in the
6739 <a href="#ENTRY">ENTRY</a> category.
6740 ;
6741 _item.name '<a href="#_map.entry_id" >_map.entry_id</a>'
6742 _item.category_id map
6743 _item.mandatory_code implicit
6744 _item_type.code code
6745 save_
6746
6747
6748 save_<a name="_map.id" >_map.id</a>
6749 _item_description.description
6750 ; The value of <a href="#_map.id" >_map.id</a> must uniquely identify
6751 each map for the given diffrn.id or entry.id.
6752 ;
6753 loop_
6754 _item.name
6755 _item.category_id
6756 _item.mandatory_code
6757 '<a href="#_map.id" >_map.id</a>' map yes
6758 '<a href="#_map_segment.id" >_map_segment.id</a>' map_segment yes
6759 _item_type.code code
6760 loop_
6761 _item_linked.child_name
6762 _item_linked.parent_name
6763 '<a href="#_map_segment.id" >_map_segment.id</a>' '<a href="#_map.id" >_map.id</a>'
6764 save_
6765
6766 save_<a name="_map.variant" >_map.variant</a>
6767 _item_description.description
6768 ; The value of <a href="#_map.variant" >_map.variant</a> gives the variant
6769 to which the given map row is related.
6770
6771 If this value is not given, the variant is assumed to the default
6772 null variant.
6773
6774 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
6775 <a href="#VARIANT">VARIANT</a> category.
6776 ;
6777 _item.name '<a href="#_map.variant" >_map.variant</a>'
6778 _item.category_id map
6779 _item.mandatory_code no
6780 _item_type.code code
6781 save_
6782
6783
6784
6785 ###############
6786 # <a name="MAP_SEGMENT">MAP_SEGMENT</a> #
6787 ###############
6788
6789
6790 save_MAP_SEGMENT
6791 _category.description
6792 ; Data items in the <a href="#MAP_SEGMENT">MAP_SEGMENT</a> category record
6793 the details about each segment (section or brick) of a map.
6794 ;
6795 _category.id map_segment
6796 _category.mandatory_code no
6797 loop_
6798 _category_key.name '<a href="#_map_segment.id" >_map_segment.id</a>'
6799 '<a href="#_map_segment.map_id" >_map_segment.map_id</a>'
6800 '<a href="#_map_segment.variant" >_map_segment.variant</a>'
6801 loop_
6802 _category_group.id 'inclusive_group'
6803 'array_data_group'
6804 'map_group'
6805 loop_
6806 _category_examples.detail
6807 _category_examples.case
6808 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6809 ; Example 1 - Identifying an observed density map
6810 and a calculated density map, each consisting of one
6811 segment, both using the same array structure
6812 and mask.
6813 ;
6814 ;
6815
6816 loop_
6817 <a href="#_map.id" >_map.id</a>
6818 <a href="#_map.details" >_map.details</a>
6819
6820 rho_calc
6821 ;
6822 density calculated from F_calc derived from the ATOM_SITE list
6823 ;
6824 rho_obs
6825 ;
6826 density combining the observed structure factors with the
6827 calculated phases
6828 ;
6829
6830 loop_
6831 _map_segment.map_id
6832 _map_segment.id
6833 _map_segment.array_id
6834 _map_segment.binary_id
6835 _map_segment.mask_array_id
6836 _map_segment.mask_binary_id
6837 rho_calc rho_calc map_structure 1 mask_structure 1
6838 rho_obs rho_obs map_structure 2 mask_structure 1
6839 ;
6840
6841 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
6842 save_
6843
6844
6845 save_<a name="_map_segment.array_id" >_map_segment.array_id</a>
6846 _item_description.description
6847 ; The value of _map_segment.array_id identifies the array
6848 structure into which the map is organized.
6849
6850 This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
6851 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
6852 ;
6853 _item.name '<a href="#_map_segement.array_id" >_map_segment.array_id</a>'
6854 _item.category_id map_segment
6855 _item.mandatory_code implicit
6856 _item_type.code code
6857 save_
6858
6859
6860 save_<a name="_map_segment.binary_id" >_map_segment.binary_id</a>
6861 _item_description.description
6862 ; The value of <a href="#_map_segment.binary_id">_map_segment.binary_id</a> distinguishes the particular
6863 set of data organized according to <a href="#_map_segment.mask_array_id">_map_segment.array_id</a> in
6864 which the data values of the map are stored.
6865
6866 This item is a pointer to <a href="#_array_data.binary_id" >_array_data.binary_id</a> in the
6867 <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
6868 ;
6869 _item.name '<a href="#_map_segment.binary_id" >_map_segment.binary_id</a>'
6870 _item.category_id map_segment
6871 _item.mandatory_code implicit
6872 _item_type.code int
6873 save_
6874
6875 save_<a name="_map_segment.mask_array_id" >_map_segment.mask_array_id</a>
6876 _item_description.description
6877 ; The value of <a href="#_map_segment.mask_array_id">_map_segment.mask_array_id</a>, if given, the array
6878 structure into which the mask for the map is organized. If no
6879 value is given, then all elements of the map are valid. If a
6880 value is given, then only elements of the map for which the
6881 corresponding element of the mask is non-zero are valid. The
6882 value of <a href="#_map_segment.mask_array_id">_map_segment.mask_array_id</a> differs from the value of
6883 <a href="#_map_segment.array_id">_map_segment.array_id</a> in order to permit the mask to be given
6884 as, say, unsigned 8-bit integers, while the map is given as
6885 a data type with more range. However, the two array structures
6886 must be aligned, using the same axes in the same order with the
6887 same displacements and increments
6888
6889 This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
6890 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> category.
6891 ;
6892 _item.name '<a href="#_map_segment.mask_array_id" >_map_segment.mask_array_id</a>'
6893 _item.category_id map_segment
6894 _item.mandatory_code implicit
6895 _item_type.code code
6896 save_
6897
6898
6899 save_<a name="_map_segment.mask_binary_id" >_map_segment.mask_binary_id</a>
6900 _item_description.description
6901 ; The value of <a href="#_map_segment.mask_binary_id">_map_segment.mask_binary_id</a> identifies the
6902 particular set of data organized according to
6903 _map_segment.mask_array_id specifying the mask for the map.
6904
6905 This item is a pointer to <a href="#_array_data.mask_binary_id" >_array_data.mask_binary_id</a> in the
6906 <a href="#ARRAY_DATA">ARRAY_DATA</a> category.
6907 ;
6908 _item.name '<a href="#_map_segment.mask_binary_id" >_map_segment.mask_binary_id</a>'
6909 _item.category_id map_segment
6910 _item.mandatory_code implicit
6911 _item_type.code int
6912 save_
6913
6914
6915 save_<a name="_map_segment.id" >_map_segment.id</a>
6916 _item_description.description
6917 ; The value of <a href="#_map_segment.id" >_map_segment.id</a> must uniquely
6918 identify each segment of a map.
6919 ;
6920 loop_
6921 _item.name
6922 _item.category_id
6923 _item.mandatory_code
6924 '<a href="#_map_segment.id" >_map_segment.id</a>'
6925 map_segment
6926 yes
6927 _item_type.code code
6928 loop_
6929 _item_linked.child_name
6930 _item_linked.parent_name
6931 '<a href="#_map_data_frame.map_segment_id" >_map_data_frame.map_segment_id</a>'
6932 '<a href="#_map_segment.id" >_map_segment.id</a>'
6933
6934 save_
6935
6936
6937 save_<a name="_map_segment.map_id" >_map_segment.map_id</a>
6938 _item_description.description
6939 ; This item is a pointer to <a href="#_map.id" >_map.id</a>
6940 in the <a href="#MAP">MAP</a> category.
6941 ;
6942 _item.name '<a href="#_map_segment.map_id" >_map_segment.map_id</a>'
6943 _item.category_id map_segment
6944 _item.mandatory_code yes
6945 _item_type.code code
6946 save_
6947
6948 save_<a name="_map_segment.details" >_map_segment.details</a>
6949 _item_description.description
6950 ; The value of <a href="#_map_segment.details" >_map_segment.details</a> should give a
6951 description of special aspects of each segment of a map.
6952
6953 ;
6954 _item.name '<a name="_map_segment.details" >_map_segment.details</a>'
6955 _item.category_id map_segment
6956 _item.mandatory_code no
6957 _item_type.code text
6958 loop_
6959 _item_examples.case
6960 _item_examples.detail
6961 ; Example to be provided
6962 ;
6963 ;
6964
6965 ;
6966 save_
6967
6968 save_<a name="_map_segment.variant" >_map_segment.variant</a>
6969 _item_description.description
6970 ; The value of <a href="#_map_segment.variant" >_map_segment.variant</a> gives the variant
6971 to which the given map segment is related.
6972
6973 If this value is not given, the variant is assumed to the default
6974 null variant.
6975
6976 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
6977 <a href="#VARIANT">VARIANT</a> category.
6978 ;
6979 _item.name '<a href="#_map_segment.variant" >_map_segment.variant</a>'
6980 _item.category_id map_segment
6981 _item.mandatory_code no
6982 _item_type.code code
6983 save_
6984
6985
6986 ###########
6987 # <a name="VARIANT">VARIANT</a> #
6988 ###########
6989
6990
6991 save_VARIANT
6992 _category.description
6993 ; Data items in the <a href="#VARIANT">VARIANT</a> category record
6994 the details about sets of variants of data items.
6995
6996 There is sometimes a need to allow for multiple versions of the
6997 same data items in order to allow for refinements and corrections
6998 to earlier assumptions, observations and calculations. In order
6999 to allow data sets to contain more than one variant of the same
7000 information, an optional ...variant data item as a pointer to
7001 _variant.variant has been added to the key of every category,
7002 as an implicit data item with a null (empty) default value.
7003
7004 All rows in a category with the same variant value are considered
7005 to be related to one another and to all rows in other categories
7006 with the same variant value. For a given variant, all such rows
7007 are also considered to be related to all rows with a null variant
7008 value, except that a row with a null variant value is for which
7009 all other components of its key are identical to those entries
7010 in another row with a non-null variant value is not related the
7011 the rows with that non-null variant value. This behavior is
7012 similar to the convention for identifying alternate conformers
7013 in an atom list.
7014
7015 An optional role may be specified for a variant as the value of
7016 _variant.role. Possible roles are null, "preferred",
7017 "raw data", "unsuccessful trial".
7018
7019 Variants may carry an optional timestamp as the value of
7020 _variant.timestamp.
7021
7022 Variants may be related to other variants from which they were
7023 derived by the value of _variant.variant_of
7024
7025 Further details about the variant may be specified as the value
7026 of _variant.details.
7027
7028 In order to allow variant information from multiple datasets to
7029 be combined, _variant.diffrn_id and/or _variant.entry_id may
7030 be used.
7031
7032 ;
7033 _category.id variant
7034 _category.mandatory_code no
7035 loop_
7036 _category_key.name '<a href="#_variant.variant" >_variant.variant</a>'
7037 '<a href="#_variant.diffrn_id" >_variant.diffrn_id</a>'
7038 '<a href="#_variant.entry_id" >_variant.entry_id</a>'
7039 loop_
7040 _category_group.id 'inclusive_group'
7041 'variant_group'
7042 loop_
7043 _category_examples.detail
7044 _category_examples.case
7045 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
7046 ; Example 1 - Distinguishing between a raw beam center and a refined beam
7047 center inferred after indexing. Detector d1 is composed of
7048 four CCD detector elements, each 200 mm by 200 mm, arranged
7049 in a square, in the pattern
7050
7051 1 2
7052 *
7053 3 4
7054
7055 Note that the beam centre is slightly displaced from each of the
7056 detector elements, just beyond the lower right corner of 1,
7057 the lower left corner of 2, the upper right corner of 3 and
7058 the upper left corner of 4. For each element, the detector
7059 face coordiate system, is assumed to have the fast axis
7060 running from left to right and the slow axis running from
7061 top to bottom with the origin at the top left corner.
7062
7063 After indexing and refinement, the center is shifted by .2 mm
7064 left and .1 mm down.
7065
7066
7067 ;
7068 ;
7069
7070 loop_
7071 _variant.variant
7072 _variant.role
7073 _variant.timestamp
7074 _variant.variant_of
7075 _variant.details
7076 . "raw data" 2007-08-03T23:20:00 . .
7077 indexed "preferred" 2007-08-04T01:17:28 .
7078 "indexed cell and refined beam center"
7079
7080 loop_
7081 <a href="#_diffrn_detector_element.detector_id" >_diffrn_detector_element.detector_id</a>
7082 <a href="#_diffrn_detector_element.id" >_diffrn_detector_element.id</a>
7083 <a href="#_diffrn_detector_elelemt.reference_center_fast" >_diffrn_detector_element.reference_center_fast</a>
7084 <a href="#_diffrn_detector_element.reference_center_slow" >_diffrn_detector_element.reference_center_slow</a>
7085 <a href="#_diffrn_detector_element.reference_center_units" >_diffrn_detector_element.reference_center_units</a>
7086 <a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>
7087 d1 d1_ccd_1 201.5 201.5 mm .
7088 d1 d1_ccd_2 -1.8 201.5 mm .
7089 d1 d1_ccd_3 201.6 -1.4 mm .
7090 d1 d1_ccd_4 -1.7 -1.5 mm .
7091 d1 d1_ccd_1 201.3 201.6 mm indexed
7092 d1 d1_ccd_2 -2.0 201.6 mm indexed
7093 d1 d1_ccd_3 201.3 -1.5 mm indexed
7094 d1 d1_ccd_4 -1.9 -1.6 mm indexed
7095 ;
7096 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
7097
7098 save_
7099
7100 save_<a name="_variant.details" >_variant.details</a>
7101 _item_description.description
7102 ; A description of special aspects of the variant.
7103 ;
7104 _item.name '<a href="#_variant.details" >_variant.details</a>'
7105 _item.category_id variant
7106 _item.mandatory_code no
7107 _item_type.code text
7108 _item_examples.case
7109 ; indexed cell and refined beam center
7110 ;
7111 save_
7112
7113
7114 save_<a name="_variant.role" >_variant.role</a>
7115 _item_description.description
7116 ; The value of <a href="#_variant.role" >_variant.role</a> specified a role
7117 for this variant. Possible roles are null, "preferred",
7118 "raw data", and "unsuccessful trial".
7119 ;
7120 _item.name '<a href="#_variant.role" >_variant.role</a>'
7121 _item.category_id variant
7122 _item.mandatory_code no
7123 _item_type.code uline
7124 loop_
7125 _item_enumeration.value
7126 _item_enumeration.detail
7127 .
7128 ; A null value for <a href="#_variant.role" >_variant.role</a> leaves the precise role of
7129 the variant unspecified. No inference should be made that the variant
7130 with the latest time stamp is preferred.
7131 ;
7132 "preferred"
7133 ; A value of "preferred" indicates that rows of any categories specifying
7134 this variant should be used in preference to rows with the same key
7135 specifying other variants or the null variant. It is an error to specify
7136 two variants that appear in the same category with the same key as being
7137 preferred, but it is not an error to specify more than one variant as
7138 preferred in other cases.
7139 ;
7140 "raw data"
7141 ; A value of "raw data" indicates data prior to any corrections,
7142 calculations or refinements. It is not necessarily an error for raw data
7143 to also be a variant of an earlier variant. It may be replacement raw
7144 data for earlier data believed to be erroneous.
7145 ;
7146 "unsuccessful trial"
7147 ; A value of "unsuccessful trial" indicates data that should not be used
7148 for further calculation.
7149 ;
7150 save_
7151
7152
7153 save_<a name="_variant.timestamp">_variant.timestamp</a>
7154 _item_description.description
7155 ; The date and time identifying a variant. This is not
7156 necessarily the precise time of the measurement or calculation
7157 of the individual related data items, but a timestamp that
7158 reflects the order in which the variants were defined.
7159 ;
7160 _item.name '<a href="#_variant.timestamp">_variant.timestamp</a>'
7161 _item.category_id variant
7162 _item.mandatory_code no
7163 _item_type.code yyyy-mm-dd
7164 save_
7165
7166
7167 save_<a name="_variant.variant" >_variant.variant</a>
7168 _item_description.description
7169 ; The value of <a href="#_variant.variant" >_variant.variant</a> must uniquely identify
7170 each variant for the given diffraction experiment and/or entry
7171
7172 This item has been made implicit and given a default value of
7173 null.
7174 ;
7175 loop_
7176 _item.name
7177 _item.category_id
7178 _item.mandatory_code
7179 '<a href="#_variant.variant" >_variant.variant</a>' variant implicit
7180 '<a href="#_variant.variant_of" >_variant.variant_of</a>' variant implicit
7181 '<a href="#_array_data.variant" >_array_data.variant</a>' array_data implicit
7182 '<a href="#_array_element_size.variant" >_array_element_size.variant</a>' array_element_size implicit
7183 '<a href="#_array_intensities.variant" >_array_intensities.variant</a>' array_intensities implicit
7184 '<a href="#_array_structure.variant" >_array_structure.variant</a>' array_structure implicit
7185 '<a href="#_array_structure_list.variant" >_array_structure_list.variant</a>' array_structure_list
7186 implicit
7187 '<a href="#_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a>' array_structure_list_axis
7188 implicit
7189 '<a href="#_axis.variant" >_axis.variant</a>' axis implicit
7190 '<a href="#_diffrn_data_frame.variant" >_diffrn_data_frame.variant</a>' diffrn_data_frame implicit
7191 '<a href="#_diffrn_detector.variant" >_diffrn_detector.variant</a>' diffrn_detector implicit
7192 '<a href="#_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a>' diffrn_detector_axis
7193 implicit
7194 '<a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>' diffrn_detector_element
7195 implicit
7196 '<a href="#_diffrn_measurement.variant" >_diffrn_measurement.variant</a>' diffrn_measurement implicit
7197 '<a href="#_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a>' diffrn_measurement_axis
7198 implicit
7199 '<a href="#_diffrn_radiation.variant" >_diffrn_radiation.variant</a>' diffrn_radiation implicit
7200 '<a href="#_diffrn_refln.variant" >_diffrn_refln.variant</a>' diffrn_refln implicit
7201 '<a href="#_diffrn_scan.variant" >_diffrn_scan.variant</a>' diffrn_scan implicit
7202 '<a href="#_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a>' diffrn_scan_axis implicit
7203 '<a href="#_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a>' diffrn_scan_frame implicit
7204 '<a href="#_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a>' diffrn_scan_frame_axis
7205 implicit
7206 '<a href="#_diffrn_scan_frame_monitor.variant" >_diffrn_scan_frame_monitor.variant</a>' diffrn_scan_frame_monitor
7207 implicit
7208 '<a href="#_map.variant" >_map.variant</a>' map implicit
7209 '<a href="#_map_segment.variant" >_map_segment.variant</a>' map_segment implicit
7210
7211
7212 _item_default.value .
7213 _item_type.code code
7214 loop_
7215 _item_linked.child_name
7216 _item_linked.parent_name
7217 '<a href="#_array_data.variant" >_array_data.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7218 '<a href="#_array_data.variant_of" >_array_data.variant_of</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7219 '<a href="#_array_element_size.variant" >_array_element_size.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7220 '<a href="#_array_intensities.variant" >_array_intensities.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7221 '<a href="#_array_structure.variant" >_array_structure.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7222 '<a href="#_array_structure_list.variant" >_array_structure_list.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7223 '<a href="#_array_structure_list_axis.variant" >_array_structure_list_axis.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7224 '<a href="#_axis.variant" >_axis.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7225 '<a href="#_diffrn_data_frame.variant" >_diffrn_data_frame.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7226 '<a href="#_diffrn_detector.variant" >_diffrn_detector.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7227 '<a href="#_diffrn_detector_axis.variant" >_diffrn_detector_axis.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7228 '<a href="#_diffrn_detector_element.variant" >_diffrn_detector_element.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7229 '<a href="#_diffrn_measurement.variant" >_diffrn_measurement.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7230 '<a href="#_diffrn_measurement_axis.variant" >_diffrn_measurement_axis.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7231 '<a href="#_diffrn_radiation.variant" >_diffrn_radiation.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7232 '<a href="#_diffrn_refln.variant" >_diffrn_refln.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7233 '<a href="#_diffrn_scan.variant" >_diffrn_scan.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7234 '<a href="#_diffrn_scan_axis.variant" >_diffrn_scan_axis.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7235 '<a href="#_diffrn_scan_frame.variant" >_diffrn_scan_frame.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7236 '<a href="#_diffrn_scan_frame_axis.variant" >_diffrn_scan_frame_axis.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7237 '<a href="#_diffrn_scan_frame_monitor.variant" >_diffrn_scan_frame_monitor.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7238 '<a href="#_map.variant" >_map.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7239 '<a href="#_map_segment.variant" >_map_segment.variant</a>' '<a href="#_variant.variant" >_variant.variant</a>'
7240
7241 save_
7242
7243
7244 save_<a name="_variant.variant_of" >_variant.variant_of</a>
7245 _item_description.description
7246 ; The value of <a href="#_variant.variant_of" >_variant.variant_of</a> gives the variant
7247 from which this variant was derived. If this value is not given,
7248 the variant is assumed to be derived from the default null
7249 variant.
7250
7251 This item is a pointer to <a href="#_variant.variant" >_variant.variant</a> in the
7252 <a href="#VARIANT">VARIANT</a> category.
7253 ;
7254 _item.name '<a href="#_variant.variant_of" >_variant.variant_of</a>'
7255 _item.category_id variant
7256 _item.mandatory_code no
7257 _item_type.code code
7258 save_
7259
7260
7261
7262
7263 ######################## DEPRECATED DATA ITEMS ########################
7264
7265 save_<a name="_diffrn_detector_axis.id">_diffrn_detector_axis.id</a>
7266 _item_description.description
7267 ; This data item is a pointer to <a href="#_diffrn_detector.id">_diffrn_detector.id</a> in
7268 the <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> category.
7269
7270 DEPRECATED -- DO NOT USE
7271 ;
7272 _item.name '<a href="#_diffrn_detector_axis.id">_diffrn_detector_axis.id</a>'
7273 _item.category_id diffrn_detector_axis
7274 _item.mandatory_code no
7275 _item_type.code code
7276 save_
7277
7278 save_<a name="_diffrn_detector_element.center[1]" >_diffrn_detector_element.center[1]</a>
7279 _item_description.description
7280 ; The value of <a href="#_diffrn_detector_element.center[1]" >_diffrn_detector_element.center[1]</a> is the <b>X</b>
7281 component of the distortion-corrected beam centre in
7282 millimetres from the (0, 0) (lower-left) corner of the
7283 detector element viewed from the sample side.
7284
7285 The <b>X</b> and <b>Y</b> axes are the laboratory coordinate system
7286 coordinates defined in the <a href="#AXIS">AXIS category</a> measured
7287 when all positioning axes for the detector are at their zero
7288 settings. If the resulting <b>X</b> or <b>Y</b> axis is then orthogonal to the
7289 detector, the <b>Z</b> axis is used instead of the orthogonal axis.
7290
7291 Because of ambiguity about the setting used to determine this
7292 center, use of this data item is deprecated. The data item
7293 <a href="#_diffrn_data_frame.center_fast">_diffrn_data_frame.center_fast</a>
7294 which is referenced to the detector coordinate system and not
7295 directly to the laboratory coordinate system should be used
7296 instead.
7297
7298 ;
7299 _item.name '<a href="#_diffrn_detector_element.center[1]" >_diffrn_detector_element.center[1]</a>'
7300 _item.category_id diffrn_detector_element
7301 _item.mandatory_code no
7302 _item_default.value 0.0
7303 _item_sub_category.id vector
7304 _item_type.code float
7305 _item_units.code millimetres
7306
7307 save_
7308
7309
7310 save_<a name="_diffrn_detector_element.center[2]" >_diffrn_detector_element.center[2]</a>
7311 _item_description.description
7312 ; The value of <a href="#_diffrn_detector_element.center[2]" >_diffrn_detector_element.center[2]</a> is the <b>Y</b>
7313 component of the distortion-corrected beam centre in
7314 millimetres from the (0, 0) (lower-left) corner of the
7315 detector element viewed from the sample side.
7316
7317 The <b>X</b> and <b>Y</b> axes are the laboratory coordinate system
7318 coordinates defined in the <a href="#AXIS">AXIS category</a> measured
7319 when all positioning axes for the detector are at their zero
7320 settings. If the resulting <b>X</b> or <b>Y</b> axis is then orthogonal to the
7321 detector, the <b>Z</b> axis is used instead of the orthogonal axis.
7322
7323 Because of ambiguity about the setting used to determine this
7324 center, use of this data item is deprecated. The data item
7325 <a href="#_diffrn_data_frame.center_slow">_diffrn_data_frame.center_slow</a>
7326 which is referenced to the detector coordinate system and not
7327 directly to the laboratory coordinate system should be used
7328 instead.
7329
7330 ;
7331 _item.name '<a href="#_diffrn_detector_element.center[2]" >_diffrn_detector_element.center[2]</a>'
7332 _item.category_id diffrn_detector_element
7333 _item.mandatory_code no
7334 _item_default.value 0.0
7335 _item_sub_category.id vector
7336 _item_type.code float
7337 _item_units.code millimetres
7338
7339 save_
7340
7341
7342
7343 save_<a name="_diffrn_measurement_axis.id">_diffrn_measurement_axis.id</a>
7344 _item_description.description
7345 ; This data item is a pointer to <a href="#_diffrn_measurement.id">_diffrn_measurement.id</a> in
7346 the <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> category.
7347
7348 DEPRECATED -- DO NOT USE
7349 ;
7350 _item.name '<a href="#_diffrn_measurement_axis.id">_diffrn_measurement_axis.id</a>'
7351 _item.category_id diffrn_measurement_axis
7352 _item.mandatory_code no
7353 _item_type.code code
7354 save_
7355
7356 ######################### DEPRECATED CATEGORY #########################
7357 #####################
7358 # <a name="DIFFRN_FRAME_DATA" >DIFFRN_FRAME_DATA</a> #
7359 #####################
7360
7361
7362 save_DIFFRN_FRAME_DATA
7363 _category.description
7364 ; Data items in the DIFFRN_FRAME_DATA category record
7365 the details about each frame of data.
7366
7367 The items in this category are now in the
7368 <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a> category.
7369
7370 The items in the DIFFRN_FRAME_DATA category
7371 are now deprecated. The items from this category
7372 are provided as aliases in the 1.0 dictionary
7373 or, in the case of _diffrn_frame_data.details,
7374 in the 1.4 dictionary. THESE ITEMS SHOULD NOT
7375 BE USED FOR NEW WORK.
7376
7377 The items from the old category are provided
7378 in this dictionary for completeness
7379 but should not be used or cited. To avoid
7380 confusion, the example has been removed
7381 and the redundant parent-child links to other
7382 categories have been removed.
7383
7384 All _item.mandatory_code values have been changed to no
7385 ;
7386 _category.id diffrn_frame_data
7387 _category.mandatory_code no
7388 loop_
7389 _category_key.name '<a href="#_diffrn_frame_data.id" >_diffrn_frame_data.id</a>'
7390 '<a href="#_diffrn_frame_data.detector_element_id" >_diffrn_frame_data.detector_element_id</a>'
7391 loop_
7392 _category_group.id 'inclusive_group'
7393 'array_data_group'
7394 loop_
7395 _category_examples.detail
7396 _category_examples.case
7397 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
7398 ;
7399 THE DIFFRN_FRAME_DATA category is deprecated and should not be used.
7400 ;
7401 ;
7402 # EXAMPLE REMOVED #
7403 ;
7404 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
7405 save_
7406
7407
7408 save_<a name="_diffrn_frame_data.array_id" >_diffrn_frame_data.array_id</a>
7409 _item_description.description
7410 ; This item is a pointer to <a href="#_array_structure.id" >_array_structure.id</a> in the
7411 ARRAY_STRUCTURE category.
7412
7413 DEPRECATED -- DO NOT USE
7414 ;
7415 _item.name '<a href="#_diffrn_frame_data.array_id" >_diffrn_frame_data.array_id</a>'
7416 _item.category_id diffrn_frame_data
7417 _item.mandatory_code no
7418 _item_type.code code
7419 save_
7420
7421
7422 save_<a name="_diffrn_frame_data.binary_id" >_diffrn_frame_data.binary_id</a>
7423 _item_description.description
7424 ; This item is a pointer to <a href="#_array_data.binary_id" >_array_data.binary_id</a> in the
7425 ARRAY_STRUCTURE category.
7426
7427 DEPRECATED -- DO NOT USE
7428 ;
7429 _item.name '<a href="#_diffrn_frame_data.binary_id" >_diffrn_frame_data.binary_id</a>'
7430 _item.category_id diffrn_frame_data
7431 _item.mandatory_code no
7432 _item_type.code int
7433 save_
7434
7435
7436 save_<a name="_diffrn_frame_data.detector_element_id" >_diffrn_frame_data.detector_element_id</a>
7437 _item_description.description
7438 ; This item is a pointer to <a href="#_diffrn_detector_element.id">_diffrn_detector_element.id</a>
7439 in the DIFFRN_DETECTOR_ELEMENT category.
7440
7441 DEPRECATED -- DO NOT USE
7442 ;
7443 _item.name '<a href="#_diffrn_frame_data.detector_element_id" >_diffrn_frame_data.detector_element_id</a>'
7444 _item.category_id diffrn_frame_data
7445 _item.mandatory_code no
7446 _item_type.code code
7447 save_
7448
7449
7450 save_<a name="_diffrn_frame_data.id" >_diffrn_frame_data.id</a>
7451 _item_description.description
7452 ; The value of <a href="#_diffrn_frame_data.id" >_diffrn_frame_data.id</a> must uniquely identify
7453 each complete frame of data.
7454
7455 DEPRECATED -- DO NOT USE
7456 ;
7457 loop_
7458 _item.name
7459 _item.category_id
7460 _item.mandatory_code
7461 '<a href="#_diffrn_frame_data.id" >_diffrn_frame_data.id</a>' diffrn_frame_data yes
7462 _item_type.code code
7463 save_
7464
7465 save_<a name="_diffrn_frame_data.details" >_diffrn_frame_data.details</a>
7466 _item_description.description
7467 ; The value of <a href="#_diffrn_data_frame.details" >_diffrn_data_frame.details</a> should give a
7468 description of special aspects of each frame of data.
7469
7470 DEPRECATED -- DO NOT USE
7471 ;
7472 _item.name '<a name="_diffrn_frame_data.details" >_diffrn_frame_data.details</a>'
7473 _item.category_id diffrn_frame_data
7474 _item.mandatory_code no
7475 _item_type.code text
7476 save_
7477
7478 ################ END DEPRECATED SECTION ###########
7479
7480
7481 ####################
7482 ## <a name="ITEM_TYPE_LIST">ITEM_TYPE_LIST</a> ##
7483 ####################
7484 #
7485 #
7486 # The regular expressions defined here are not compliant
7487 # with the POSIX 1003.2 standard as they include the
7488 # '\n' and '\t' special characters. These regular expressions
7489 # have been tested using version 0.12 of Richard Stallman's
7490 # GNU regular expression library in POSIX mode.
7491 # In order to allow presentation of a regular expression
7492 # in a text field concatenate any line ending in a backslash
7493 # with the following line, after discarding the backslash.
7494 #
7495 # A formal definition of the '\n' and '\t' special characters
7496 # is most properly done in the DDL, but for completeness, please
7497 # note that '\n' is the line termination character ('newline')
7498 # and '\t' is the horizontal tab character. There is a formal
7499 # ambiguity in the use of '\n' for line termination, in that
7500 # the intention is that the equivalent machine/OS-dependent line
7501 # termination character sequence should be accepted as a match, e.g.
7502 #
7503 # '\r' (control-M) under MacOS
7504 # '\n' (control-J) under Unix
7505 # '\r\n' (control-M control-J) under DOS and MS Windows
7506 #
7507 loop_
7508 _item_type_list.code
7509 _item_type_list.primitive_code
7510 _item_type_list.construct
7511 _item_type_list.detail
7512 code char
7513 '[_,.;:&quot;&amp;&lt;&gt;()/\{}'`~!@#$%A-Za-z0-9*|+-]*'
7514 ; code item types/single words ...
7515 ;
7516 ucode uchar
7517 '[_,.;:&quot;&amp;&lt;&gt;()/\{}'`~!@#$%A-Za-z0-9*|+-]*'
7518 ; code item types/single words (case insensitive) ...
7519 ;
7520 line char
7521 '[][ \t_(),.;:&quot;&amp;&lt;&gt;/\{}'`~!@#$%?+=*A-Za-z0-9|^-]*'
7522 ; char item types / multi-word items ...
7523 ;
7524 uline uchar
7525 '[][ \t_(),.;:&quot;&amp;&lt;&gt;/\{}'`~!@#$%?+=*A-Za-z0-9|^-]*'
7526 ; char item types / multi-word items (case insensitive)...
7527 ;
7528 text char
7529 '[][ \n\t()_,.;:&quot;&amp;&lt;&gt;/\{}'`~!@#$%?+=*A-Za-z0-9|^-]*'
7530 ; text item types / multi-line text ...
7531 ;
7532 binary char
7533 ;\n--CIF-BINARY-FORMAT-SECTION--\n\
7534 [][ \n\t()_,.;:&quot;&amp;&lt;&gt;/\{}'`~!@#$%?+=*A-Za-z0-9|^-]*\
7535 \n--CIF-BINARY-FORMAT-SECTION----
7536 ;
7537 ; binary items are presented as MIME-like ascii-encoded
7538 sections in an imgCIF. In a CBF, raw octet streams
7539 are used to convey the same information.
7540 ;
7541 int numb
7542 '-?[0-9]+'
7543 ; int item types are the subset of numbers that are the negative
7544 or positive integers.
7545 ;
7546 float numb
7547 '-?(([0-9]+)[.]?|([0-9]*[.][0-9]+))([(][0-9]+[)])?([eE][+-]?[0-9]+)?'
7548 ; float item types are the subset of numbers that are the floating
7549 point numbers.
7550 ;
7551 any char
7552 '.*'
7553 ; A catch all for items that may take any form...
7554 ;
7555 yyyy-mm-dd char
7556 ;\
7557 [0-9]?[0-9]?[0-9][0-9]-[0-9]?[0-9]-[0-9]?[0-9]\
7558 ((T[0-2][0-9](:[0-5][0-9](:[0-5][0-9](.[0-9]+)?)?)?)?\
7559 ([+-][0-5][0-9]:[0-5][0-9]))?
7560 ;
7561 ;
7562 Standard format for CIF date and time strings (see
7563 http://www.iucr.org/iucr-top/cif/spec/datetime.html),
7564 consisting of a yyyy-mm-dd date optionally followed by
7565 the character 'T' followed by a 24-hour clock time,
7566 optionally followed by a signed time-zone offset.
7567
7568 The IUCr standard has been extended to allow for an optional
7569 decimal fraction on the seconds of time.
7570
7571 Time is local time if no time-zone offset is given.
7572
7573 Note that this type extends the mmCIF yyyy-mm-dd type
7574 but does not conform to the mmCIF yyyy-mm-dd:hh:mm
7575 type that uses a ':' in place if the 'T' specified
7576 by the IUCr standard. For reading, both forms should
7577 be accepted, but for writing, only the IUCr form should
7578 be used.
7579
7580 For maximal compatibility, the special time zone
7581 indicator 'Z' (for 'zulu') should be accepted on
7582 reading in place of '+00:00' for GMT.
7583 ;
7584
7585
7586 #####################
7587 ## <a name="ITEM_UNITS_LIST">ITEM_UNITS_LIST</a> ##
7588 #####################
7589
7590 loop_
7591 _item_units_list.code
7592 _item_units_list.detail
7593 #
7594 'metres' 'metres'
7595 'centimetres' 'centimetres (metres * 10^<sup>( -2)</sup>^)'
7596 'millimetres' 'millimetres (metres * 10^<sup>( -3)</sup>^)'
7597 'nanometres' 'nanometres (metres * 10^<sup>( -9)</sup>^)'
7598 'angstroms' '\%Angstroms (metres * 10^<sup>(-10)</sup>^)'
7599 'picometres' 'picometres (metres * 10^<sup>(-12)</sup>^)'
7600 'femtometres' 'femtometres (metres * 10^<sup>(-15)</sup>^)'
7601 #
7602 'reciprocal_metres' 'reciprocal metres (metres^<sup>(-1)</sup>^)'
7603 'reciprocal_centimetres'
7604 'reciprocal centimetres ((metres * 10^<sup>( -2)</sup>^)^<sup>(-1)</sup>^)'
7605 'reciprocal_millimetres'
7606 'reciprocal millimetres ((metres * 10^<sup>( -3)</sup>^)^<sup>(-1)</sup>^)'
7607 'reciprocal_nanometres'
7608 'reciprocal nanometres ((metres * 10^<sup>( -9)</sup>^)^<sup>(-1)</sup>^)'
7609 'reciprocal_angstroms'
7610 'reciprocal \%Angstroms ((metres * 10^<sup>(-10)</sup>^)^<sup>(-1)</sup>^)'
7611 'reciprocal_picometres'
7612 'reciprocal picometres ((metres * 10^<sup>(-12)</sup>^)^<sup>(-1)</sup>^)'
7613 #
7614 'nanometres_squared' 'nanometres squared (metres * 10^<sup>( -9)</sup>^)^<sup>2</sup>^'
7615 'angstroms_squared' '\%Angstroms squared (metres * 10^<sup>(-10)</sup>^)^<sup>2</sup>^'
7616 '8pi2_angstroms_squared'
7617 '8\p^<sup>2</sup>^ * \%Angstroms squared (metres * 10^<sup>(-10)</sup>^)^<sup>2</sup>^'
7618 'picometres_squared' 'picometres squared (metres * 10^<sup>(-12)</sup>^)^<sup>2</sup>^'
7619 #
7620 'nanometres_cubed' 'nanometres cubed (metres * 10^<sup>( -9)</sup>^)^<sup>3</sup>^'
7621 'angstroms_cubed' '\%Angstroms cubed (metres * 10^<sup>(-10)</sup>^)^<sup>3</sup>^'
7622 'picometres_cubed' 'picometres cubed (metres * 10^<sup>(-12)</sup>^)^<sup>3</sup>^'
7623 #
7624 'kilopascals' 'kilopascals'
7625 'gigapascals' 'gigapascals'
7626 #
7627 'hours' 'hours'
7628 'minutes' 'minutes'
7629 'seconds' 'seconds'
7630 'microseconds' 'microseconds'
7631 #
7632 'degrees' 'degrees (of arc)'
7633 'degrees_squared' 'degrees (of arc) squared'
7634 #
7635 'degrees_per_minute' 'degrees (of arc) per minute'
7636 #
7637 'celsius' 'degrees (of temperature) Celsius'
7638 'kelvins' 'degrees (of temperature) Kelvin'
7639 #
7640 'counts' 'counts'
7641 'counts_per_photon' 'counts per photon'
7642 #
7643 'electrons' 'electrons'
7644 #
7645 'electrons_squared' 'electrons squared'
7646 #
7647 'electrons_per_nanometres_cubed'
7648 ; electrons per nanometres cubed (electrons/(metres * 10^<sup>( -9)</sup>^)^<sup>(-3)</sup>^)
7649 ;
7650 'electrons_per_angstroms_cubed'
7651 ; electrons per \%Angstroms cubed (electrons/(metres * 10^<sup>(-10)</sup>^)^<sup>(-3)</sup>^)
7652 ;
7653 'electrons_per_picometres_cubed'
7654 ; electrons per picometres cubed (electrons/(metres * 10^<sup>(-12)</sup>^)^<sup>(-3)</sup>^)
7655 ;
7656 'kilowatts' 'kilowatts'
7657 'milliamperes' 'milliamperes'
7658 'kilovolts' 'kilovolts'
7659 #
7660 'pixels_per_element' '(image) pixels per (array) element'
7661 #
7662 'arbitrary'
7663 ; arbitrary system of units.
7664 ;
7665 #
7666
7667 loop_
7668 _item_units_conversion.from_code
7669 _item_units_conversion.to_code
7670 _item_units_conversion.operator
7671 _item_units_conversion.factor
7672 ###
7673 'metres' 'centimetres' '*' 1.0E+02
7674 'metres' 'millimetres' '*' 1.0E+03
7675 'metres' 'nanometres' '*' 1.0E+09
7676 'metres' 'angstroms' '*' 1.0E+10
7677 'metres' 'picometres' '*' 1.0E+12
7678 'metres' 'femtometres' '*' 1.0E+15
7679 #
7680 'centimetres' 'metres' '*' 1.0E-02
7681 'centimetres' 'millimetres' '*' 1.0E+01
7682 'centimetres' 'nanometres' '*' 1.0E+07
7683 'centimetres' 'angstroms' '*' 1.0E+08
7684 'centimetres' 'picometres' '*' 1.0E+10
7685 'centimetres' 'femtometres' '*' 1.0E+13
7686 #
7687 'millimetres' 'metres' '*' 1.0E-03
7688 'millimetres' 'centimetres' '*' 1.0E-01
7689 'millimetres' 'nanometres' '*' 1.0E+06
7690 'millimetres' 'angstroms' '*' 1.0E+07
7691 'millimetres' 'picometres' '*' 1.0E+09
7692 'millimetres' 'femtometres' '*' 1.0E+12
7693 #
7694 'nanometres' 'metres' '*' 1.0E-09
7695 'nanometres' 'centimetres' '*' 1.0E-07
7696 'nanometres' 'millimetres' '*' 1.0E-06
7697 'nanometres' 'angstroms' '*' 1.0E+01
7698 'nanometres' 'picometres' '*' 1.0E+03
7699 'nanometres' 'femtometres' '*' 1.0E+06
7700 #
7701 'angstroms' 'metres' '*' 1.0E-10
7702 'angstroms' 'centimetres' '*' 1.0E-08
7703 'angstroms' 'millimetres' '*' 1.0E-07
7704 'angstroms' 'nanometres' '*' 1.0E-01
7705 'angstroms' 'picometres' '*' 1.0E+02
7706 'angstroms' 'femtometres' '*' 1.0E+05
7707 #
7708 'picometres' 'metres' '*' 1.0E-12
7709 'picometres' 'centimetres' '*' 1.0E-10
7710 'picometres' 'millimetres' '*' 1.0E-09
7711 'picometres' 'nanometres' '*' 1.0E-03
7712 'picometres' 'angstroms' '*' 1.0E-02
7713 'picometres' 'femtometres' '*' 1.0E+03
7714 #
7715 'femtometres' 'metres' '*' 1.0E-15
7716 'femtometres' 'centimetres' '*' 1.0E-13
7717 'femtometres' 'millimetres' '*' 1.0E-12
7718 'femtometres' 'nanometres' '*' 1.0E-06
7719 'femtometres' 'angstroms' '*' 1.0E-05
7720 'femtometres' 'picometres' '*' 1.0E-03
7721 ###
7722 'reciprocal_centimetres' 'reciprocal_metres' '*' 1.0E+02
7723 'reciprocal_centimetres' 'reciprocal_millimetres' '*' 1.0E-01
7724 'reciprocal_centimetres' 'reciprocal_nanometres' '*' 1.0E-07
7725 'reciprocal_centimetres' 'reciprocal_angstroms' '*' 1.0E-08
7726 'reciprocal_centimetres' 'reciprocal_picometres' '*' 1.0E-10
7727 #
7728 'reciprocal_millimetres' 'reciprocal_metres' '*' 1.0E+03
7729 'reciprocal_millimetres' 'reciprocal_centimetres' '*' 1.0E+01
7730 'reciprocal_millimetres' 'reciprocal_nanometres' '*' 1.0E-06
7731 'reciprocal_millimetres' 'reciprocal_angstroms' '*' 1.0E-07
7732 'reciprocal_millimetres' 'reciprocal_picometres' '*' 1.0E-09
7733 #
7734 'reciprocal_nanometres' 'reciprocal_metres' '*' 1.0E+09
7735 'reciprocal_nanometres' 'reciprocal_centimetres' '*' 1.0E+07
7736 'reciprocal_nanometres' 'reciprocal_millimetres' '*' 1.0E+06
7737 'reciprocal_nanometres' 'reciprocal_angstroms' '*' 1.0E-01
7738 'reciprocal_nanometres' 'reciprocal_picometres' '*' 1.0E-03
7739 #
7740 'reciprocal_angstroms' 'reciprocal_metres' '*' 1.0E+10
7741 'reciprocal_angstroms' 'reciprocal_centimetres' '*' 1.0E+08
7742 'reciprocal_angstroms' 'reciprocal_millimetres' '*' 1.0E+07
7743 'reciprocal_angstroms' 'reciprocal_nanometres' '*' 1.0E+01
7744 'reciprocal_angstroms' 'reciprocal_picometres' '*' 1.0E-02
7745 #
7746 'reciprocal_picometres' 'reciprocal_metres' '*' 1.0E+12
7747 'reciprocal_picometres' 'reciprocal_centimetres' '*' 1.0E+10
7748 'reciprocal_picometres' 'reciprocal_millimetres' '*' 1.0E+09
7749 'reciprocal_picometres' 'reciprocal_nanometres' '*' 1.0E+03
7750 'reciprocal_picometres' 'reciprocal_angstroms' '*' 1.0E+01
7751 ###
7752 'nanometres_squared' 'angstroms_squared' '*' 1.0E+02
7753 'nanometres_squared' 'picometres_squared' '*' 1.0E+06
7754 #
7755 'angstroms_squared' 'nanometres_squared' '*' 1.0E-02
7756 'angstroms_squared' 'picometres_squared' '*' 1.0E+04
7757 'angstroms_squared' '8pi2_angstroms_squared' '*' 78.9568
7758
7759 #
7760 'picometres_squared' 'nanometres_squared' '*' 1.0E-06
7761 'picometres_squared' 'angstroms_squared' '*' 1.0E-04
7762 ###
7763 'nanometres_cubed' 'angstroms_cubed' '*' 1.0E+03
7764 'nanometres_cubed' 'picometres_cubed' '*' 1.0E+09
7765 #
7766 'angstroms_cubed' 'nanometres_cubed' '*' 1.0E-03
7767 'angstroms_cubed' 'picometres_cubed' '*' 1.0E+06
7768 #
7769 'picometres_cubed' 'nanometres_cubed' '*' 1.0E-09
7770 'picometres_cubed' 'angstroms_cubed' '*' 1.0E-06
7771 ###
7772 'kilopascals' 'gigapascals' '*' 1.0E-06
7773 'gigapascals' 'kilopascals' '*' 1.0E+06
7774 ###
7775 'hours' 'minutes' '*' 6.0E+01
7776 'hours' 'seconds' '*' 3.6E+03
7777 'hours' 'microseconds' '*' 3.6E+09
7778 #
7779 'minutes' 'hours' '/' 6.0E+01
7780 'minutes' 'seconds' '*' 6.0E+01
7781 'minutes' 'microseconds' '*' 6.0E+07
7782 #
7783 'seconds' 'hours' '/' 3.6E+03
7784 'seconds' 'minutes' '/' 6.0E+01
7785 'seconds' 'microseconds' '*' 1.0E+06
7786 #
7787 'microseconds' 'hours' '/' 3.6E+09
7788 'microseconds' 'minutes' '/' 6.0E+07
7789 'microseconds' 'seconds' '/' 1.0E+06
7790 ###
7791 'celsius' 'kelvins' '-' 273.0
7792 'kelvins' 'celsius' '+' 273.0
7793 ###
7794 'electrons_per_nanometres_cubed'
7795 'electrons_per_angstroms_cubed' '*' 1.0E+03
7796 'electrons_per_nanometres_cubed'
7797 'electrons_per_picometres_cubed' '*' 1.0E+09
7798 #
7799 'electrons_per_angstroms_cubed'
7800 'electrons_per_nanometres_cubed' '*' 1.0E-03
7801 'electrons_per_angstroms_cubed'
7802 'electrons_per_picometres_cubed' '*' 1.0E+06
7803 #
7804 'electrons_per_picometres_cubed'
7805 'electrons_per_nanometres_cubed' '*' 1.0E-09
7806 'electrons_per_picometres_cubed'
7807 'electrons_per_angstroms_cubed' '*' 1.0E-06
7808 ###
7809
7810 ########################
7811 ## <a name="DICTIONARY_HISTORY">DICTIONARY_HISTORY</a> ##
7812 ########################
7813
7814 loop_
7815 _dictionary_history.version
7816 _dictionary_history.update
7817 _dictionary_history.revision
7818
7819 1.6.4 2011-07-02
7820
7821 ; Corrections to support DLS Dectris header as per G. Winter (HJB)
7822
7823 + Define new tags <a href="#_diffrn_scan.time_period">_diffrn_scan.time_period</a>,
7824 <a href="#_diffrn_scan.time_rstrt_incr">_diffrn_scan.time_rstrt_incr</a>,
7825 <a href="#_diffrn_scan_frame.time_period">_diffrn_scan_frame.time_period</a>,
7826 <a href="#_diffrn_scan_frame.time_rstrt_incr">_diffrn_scan_frame.time_rstrt_incr</a>
7827 + fix bad category name in loop in <a href="#_diffrn_detector.id">_diffrn_detector.id</a>
7828 + remove stray text field terminator at line 4642
7829 + fix unquoted tag as a value in <a href="#_diffrn_scan_frame_monitor.id">_diffrn_scan_frame_monitor.id</a>
7830 + make formerly mandatory and implicit deprecated items non-mandatory
7831
7832 ;
7833
7834 1.6.3 2010-08-26
7835
7836 ; Cummulative corrections from 1.6.0, 1, 2 drafts (HJB)
7837
7838 + Move descriptive dictionary comments into
7839 _datablock.description with catgeory tree described
7840 + add default <a href="#_array_data.array_id">_array_data.array_id</a> value of 1
7841 + add option of CBF_BACKGROUND_OFFSET_DELTA compression
7842 + add VARIANT catgeory and tags
7843 + add DIFFRN_SCAN_FRAME_MONITOR category
7844
7845 ;
7846
7847 1.5.4 2007-07-28
7848
7849 ; Typographics corrections (HJB)
7850
7851 + Corrected embedded degree characters to \%
7852 + Corrected embedded Aring to \%A
7853 + Added trailing ^ for a power
7854 + Removed 2 cases of a space after an underscore
7855 in tag name.
7856 ;
7857
7858 1.5.3 2007-07-08
7859
7860 ; Changes to support SLS miniCBF and suggestions
7861 from the 24 May 07 BNL imgCIF workshop (HJB)
7862
7863 + Added new data items
7864 '<a href="#_array_data.header_contents" >_array_data.header_contents</a>',
7865 '<a href="#_array_data.header_convention" >_array_data.header_convention</a>',
7866 '<a href="#_diffrn_data_frame.center_fast" >_diffrn_data_frame.center_fast</a>',
7867 '<a href="#_diffrn_data_frame.center_slow" >_diffrn_data_frame.center_slow</a>',
7868 '<a href="#_diffrn_data_frame.center_units" >_diffrn_data_frame.center_units</a>',
7869 '<a href="#_diffrn_measurement.sample_detector_distance" >_diffrn_measurement.sample_detector_distance</a>',
7870 '<a href="#_diffrn_measurement.sample_detector_voffset" >_diffrn_measurement.sample_detector_voffset</a>
7871 + Deprecated data items
7872 '<a href="#_diffrn_detector_element.center[1]" >_diffrn_detector_element.center[1]</a>',
7873 '<a href="#_diffrn_detector_element.center[2]" >_diffrn_detector_element.center[2]</a>'
7874 + Added comments and example on miniCBF
7875 + Changed all array_id data items to implicit
7876 ;
7877
7878 1.5.2 2007-05-06
7879
7880 ; Further clarifications of the coordinate system. (HJB)
7881 ;
7882
7883 1.5.1 2007-04-26
7884
7885 ; Improve defintion of X-axis to cover the case of no goniometer
7886 and clean up more line folds (HJB)
7887 ;
7888
7889 1.5 2007-07-25
7890
7891 ; This is a cummulative list of the changes proposed since the
7892 imgCIF workshop in Hawaii in July 2006. It is the result
7893 of contributions by H. J. Bernstein, A. Hammersley,
7894 J. Wright and W. Kabsch.
7895
7896 2007-02-19 Consolidated changes (edited by HJB)
7897 + Added new data items
7898 '<a href="#_array_structure.compression_type_flag" >_array_structure.compression_type_flag</a>',
7899 '<a href="#_array_structure_list_axis.fract_displacement">_array_structure_list_axis.fract_displacement</a>',
7900 '<a href="#_array_structure_list_axis.fract_displacement_increment" >_array_structure_list_axis.displacement_increment</a>',
7901 '<a href="#_array_structure_list_axis.reference_angle" >_array_structure_list_axis.reference_angle</a>',
7902 '<a href="#_array_structure_list_axis.reference_displacement" >_array_structure_list_axis.reference_displacement</a>',
7903 '<a href="#_axis.sdystem" >_axis.system</a>',
7904 '<a href="#_diffrn_detector_element.reference_center_fast" >_diffrn_detector_element.reference_center_fast</a>',
7905 '<a href="#_diffrn_detector_element.reference_center_slow" >_diffrn_detector_element.reference_center_slow</a>',
7906 '<a href="#_diffrn_scan_axis.reference_angle" >_diffrn_scan_axis.reference_angle</a>',
7907 '<a href="#_diffrn_scan_axis.reference_displacement" >_diffrn_scan_axis.reference_displacement</a>',
7908 '<a href="#_map.details" >_map.details</a>', '<a href="#_map.diffrn_id" >_map.diffrn_id</a>',
7909 '<a href="#_map.entry_id" >_map.entry_id</a>', '<a name="#_map.id" >_map.id</a>',
7910 '<a href="#_map_segment.array_id" >_map_segment.array_id</a>', '<a href="#_map_segment.binary_id" >_map_segment.binary_id</a>',
7911 '<a href="#_map_segment.mask_array_id" >_map_segment.mask_array_id</a>', '<a href="#_map_segment.mask_binary_id" >_map_segment.mask_binary_id</a>',
7912 '<a href="#_map_segment.id" >_map_segment.id</a>', '<a href="#_map_segment.map_id" >_map_segment.map_id</a>',
7913 '<a href="#_map_segment.details" >_map_segment.details</a>.
7914 + Change type of
7915 '<a href="#_array_structure.byte_order" >_array_structure.byte_order</a>' and
7916 '<a href="#_array_structure.compression_type" >_array_structure.compression_type</a>'
7917 to ucode to make these values case-insensitive
7918 + Add values 'packed_v2' and 'byte_offset' to enumeration of values for
7919 '<a href="#_array_structure.compression_type" >_array_structure.compression_type</a>'
7920 + Add to definitions for the binary data type to handle new compression
7921 types, maps, and a variety of new axis types.
7922 2007-07-25 Cleanup of typos for formal release (HJB)
7923 + Corrected text fields for reference_ tag descriptions that
7924 were off by one column
7925 + Fix typos in comments listing fract_ tags
7926 + Changed name of release from 1.5_DRAFT to 1.5
7927 + Fix unclosed text fields in various map definitions
7928
7929 ;
7930
7931 1.4 2006-07-04
7932
7933 ; This is a change to reintegrate all changes made in the course of
7934 publication of ITVG, by the RCSB from April 2005 through
7935 August 2008 and changes for the 2006 imgCIF workshop in
7936 Hawaii.
7937
7938 2006-07-04 Consolidated changes for the 2006 imgCIF workshop (edited by HJB)
7939 + Correct type of '<a href="#_array_structure_list.direction">_array_structure_list.direction</a>' from 'int' to 'code'.
7940 + Added new data items suggested by CN
7941 '<a href="#_diffrn_data_frame.details">_diffrn_data_frame.details</a>'
7942 '<a href="#_array_intensities.pixel_fast_bin_size" >_array_intensities.pixel_fast_bin_size</a>',
7943 '<a href="#_array_intensities.pixel_slow_bin_size" >_array_intensities.pixel_slow_bin_size</a> and
7944 '<a href="#_array_intensities.pixel_binning_method" >_array_intensities.pixel_binning_method</a>
7945 + Added deprecated item for completeness
7946 '<a href="#_diffrn_frame_data.details">_diffrn_frame_data.details</a>'
7947 + Added entry for missing item in contents list
7948 '<a href="#_array_structure_list_axis.displacement" >_array_structure_list_axis.displacement</a>'
7949 + Added new MIME type <b>X</b>-BASE32K based on work by VL, KM, GD, HJB
7950 + Correct description of MIME boundary delimiter to start in
7951 column 1.
7952 + General cleanup of text fields to conform to changes for ITVG
7953 by removing empty lines at start and finish of text field.
7954 + Amend example for ARRAY_INTENSITIES to include binning.
7955 + Add local copy of type specification (as 'code') for all children
7956 of '<a href="#_diffrn.id">_diffrn.id</a>'.
7957 + For consistency, change all references to 'pi' to '\p' and all
7958 references to 'Angstroms' to '\%Angstroms'.
7959 + Clean up all powers to use IUCr convention of '^power^', as in
7960 '10^3^' for '10**3'.
7961 + Update 'yyyy-mm-dd' type regex to allow truncation from the right
7962 and improve comments to explain handling of related mmCIF
7963 'yyyy-mm-dd:hh:mm' type, and use of 'Z' for GMT time zone.
7964
7965 2005-03-08 and
7966 2004-08-08 fixed cases where _item_units.code used
7967 instead of _item_type.code (JDW)
7968 2004-04-15 fixed item ordering in
7969 _diffrn_measurement_axis.measurement_id
7970 added sub_category 'vector' (JDW)
7971 ;
7972
7973 1.3.2 2005-06-25
7974
7975 ; 2005-06-25 ITEM_TYPE_LIST: code, ucode, line, uline regexps updated
7976 to those of current mmCIF; float modified by allowing integers
7977 terminated by a point as valid. The 'time' part of
7978 yyyy-mm-dd types made optional in the regexp. (BM)
7979
7980 2005-06-17 Minor corrections as for proofs for IT G Chapter 4.6
7981 (NJA)
7982
7983 2005-02-21 Minor corrections to spelling and punctuation
7984 (NJA)
7985
7986 2005-01-08 Changes as per Nicola Ashcroft.
7987 + Updated example 1 for DIFFRN_MEASUREMENT to agree with mmCIF.
7988 + Spelled out "micrometres" for "um" and "millimetres" for "mm".
7989 + Removed phrase "which may be stored" from ARRAY_STRUCTURE
7990 description.
7991 + Removed unused 'byte-offsets' compressions and updated
7992 cites to ITVG for '_array_structure.compression_type'.
7993 (HJB)
7994 ;
7995
7996 1.3.1 2003-08-13
7997 ;
7998 Changes as per Frances C. Bernstein.
7999 + Identify initials.
8000 + Adopt British spelling for centre in text.
8001 + Set \p and \%Angstrom and powers.
8002 + Clean up commas and unclear wordings.
8003 + Clean up tenses in history.
8004 Changes as per Gotzon Madariaga.
8005 + Fix the ARRAY_DATA example to align '_array_data.binary_id'
8006 and <b>X</b>-Binary-ID.
8007 + Add a range to '<a href="#_array_intensities.gain_esd">_array_intensities.gain_esd</a>'.
8008 + In the example of DIFFRN_DETECTOR_ELEMENT,
8009 '<a href="#_diffrn_detector_element.id">_diffrn_detector_element.id</a>' and
8010 '<a href="#_diffrn_detector_element.detector_id">_diffrn_detector_element.detector_id</a>' interchanged.
8011 + Fix typos for direction, detector and axes.
8012 + Clarify description of polarisation.
8013 + Clarify axes in '<a href="#_diffrn_detector_element.center[1]">_diffrn_detector_element.center[1]</a>'
8014 '<a href="#_diffrn_detector_element.center[2]">_diffrn_detector_element.center[2]</a>'.
8015 + Add local item types for items that are pointers.
8016 (HJB)
8017 ;
8018
8019
8020 1.3.0 2003-07-24
8021 ;
8022 Changes as per Brian McMahon.
8023 + Consistently quote tags embedded in text.
8024 + Clean up introductory comments.
8025 + Adjust line lengths to fit in 80 character window.
8026 + Fix several descriptions in AXIS category which
8027 referred to '_axis.type' instead of the current item.
8028 + Fix erroneous use of deprecated item
8029 '_diffrn_detector_axis.id' in examples for
8030 DIFFRN_SCAN_AXIS.
8031 + Add deprecated items '_diffrn_detector_axis.id'
8032 and '_diffrn_measurement_axis.id'.
8033 (HJB)
8034 ;
8035
8036
8037 1.2.4 2003-07-14
8038 ;
8039 Changes as per I. David Brown.
8040 + Enhance descriptions in DIFFRN_SCAN_AXIS to make them less
8041 dependent on the descriptions in DIFFRN_SCAN_FRAME_AXIS.
8042 + Provide a copy of the deprecated DIFFRN_FRAME_DATA
8043 category for completeness.
8044 (HJB)
8045 ;
8046
8047
8048 1.2.3 2003-07-03
8049 ;
8050 Cleanup to conform to ITVG.
8051 + Correct sign error in ..._cubed units.
8052 + Correct '_diffrn_radiation.polarisn_norm' range.
8053 (HJB)
8054 ;
8055
8056
8057 1.2.2 2003-03-10
8058 ;
8059 Correction of typos in various DIFFRN_SCAN_AXIS descriptions.
8060 (HJB)
8061 ;
8062
8063
8064 1.2.1 2003-02-22
8065 ;
8066 Correction of ATOM_ for ARRAY_ typos in various descriptions.
8067 (HJB)
8068 ;
8069
8070
8071 1.2 2003-02-07
8072 ;
8073 Corrections to encodings (remove extraneous hyphens) remove
8074 extraneous underscore in '<a href="#_array_structure.encoding_type">_array_structure.encoding_type</a>'
8075 enumeration. Correct typos in items units list. (HJB)
8076 ;
8077
8078
8079 1.1.3 2001-04-19
8080 ;
8081 Another typo corrections by Wilfred Li, and cleanup by HJB.
8082 ;
8083
8084
8085 1.1.2 2001-03-06
8086 ;
8087 Several typo corrections by Wilfred Li.
8088 ;
8089
8090
8091 1.1.1 2001-02-16
8092 ;
8093 Several typo corrections by JW.
8094 ;
8095
8096
8097 1.1 2001-02-06
8098 ;
8099 Draft resulting from discussions on header for use at NSLS. (HJB)
8100
8101 + Change DIFFRN_FRAME_DATA to <a href="#DIFFRN_DATA_FRAME">DIFFRN_DATA_FRAME</a>.
8102
8103 + Change '_diffrn_detector_axis.id' to '<a href="#_diffrn_detector_axis.detector_id">_diffrn_detector_axis.detector_id</a>'.
8104
8105 + Add '<a href="#_diffrn_measurement_axis.measurement_device">_diffrn_measurement_axis.measurement_device</a>' and change
8106 '_diffrn_measurement_axis.id' to
8107 '<a href="#_diffrn_measurement_axis.measurement_id">_diffrn_measurement_axis.measurement_id</a>'.
8108
8109 + Add '<a href="#_diffrn_radiation.div_x_source">_diffrn_radiation.div_x_source</a>', '<a href="#_diffrn_radiation.div_y_source">_diffrn_radiation.div_y_source</a>',
8110 '<a href="#_diffrn_radiation.div_x_y_source">_diffrn_radiation.div_x_y_source</a>',
8111 '<a href="#_diffrn_radiation.polarizn_source_norm">_diffrn_radiation.polarizn_source_norm</a>',
8112 '<a href="#_diffrn_radiation.polarizn_source_ratio">_diffrn_radiation.polarizn_source_ratio</a>', '<a href="#_diffrn_scan.date_end">_diffrn_scan.date_end</a>',
8113 '<a href="#_diffrn_scan.date_start">_diffrn_scan.date_start</a>', '<a href="#_diffrn_scan_axis.angle_rstrt_incr">_diffrn_scan_axis.angle_rstrt_incr</a>',
8114 '<a href="#_diffrn_scan_axis.displacement_rstrt_incr">_diffrn_scan_axis.displacement_rstrt_incr</a>',
8115 '<a href="#_diffrn_scan_frame_axis.angle_increment">_diffrn_scan_frame_axis.angle_increment</a>',
8116 '<a href="#_diffrn_scan_frame_axis.angle_rstrt_incr">_diffrn_scan_frame_axis.angle_rstrt_incr</a>',
8117 '<a href="#_diffrn_scan_frame_axis.displacement">_diffrn_scan_frame_axis.displacement</a>',
8118 '<a href="#_diffrn_scan_frame_axis.displacement_increment">_diffrn_scan_frame_axis.displacement_increment</a>',and
8119 '<a href="#_diffrn_scan_frame_axis.displacement_rstrt_incr">_diffrn_scan_frame_axis.displacement_rstrt_incr</a>'.
8120
8121 + Add '<a href="#_diffrn_measurement.device">_diffrn_measurement.device</a>' to category key.
8122
8123 + Update yyyy-mm-dd to allow optional time with fractional seconds
8124 for time stamps.
8125
8126 + Fix typos caught by RS.
8127
8128 + Add <a href="#ARRAY_STRUCTURE_LIST_AXIS">ARRAY_STRUCTURE_LIST_AXIS</a> category, and use concept of axis sets to
8129 allow for coupled axes, as in spiral scans.
8130
8131 + Add examples for fairly complete headers thanks to R. Sweet and P.
8132 Ellis.
8133 ;
8134
8135
8136 1.0 2000-12-21
8137 ;
8138 Release version - few typos and tidying up. (BM &amp; HJB)
8139
8140 + Move ITEM_TYPE_LIST, ITEM_UNITS_LIST and DICTIONARY_HISTORY to end
8141 of dictionary.
8142
8143 + Alphabetize dictionary.
8144 ;
8145
8146
8147 0.7.1 2000-09-29
8148 ;
8149 Cleanup fixes. (JW)
8150
8151 + Correct spelling of diffrn_measurement_axis in '<a href="#_axis.id">_axis.id</a>'
8152
8153 + Correct ordering of uses of '_item.mandatory_code' and
8154 '_item_default.value'.
8155 ;
8156
8157
8158 0.7.0 2000-09-09
8159 ;
8160 Respond to comments by I. David Brown. (HJB)
8161
8162 + Add further comments on '\n' and '\t'.
8163
8164 + Update ITEM_UNITS_LIST by taking section from mmCIF dictionary
8165 and adding metres. Change 'meter' to 'metre' throughout.
8166
8167 + Add missing enumerations to '<a href="#_array_structure.compression_type">_array_structure.compression_type</a>'
8168 and make 'none' the default.
8169
8170 + Remove parent-child relationship between
8171 '<a href="#_array_structure_list.index">_array_structure_list.index</a>' and '<a href="#_array_structure_list.precedence">_array_structure_list.precedence</a>'.
8172
8173 + Improve alphabetization.
8174
8175 + Fix '<a href="#_array_intensities.gain_esd">_array_intensities_gain.esd</a>' related function.
8176
8177 + Improve comments in <a href="#AXIS">AXIS</a>.
8178
8179 + Fix DIFFRN_FRAME_DATA example.
8180
8181 + Remove erroneous <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> example.
8182
8183 + Add '<a href="#_diffrn_measurement_axis.id">_diffrn_measurement_axis.id</a>' to the category key.
8184 ;
8185
8186
8187 0.6.0 1999-01-14
8188 ;
8189 Remove redundant information for ENC_NONE data. (HJB)
8190
8191 + After the D5 remove binary section identifier, size and
8192 compression type.
8193
8194 + Add Control-L to header.
8195 ;
8196
8197
8198 0.5.1 1999-01-03
8199 ;
8200 Cleanup of typos and syntax errors. (HJB)
8201
8202 + Cleanup example details for <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a> category.
8203
8204 + Add missing quote marks for '<a href="#_diffrn_scan.id" >_diffrn_scan.id</a>' definition.
8205 ;
8206
8207
8208 0.5 1999-01-01
8209 ;
8210 Modifications for axis definitions and reduction of binary header. (HJB)
8211
8212 + Restore '<a href="#_diffrn_detector.diffrn_id" >_diffrn_detector.diffrn_id</a>' to <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> KEY.
8213
8214 + Add <a href="#AXIS">AXIS</a> category.
8215
8216 + Bring in complete <a href="#DIFFRN_DETECTOR">DIFFRN_DETECTOR</a> and <a href="#DIFFRN_MEASUREMENT">DIFFRN_MEASUREMENT</a> categories
8217 from cif_mm.dic for clarity.
8218
8219 + Change '<a href="#_array_structure.encoding_type">_array_structure.encoding_type</a>' from type code to uline and
8220 added X-Binary-Element-Type to MIME header.
8221
8222 + Add detector beam centre '<a href="#_diffrn_detector_element.center[1]">_diffrn_detector_element.center[1]</a>' and
8223 '<a href="#_diffrn_detector_element.center[2]">_diffrn_detector_element.center[2]</a>'.
8224
8225 + Correct item name of '<a href="#_diffrn_refln.frame_id">_diffrn_refln.frame_id</a>'.
8226
8227 + Replace reference to '_array_intensities.undefined' by
8228 '_array_intensities.undefined_value'.
8229
8230 + Replace references to '_array_intensity.scaling' with
8231 '_array_intensities.scaling'.
8232
8233 + Add <a href="#DIFFRN_SCAN">DIFFRN_SCAN</a>... categories.
8234 ;
8235
8236
8237 0.4 1998-08-11
8238 ;
8239 Modifications to the 0.3 imgCIF draft. (HJB)
8240
8241 + Reflow comment lines over 80 characters and corrected typos.
8242
8243 + Update examples and descriptions of MIME encoded data.
8244
8245 + Change name to cbfext98.dic.
8246 ;
8247
8248
8249 0.3 1998-07-04
8250 ;
8251 Modifications for imgCIF. (HJB)
8252
8253 + Add binary type, which is a text field containing a variant on
8254 MIME encoded data.
8255
8256 + Change type of '<a href="#_array_data.data" >_array_data.data</a>' to binary and specify internal
8257 structure of raw binary data.
8258
8259 + Add '<a href="#_array_data.binary_id" >_array_data.binary_id</a>', and make
8260 '<a href="#_diffrn_frame_data.binary_id" >_diffrn_frame_data.binary_id</a>' and '<a href="#_array_intensities.binary_id" >_array_intensities.binary_id</a>'
8261 into pointers to this item.
8262 ;
8263
8264
8265 0.2 1997-12-02
8266 ;
8267 Modifications to the CBF draft. (JW)
8268
8269 + Add category hierarchy for describing frame data developed from
8270 discussions at the BNL imgCIF Workshop Oct 1997. The following
8271 changes are made in implementing the workshop draft. Category
8272 DIFFRN_ARRAY_DATA is renamed to DIFFRN_FRAME_DATA. Category
8273 DIFFRN_FRAME_TYPE is renamed to <a href="#DIFFRN_DETECTOR_ELEMENT">DIFFRN_DETECTOR_ELEMENT</a>. The
8274 parent item for '<a href="#_diffrn_frame_data.array_id" >_diffrn_frame_data.array_id</a>' is changed from
8275 '_array_structure_list.array_id' to '_array_structure.id'. Item
8276 '_diffrn_detector.array_id' is deleted.
8277 + Add data item '<a href="#_diffrn_frame_data.binary_id" >_diffrn_frame_data.binary_id</a>' to identify data
8278 groups within a binary section. The formal identification of the
8279 binary section is still fuzzy.
8280 ;
8281
8282
8283 0.1 1997-01-24
8284 ;
8285 First draft of this dictionary in DDL 2.1 compliant format by John
8286 Westbrook (JW). This version is adapted from the Crystallographic
8287 Binary File (CBF) Format Draft Proposal provided by Andy Hammersley
8288 (AH).
8289
8290 Modifications to the CBF draft. (JW)
8291
8292 + In this version the array description has been cast in the categories
8293 <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> and <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a>. These categories
8294 have been generalized to describe array data of arbitrary dimension.
8295
8296 + Array data in this description are contained in the category
8297 <a href="#ARRAY_DATA">ARRAY_DATA</a>. This departs from the CBF notion of data existing
8298 in some special comment. In this description, data are handled as an
8299 ordinary data item encapsulated in a character data type. Although
8300 data this manner deviates from CIF conventions, it does not violate
8301 any DDL 2.1 rules. DDL 2.1 regular expressions can be used to define
8302 the binary representation which will permit some level of data
8303 validation. In this version, the placeholder type code "any" has
8304 been used. This translates to a regular expression which will match
8305 any pattern.
8306
8307 It should be noted that DDL 2.1 already supports array data objects
8308 although these have not been used in the current mmCIF dictionary.
8309 It may be possible to use the DDL 2.1 ITEM_STRUCTURE and
8310 ITEM_STRUCTURE_LIST categories to provide the information that is
8311 carried in by the <a href="#ARRAY_STRUCTURE">ARRAY_STRUCTURE</a> and <a href="#ARRAY_STRUCTURE_LIST">ARRAY_STRUCTURE_LIST</a>. By
8312 moving the array structure to the DDL level it would be possible to
8313 define an array type as well as a regular expression defining the
8314 data format.
8315
8316 + Multiple array sections can be properly handled within a single
8317 datablock.
8318 ;
8319
8320
8321 #-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof-eof
8322 </PRE>
8323 </BODY>
8324 </HTML>