dectris.albula.DEigerMonitor Class Reference

class DEigerMonitor provides access the Eiger monitor interface. More...

Public Member Functions
def	DEigerMonitor (host, port=80)
	Contruct DEigerMonitor that connects to host and port. More...
def	version ()
	Get the API version of the monitor interface from the Eiger server. More...
def	enabled ()
	Return True (False) if the monitor interface on the Eiger server is enabled (disabled) More...
def	setEnabled (enabled)
	Enable (disable) the monitor interface on the Eiger server by passing True (False) More...
def	bufferSize ()
	Return the buffer size of the monitor interface on the Eiger server. More...
def	setBufferSize (bufferSize)
	Set the buffer size of the monitor interface on the Eiger server. More...
def	monitor (timeout=0)
	Get most recent image that is taken on the Eiger detector. More...
def	monitorAll (timeout=0)
	Get most recent image that is taken on the Eiger detector together with its series and image ID. More...
def	next (timeout=0)
	Get next image of the current image series that is taken on the Eiger detector. More...
def	nextAll (timeout=0)
	Get next image of the current image series that is taken on the Eiger detector together with its series and image ID. More...

Detailed Description

class DEigerMonitor provides access the Eiger monitor interface.

In order to used monitor Eiger its monitor interface must be enabled (see enabled(), setEnabled()). Images may be obtaine via the methods monitor() and next().

Constructor & Destructor Documentation

DEigerMonitor()

def dectris.albula.DEigerMonitor.DEigerMonitor	(		host,
			port = 80
	)

Contruct DEigerMonitor that connects to host and port.

Parameters

host	String containing the host name or IP address of the Eiger server.
port	Integer containing the port number of the Eiger server.

Member Function Documentation

bufferSize()

def dectris.albula.DEigerMonitor.bufferSize

(

)

Return the buffer size of the monitor interface on the Eiger server.

Getting images via next() necessitates buffer size > 0.

Returns

Integer

enabled()

def dectris.albula.DEigerMonitor.enabled

(

)

Return True (False) if the monitor interface on the Eiger server is enabled (disabled)

Returns

True or False

monitor()

def dectris.albula.DEigerMonitor.monitor

(

timeout = 0

)

Get most recent image that is taken on the Eiger detector.

Raises DTimeoutException in case of timeout.

Parameters

timeout

timeout in ms

Returns

DImage

monitorAll()

def dectris.albula.DEigerMonitor.monitorAll

(

timeout = 0

)

Get most recent image that is taken on the Eiger detector together with its series and image ID.

Raises DTimeoutException in case of timeout.

Parameters

timeout

timeout in ms

Returns

Tuple (DImage, Integer, Integer) containing the image, series ID and image ID

next()

def dectris.albula.DEigerMonitor.next

(

timeout = 0

)

Get next image of the current image series that is taken on the Eiger detector.

Raises DTimeoutException in case of timeout. Getting images via next() necessitates buffer size > 0.

Parameters

timeout

timeout in ms

Returns

DImage

nextAll()

def dectris.albula.DEigerMonitor.nextAll

(

timeout = 0

)

Get next image of the current image series that is taken on the Eiger detector together with its series and image ID.

Raises DTimeoutException in case of timeout.

Parameters

timeout

timeout in ms

Returns

Tuple (DImage, Integer, Integer) containing the image, series ID and image ID

setBufferSize()

def dectris.albula.DEigerMonitor.setBufferSize

(

bufferSize

)

Set the buffer size of the monitor interface on the Eiger server.

Getting images via next() necessitates buffer size > 0.

Parameters

bufferSize

Integer

setEnabled()

def dectris.albula.DEigerMonitor.setEnabled

(

enabled

)

Enable (disable) the monitor interface on the Eiger server by passing True (False)

Parameters

enabled

True or False

version()

def dectris.albula.DEigerMonitor.version

(

)

Get the API version of the monitor interface from the Eiger server.

Returns

String