/usr/lib/python2.7/dist-packages/pyFAI/io.py is in pyfai 0.10.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 | # !/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Project: Fast Azimuthal Integration
# https://github.com/kif/
#
#
# Copyright (C) European Synchrotron Radiation Facility, Grenoble, France
#
# Principal author: Jérôme Kieffer (Jerome.Kieffer@ESRF.eu)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
__author__ = "Jerome Kieffer"
__contact__ = "Jerome.Kieffer@ESRF.eu"
__license__ = "GPLv3+"
__copyright__ = "European Synchrotron Radiation Facility, Grenoble, France"
__date__ = "24/09/2014"
__status__ = "beta"
__docformat__ = 'restructuredtext'
__doc__ = """
Module for "high-performance" writing in either 1D with Ascii , or 2D with FabIO
or even nD with n varying from 2 to 4 using HDF5
Stand-alone module which tries to offer interface to HDF5 via H5Py and
capabilities to write EDF or other formats using fabio.
Can be imported without h5py but then limited to fabio & ascii formats.
TODO:
* add monitor to HDF5
"""
import fabio
import json
import logging
import numpy
import os
import posixpath
import sys
import threading
import time
import types
from . import units
from . import version
logger = logging.getLogger("pyFAI.io")
try:
import h5py
except ImportError as error:
h5py = None
logger.error("h5py module missing")
else:
try:
h5py._errors.silence_errors()
except AttributeError: #old h5py
pass
def get_isotime(forceTime=None):
"""
@param forceTime: enforce a given time (current by default)
@type forceTime: float
@return: the current time as an ISO8601 string
@rtype: string
"""
if forceTime is None:
forceTime = time.time()
localtime = time.localtime(forceTime)
gmtime = time.gmtime(forceTime)
tz_h = localtime.tm_hour - gmtime.tm_hour
tz_m = localtime.tm_min - gmtime.tm_min
return "%s%+03i:%02i" % (time.strftime("%Y-%m-%dT%H:%M:%S", localtime), tz_h, tz_m)
def from_isotime(text, use_tz=False):
"""
@param text: string representing the time is iso format
"""
text = str(text)
base = text[:19]
if use_tz and len(text) == 25:
sgn = 1 if text[:19] == "+" else -1
tz = 60 * (60 * int(text[20:22]) + int(text[23:25])) * sgn
else:
tz = 0
return time.mktime(time.strptime(base, "%Y-%m-%dT%H:%M:%S")) + tz
def is_hdf5(filename):
"""
Check if a file is actually a HDF5 file
@param filename: this file has better to exist
"""
signature = [137, 72, 68, 70, 13, 10, 26, 10]
if not os.path.exists(filename):
raise IOError("No such file %s" % (filename))
with open(filename, "rb") as f:
sig = [ord(i) for i in f.read(8)]
return sig == signature
class Writer(object):
"""
Abstract class for writers.
"""
CONFIG_ITEMS = ["filename", "dirname", "extension", "subdir", "hpath"]
def __init__(self, filename=None, extension=None):
"""
"""
self.filename = filename
if os.path.exists(filename):
logger.warning("Destination file %s exists" % filename)
self._sem = threading.Semaphore()
self.dirname = None
self.subdir = None
self.extension = extension
self.fai_cfg = {}
self.lima_cfg = {}
def __repr__(self):
return "Generic writer on file %s" % (self.filename)
def init(self, fai_cfg=None, lima_cfg=None):
"""
Creates the directory that will host the output file(s)
@param fai_cfg: configuration for worker
@param lima_cfg: configuration for acquisition
"""
with self._sem:
if fai_cfg is not None:
self.fai_cfg = fai_cfg
if lima_cfg is not None:
self.lima_cfg = lima_cfg
if self.filename is not None:
dirname = os.path.dirname(self.filename)
if dirname and not os.path.exists(dirname):
try:
os.makedirs(dirname)
except Exception as err:
logger.info("Problem while creating directory %s: %s" % (dirname, err))
def flush(self, *arg, **kwarg):
"""
To be implemented
"""
pass
def write(self, data):
"""
To be implemented
"""
pass
def setJsonConfig(self, json_config=None):
"""
Sets the JSON configuration
"""
if type(json_config) in types.StringTypes:
if os.path.isfile(json_config):
config = json.load(open(json_config, "r"))
else:
config = json.loads(json_config)
else:
config = dict(json_config)
for k, v in config.items():
if k in self.CONFIG_ITEMS:
self.__setattr__(k, v)
class HDF5Writer(Writer):
"""
Class allowing to write HDF5 Files.
"""
CONFIG = "pyFAI"
DATASET_NAME = "data"
def __init__(self, filename, hpath="data", fast_scan_width=None):
"""
Constructor of an HDF5 writer:
@param filename: name of the file
@param hpath: name of the group: it will contain data (2-4D dataset), [tth|q|r] and pyFAI, group containing the configuration
@param fast_scan_width: set it to define the width of
"""
Writer.__init__(self, filename)
self.hpath = hpath
self.fast_scan_width = None
if fast_scan_width is not None:
try:
self.fast_scan_width = int(fast_scan_width)
except:
pass
self.hdf5 = None
self.group = None
self.dataset = None
self.pyFAI_grp = None
self.radial_values = None
self.azimuthal_values = None
self.error_values = None
self.has_radial_values = False
self.has_azimuthal_values = False
self.has_error_values = False
self.chunk = None
self.shape = None
self.ndim = None
def __repr__(self):
return "HDF5 writer on file %s:%s %sinitialized" % (self.filename, self.hpath, "" if self._initialized else "un")
def init(self, fai_cfg=None, lima_cfg=None):
"""
Initializes the HDF5 file for writing
@param fai_cfg: the configuration of the worker as a dictionary
"""
logger.debug("in init")
Writer.init(self, fai_cfg, lima_cfg)
with self._sem:
#TODO: this is Debug statement
open("fai_cfg.json", "w").write(json.dumps(self.fai_cfg, indent=4))
open("lima_cfg.json", "w").write(json.dumps(self.lima_cfg, indent=4))
self.fai_cfg["nbpt_rad"] = self.fai_cfg.get("nbpt_rad", 1000)
if h5py:
try:
self.hdf5 = h5py.File(self.filename)
except IOError: #typically a corrupted HDF5 file !
os.unlink(self.filename)
self.hdf5 = h5py.File(self.filename)
else:
logger.error("No h5py library, no chance")
raise RuntimeError("No h5py library, no chance")
self.group = self.hdf5.require_group(self.hpath)
self.group.attrs["NX_class"] = "NXentry"
self.pyFAI_grp = self.hdf5.require_group(posixpath.join(self.hpath, self.CONFIG))
self.pyFAI_grp.attrs["desc"] = "PyFAI worker configuration"
for key, value in self.fai_cfg.items():
if value is None:
continue
try:
self.pyFAI_grp[key] = value
except:
print("Unable to set %s: %s" % (key, value))
self.close()
sys.exit(1)
rad_name, rad_unit = str(self.fai_cfg.get("unit", "2th_deg")).split("_", 1)
self.radial_values = self.group.require_dataset(rad_name, (self.fai_cfg["nbpt_rad"],), numpy.float32)
if self.fai_cfg.get("nbpt_azim", 0) > 1:
self.azimuthal_values = self.group.require_dataset("chi", (self.fai_cfg["nbpt_azim"],), numpy.float32)
self.azimuthal_values.attrs["unit"] = "deg"
self.azimuthal_values.attrs["interpretation"] = "scalar"
self.azimuthal_values.attrs["long name"] = "Azimuthal angle"
self.radial_values.attrs["unit"] = rad_unit
self.radial_values.attrs["interpretation"] = "scalar"
self.radial_values.attrs["long name"] = "diffraction radial direction"
if self.fast_scan_width:
self.fast_motor = self.group.require_dataset("fast", (self.fast_scan_width,) , numpy.float32)
self.fast_motor.attrs["long name"] = "Fast motor position"
self.fast_motor.attrs["interpretation"] = "scalar"
self.fast_motor.attrs["axis"] = "1"
self.radial_values.attrs["axis"] = "2"
if self.azimuthal_values is not None:
chunk = 1, self.fast_scan_width, self.fai_cfg["nbpt_azim"], self.fai_cfg["nbpt_rad"]
self.ndim = 4
self.azimuthal_values.attrs["axis"] = "3"
else:
chunk = 1, self.fast_scan_width, self.fai_cfg["nbpt_rad"]
self.ndim = 3
else:
self.radial_values.attrs["axis"] = "1"
if self.azimuthal_values is not None:
chunk = 1, self.fai_cfg["nbpt_azim"], self.fai_cfg["nbpt_rad"]
self.ndim = 3
self.azimuthal_values.attrs["axis"] = "2"
else:
chunk = 1, self.fai_cfg["nbpt_rad"]
self.ndim = 2
if self.DATASET_NAME in self.group:
del self.group[self.DATASET_NAME]
shape = list(chunk)
if self.lima_cfg.get("number_of_frames", 0) > 0:
if self.fast_scan_width is not None:
size[0] = 1 + self.lima_cfg["number_of_frames"] // self.fast_scan_width
else:
size[0] = self.lima_cfg["number_of_frames"]
dtype = self.lima_cfg.get("dtype") or self.fai_cfg.get("dtype")
if dtype is None:
dtype = numpy.float32
else:
dtype = numpy.dtype(dtype)
self.dataset = self.group.require_dataset(self.DATASET_NAME, shape, dtype=dtype, chunks=chunk,
maxshape=(None,) + chunk[1:])
if self.fai_cfg.get("nbpt_azim", 0) > 1:
self.dataset.attrs["interpretation"] = "image"
else:
self.dataset.attrs["interpretation"] = "spectrum"
self.dataset.attrs["signal"] = "1"
self.chunk = chunk
self.shape = chunk
name = "Mapping " if self.fast_scan_width else "Scanning "
name += "2D" if self.fai_cfg.get("nbpt_azim", 0) > 1 else "1D"
name += " experiment"
self.group["title"] = name
self.group["program"] = "PyFAI"
self.group["start_time"] = get_isotime()
def flush(self, radial=None, azimuthal=None):
"""
Update some data like axis units and so on.
@param radial: position in radial direction
@param azimuthal: position in azimuthal direction
"""
with self._sem:
if not self.hdf5:
raise RuntimeError('No opened file')
if radial is not None:
if radial.shape == self.radial_values.shape:
self.radial_values[:] = radial
else:
logger.warning("Unable to assign radial axis position")
if azimuthal is not None:
if azimuthal.shape == self.azimuthal_values.shape:
self.azimuthal_values[:] = azimuthal
else:
logger.warning("Unable to assign azimuthal axis position")
self.hdf5.flush()
def close(self):
logger.debug("In close")
if self.hdf5:
self.flush()
with self._sem:
self.hdf5.close()
self.hdf5 = None
def write(self, data, index=0):
"""
Minimalistic method to limit the overhead.
@param data: array with intensities or tuple (2th,I) or (I,2th,chi)
"""
logger.debug("In write, index %s" % index)
radial = None
azimuthal = None
error = None
if isinstance(data, numpy.ndarray):
I = data
elif isinstance(data, (list, tuple)):
n = len(data)
if n == 2:
radial, I = data
elif n == 3:
if data[0].ndim == 2:
I, radial, azimuthal = data
else:
radial, I, error = data
with self._sem:
if self.dataset is None:
logger.warning("Writer not initialized !")
return
if self.fast_scan_width:
index0, index1 = (index // self.fast_scan_width, index % self.fast_scan_width)
if index0 >= self.dataset.shape[0]:
self.dataset.resize(index0 + 1, axis=0)
self.dataset[index0, index1] = data
else:
if index >= self.dataset.shape[0]:
self.dataset.resize(index + 1, axis=0)
self.dataset[index] = I
if (not self.has_azimuthal_values) and \
(azimuthal is not None) and \
self.azimuthal_values is not None:
self.azimuthal_values[:] = azimuthal
if (not self.has_azimuthal_values) and \
(azimuthal is not None) and \
self.azimuthal_values is not None:
self.azimuthal_values[:] = azimuthal
self.has_azimuthal_values = True
if (not self.has_radial_values) and \
(radial is not None) and \
self.radial_values is not None:
self.radial_values[:] = radial
self.has_radial_values = True
class AsciiWriter(Writer):
"""
Ascii file writer (.xy or .dat)
"""
def __init__(self, filename=None, prefix="fai_", extension=".dat"):
"""
"""
Writer.__init__(self, filename, extension)
self.header = None
if os.path.isdir(filename):
self.directory = filename
else:
self.directory = os.path.dirname(filename)
self.prefix = prefix
self.index_format = "%04i"
self.start_index = 0
def __repr__(self):
return "Ascii writer on file %s" % (self.filename)
def init(self, fai_cfg=None, lima_cfg=None):
"""
Creates the directory that will host the output file(s)
"""
Writer.init(self, fai_cfg, lima_cfg)
with self._sem:
headerLst = ["", "== Detector =="]
if "detector" in self.fai_cfg:
headerLst.append("Detector: %s" % self.fai_cfg["detector"])
if "splineFile" in self.fai_cfg:
headerLst.append("SplineFile: %s" % self.fai_cfg["splineFile"])
if "pixel1" in self.fai_cfg:
headerLst.append("PixelSize: %.3e, %.3e m" % (self.fai_cfg["pixel1"], self.fai_cfg["pixel2"]))
if "mask_file" in self.fai_cfg:
headerLst.append("MaskFile: %s" % (self.fai_cfg["mask_file"]))
headerLst.append("== pyFAI calibration ==")
if "poni1" in self.fai_cfg:
headerLst.append("PONI: %.3e, %.3e m" % (self.fai_cfg["poni1"], self.fai_cfg["poni2"]))
if "dist" in self.fai_cfg:
headerLst.append("Distance Sample to Detector: %s m" % self.fai_cfg["dist"])
if "rot1" in self.fai_cfg:
headerLst.append("Rotations: %.6f %.6f %.6f rad" % (self.fai_cfg["rot1"], self.fai_cfg["rot2"], self.fai_cfg["rot3"]))
if "wavelength" in self.fai_cfg:
headerLst.append("Wavelength: %s" % self.fai_cfg["wavelength"])
if "dark_current" in self.fai_cfg:
headerLst.append("Dark current: %s" % self.fai_cfg["dark_current"])
if "flat_field" in self.fai_cfg:
headerLst.append("Flat field: %s" % self.fai_cfg["flat_field"])
if "polarization_factor" in self.fai_cfg:
headerLst.append("Polarization factor: %s" % self.fai_cfg["polarization_factor"])
headerLst.append("")
if "do_poisson" in self.fai_cfg:
headerLst.append("%14s %14s %s" % (self.fai_cfg["unit"], "I", "sigma"))
else:
headerLst.append("%14s %14s" % (self.fai_cfg["unit"], "I"))
# headerLst.append("")
self.header = os.linesep.join([""] + ["# " + i for i in headerLst] + [""])
self.prefix = lima_cfg.get("prefix", self.prefix)
self.index_format = lima_cfg.get("index_format", self.index_format)
self.start_index = lima_cfg.get("start_index", self.start_index)
if not self.subdir:
self.directory = lima_cfg.get("directory", self.directory)
elif self.subdir.startswith("/"):
self.directory = self.subdir
else:
self.directory = os.path.join(lima_cfg.get("directory", self.directory), self.subdir)
if not os.path.exists(self.directory):
logger.warning("Output directory: %s does not exist,creating it" % self.directory)
try:
os.makedirs(self.directory)
except Exception as error:
logger.info("Problem while creating directory %s: %s" % (self.directory, error))
def write(self, data, index=0):
filename = os.path.join(self.directory, self.prefix + (self.index_format % (self.start_index + index)) + self.extension)
if filename:
with open(filename, "w") as f:
f.write("# Processing time: %s%s" % (get_isotime(), self.header))
numpy.savetxt(f, data)
class FabioWriter(Writer):
"""
Image file writer based on FabIO
TODO !!!
"""
def __init__(self, filename=None):
"""
"""
Writer.__init__(self, filename)
self.header = None
self.directory = None
self.prefix = None
self.index_format = "%04i"
self.start_index = 0
self.fabio_class = None
def __repr__(self):
return "Image writer on file %s" % (self.filename)
def init(self, fai_cfg=None, lima_cfg=None):
"""
Creates the directory that will host the output file(s)
"""
Writer.init(self, fai_cfg, lima_cfg)
with self._sem:
# dim1_unit = units.to_unit(fai_cfg.get("unit", "r_mm"))
header_keys = ["dist", "poni1", "poni2", "rot1", "rot2", "rot3",
# "chi_min", "chi_max",
# dim1_unit.REPR + "_min",
# dim1_unit.REPR + "_max",
# "pixelX", "pixelY",
# "dark", "flat", "polarization_factor", "normalization_factor"
]
header = {"dist": str(fai_cfg.get("dist")),
"poni1": str(fai_cfg.get("poni1")),
"poni2": str(fai_cfg.get("poni2")),
"rot1": str(fai_cfg.get("rot1")),
"rot2": str(fai_cfg.get("rot2")),
"rot3": str(fai_cfg.get("rot3")),
# "chi_min": str(fai_cfg.get("chi_min")),
# "chi_max": str(fai_cfg.get("chi_max")),
# dim1_unit.REPR + "_min": str(fai_cfg.get("dist")),
# dim1_unit.REPR + "_max": str(fai_cfg.get("dist")),
# "pixelX": str(fai_cfg.get("dist")), # this is not a bug ... most people expect dim1 to be X
# "pixelY": str(fai_cfg.get("dist")), # this is not a bug ... most people expect dim2 to be Y
# "polarization_factor": str(fai_cfg.get("dist")),
# "normalization_factor":str(fai_cfg.get("dist")),
}
# if self.splineFile:
# header["spline"] = str(self.splineFile)
#
# if dark is not None:
# if self.darkfiles:
# header["dark"] = self.darkfiles
# else:
# header["dark"] = 'unknown dark applied'
# if flat is not None:
# if self.flatfiles:
# header["flat"] = self.flatfiles
# else:
# header["flat"] = 'unknown flat applied'
# f2d = self.getFit2D()
# for key in f2d:
# header["key"] = f2d[key]
self.prefix = fai_cfg.get("prefix", "")
self.index_format = fai_cfg.get("index_format", "%04i")
self.start_index = fai_cfg.get("start_index", 0)
if not self.subdir:
self.directory = directory
elif self.subdir.startswith("/"):
self.directory = self.subdir
else:
self.directory = os.path.join(directory, self.subdir)
if not os.path.exists(self.directory):
logger.warning("Output directory: %s does not exist,creating it" % self.directory)
try:
os.makedirs(self.directory)
except Exception as error:
logger.info("Problem while creating directory %s: %s" % (self.directory, error))
def write(self, data, index=0):
filename = os.path.join(self.directory, self.prefix + (self.index_format % (self.start_index + index)) + self.extension)
if filename:
with open(filename, "w") as f:
f.write("# Processing time: %s%s" % (get_isotime(), self.header))
numpy.savetxt(f, data)
class Nexus(object):
"""
Writer class to handle Nexus/HDF5 data
Manages:
entry
pyFAI-subentry
detector
#TODO: make it thread-safe !!!
"""
def __init__(self, filename, mode="r"):
"""
Constructor
@param filename: name of the hdf5 file containing the nexus
@param mode: can be r or a
"""
self.filename = os.path.abspath(filename)
self.mode = mode
if not h5py:
logger.error("h5py module missing: NeXus not supported")
raise RuntimeError("H5py module is missing")
if os.path.exists(self.filename) and self.mode == "r":
self.h5 = h5py.File(self.filename, mode=self.mode)
else:
self.h5 = h5py.File(self.filename)
self.to_close = []
def close(self):
"""
close the filename and update all entries
"""
end_time = get_isotime()
for entry in self.to_close:
entry["end_time"] = end_time
self.h5.close()
def get_entry(self, name):
"""
Retrieves an entry from its name
@param name: name of the entry to retrieve
@return: HDF5 group of NXclass == NXentry
"""
for grp_name in self.h5:
if grp_name == name:
grp = self.h5[grp_name]
if isinstance(grp, h5py.Group) and \
"start_time" in grp and \
"NX_class" in grp.attrs and \
grp.attrs["NX_class"] == "NXentry" :
return grp
def get_entries(self):
"""
retrieves all entry sorted the latest first.
@return: list of HDF5 groups
"""
entries = [(grp, from_isotime(self.h5[grp + "/start_time"].value))
for grp in self.h5
if (isinstance(self.h5[grp], h5py.Group) and \
"start_time" in self.h5[grp] and \
"NX_class" in self.h5[grp].attrs and \
self.h5[grp].attrs["NX_class"] == "NXentry")]
entries.sort(cmp=lambda a, b: 1 if a[1] < b[1] else -1) #sort entries in decreasing time
return [self.h5[i[0]] for i in entries]
def find_detector(self, all=False):
"""
Tries to find a detector within a NeXus file, takes the first compatible detector
@param all: return all detectors found as a list
"""
result = []
for entry in self.get_entries():
for instrument in self.get_class(entry, "NXsubentry"):
for detector in self.get_class(instrument, "NXdetector"):
if all:
result.append(detector)
else:
return detector
return result
def new_entry(self, entry="entry"):
"""
Create a new entry
@param entry: name of the entry
@return: the corresponding HDF5 group
"""
nb_entries = len(self.get_entries())
entry_grp = self.h5.require_group("%s_%04i" % (entry, nb_entries))
entry_grp.attrs["NX_class"] = "NXentry"
entry_grp["start_time"] = numpy.string_(get_isotime())
entry_grp["title"] = numpy.string_("description of experiment")
entry_grp["program_name"] = numpy.string_("pyFAI")
self.to_close.append(entry_grp)
return entry_grp
def new_instrument(self, entry="entry", instrument_name="id00",):
"""
Create an instrument in an entry or create both the entry and the instrument if
"""
if not isinstance(entry, h5py.Group):
entry = self.new_entry(entry)
return self.new_class(entry, instrument_name, "NXinstrument")
# howto external link
#myfile['ext link'] = h5py.ExternalLink("otherfile.hdf5", "/path/to/resource")
def new_class(self, grp, name, class_type="NXcollection"):
"""
create a new sub-group with type class_type
@param grp: parent group
@param name: name of the sub-group
@param class_type: NeXus class name
@return: subgroup created
"""
sub = grp.require_group(name)
sub.attrs["NX_class"] = class_type
return sub
def new_detector(self, name="detector", entry="entry", subentry="pyFAI"):
"""
Create a new entry/pyFAI/Detector
@param detector: name of the detector
@param entry: name of the entry
@param subentry: all pyFAI description of detectors should be in a pyFAI sub-entry
"""
entry_grp = self.new_entry(entry)
pyFAI_grp = self.new_class(entry_grp, subentry, "NXsubentry")
pyFAI_grp["definition_local"] = numpy.string_("pyFAI")
pyFAI_grp["definition_local"].attrs["version"] = version
det_grp = self.new_class(pyFAI_grp, name, "NXdetector")
return det_grp
def get_class(self, grp, class_type="NXcollection"):
"""
return all sub-groups of the given type within a group
@param grp: HDF5 group
@param class_type: name of the NeXus class
"""
coll = [grp[name] for name in grp
if (isinstance(grp[name], h5py.Group) and \
"NX_class" in grp[name].attrs and \
grp[name].attrs["NX_class"] == class_type)]
return coll
def get_data(self, grp, class_type="NXdata"):
"""
return all dataset of the the NeXus class NXdata
@param grp: HDF5 group
@param class_type: name of the NeXus class
"""
coll = [grp[name] for name in grp
if (isinstance(grp[name], h5py.Dataset) and \
"NX_class" in grp[name].attrs and \
grp[name].attrs["NX_class"] == class_type)]
return coll
|