dectris.albula Namespace Reference

Classes
class	DAbstractNeXusData
	class DAbstractNeXusData represents NeXus nodes that accommodate data, i.e. More...
class	DColorMap
	class DColorMap lets you map image data to rgb data. More...
class	DColorTable
	Class DColorTable is an opaque class containing color data that shall be passed to DColorMap. More...
class	DContrast
	Class DContrast computes recommendations for foreground and background values, that may be used when representing a DImageInt or DImageFloat by a color scale. More...
class	DDrawingEllipse
	class DDrawingEllipse is a DDrawingPrimitive that represents a ellipse in the viewer window. More...
class	DDrawingLine
	class DDrawingLine is a DDrawingPrimitive that represents a line in the viewer window. More...
class	DDrawingPixel
	class DDrawingPixel is a DDrawingPrimitive that highlights a pixel in the viewer window by a cross. More...
class	DDrawingPrimitive
	class DDrawingPrimitve contains primitives that are displayed in a viewer window. More...
class	DDrawingString
	class DDrawingString is a DDrawingPrimitive that represents a string in the viewer window. More...
class	DEfficiencyCorrection
	Implements the efficiency correction More...
class	DEigerDetector
	class DEigerDetector provides access the Eiger configuration interface. More...
class	DEigerFileWriter
	class DEigerFileWriter provides access to the EIGER filewriter module. More...
class	DEigerMonitor
	class DEigerMonitor provides access the Eiger monitor interface. More...
class	DEigerStream
	class DEigerStream provides access the Eiger stream interface. More...
class	DFrame
	class DFrame is the parent class of class DMainFrame and DSubFrame. More...
class	DHdf5Writer
	Class DHdf5Writer writes DImage objects to an HDF5 container file. More...
class	DImage
	The Dectris Image class. More...
class	DImageModule
	class DImageModule provides information of an image module e.g. More...
class	DImageOptionalData
	The DImageOptionalData class contains optional image parameters. More...
class	DImageSeries
	class DImageSeries provides access to image series, which may reside in a series of single image files or in one hdf5 container file. More...
class	DImageWriter
	class DImageWriter writes DImage objects to files. More...
class	DMainFrame
	class DMainFrame represents a graphical unit that contains DSubFrames Open a DMainFrame via openMainFrame(). More...
class	DMessageQueue
	Class DMessageQueue opens a message queue to communicate between processes More...
class	DNeXusAttribute
	class DNeXusGroup represents an attribute in the NeXus tree. More...
class	DNeXusData
	class DNeXusGroup represents a dataset in the NeXus tree. More...
class	DNeXusGroup
	class DNeXusGroup represents a group in the NeXus tree. More...
class	DNeXusNode
	class DNeXusNode represents a NeXus node in a DNeXusTree. More...
class	DNeXusTree
	class DNeXusTree forms a tree like representation of the NeXus/Hdf5 header. More...
class	DNoAlbulaExecutable
	Exception thrown if no ALBULA executable is found. More...
class	DNoMethod
	Exception thrown if non-existing method is called on an object. More...
class	DNoObject
	Exception thrown if an DMainFrame or DSubframe can no longer be addressed as it was explicitely closed by the user. More...
class	DPilatusCalibration
	DPilatusCalibration deprecated. More...
class	DRateCorrection
	Implements the rate correction More...
class	DRect
	The DRect class defines a rectangle in the plane using integer precision. More...
class	DSubFrame
	class DSubFrame displays an image within a DMainFrame More...
class	DViewerClient
	Opens instance of ALBULA viewer and connects to it. More...

Functions
def	__DImageRadd__ (image, val)
def	__DImageRsub__ (image, val)
def	__DImageRmul__ (image, val)
def	__DImageRdiv__ (image, val)
def	__DImageSeriesIter__ (imageSeries)
def	__DHdf5WriterEnter__ (self)
def	__DHdf5WriterExit__ (self, exc_type, exc_value, traceback)
def	openMainFrame (width=-1, height=-1, hideToolBar=False, disableClose=False, enableGLSL=True)
	Creates and displays new DMainFrame. More...
def	display (image, width=-1, height=-1, hideToolBar=False, disableClose=False, hideToolButtons=False, title=None)
	Displays image in new DMainFrame. More...
def	readImage (fileName, timeout=0)
	Read an image from a file and return an image object. More...
def	version ()
	Version string. More...
def	versionMajor ()
	Major version. More...
def	versionMinor ()
	Minor version. More...
def	versionPatch ()
	Patch version. More...

Variables
	path
	msg = str(e)

Function Documentation

__DHdf5WriterEnter__()

def dectris.albula.__DHdf5WriterEnter__

(

self

)

__DHdf5WriterExit__()

def dectris.albula.__DHdf5WriterExit__	(		self,
			exc_type,
			exc_value,
			traceback
	)

__DImageRadd__()

def dectris.albula.__DImageRadd__	(		image,
			val
	)

__DImageRdiv__()

def dectris.albula.__DImageRdiv__	(		image,
			val
	)

__DImageRmul__()

def dectris.albula.__DImageRmul__	(		image,
			val
	)

__DImageRsub__()

def dectris.albula.__DImageRsub__	(		image,
			val
	)

__DImageSeriesIter__()

def dectris.albula.__DImageSeriesIter__

(

imageSeries

)

display()

def dectris.albula.display	(		image,
			width = -1,
			height = -1,
			hideToolBar = False,
			disableClose = False,
			hideToolButtons = False,
			title = None
	)

Displays image in new DMainFrame.

Parameters

image	Either path to image file or DImage object
width	Displayed width
height	Displayed height
hideToolBar	hide the tool bar. See DMainFrame.showToolBar() and DMainFrame.hideToolBar()
disableClose	If set to True clicking the exit button does not close the DMainFrame.
hideToolButtons	See DMainFrame.openSubFrame()
title	See DMainFrame.openSubFrame()

Returns

Tuple (DMainFrame, DSubFrame)

openMainFrame()

def dectris.albula.openMainFrame	(		width = -1,
			height = -1,
			hideToolBar = False,
			disableClose = False,
			enableGLSL = True
	)

Creates and displays new DMainFrame.

Parameters

width	Displayed width
height	Displayed height
hideToolBar	hide the tool bar. See DMainFrame.showToolBar() and DMainFrame.hideToolBar()
disableClose	If set to True clicking the exit button does not close the DMainFrame.
enableGLSL	enable OpenGL shaders. For GLSL version < 1.30 (i.e. OpenGL version < 3.0) this option has no effect.

Returns

DMainFrame object

readImage()

def dectris.albula.readImage	(		fileName,
			timeout = 0
	)

Read an image from a file and return an image object.

If timeout > 0 wait timeout milliseconds for file to be created. Caveat: There is no way to figure out when writing to a file ALBULA is waiting for is finished. Hence write image first to a temporary file and rename it atomically to fileName. (rename, mv are atomic operations on unix systems)

Parameters

fileName	Path to file from where the image is read.
timeout	Wait timeout milliseconds for file to be created (timeout == 0: return immediately, timeout < 0: wait forever)

Returns

DImage

version()

def dectris.albula.version

(

)

Version string.

Returns

String "Major.Minor-Patch"

versionMajor()

def dectris.albula.versionMajor

(

)

Major version.

Returns

Integer

versionMinor()

def dectris.albula.versionMinor

(

)

Minor version.

Returns

Integer

versionPatch()

def dectris.albula.versionPatch

(

)

Patch version.

Returns

Integer

Variable Documentation

msg

dectris.albula.msg = str(e)

path

dectris.albula.path