dectris.albula.DEigerStream Class Reference

class DEigerStream provides access the Eiger stream interface. More...

Public Member Functions
def	DEigerStream (host, port=80)
	Contruct DEigerStream that connects to host and port. More...
def	version ()
	Get the API version of the stream interface from the Eiger server. More...
def	enabled ()
	Return True (False) if the stream interface on the Eiger server is enabled (disabled) More...
def	setEnabled (enabled)
	Enable (disable) the stream interface on the Eiger server by passing True (False) More...
def	headerDetail ()
	Returns the degree of detail of the data header More...
def	setHeaderDetail (headerDetail)
	Set the degree of detail of the data header More...
def	dropped ()
	Returns number of dropped images inside the detector. More...
def	pop ()
	Get most recent image that is taken on the Eiger detector together with its series and image ID. More...

Detailed Description

class DEigerStream provides access the Eiger stream interface.

In order to used monitor Eiger its stream interface must be enabled (see enabled(), setEnabled()).

Constructor & Destructor Documentation

DEigerStream()

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

Contruct DEigerStream 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

dropped()

def dectris.albula.DEigerStream.dropped

(

)

Returns number of dropped images inside the detector.

Returns

Integer.

enabled()

def dectris.albula.DEigerStream.enabled

(

)

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

Returns

True or False

headerDetail()

def dectris.albula.DEigerStream.headerDetail

(

)

Returns the degree of detail of the data header

Returns

String. "basic", "all" or "none"

pop()

def dectris.albula.DEigerStream.pop

(

)

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

Raises DTimeoutException in case of timeout.

Returns

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

setEnabled()

def dectris.albula.DEigerStream.setEnabled

(

enabled

)

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

Parameters

enabled

True or False

setHeaderDetail()

def dectris.albula.DEigerStream.setHeaderDetail

(

headerDetail

)

Set the degree of detail of the data header

Parameters

headerDetail

String. "basic", "all" or "none"

version()

def dectris.albula.DEigerStream.version

(

)

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

Returns

String