|
| def | DImageSeries (listsize=0) |
| | Access to list of images that contains at most listsize (infinite) images if listsize > 0 (listsize == 0). More...
|
| |
| def | DImageSeries (fileName) |
| | Construct readonly DImageSeries from hdf5 file or arbitrary file of a set of image files following the name pattern /path/to/image<Number>.suffix. More...
|
| |
| def | open (listsize=0) |
| | Access to list of images that contains at most listsize (infinite) images if listsize > 0 (listsize == 0). More...
|
| |
| def | open (fileName) |
| | Access to an image series of single image files or one container file (hdf5). More...
|
| |
| def | blocking () |
| | Returns True if blocking mode is on else false. More...
|
| |
| def | setBlocking (blocking, timeout=0) |
| | Set blocking mode when trying to access resources of the series that are still absent (e.g. a missing image file). More...
|
| |
| def | front () |
| | front element on the DImage series It is guaranteed that for the returned image optionalData().pixel_mask() is set. More...
|
| |
| def | popFront () |
| | Removes first image of the list. More...
|
| |
| def | pushBack (img) |
| | If accommodating a list of of DImage objects, add image at the end of the list. More...
|
| |
| def | size () |
| | number of images the series contains. More...
|
| |
| def | first () |
| | index of the first image More...
|
| |
| def | last () |
| | index of the last image More...
|
| |
| def | at (index) |
| | Identical to DImageSeries[n]. More...
|
| |
| def | neXus () |
| | If the underlying data is a Hdf5 container return its NeXus tree, else raise DRuntimeException. More...
|
| |
| def | empty () |
| | Indicates if front() is valid. More...
|
| |
| def | update () |
| | Scan the resource (e.g. the hdf5 file) for new images. More...
|
| |
| def | pathToImage (index) |
| | Throws DRuntimeException if operation does not make sense (e.g. on a image list). More...
|
| |
class DImageSeries provides access to image series, which may reside in a series of single image files or in one hdf5 container file.
In addition DImageSeries may accomodate a list of separated DImage objects. A series of single image files is accessed by passing the path to any of the files as fileName argument to the constructor or to open(). All images belonging to the same series are assumed to follow the name pattern /path/to/image<Number>.<suffix>, where <Number> runs from a minimum to a maximum value. <suffix> identifies the file format. Currently cbf, tif and edf files taken by Pilatus detectors are supported. Hdf5 files are opend by passing their paths as fileName argument to the constructor or to open(). DImageSeries objects accomodating a series of files or a hdf5 file are read only. I.e. pushBack() throws a DRuntimeException. If an integer size is passed as listsize argument to the constructor or to open(), DImageSeries behaves like a list of DImage objects, which may be pushed at one end via pushBack() and popped from the other end via popFront(). Random access is still possible via at() or the [] operator.
class DImageSeries provides the following operations:
| DImageSeries[ index ] | \brief Random access to the DImages
\anchor DImageSeries_operator_at
If n is not a valid index the method may either block (if blocking())
or a DOutOfRangeException is thrown. If blocking and operation timed out
a DTimeoutException is thrown.
It is guaranteed that in the returned image optionalData().pixel_mask() is set.
\param n Index of the image to load. The index of the series does not
neccessarily start from 0. Query the first index via first().
\return DImage
|
1.8.17