Hyppie CCD Detector control

This is the basic Python class to help in the configuration and control of CCD devices by using EPICS set of tools to provide the minimal infrastructure for use in managing and operating motor devices by reading and/or setting their record fields - also known as PVs, Process Variables.

Charge-Coupled Device (CCD) is a silicon light sensor which converts incident light, or photons, into electrons.

Using EPICS-Hyppie CCD Detector control module

Usage of Python Class for EPICS LabView RT Detector control.

class py4syn.epics.HyppieCCDClass.HyppieCCD(pvName, mnemonic, scalerObject='')

Python class to help configuration and control of Charge-Coupled Devices (CCD) via Hyppie over EPICS.

CCD is the most common mechanism for converting optical images to electrical signals. In fact, the term CCD is know by many people because of their use of video cameras and digital still cameras.

Constructor

Parameters:

pvName : string

Charge-Coupled Device (CCD)’s naming of the PV (Process Variable)

mnemonic : string

Device mnemonic

scalerObject : object

It represents logically the Scaler device

acquire(waitComplete=False)

Start process of image capturing.

Parameters:

waitComplete : boolean [OPTIONAL]

Whether to wait for all of the reading process of the image to complete, or not.

Note

• True – Wait for all image reading conclusion;
• False [DEFAULT] – DON’T wait for all image reading conclusion.

disableAutoIncrement()

Set AutoIncrement property of device to 0 (ZERO), that is, disables it.

Parameters:

None

enableAutoIncrement()

Set AutoIncrement property of device to 1 (ONE), that is, enables it.

Parameters:

None

getAcquireTime()

Read acquisition time of a Charge-Coupled Device (CCD).

Returns:

`float`

getCommandInput(cmd)

Return the input command submitted to the device.

Returns:

`string`

getCommandOutput(cmd)

Return the output of command the command sent to device.

Returns:

`string`

getCompleteFileName()

Return the full file name, with extension, of the current image which is being read.

Returns:

`string`

getCompletePreviousFileName()

Return the full file name, with extension, of the image which were read previously.

Returns:

`string`

getFileName()

Return the full file name of the current image which is being read.

Returns:

`string`

getFileNumber()

Return the number sequence of the file of current image which is being read.

Returns:

`integer`

getFilePath()

Return the full path where is the file of current image which is being read.

Returns:

`string`

getIntensity()

Return the intensity of the scaler device.

Returns:

`string`

isDone()

Check whether acquisition process has been concluded or not.

Returns:

`boolean`

.. note::

• True – Acquisition has been concluded;
• False – Acquisition has NOT been concluded.

isDoneConfig()

Check whether configuration process has been concluded or not.

Returns:

`boolean`

.. note::

• True – Configuration has been concluded;
• False – Configuration has NOT been concluded.

onAcquireChange(value, **kw)

Internal use method to check whether an acquisition in execution is done or not.

Parameters:

value : integer

0 (ZERO) Indicates the process has been concluded

kw : matrix

Internal array of parameters

onWaitChange(value, **kw)

Internal use method to check whether a configuration change request sent to the Charge-Coupled device has been performed or not.

Parameters:

value : integer

0 (ZERO) Indicates the configuration change has been conclude

kw : matrix

Internal array of parameters

setAcquireTime(time)

Set the acquisition time to the Charge-Coupled Device (CCD).

Parameters:

unit : float

Time value to be configured for the acquire-time property of CCD.

setCommandInput(cmd)

Set the input command to be submitted to the device.

Parameters:

unit : string

Command to send to device.

setFileName(name)

Set the full file name of current image which is being read.

Parameters:

unit : string

Name of image file to capture.

setFileNumber(number)

Set the number sequence of the file for the current image which is being read.

Parameters:

unit : integer

Sequence number to set to the image file.

setFilePath(name)

Set the full path where file of current image which is being read must be saved.

Parameters:

name : string

Description of path where image file should be stored.

setNumImages(number)

Set the number of images which should be read.

Parameters:

number : integer

Number of images to be captured.

setROI(startX, sizeX, startY, sizeY)

Method to determine the Region Of Interest (ROI) of a CCD device.

Parameters:

startX : float

X position to start the region of interest of the Charge-Coupled Device (CCD)

sizeX : float

size of X positioning

startY : float

Y position to start the region of interest of the Charge-Coupled Device (CCD)

sizeY : float

size of Y positioning

Examples

>>> import py4syn.epics.HyppieCCDClass.HyppieCCD as hyppie_ccd
>>> hyppie_ccd.setROI(32, 100, 15, 49)

Note

This method must be used only after default configuration was set in the Charge-Coupled Devide (CCD)

wait()

Method which keeps a sleeping period meanwhile any command execution is being performed.

Parameters:

None

waitConfig()

Method which keeps a sleeping period meanwhile any configuration is being set.

Parameters:

None