dectris.albula.DEigerDetector Class Reference

class DEigerDetector provides access the Eiger configuration interface. More...

Public Member Functions
def	DEigerDetector (host, port=80)
	Contruct DEigerDetector that connects to host and port. More...
def	version ()
	Get the API version of the configuration interface from the Eiger server. More...
def	setCountTime (time)
	Set count time in seconds. More...
def	countTime ()
	Return count time, its min and max values in seconds. More...
def	setFrameTime (time)
	Set frame time in seconds. More...
def	frameTime ()
	Return frame time, its min and max values in seconds. More...
def	setNImages (nImages)
	Set number of images. More...
def	nImages ()
	Return number of images, mininum and maximum number of images. More...
def	setPhotonEnergy (energy)
	Return photon energy, its min and max values in seconds. More...
def	photonEnergy ()
	Return photon energy in eV. More...
def	status ()
	Return status of EIGER More...
def	isError ()
	Return True if EIGER is in an error state, else return False. More...
def	initialize ()
	Send "initialize" command to EIGER. More...
def	arm ()
	Send "arm" command to EIGER. More...
def	trigger ()
	Send "trigger" command to EIGER. More...
def	disarm ()
	Send "disarm" command to EIGER. More...
def	abort ()
	Send "abort" command to EIGER. More...

Detailed Description

class DEigerDetector provides access the Eiger configuration interface.

Constructor & Destructor Documentation

DEigerDetector()

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

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

abort()

def dectris.albula.DEigerDetector.abort

(

)

Send "abort" command to EIGER.

Blocking operation.

arm()

def dectris.albula.DEigerDetector.arm

(

)

Send "arm" command to EIGER.

Blocking operation.

countTime()

def dectris.albula.DEigerDetector.countTime

(

)

Return count time, its min and max values in seconds.

Returns

Triple of Float values: count time, min and max.

disarm()

def dectris.albula.DEigerDetector.disarm

(

)

Send "disarm" command to EIGER.

Blocking operation.

frameTime()

def dectris.albula.DEigerDetector.frameTime

(

)

Return frame time, its min and max values in seconds.

Returns

Triple of Float values: frame time, min and max.

initialize()

def dectris.albula.DEigerDetector.initialize

(

)

Send "initialize" command to EIGER.

Blocking operation.

isError()

def dectris.albula.DEigerDetector.isError

(

)

Return True if EIGER is in an error state, else return False.

Returns

True or False

nImages()

def dectris.albula.DEigerDetector.nImages

(

)

Return number of images, mininum and maximum number of images.

Returns

Triple of Integer values: number of images, min and max.

photonEnergy()

def dectris.albula.DEigerDetector.photonEnergy

(

)

Return photon energy in eV.

Returns

Float value.

setCountTime()

def dectris.albula.DEigerDetector.setCountTime

(

time

)

Set count time in seconds.

Parameters

time.

Float value.

setFrameTime()

def dectris.albula.DEigerDetector.setFrameTime

(

time

)

Set frame time in seconds.

Parameters

time.

Float value.

setNImages()

def dectris.albula.DEigerDetector.setNImages

(

nImages

)

Set number of images.

Parameters

time.

Integer value.

setPhotonEnergy()

def dectris.albula.DEigerDetector.setPhotonEnergy

(

energy

)

Return photon energy, its min and max values in seconds.

Returns

Triple of Float values: photon energy, min and max.

status()

def dectris.albula.DEigerDetector.status

(

)

Return status of EIGER

Returns

String value.

trigger()

def dectris.albula.DEigerDetector.trigger

(

)

Send "trigger" command to EIGER.

Blocking operation.

version()

def dectris.albula.DEigerDetector.version

(

)

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

Returns

String