Debian Codegraph @

doc/cif_img_1.6.3_26Aug10.html

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