Debian Codegraph @

doc/demo/full.py

raw
1 # -*- coding: utf-8 -*-
2 """
3 .. module:: simple.py
4 :platform: Unix
5 :synopsis: Generate test files in data exchange.
6
7 :Author:
8 `Francesco De Carlo <mailto: [email protected]>`_
9
10 :Organization:
11 Argonne National Laboratory, Argonne, IL 60439 USA
12
13 :Version: 2014.08.15
14 """
15
16 import os
17 import time import pytz import datetime import numpy as np
18 import dxfile.dxtomo as dx
19
20 def iso_time():
21 # set the experiment date now = datetime.datetime.today()
22
23 # set iso format time central = pytz.timezone('US/Central') local_time = central.localize(now) local_time_iso = local_time.isoformat()
24
25 return local_time_iso
26
27 def main():
28
29 fname = './demo.h5'
30 ccd_x, ccd_y = 128, 128
31
32 sample_name = 'sample_name'
33 sample_description = 'sample description'
34 sample_preparation_date = iso_time()
35 sample_chemical_formula = 'H2O'
36 sample_mass = '1234'
37 sample_concentration = '1234'
38 sample_environment = '1234'
39 sample_temperature = '1234'
40 sample_temperature_set = '1234'
41 sample_pressure = '1234'
42 sample_thickness = '1234'
43 sample_tray = 'A5'
44 sample_comment = 'sample comment'
45
46 experiment_prosal = '1234'
47 experiment_activity = '5678'
48 experiment_safety = '9012'
49 experiment_title = '4D Dynamics of Stress Corrosion Cracking in High Performance Aluminum Alloy'
50
51 experimenter_name = 'Joe'
52 experimenter_role = 'PI'
53 experimenter_affiliation = 'Argonne National Laboratory'
54 experimenter_address = '9700 S. Cass Av.'
55 experimenter_phone = '1-123-456-7890'
56 experimenter_email = '[email protected]'
57 experimenter_facility_user_id = '1234'
58
59 instrument_name = '32-ID TXM'
60 instrument_comment = 'nice instrument'
61
62 source_name = 'APS'
63 source_datetime = iso_time()
64 source_beamline = 'U18'
65 source_current = '100'
66 source_energy = '123'
67 source_pulse_energy = '45'
68 source_pulse_width = '67'
69 source_mode = 'top-up'
70 source_beam_intensity_incident = '123'
71 source_beam_intensity_transmitted = '456'
72
73 attenuator_name = 'filter'
74 attenuator_description = 'a nice filter'
75 attenuator_thickness = 1
76 attenuator_transmission = 0.754
77
78 monochromator_name = 'mono'
79 monochromator_description = 'a nice mono'
80 monochromator_energy = 27.5
81 monochromator_energy_units = 'keV'
82 monochromator_energy_error = '456'
83 monochromator_mono_stripe = 'Au/Ag'
84
85 mirror_name = 'mirror'
86 mirror_description = 'a nice mirror'
87 mirror_angle = 2.657
88 mirror_angle_units = 'rad'
89
90 detector_name = 'camera'
91 detector_description = 'a nice camera'
92 detector_manufacturer = 'a nice company'
93 detector_model = '123'
94 detector_serial_number = '456'
95 detector_firmware_version = '789'
96 detector_software_version = '012'
97 detector_bit_dept = '16'
98 detector_pixel_size_x = 0.65e-4
99 detector_pixel_size_y = 0.65e-4
100 detector_actual_pixel_size_x = 1.2
101 detector_actual_pixel_size_y = 1.2
102 detector_dimension_x = ccd_x
103 detector_dimension_y = ccd_y
104 detector_binning_x = 1
105 detector_binning_y = 1
106 detector_operating_temperature = 12
107 detector_exposure_time = 0.2
108 detector_delay_time = 0.001
109 detector_stabilization_time = 0.0001
110 detector_frame_rate = 160
111 detector_shutter_mode = 'global'
112 detector_output_data = '/exchange'
113 detector_counts_per_joule = '123'
114 detector_basis_vectors = '456'
115 detector_corner_position = '789'
116
117 detector_roi_name = 'roi'
118 detector_roi_description = 'a nice roi'
119 detector_roi_min_x = 0
120 detector_roi_min_y = 0
121 detector_roi_size_x = ccd_x
122 detector_roi_size_y = ccd_y
123
124 objective_name = 'objective'
125 objective_description = 'a nice objective'
126 objective_manufacturer = 'a nice company'
127 objective_model = 'a nice model'
128 objective_magnification = 1.5
129 objective_numerical_aperture = 0.8
130
131 scintillator_name = 'scintillator'
132 scintillator_description = 'a nice scintillator'
133 scintillator_manufacturer = 'a nice company'
134 scintillator_serial_number = '123'
135 scintillator_scintillating_thickness = 456
136 scintillator_substrate_thickness = 789
137
138 sample_stack_name = 'sample stack'
139 sample_stack_description = 'a nice sample stack'
140
141 sample_stack_setup_sample_x = 1
142 sample_stack_setup_sample_y = 2
143 sample_stack_setup_sample_z = 3
144 sample_stack_setup_sample_xx = 11
145 sample_stack_setup_sample_zz = 33
146 sample_detector_distance = 60
147
148 interferometer_name = 'interferometer'
149 interferometer_description = 'a nice interferometer'
150
151 interferometer_setup_grid_start = 123
152 interferometer_setup_grid_end = 456
153 interferometer_setup_number_of_grid_periods = 789
154 interferometer_setup_number_of_grid_steps = 123
155
156
157 process_name = 'the best process'
158
159 acquisition_sample_position_x = np.random.rand(180)
160 acquisition_sample_position_y = np.random.rand(180)
161 acquisition_sample_position_z = np.random.rand(180)
162 acquisition_sample_image_shift_x = np.random.rand(180)
163 acquisition_sample_image_shift_y = np.random.rand(180)
164 acquisition_image_theta = range(0, 180, 1)
165 acquisition_scan_index = range(0, 180, 1)
166 acquisition_scan_date = [iso_time() for x in range(180)]
167 acquisition_image_date = [iso_time() for x in range(180)]
168 acquisition_time_stamp = [iso_time() for x in range(180)]
169 acquisition_image_number = range(0, 180, 1)
170 acquisition_image_exposure_time = np.ones(180) * detector_exposure_time
171 acquisition_image_is_complete = np.ones(180)
172 acquisition_shutter = np.ones(180)
173 acquisition_image_type = np.ones(180)
174 acquisition_start_date = iso_time()
175 acquisition_end_date = iso_time()
176
177 acquisition_setup_number_of_projections = 180
178 acquisition_setup_number_of_darks = 10
179 acquisition_setup_number_of_whites = 10
180 acquisition_setup_number_of_inter_whites = 1
181 acquisition_setup_white_frequency = 1
182 acquisition_setup_sample_in = 0
183 acquisition_setup_sample_out = 4
184 acquisition_setup_rotation_start_angle = 0
185 acquisition_setup_rotation_end_angle = 180
186 acquisition_setup_rotation_speed = 0.750
187 acquisition_setup_angular_step = (acquisition_setup_rotation_end_angle - acquisition_setup_rotation_start_angle) / 180
188 acquisition_setup_mode = 'fly scan'
189 acquisition_setup_comment = 'a nice fly scan'
190
191
192 data = np.random.rand(180, ccd_y, ccd_x)
193 data_white = np.ones((acquisition_setup_number_of_whites, ccd_y, ccd_x)) # Array filled with zeros
194 data_dark = np.zeros((acquisition_setup_number_of_darks, ccd_y, ccd_x)) # Array filled with zeros
195 theta = range(0, 180, 1)
196
197
198 if (fname != None):
199 if os.path.isfile(fname):
200 print "Data Exchange file already exists: ", fname
201 else:
202 # Create new folder.
203 dirPath = os.path.dirname(fname)
204 if not os.path.exists(dirPath):
205 os.makedirs(dirPath)
206
207 # Open DataExchange file
208 f = dx.File(fname, mode='w')
209
210 # Write the Data Exchange HDF5 file.
211 f.add_entry(dx.Entry.sample( name={'value':sample_name}))
212 f.add_entry(dx.Entry.sample( description={'value':sample_description}))
213 f.add_entry(dx.Entry.sample( preparation_date={'value':sample_preparation_date}))
214 f.add_entry(dx.Entry.sample( chemical_formula={'value':sample_chemical_formula}))
215 f.add_entry(dx.Entry.sample( mass={'value':sample_mass}))
216 f.add_entry(dx.Entry.sample( concentration={'value':sample_concentration}))
217 f.add_entry(dx.Entry.sample( environment={'value':sample_environment}))
218 f.add_entry(dx.Entry.sample( temperature={'value':sample_temperature}))
219 f.add_entry(dx.Entry.sample( temperature_set={'value':sample_temperature_set}))
220 f.add_entry(dx.Entry.sample( pressure={'value':sample_pressure}))
221 f.add_entry(dx.Entry.sample( thickness={'value':sample_thickness}))
222 f.add_entry(dx.Entry.sample( tray={'value':sample_tray}))
223 f.add_entry(dx.Entry.sample( comment={'value':sample_comment}))
224
225 f.add_entry(dx.Entry.experiment( proposal={'value':experiment_prosal}))
226 f.add_entry(dx.Entry.experiment( activity={'value':experiment_activity}))
227 f.add_entry(dx.Entry.experiment( safety={'value':experiment_safety}))
228 f.add_entry(dx.Entry.experiment( title={'value':experiment_title}))
229
230 f.add_entry(dx.Entry.experimenter(name={'value':experimenter_name}))
231 f.add_entry(dx.Entry.experimenter(role={'value':experimenter_role}))
232 f.add_entry(dx.Entry.experimenter(affiliation={'value':experimenter_affiliation}))
233 f.add_entry(dx.Entry.experimenter(address={'value':experimenter_address}))
234 f.add_entry(dx.Entry.experimenter(phone={'value':experimenter_phone}))
235 f.add_entry(dx.Entry.experimenter(email={'value':experimenter_email}))
236 f.add_entry(dx.Entry.experimenter(facility_user_id={'value':experimenter_facility_user_id}))
237
238 f.add_entry(dx.Entry.instrument(name={'value':instrument_name}))
239 f.add_entry(dx.Entry.instrument(comment={'value':instrument_comment}))
240
241 f.add_entry(dx.Entry.source(name={'value':source_name}))
242 f.add_entry(dx.Entry.source(datetime={'value':source_datetime}))
243 f.add_entry(dx.Entry.source(beamline={'value':source_beamline}))
244 f.add_entry(dx.Entry.source(current={'value':source_current}))
245 f.add_entry(dx.Entry.source(energy={'value':source_energy}))
246 f.add_entry(dx.Entry.source(pulse_energy={'value':source_pulse_energy}))
247 f.add_entry(dx.Entry.source(pulse_width={'value':source_pulse_width}))
248 f.add_entry(dx.Entry.source(mode={'value':source_mode}))
249 f.add_entry(dx.Entry.source(beam_intensity_incident={'value':source_beam_intensity_incident}))
250 f.add_entry(dx.Entry.source(beam_intensity_transmitted={'value':source_beam_intensity_transmitted}))
251
252 f.add_entry(dx.Entry.attenuator( name={'value':attenuator_name}))
253 f.add_entry(dx.Entry.attenuator( description={'value':attenuator_description}))
254 f.add_entry(dx.Entry.attenuator( thickness={'value':attenuator_thickness, 'units':'mm'}))
255 f.add_entry(dx.Entry.attenuator( transmission={'value':attenuator_transmission}))
256
257 f.add_entry(dx.Entry.monochromator( name={'value':monochromator_name}))
258 f.add_entry(dx.Entry.monochromator( description={'value':monochromator_description}))
259 f.add_entry(dx.Entry.monochromator( energy={'value':monochromator_energy, 'units':monochromator_energy_units}))
260 f.add_entry(dx.Entry.monochromator( energy_error={'value':monochromator_energy_error}))
261 f.add_entry(dx.Entry.monochromator( mono_stripe={'value':monochromator_mono_stripe}))
262
263 f.add_entry(dx.Entry.mirror( name={'value':mirror_name}))
264 f.add_entry(dx.Entry.mirror( description={'value':mirror_description}))
265 f.add_entry(dx.Entry.mirror( angle={'value':mirror_angle, 'units':mirror_angle_units}))
266
267 f.add_entry(dx.Entry.detector(name={'value':detector_name}))
268 f.add_entry(dx.Entry.detector(description={'value':detector_description}))
269 f.add_entry(dx.Entry.detector(manufacturer={'value':detector_manufacturer}))
270 f.add_entry(dx.Entry.detector(model={'value':detector_model}))
271 f.add_entry(dx.Entry.detector(serial_number={'value':detector_serial_number}))
272 f.add_entry(dx.Entry.detector(firmware_version={'value':detector_firmware_version}))
273 f.add_entry(dx.Entry.detector(software_version={'value':detector_software_version}))
274 f.add_entry(dx.Entry.detector(bit_dept={'value':detector_bit_dept}))
275 f.add_entry(dx.Entry.detector(pixel_size_x={'value':detector_pixel_size_x, 'units':'m'}))
276 f.add_entry(dx.Entry.detector(pixel_size_y={'value':detector_pixel_size_y, 'units':'m'}))
277 f.add_entry(dx.Entry.detector(actual_pixel_size_x={'value':detector_actual_pixel_size_x, 'units':'um'}))
278 f.add_entry(dx.Entry.detector(actual_pixel_size_y={'value':detector_actual_pixel_size_y, 'units':'um'}))
279 f.add_entry(dx.Entry.detector(dimension_x={'value':detector_dimension_x}))
280 f.add_entry(dx.Entry.detector(dimension_y={'value':detector_dimension_y}))
281 f.add_entry(dx.Entry.detector(binning_x={'value':detector_binning_x}))
282 f.add_entry(dx.Entry.detector(binning_y={'value':detector_binning_y}))
283 f.add_entry(dx.Entry.detector(operating_temperature={'value':detector_operating_temperature}))
284 f.add_entry(dx.Entry.detector(exposure_time={'value':detector_exposure_time}))
285 f.add_entry(dx.Entry.detector(delay_time={'value':detector_delay_time}))
286 f.add_entry(dx.Entry.detector(stabilization_time={'value':detector_stabilization_time}))
287 f.add_entry(dx.Entry.detector(frame_rate={'value':detector_frame_rate}))
288 f.add_entry(dx.Entry.detector(shutter_mode={'value':detector_shutter_mode}))
289 f.add_entry(dx.Entry.detector(output_data={'value':detector_output_data}))
290 f.add_entry(dx.Entry.detector(counts_per_joule={'value':detector_counts_per_joule}))
291 f.add_entry(dx.Entry.detector(basis_vectors={'value':detector_basis_vectors}))
292 f.add_entry(dx.Entry.detector(corner_position={'value':detector_corner_position}))
293
294 f.add_entry(dx.Entry.roi(name={'value':detector_roi_name}))
295 f.add_entry(dx.Entry.roi(description={'value':detector_roi_description}))
296 f.add_entry(dx.Entry.roi(min_x={'value':detector_roi_min_x}))
297 f.add_entry(dx.Entry.roi(min_y={'value':detector_roi_min_y}))
298 f.add_entry(dx.Entry.roi(size_x={'value':detector_roi_size_x}))
299 f.add_entry(dx.Entry.roi(size_y={'value':detector_roi_size_y}))
300
301 f.add_entry(dx.Entry.objective(name={'value':objective_name}))
302 f.add_entry(dx.Entry.objective(description={'value':objective_description}))
303 f.add_entry(dx.Entry.objective(manufacturer={'value':objective_manufacturer}))
304 f.add_entry(dx.Entry.objective(model={'value':objective_model}))
305 f.add_entry(dx.Entry.objective(magnification={'value':objective_magnification}))
306 f.add_entry(dx.Entry.objective(numerical_aperture={'value':objective_numerical_aperture}))
307
308 f.add_entry(dx.Entry.scintillator(name={'value':scintillator_name}))
309 f.add_entry(dx.Entry.scintillator(description={'value':scintillator_description}))
310 f.add_entry(dx.Entry.scintillator(manufacturer={'value':scintillator_manufacturer}))
311 f.add_entry(dx.Entry.scintillator(serial_number={'value':scintillator_serial_number}))
312 f.add_entry(dx.Entry.scintillator(scintillating_thickness={'value':scintillator_scintillating_thickness, 'units':'um'}))
313 f.add_entry(dx.Entry.scintillator(substrate_thickness={'value':scintillator_substrate_thickness, 'units':'um'}))
314
315 f.add_entry(dx.Entry.sample_stack(name={'value':sample_stack_name}))
316 f.add_entry(dx.Entry.sample_stack(description={'value':sample_stack_description}))
317
318 f.add_entry(dx.Entry.sample_stack_setup(sample_x={'value':sample_stack_setup_sample_x, 'units':'mm'}))
319 f.add_entry(dx.Entry.sample_stack_setup(sample_y={'value':sample_stack_setup_sample_y, 'units':'mm'}))
320 f.add_entry(dx.Entry.sample_stack_setup(sample_z={'value':sample_stack_setup_sample_z, 'units':'mm'}))
321 f.add_entry(dx.Entry.sample_stack_setup(sample_xx={'value':sample_stack_setup_sample_xx, 'units':'mm'}))
322 f.add_entry(dx.Entry.sample_stack_setup(sample_zz={'value':sample_stack_setup_sample_zz, 'units':'mm'}))
323 f.add_entry(dx.Entry.sample_stack_setup(sample_detector_distance={'value':sample_detector_distance, 'units':'mm'}))
324
325 f.add_entry(dx.Entry.interferometer(name={'value':interferometer_name}))
326 f.add_entry(dx.Entry.interferometer(description={'value':interferometer_description}))
327
328 f.add_entry(dx.Entry.interferometer_setup(grid_start={'value':interferometer_setup_grid_start}))
329 f.add_entry(dx.Entry.interferometer_setup(grid_end={'value':interferometer_setup_grid_end}))
330 f.add_entry(dx.Entry.interferometer_setup(number_of_grid_periods={'value':interferometer_setup_number_of_grid_periods}))
331 f.add_entry(dx.Entry.interferometer_setup(number_of_grid_steps={'value':interferometer_setup_number_of_grid_steps}))
332
333 f.add_entry(dx.Entry.process(name={'value':process_name}))
334
335 f.add_entry(dx.Entry.acquisition(sample_position_x={'value':acquisition_sample_position_x}))
336 f.add_entry(dx.Entry.acquisition(sample_position_y={'value':acquisition_sample_position_y}))
337 f.add_entry(dx.Entry.acquisition(sample_position_z={'value':acquisition_sample_position_z}))
338 f.add_entry(dx.Entry.acquisition(sample_image_shift_x={'value':acquisition_sample_image_shift_x}))
339 f.add_entry(dx.Entry.acquisition(sample_image_shift_y={'value':acquisition_sample_image_shift_y}))
340 f.add_entry(dx.Entry.acquisition(image_theta={'value':acquisition_image_theta}))
341 f.add_entry(dx.Entry.acquisition(scan_index={'value':acquisition_scan_index}))
342 f.add_entry(dx.Entry.acquisition(scan_date={'value':acquisition_scan_date}))
343 f.add_entry(dx.Entry.acquisition(image_date={'value':acquisition_image_date}))
344 f.add_entry(dx.Entry.acquisition(time_stamp={'value':acquisition_time_stamp}))
345 f.add_entry(dx.Entry.acquisition(image_number={'value':acquisition_image_number}))
346 f.add_entry(dx.Entry.acquisition(image_exposure_time={'value':acquisition_image_exposure_time}))
347 f.add_entry(dx.Entry.acquisition(image_is_complete={'value':acquisition_image_is_complete}))
348 f.add_entry(dx.Entry.acquisition(shutter={'value':acquisition_shutter}))
349 f.add_entry(dx.Entry.acquisition(image_type={'value':acquisition_image_type}))
350 f.add_entry(dx.Entry.acquisition(start_date={'value':acquisition_start_date}))
351 f.add_entry(dx.Entry.acquisition(end_date={'value':acquisition_end_date}))
352
353 f.add_entry(dx.Entry.acquisition_setup(number_of_projections={'value':acquisition_setup_number_of_projections}))
354 f.add_entry(dx.Entry.acquisition_setup(number_of_darks={'value':acquisition_setup_number_of_darks}))
355 f.add_entry(dx.Entry.acquisition_setup(number_of_whites={'value':acquisition_setup_number_of_whites}))
356 f.add_entry(dx.Entry.acquisition_setup(number_of_inter_whites={'value':acquisition_setup_number_of_inter_whites}))
357 f.add_entry(dx.Entry.acquisition_setup(white_frequency={'value':acquisition_setup_white_frequency}))
358 f.add_entry(dx.Entry.acquisition_setup(sample_in={'value':acquisition_setup_sample_in}))
359 f.add_entry(dx.Entry.acquisition_setup(sample_out={'value':acquisition_setup_sample_out}))
360 f.add_entry(dx.Entry.acquisition_setup(rotation_start_angle={'value':acquisition_setup_rotation_start_angle}))
361 f.add_entry(dx.Entry.acquisition_setup(rotation_end_angle={'value':acquisition_setup_rotation_end_angle}))
362 f.add_entry(dx.Entry.acquisition_setup(rotation_speed={'value':acquisition_setup_rotation_speed}))
363 f.add_entry(dx.Entry.acquisition_setup(angular_step={'value':acquisition_setup_angular_step}))
364 f.add_entry(dx.Entry.acquisition_setup(mode={'value':acquisition_setup_mode}))
365 f.add_entry(dx.Entry.acquisition_setup(comment={'value':acquisition_setup_comment}))
366
367 f.add_entry(dx.Entry.data(data={'value': data, 'units':'counts'}))
368 f.add_entry(dx.Entry.data(data_white={'value': data_white, 'units':'counts'}))
369 f.add_entry(dx.Entry.data(data_dark={'value': data_dark, 'units':'counts'}))
370 f.add_entry(dx.Entry.data(theta={'value': theta, 'units':'degrees'}))
371
372 f.close()
373
374 else:
375 print "Nothing to do ..."
376
377 if __name__ == "__main__":
378 main()
379