cansas_reader.py @ ffbe487

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload

Last change on this file since ffbe487 was ffbe487, checked in by Mathieu Doucet <doucetm@…>, 11 years ago
Update loader imports for latest move
Property mode set to `100644`
File size: 40.8 KB

Line
1	"""
2	CanSAS data reader
3	"""
4	############################################################################
5	#This software was developed by the University of Tennessee as part of the
6	#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
7	#project funded by the US National Science Foundation.
8	#If you use DANSE applications to do scientific research that leads to
9	#publication, we ask that you acknowledge the use of the software with the
10	#following sentence:
11	#This work benefited from DANSE software developed under NSF award DMR-0520547.
12	#copyright 2008,2009 University of Tennessee
13	#############################################################################
14
15	# Known issue: reader not compatible with multiple SASdata entries
16	# within a single SASentry. Will raise a runtime error.
17
18	#TODO: check that all vectors are written only if they have at
19	# least one non-empty value
20	#TODO: Writing only allows one SASentry per file.
21	# Would be best to allow multiple entries.
22	#TODO: Store error list
23	#TODO: Allow for additional meta data for each section
24	#TODO: Notes need to be implemented. They can be any XML
25	# structure in version 1.0
26	# Process notes have the same problem.
27	#TODO: Unit conversion is not complete (temperature units are missing)
28
29	import logging
30	import numpy
31	import os
32	import sys
33	from sans.dataloader.data_info import Data1D
34	from sans.dataloader.data_info import Collimation
35	from sans.dataloader.data_info import Detector
36	from sans.dataloader.data_info import Process
37	from sans.dataloader.data_info import Aperture
38	from lxml import etree
39	import xml.dom.minidom
40	_ZERO = 1e-16
41	HAS_CONVERTER = True
42	try:
43	from sans.data_util.nxsunit import Converter
44	except:
45	HAS_CONVERTER = False
46
47	CANSAS_NS = "cansas1d/1.0"
48	ALLOW_ALL = True
49
50
51	def write_node(doc, parent, name, value, attr={}):
52	"""
53	:param doc: document DOM
54	:param parent: parent node
55	:param name: tag of the element
56	:param value: value of the child text node
57	:param attr: attribute dictionary
58
59	:return: True if something was appended, otherwise False
60	"""
61	if value is not None:
62	node = doc.createElement(name)
63	node.appendChild(doc.createTextNode(str(value)))
64	for item in attr:
65	node.setAttribute(item, attr[item])
66	parent.appendChild(node)
67	return True
68	return False
69
70
71	def get_content(location, node):
72	"""
73	Get the first instance of the content of a xpath location.
74
75	:param location: xpath location
76	:param node: node to start at
77
78	:return: Element, or None
79	"""
80	nodes = node.xpath(location, namespaces={'ns': CANSAS_NS})
81
82	if len(nodes) > 0:
83	return nodes[0]
84	else:
85	return None
86
87
88	def get_float(location, node):
89	"""
90	Get the content of a node as a float
91
92	:param location: xpath location
93	:param node: node to start at
94	"""
95	nodes = node.xpath(location, namespaces={'ns': CANSAS_NS})
96
97	value = None
98	attr = {}
99	if len(nodes) > 0:
100	try:
101	value = float(nodes[0].text)
102	except:
103	# Could not pass, skip and return None
104	msg = "cansas_reader.get_float: could not "
105	msg += " convert '%s' to float" % nodes[0].text
106	logging.error(msg)
107	if nodes[0].get('unit') is not None:
108	attr['unit'] = nodes[0].get('unit')
109	return value, attr
110
111
112	class Reader:
113	"""
114	Class to load cansas 1D XML files
115
116	:Dependencies:
117	The CanSas reader requires PyXML 0.8.4 or later.
118	"""
119	## CanSAS version
120	version = '1.0'
121	## File type
122	type_name = "CanSAS 1D"
123	## Wildcards
124	type = ["CanSAS 1D files (.xml)\|.xml",
125	"CanSAS 1D AVE files (.AVEx)\|.AVEx",
126	"CanSAS 1D AVE files (.ABSx)\|.ABSx"]
127
128	## List of allowed extensions
129	ext = ['.xml', '.XML', '.avex', '.AVEx', '.absx', 'ABSx']
130
131	def __init__(self):
132	## List of errors
133	self.errors = []
134
135	def read(self, path):
136	"""
137	Load data file
138
139	:param path: file path
140
141	:return: Data1D object if a single SASentry was found,
142	or a list of Data1D objects if multiple entries were found,
143	or None of nothing was found
144
145	:raise RuntimeError: when the file can't be opened
146	:raise ValueError: when the length of the data vectors are inconsistent
147	"""
148	output = []
149	if os.path.isfile(path):
150	basename = os.path.basename(path)
151	root, extension = os.path.splitext(basename)
152	if ALLOW_ALL or extension.lower() in self.ext:
153	try:
154	tree = etree.parse(path, parser=etree.ETCompatXMLParser())
155	# Check the format version number
156	# Specifying the namespace will take care of the file
157	# format version
158	root = tree.getroot()
159
160	entry_list = root.xpath('/ns:SASroot/ns:SASentry',
161	namespaces={'ns': CANSAS_NS})
162
163	for entry in entry_list:
164	self.errors = []
165	sas_entry = self._parse_entry(entry)
166	sas_entry.filename = basename
167
168	# Store loading process information
169	sas_entry.errors = self.errors
170	sas_entry.meta_data['loader'] = self.type_name
171	output.append(sas_entry)
172	except:
173	raise RuntimeError, "%s cannot be read \n" % path
174	else:
175	raise RuntimeError, "%s is not a file" % path
176	# Return output consistent with the loader's api
177	if len(output) == 0:
178	#cannot return none when it cannot read
179	#return None
180	raise RuntimeError, "%s cannot be read \n" % path
181	elif len(output) == 1:
182	return output[0]
183	else:
184	return output
185
186	def _parse_entry(self, dom):
187	"""
188	Parse a SASentry
189
190	:param node: SASentry node
191
192	:return: Data1D object
193	"""
194	x = numpy.zeros(0)
195	y = numpy.zeros(0)
196
197	data_info = Data1D(x, y)
198
199	# Look up title
200	self._store_content('ns:Title', dom, 'title', data_info)
201
202	# Look up run number
203	nodes = dom.xpath('ns:Run', namespaces={'ns': CANSAS_NS})
204	for item in nodes:
205	if item.text is not None:
206	value = item.text.strip()
207	if len(value) > 0:
208	data_info.run.append(value)
209	if item.get('name') is not None:
210	data_info.run_name[value] = item.get('name')
211
212	# Look up instrument name
213	self._store_content('ns:SASinstrument/ns:name', dom, 'instrument',
214	data_info)
215
216	# Notes
217	note_list = dom.xpath('ns:SASnote', namespaces={'ns': CANSAS_NS})
218	for note in note_list:
219	try:
220	if note.text is not None:
221	note_value = note.text.strip()
222	if len(note_value) > 0:
223	data_info.notes.append(note_value)
224	except:
225	err_mess = "cansas_reader.read: error processing"
226	err_mess += " entry notes\n %s" % sys.exc_value
227	self.errors.append(err_mess)
228	logging.error(err_mess)
229
230	# Sample info ###################
231	entry = get_content('ns:SASsample', dom)
232	if entry is not None:
233	data_info.sample.name = entry.get('name')
234
235	self._store_content('ns:SASsample/ns:ID',
236	dom, 'ID', data_info.sample)
237	self._store_float('ns:SASsample/ns:thickness',
238	dom, 'thickness', data_info.sample)
239	self._store_float('ns:SASsample/ns:transmission',
240	dom, 'transmission', data_info.sample)
241	self._store_float('ns:SASsample/ns:temperature',
242	dom, 'temperature', data_info.sample)
243
244	nodes = dom.xpath('ns:SASsample/ns:details',
245	namespaces={'ns': CANSAS_NS})
246	for item in nodes:
247	try:
248	if item.text is not None:
249	detail_value = item.text.strip()
250	if len(detail_value) > 0:
251	data_info.sample.details.append(detail_value)
252	except:
253	err_mess = "cansas_reader.read: error processing "
254	err_mess += " sample details\n %s" % sys.exc_value
255	self.errors.append(err_mess)
256	logging.error(err_mess)
257
258	# Position (as a vector)
259	self._store_float('ns:SASsample/ns:position/ns:x',
260	dom, 'position.x', data_info.sample)
261	self._store_float('ns:SASsample/ns:position/ns:y',
262	dom, 'position.y', data_info.sample)
263	self._store_float('ns:SASsample/ns:position/ns:z',
264	dom, 'position.z', data_info.sample)
265
266	# Orientation (as a vector)
267	self._store_float('ns:SASsample/ns:orientation/ns:roll',
268	dom, 'orientation.x', data_info.sample)
269	self._store_float('ns:SASsample/ns:orientation/ns:pitch',
270	dom, 'orientation.y', data_info.sample)
271	self._store_float('ns:SASsample/ns:orientation/ns:yaw',
272	dom, 'orientation.z', data_info.sample)
273
274	# Source info ###################
275	entry = get_content('ns:SASinstrument/ns:SASsource', dom)
276	if entry is not None:
277	data_info.source.name = entry.get('name')
278
279	self._store_content('ns:SASinstrument/ns:SASsource/ns:radiation',
280	dom, 'radiation', data_info.source)
281	self._store_content('ns:SASinstrument/ns:SASsource/ns:beam_shape',
282	dom, 'beam_shape', data_info.source)
283	self._store_float('ns:SASinstrument/ns:SASsource/ns:wavelength',
284	dom, 'wavelength', data_info.source)
285	self._store_float('ns:SASinstrument/ns:SASsource/ns:wavelength_min',
286	dom, 'wavelength_min', data_info.source)
287	self._store_float('ns:SASinstrument/ns:SASsource/ns:wavelength_max',
288	dom, 'wavelength_max', data_info.source)
289	self._store_float('ns:SASinstrument/ns:SASsource/ns:wavelength_spread',
290	dom, 'wavelength_spread', data_info.source)
291
292	# Beam size (as a vector)
293	entry = get_content('ns:SASinstrument/ns:SASsource/ns:beam_size', dom)
294	if entry is not None:
295	data_info.source.beam_size_name = entry.get('name')
296
297	self._store_float('ns:SASinstrument/ns:SASsource/ns:beam_size/ns:x',
298	dom, 'beam_size.x', data_info.source)
299	self._store_float('ns:SASinstrument/ns:SASsource/ns:beam_size/ns:y',
300	dom, 'beam_size.y', data_info.source)
301	self._store_float('ns:SASinstrument/ns:SASsource/ns:beam_size/ns:z',
302	dom, 'beam_size.z', data_info.source)
303
304	# Collimation info ###################
305	nodes = dom.xpath('ns:SASinstrument/ns:SAScollimation',
306	namespaces={'ns': CANSAS_NS})
307	for item in nodes:
308	collim = Collimation()
309	if item.get('name') is not None:
310	collim.name = item.get('name')
311	self._store_float('ns:length', item, 'length', collim)
312
313	# Look for apertures
314	apert_list = item.xpath('ns:aperture', namespaces={'ns': CANSAS_NS})
315	for apert in apert_list:
316	aperture = Aperture()
317
318	# Get the name and type of the aperture
319	aperture.name = apert.get('name')
320	aperture.type = apert.get('type')
321
322	self._store_float('ns:distance', apert, 'distance', aperture)
323
324	entry = get_content('ns:size', apert)
325	if entry is not None:
326	aperture.size_name = entry.get('name')
327
328	self._store_float('ns:size/ns:x', apert, 'size.x', aperture)
329	self._store_float('ns:size/ns:y', apert, 'size.y', aperture)
330	self._store_float('ns:size/ns:z', apert, 'size.z', aperture)
331
332	collim.aperture.append(aperture)
333
334	data_info.collimation.append(collim)
335
336	# Detector info ######################
337	nodes = dom.xpath('ns:SASinstrument/ns:SASdetector',
338	namespaces={'ns': CANSAS_NS})
339	for item in nodes:
340
341	detector = Detector()
342
343	self._store_content('ns:name', item, 'name', detector)
344	self._store_float('ns:SDD', item, 'distance', detector)
345
346	# Detector offset (as a vector)
347	self._store_float('ns:offset/ns:x', item, 'offset.x', detector)
348	self._store_float('ns:offset/ns:y', item, 'offset.y', detector)
349	self._store_float('ns:offset/ns:z', item, 'offset.z', detector)
350
351	# Detector orientation (as a vector)
352	self._store_float('ns:orientation/ns:roll', item, 'orientation.x',
353	detector)
354	self._store_float('ns:orientation/ns:pitch', item, 'orientation.y',
355	detector)
356	self._store_float('ns:orientation/ns:yaw', item, 'orientation.z',
357	detector)
358
359	# Beam center (as a vector)
360	self._store_float('ns:beam_center/ns:x', item, 'beam_center.x',
361	detector)
362	self._store_float('ns:beam_center/ns:y', item, 'beam_center.y',
363	detector)
364	self._store_float('ns:beam_center/ns:z', item, 'beam_center.z',
365	detector)
366
367	# Pixel size (as a vector)
368	self._store_float('ns:pixel_size/ns:x', item, 'pixel_size.x',
369	detector)
370	self._store_float('ns:pixel_size/ns:y', item, 'pixel_size.y',
371	detector)
372	self._store_float('ns:pixel_size/ns:z', item, 'pixel_size.z',
373	detector)
374
375	self._store_float('ns:slit_length', item, 'slit_length', detector)
376
377	data_info.detector.append(detector)
378
379	# Processes info ######################
380	nodes = dom.xpath('ns:SASprocess', namespaces={'ns': CANSAS_NS})
381	for item in nodes:
382	process = Process()
383	self._store_content('ns:name', item, 'name', process)
384	self._store_content('ns:date', item, 'date', process)
385	self._store_content('ns:description', item, 'description', process)
386
387	term_list = item.xpath('ns:term', namespaces={'ns': CANSAS_NS})
388	for term in term_list:
389	try:
390	term_attr = {}
391	for attr in term.keys():
392	term_attr[attr] = term.get(attr).strip()
393	if term.text is not None:
394	term_attr['value'] = term.text.strip()
395	process.term.append(term_attr)
396	except:
397	err_mess = "cansas_reader.read: error processing "
398	err_mess += " process term\n %s" % sys.exc_value
399	self.errors.append(err_mess)
400	logging.error(err_mess)
401
402	note_list = item.xpath('ns:SASprocessnote',
403	namespaces={'ns': CANSAS_NS})
404	for note in note_list:
405	if note.text is not None:
406	process.notes.append(note.text.strip())
407
408	data_info.process.append(process)
409
410	# Data info ######################
411	nodes = dom.xpath('ns:SASdata', namespaces={'ns': CANSAS_NS})
412	if len(nodes) > 1:
413	msg = "CanSAS reader is not compatible with multiple"
414	msg += " SASdata entries"
415	raise RuntimeError, msg
416
417	nodes = dom.xpath('ns:SASdata/ns:Idata', namespaces={'ns': CANSAS_NS})
418
419	x = numpy.zeros(0)
420	y = numpy.zeros(0)
421	dx = numpy.zeros(0)
422	dy = numpy.zeros(0)
423	dxw = numpy.zeros(0)
424	dxl = numpy.zeros(0)
425
426	for item in nodes:
427	_x, attr = get_float('ns:Q', item)
428	_dx, attr_d = get_float('ns:Qdev', item)
429	_dxl, attr_l = get_float('ns:dQl', item)
430	_dxw, attr_w = get_float('ns:dQw', item)
431	if _dx == None:
432	_dx = 0.0
433	if _dxl == None:
434	_dxl = 0.0
435	if _dxw == None:
436	_dxw = 0.0
437
438	if 'unit' in attr and \
439	attr['unit'].lower() != data_info.x_unit.lower():
440	if HAS_CONVERTER == True:
441	try:
442	data_conv_q = Converter(attr['unit'])
443	_x = data_conv_q(_x, units=data_info.x_unit)
444	except:
445	msg = "CanSAS reader: could not convert "
446	msg += "Q unit [%s]; " % attr['unit'],
447	msg += "expecting [%s]\n %s" % (data_info.x_unit,
448	sys.exc_value)
449	raise ValueError, msg
450
451	else:
452	msg = "CanSAS reader: unrecognized Q unit [%s]; "\
453	% attr['unit']
454	msg += "expecting [%s]" % data_info.x_unit
455	raise ValueError, msg
456
457	# Error in Q
458	if 'unit' in attr_d and \
459	attr_d['unit'].lower() != data_info.x_unit.lower():
460	if HAS_CONVERTER == True:
461	try:
462	data_conv_q = Converter(attr_d['unit'])
463	_dx = data_conv_q(_dx, units=data_info.x_unit)
464	except:
465	msg = "CanSAS reader: could not convert dQ unit [%s]; "\
466	% attr['unit']
467	msg += " expecting "
468	msg += "[%s]\n %s" % (data_info.x_unit, sys.exc_value)
469	raise ValueError, msg
470
471	else:
472	msg = "CanSAS reader: unrecognized dQ unit [%s]; "\
473	% attr['unit']
474	msg += "expecting [%s]" % data_info.x_unit
475	raise ValueError, msg
476
477	# Slit length
478	if 'unit' in attr_l and \
479	attr_l['unit'].lower() != data_info.x_unit.lower():
480	if HAS_CONVERTER == True:
481	try:
482	data_conv_q = Converter(attr_l['unit'])
483	_dxl = data_conv_q(_dxl, units=data_info.x_unit)
484	except:
485	msg = "CanSAS reader: could not convert dQl unit [%s];"\
486	% attr['unit']
487	msg += " expecting [%s]\n %s" % (data_info.x_unit,
488	sys.exc_value)
489	raise ValueError, msg
490	else:
491	msg = "CanSAS reader: unrecognized dQl unit [%s];"\
492	% attr['unit']
493	msg += " expecting [%s]" % data_info.x_unit
494	raise ValueError, msg
495
496	# Slit width
497	if 'unit' in attr_w and \
498	attr_w['unit'].lower() != data_info.x_unit.lower():
499	if HAS_CONVERTER == True:
500	try:
501	data_conv_q = Converter(attr_w['unit'])
502	_dxw = data_conv_q(_dxw, units=data_info.x_unit)
503	except:
504	msg = "CanSAS reader: could not convert dQw unit [%s];"\
505	% attr['unit']
506	msg += " expecting [%s]\n %s" % (data_info.x_unit,
507	sys.exc_value)
508	raise ValueError, msg
509
510	else:
511	msg = "CanSAS reader: unrecognized dQw unit [%s];"\
512	% attr['unit']
513	msg += " expecting [%s]" % data_info.x_unit
514	raise ValueError, msg
515	_y, attr = get_float('ns:I', item)
516	_dy, attr_d = get_float('ns:Idev', item)
517	if _dy == None:
518	_dy = 0.0
519	if 'unit' in attr and \
520	attr['unit'].lower() != data_info.y_unit.lower():
521	if HAS_CONVERTER == True:
522	try:
523	data_conv_i = Converter(attr['unit'])
524	_y = data_conv_i(_y, units=data_info.y_unit)
525	except:
526	if attr['unit'].lower() == 'count':
527	pass
528	else:
529	msg = "CanSAS reader: could not"
530	msg += " convert I(q) unit [%s];" % str(attr['unit'])
531	msg += " expecting [%s]\n" % str(data_info.y_unit)
532	msg += " %s" % str(sys.exc_value)
533	raise ValueError, msg
534	else:
535	msg = "CanSAS reader: unrecognized I(q) unit [%s];"\
536	% attr['unit']
537	msg += " expecting [%s]" % data_info.y_unit
538	raise ValueError, msg
539
540	if 'unit' in attr_d and \
541	attr_d['unit'].lower() != data_info.y_unit.lower():
542	if HAS_CONVERTER == True:
543	try:
544	data_conv_i = Converter(attr_d['unit'])
545	_dy = data_conv_i(_dy, units=data_info.y_unit)
546	except:
547	if attr_d['unit'].lower() == 'count':
548	pass
549	else:
550	msg = "CanSAS reader: could not convert dI(q) unit "
551	msg += "[%s]; expecting [%s]\n %s" % (attr_d['unit'],
552	data_info.y_unit, sys.exc_value)
553	raise ValueError, msg
554	else:
555	msg = "CanSAS reader: unrecognized dI(q) unit [%s]; "\
556	% attr_d['unit']
557	msg += "expecting [%s]" % data_info.y_unit
558	raise ValueError, msg
559
560	if _x is not None and _y is not None:
561	x = numpy.append(x, _x)
562	y = numpy.append(y, _y)
563	dx = numpy.append(dx, _dx)
564	dy = numpy.append(dy, _dy)
565	dxl = numpy.append(dxl, _dxl)
566	dxw = numpy.append(dxw, _dxw)
567	# Zeros in dx, dy
568	if not numpy.all(dx == 0):
569	dx[dx == 0] = _ZERO
570	if not numpy.all(dy == 0):
571	dy[dy == 0] = _ZERO
572
573	data_info.x = x[x != 0]
574	data_info.y = y[x != 0]
575	data_info.dx = dx[x != 0]
576
577	data_info.dy = dy[x != 0]
578	data_info.dxl = dxl[x != 0]
579	data_info.dxw = dxw[x != 0]
580
581	data_conv_q = None
582	data_conv_i = None
583
584	if HAS_CONVERTER == True and data_info.x_unit != '1/A':
585	data_conv_q = Converter('1/A')
586	# Test it
587	data_conv_q(1.0, data_info.x_unit)
588
589	if HAS_CONVERTER == True and data_info.y_unit != '1/cm':
590	data_conv_i = Converter('1/cm')
591	# Test it
592	data_conv_i(1.0, data_info.y_unit)
593
594	if data_conv_q is not None:
595	data_info.xaxis("\\rm{Q}", data_info.x_unit)
596	else:
597	data_info.xaxis("\\rm{Q}", 'A^{-1}')
598	if data_conv_i is not None:
599	data_info.yaxis("\\rm{Intensity}", data_info.y_unit)
600	else:
601	data_info.yaxis("\\rm{Intensity}", "cm^{-1}")
602
603	return data_info
604
605	def _to_xml_doc(self, datainfo):
606	"""
607	Create an XML document to contain the content of a Data1D
608
609	:param datainfo: Data1D object
610	"""
611
612	if not issubclass(datainfo.__class__, Data1D):
613	raise RuntimeError, "The cansas writer expects a Data1D instance"
614
615	doc = xml.dom.minidom.Document()
616	main_node = doc.createElement("SASroot")
617	main_node.setAttribute("version", self.version)
618	main_node.setAttribute("xmlns", "cansas1d/%s" % self.version)
619	main_node.setAttribute("xmlns:xsi",
620	"http://www.w3.org/2001/XMLSchema-instance")
621	main_node.setAttribute("xsi:schemaLocation",
622	"cansas1d/%s http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" % self.version)
623
624	doc.appendChild(main_node)
625
626	entry_node = doc.createElement("SASentry")
627	main_node.appendChild(entry_node)
628
629	write_node(doc, entry_node, "Title", datainfo.title)
630	for item in datainfo.run:
631	runname = {}
632	if item in datainfo.run_name and \
633	len(str(datainfo.run_name[item])) > 1:
634	runname = {'name': datainfo.run_name[item]}
635	write_node(doc, entry_node, "Run", item, runname)
636
637	# Data info
638	node = doc.createElement("SASdata")
639	entry_node.appendChild(node)
640
641	for i in range(len(datainfo.x)):
642	pt = doc.createElement("Idata")
643	node.appendChild(pt)
644	write_node(doc, pt, "Q", datainfo.x[i], {'unit': datainfo.x_unit})
645	if len(datainfo.y) >= i:
646	write_node(doc, pt, "I", datainfo.y[i],
647	{'unit': datainfo.y_unit})
648	if datainfo.dx != None and len(datainfo.dx) >= i:
649	write_node(doc, pt, "Qdev", datainfo.dx[i],
650	{'unit': datainfo.x_unit})
651	if datainfo.dxl != None and len(datainfo.dxl) >= i:
652	write_node(doc, pt, "dQl", datainfo.dxl[i],
653	{'unit': datainfo.x_unit})
654	if datainfo.dxw != None and len(datainfo.dxw) >= i:
655	write_node(doc, pt, "dQw", datainfo.dxw[i],
656	{'unit': datainfo.x_unit})
657	if datainfo.dy != None and len(datainfo.dy) >= i:
658	write_node(doc, pt, "Idev", datainfo.dy[i],
659	{'unit': datainfo.y_unit})
660
661	# Sample info
662	sample = doc.createElement("SASsample")
663	if datainfo.sample.name is not None:
664	sample.setAttribute("name", str(datainfo.sample.name))
665	entry_node.appendChild(sample)
666	write_node(doc, sample, "ID", str(datainfo.sample.ID))
667	write_node(doc, sample, "thickness", datainfo.sample.thickness,
668	{"unit": datainfo.sample.thickness_unit})
669	write_node(doc, sample, "transmission", datainfo.sample.transmission)
670	write_node(doc, sample, "temperature", datainfo.sample.temperature,
671	{"unit": datainfo.sample.temperature_unit})
672
673	for item in datainfo.sample.details:
674	write_node(doc, sample, "details", item)
675
676	pos = doc.createElement("position")
677	written = write_node(doc, pos, "x", datainfo.sample.position.x,
678	{"unit": datainfo.sample.position_unit})
679	written = written \| write_node(doc, pos, "y",
680	datainfo.sample.position.y,
681	{"unit": datainfo.sample.position_unit})
682	written = written \| write_node(doc, pos, "z",
683	datainfo.sample.position.z,
684	{"unit": datainfo.sample.position_unit})
685	if written == True:
686	sample.appendChild(pos)
687
688	ori = doc.createElement("orientation")
689	written = write_node(doc, ori, "roll",
690	datainfo.sample.orientation.x,
691	{"unit": datainfo.sample.orientation_unit})
692	written = written \| write_node(doc, ori, "pitch",
693	datainfo.sample.orientation.y,
694	{"unit": datainfo.sample.orientation_unit})
695	written = written \| write_node(doc, ori, "yaw",
696	datainfo.sample.orientation.z,
697	{"unit": datainfo.sample.orientation_unit})
698	if written == True:
699	sample.appendChild(ori)
700
701	# Instrument info
702	instr = doc.createElement("SASinstrument")
703	entry_node.appendChild(instr)
704
705	write_node(doc, instr, "name", datainfo.instrument)
706
707	# Source
708	source = doc.createElement("SASsource")
709	if datainfo.source.name is not None:
710	source.setAttribute("name", str(datainfo.source.name))
711	instr.appendChild(source)
712
713	write_node(doc, source, "radiation", datainfo.source.radiation)
714	write_node(doc, source, "beam_shape", datainfo.source.beam_shape)
715	size = doc.createElement("beam_size")
716	if datainfo.source.beam_size_name is not None:
717	size.setAttribute("name", str(datainfo.source.beam_size_name))
718	written = write_node(doc, size, "x", datainfo.source.beam_size.x,
719	{"unit": datainfo.source.beam_size_unit})
720	written = written \| write_node(doc, size, "y",
721	datainfo.source.beam_size.y,
722	{"unit": datainfo.source.beam_size_unit})
723	written = written \| write_node(doc, size, "z",
724	datainfo.source.beam_size.z,
725	{"unit": datainfo.source.beam_size_unit})
726	if written == True:
727	source.appendChild(size)
728
729	write_node(doc, source, "wavelength",
730	datainfo.source.wavelength,
731	{"unit": datainfo.source.wavelength_unit})
732	write_node(doc, source, "wavelength_min",
733	datainfo.source.wavelength_min,
734	{"unit": datainfo.source.wavelength_min_unit})
735	write_node(doc, source, "wavelength_max",
736	datainfo.source.wavelength_max,
737	{"unit": datainfo.source.wavelength_max_unit})
738	write_node(doc, source, "wavelength_spread",
739	datainfo.source.wavelength_spread,
740	{"unit": datainfo.source.wavelength_spread_unit})
741
742	# Collimation
743	for item in datainfo.collimation:
744	coll = doc.createElement("SAScollimation")
745	if item.name is not None:
746	coll.setAttribute("name", str(item.name))
747	instr.appendChild(coll)
748
749	write_node(doc, coll, "length", item.length,
750	{"unit": item.length_unit})
751
752	for apert in item.aperture:
753	ap = doc.createElement("aperture")
754	if apert.name is not None:
755	ap.setAttribute("name", str(apert.name))
756	if apert.type is not None:
757	ap.setAttribute("type", str(apert.type))
758	coll.appendChild(ap)
759
760	write_node(doc, ap, "distance", apert.distance,
761	{"unit": apert.distance_unit})
762
763	size = doc.createElement("size")
764	if apert.size_name is not None:
765	size.setAttribute("name", str(apert.size_name))
766	written = write_node(doc, size, "x", apert.size.x,
767	{"unit": apert.size_unit})
768	written = written \| write_node(doc, size, "y", apert.size.y,
769	{"unit": apert.size_unit})
770	written = written \| write_node(doc, size, "z", apert.size.z,
771	{"unit": apert.size_unit})
772	if written == True:
773	ap.appendChild(size)
774
775	# Detectors
776	for item in datainfo.detector:
777	det = doc.createElement("SASdetector")
778	written = write_node(doc, det, "name", item.name)
779	written = written \| write_node(doc, det, "SDD", item.distance,
780	{"unit": item.distance_unit})
781	written = written \| write_node(doc, det, "slit_length",
782	item.slit_length,
783	{"unit": item.slit_length_unit})
784	if written == True:
785	instr.appendChild(det)
786
787	off = doc.createElement("offset")
788	written = write_node(doc, off, "x", item.offset.x,
789	{"unit": item.offset_unit})
790	written = written \| write_node(doc, off, "y", item.offset.y,
791	{"unit": item.offset_unit})
792	written = written \| write_node(doc, off, "z", item.offset.z,
793	{"unit": item.offset_unit})
794	if written == True:
795	det.appendChild(off)
796
797	center = doc.createElement("beam_center")
798	written = write_node(doc, center, "x", item.beam_center.x,
799	{"unit": item.beam_center_unit})
800	written = written \| write_node(doc, center, "y",
801	item.beam_center.y,
802	{"unit": item.beam_center_unit})
803	written = written \| write_node(doc, center, "z",
804	item.beam_center.z,
805	{"unit": item.beam_center_unit})
806	if written == True:
807	det.appendChild(center)
808
809	pix = doc.createElement("pixel_size")
810	written = write_node(doc, pix, "x", item.pixel_size.x,
811	{"unit": item.pixel_size_unit})
812	written = written \| write_node(doc, pix, "y", item.pixel_size.y,
813	{"unit": item.pixel_size_unit})
814	written = written \| write_node(doc, pix, "z", item.pixel_size.z,
815	{"unit": item.pixel_size_unit})
816	if written == True:
817	det.appendChild(pix)
818
819	ori = doc.createElement("orientation")
820	written = write_node(doc, ori, "roll", item.orientation.x,
821	{"unit": item.orientation_unit})
822	written = written \| write_node(doc, ori, "pitch",
823	item.orientation.y,
824	{"unit": item.orientation_unit})
825	written = written \| write_node(doc, ori, "yaw",
826	item.orientation.z,
827	{"unit": item.orientation_unit})
828	if written == True:
829	det.appendChild(ori)
830
831	# Processes info
832	for item in datainfo.process:
833	node = doc.createElement("SASprocess")
834	entry_node.appendChild(node)
835
836	write_node(doc, node, "name", item.name)
837	write_node(doc, node, "date", item.date)
838	write_node(doc, node, "description", item.description)
839	for term in item.term:
840	value = term['value']
841	del term['value']
842	write_node(doc, node, "term", value, term)
843	for note in item.notes:
844	write_node(doc, node, "SASprocessnote", note)
845
846	# Return the document, and the SASentry node associated with
847	# the data we just wrote
848	return doc, entry_node
849
850	def write(self, filename, datainfo):
851	"""
852	Write the content of a Data1D as a CanSAS XML file
853
854	:param filename: name of the file to write
855	:param datainfo: Data1D object
856	"""
857	# Create XML document
858	doc, _ = self._to_xml_doc(datainfo)
859	# Write the file
860	fd = open(filename, 'w')
861	fd.write(doc.toprettyxml())
862	fd.close()
863
864	def _store_float(self, location, node, variable, storage, optional=True):
865	"""
866	Get the content of a xpath location and store
867	the result. Check that the units are compatible
868	with the destination. The value is expected to
869	be a float.
870
871	The xpath location might or might not exist.
872	If it does not exist, nothing is done
873
874	:param location: xpath location to fetch
875	:param node: node to read the data from
876	:param variable: name of the data member to store it in [string]
877	:param storage: data object that has the 'variable' data member
878	:param optional: if True, no exception will be raised
879	if unit conversion can't be done
880
881	:raise ValueError: raised when the units are not recognized
882	"""
883	entry = get_content(location, node)
884	try:
885	value = float(entry.text)
886	except:
887	value = None
888
889	if value is not None:
890	# If the entry has units, check to see that they are
891	# compatible with what we currently have in the data object
892	units = entry.get('unit')
893	if units is not None:
894	toks = variable.split('.')
895	local_unit = None
896	exec "local_unit = storage.%s_unit" % toks[0]
897	if local_unit != None and units.lower() != local_unit.lower():
898	if HAS_CONVERTER == True:
899	try:
900	conv = Converter(units)
901	exec "storage.%s = %g" % (variable,
902	conv(value, units=local_unit))
903	except:
904	err_mess = "CanSAS reader: could not convert"
905	err_mess += " %s unit [%s]; expecting [%s]\n %s" \
906	% (variable, units, local_unit, sys.exc_value)
907	self.errors.append(err_mess)
908	if optional:
909	logging.info(err_mess)
910	else:
911	raise ValueError, err_mess
912	else:
913	err_mess = "CanSAS reader: unrecognized %s unit [%s];"\
914	% (variable, units)
915	err_mess += " expecting [%s]" % local_unit
916	self.errors.append(err_mess)
917	if optional:
918	logging.info(err_mess)
919	else:
920	raise ValueError, err_mess
921	else:
922	exec "storage.%s = value" % variable
923	else:
924	exec "storage.%s = value" % variable
925
926	def _store_content(self, location, node, variable, storage):
927	"""
928	Get the content of a xpath location and store
929	the result. The value is treated as a string.
930
931	The xpath location might or might not exist.
932	If it does not exist, nothing is done
933
934	:param location: xpath location to fetch
935	:param node: node to read the data from
936	:param variable: name of the data member to store it in [string]
937	:param storage: data object that has the 'variable' data member
938
939	:return: return a list of errors
940	"""
941	entry = get_content(location, node)
942	if entry is not None and entry.text is not None:
943	exec "storage.%s = entry.text.strip()" % variable

Note: See TracBrowser for help on using the repository browser.

SasView

source: sasview/src/sans/dataloader/readers/cansas_reader.py @ ffbe487

Download in other formats: