Module matisse_controller.shamrock_ple.constants

Useful constants to configure CCD and spectrometer, and error codes for these devices.

"""Useful constants to configure CCD and spectrometer, and error codes for these devices."""
import enum

# Miscellaneous constants used to set up the CCD and spectrometer, using values from Andor documentation.
ACQ_MODE_SINGLE = 1
ACQ_MODE_ACCUMULATE = 2
ACQ_MODE_KINETICS = 3
ACQ_MODE_FAST_KINETICS = 4
ACQ_MODE_UNTIL_ABORT = 5
READ_MODE_FVB = 0
READ_MODE_MULTI_TRACK = 1
READ_MODE_RANDOM_TRACK = 2
READ_MODE_SINGLE_TRACK = 3
READ_MODE_IMAGE = 4
COSMIC_RAY_FILTER_OFF = 0
COSMIC_RAY_FILTER_ON = 2
TRIGGER_MODE_INTERNAL = 0


class ShamrockErrorCode(enum.Enum):
    """
    Error codes pulled straight from the Shamrock SDK manual. Note that not all of these codes indicate errors, for
    example DRV_SUCCESS indicates a successful command.
    """
    SHAMROCK_COMMUNICATION_ERROR = 20201
    SHAMROCK_SUCCESS = 20202
    SHAMROCK_P1INVALID = 20266
    SHAMROCK_P2INVALID = 20267
    SHAMROCK_P3INVALID = 20268
    SHAMROCK_NOT_INITIALIZED = 20275


class CCDErrorCode(enum.Enum):
    """
    Error codes pulled straight from the Andor SDK manual. Note that not all of these codes indicate errors, for
    example DRV_SUCCESS indicates a successful command, and DRV_TEMPERATURE_STABILIZED indicates successful temperature
    stabilization.
    """
    DRV_ERROR_CODES = 20001
    DRV_SUCCESS = 20002
    DRV_VXDNOTINSTALLED = 20003
    DRV_ERROR_SCAN = 20004
    DRV_ERROR_CHECK_SUM = 20005
    DRV_ERROR_FILELOAD = 20006
    DRV_UNKNOWN_FUNCTION = 20007
    DRV_ERROR_VXD_INIT = 20008
    DRV_ERROR_ADDRESS = 20009
    DRV_ERROR_PAGELOCK = 20010
    DRV_ERROR_PAGE_UNLOCK = 20011
    DRV_ERROR_BOARDTEST = 20012
    DRV_ERROR_ACK = 20013
    DRV_ERROR_UP_FIFO = 20014
    DRV_ERROR_PATTERN = 20015
    DRV_ACQUISITION_ERRORS = 20017
    DRV_ACQ_BUFFER = 20018
    DRV_ACQ_DOWNFIFO_FULL = 20019
    DRV_PROC_UNKNOWN_INSTRUCTION = 20020
    DRV_ILLEGAL_OP_CODE = 20021
    DRV_KINETIC_TIME_NOT_MET = 20022
    DRV_ACCUM_TIME_NOT_MET = 20023
    DRV_NO_NEW_DATA = 20024
    PCI_DMA_FAIL = 20025
    DRV_SPOOLERROR = 20026
    DRV_SPOOLSETUPERROR = 20027
    SATURATED = 20029
    DRV_TEMPERATURE_CODES = 20033
    DRV_TEMPERATURE_OFF = 20034
    DRV_TEMP_NOT_STABILIZED = 20035
    DRV_TEMPERATURE_STABILIZED = 20036
    DRV_TEMPERATURE_NOT_REACHED = 20037
    DRV_TEMPERATURE_OUT_RANGE = 20038
    DRV_TEMPERATURE_NOT_SUPPORTED = 20039
    DRV_TEMPERATURE_DRIFT = 20040
    DRV_GENERAL_ERRORS = 20049
    DRV_INVALID_AUX = 20050
    DRV_COF_NOTLOADED = 20051
    DRV_FPGAPROG = 20052
    DRV_FLEXERROR = 20053
    DRV_GPIBERROR = 20054
    ERROR_DMA_UPLOAD = 20055
    DRV_DATATYPE = 20064
    DRV_DRIVER_ERRORS = 20065
    DRV_P1INVALID = 20066
    DRV_P2INVALID = 20067
    DRV_P3INVALID = 20068
    DRV_P4INVALID = 20069
    DRV_INIERROR = 20070
    DRV_COFERROR = 20071
    DRV_ACQUIRING = 20072
    DRV_IDLE = 20073
    DRV_TEMPCYCLE = 20074
    DRV_NOT_INITIALIZED = 20075
    DRV_P5INVALID = 20076
    DRV_P6INVALID = 20077
    DRV_INVALID_MODE = 20078
    DRV_INVALID_FILTER = 20079
    DRV_I2CERRORS = 20080
    DRV_DRV_I2CDEVNOTFOUND = 20081
    DRV_I2CTIMEOUT = 20082
    DRV_P7INVALID = 20083
    DRV_USBERROR = 20089
    DRV_IOCERROR = 20090
    DRV_VRMVERSIONERROR = 20091
    DRV_USB_INTERRUPT_ENDPOINT_ERROR = 20093
    DRV_RANDOM_TRACK_ERROR = 20094
    DRV_INVALID_TRIGGER_MODE = 20095
    DRV_LOAD_FIRMWARE_ERROR = 20096
    DRV_DIVIDE_BY_ZERO_ERROR = 20097
    DRV_INVALID_RINGEXPOSURES = 20098
    DRV_BINNING_ERROR = 20099
    DRV_ERROR_NOCAMERA = 20990
    DRV_NOT_SUPPORTED = 20991
    DRV_NOT_AVAILABLE = 20992
    DRV_ERROR_MAP = 20115
    DRV_ERROR_UNMAP = 20116
    DRV_ERROR_MDL = 20117
    DRV_ERROR_UNMDL = 20118
    DRV_ERROR_BUFFSIZE = 20119
    DRV_ERROR_NOHANDLE = 20121
    DRV_GATING_NOT_AVAILABLE = 20130
    DRV_FPGA_VOLTAGE_ERROR = 20131
    DRV_INVALID_AMPLIFIER = 20100
    DRV_INVALID_COUNTCONVERT_MODE = 20101

Classes

class CCDErrorCode (*args, **kwargs)

Error codes pulled straight from the Andor SDK manual. Note that not all of these codes indicate errors, for example DRV_SUCCESS indicates a successful command, and DRV_TEMPERATURE_STABILIZED indicates successful temperature stabilization.

Source code

class CCDErrorCode(enum.Enum):
    """
    Error codes pulled straight from the Andor SDK manual. Note that not all of these codes indicate errors, for
    example DRV_SUCCESS indicates a successful command, and DRV_TEMPERATURE_STABILIZED indicates successful temperature
    stabilization.
    """
    DRV_ERROR_CODES = 20001
    DRV_SUCCESS = 20002
    DRV_VXDNOTINSTALLED = 20003
    DRV_ERROR_SCAN = 20004
    DRV_ERROR_CHECK_SUM = 20005
    DRV_ERROR_FILELOAD = 20006
    DRV_UNKNOWN_FUNCTION = 20007
    DRV_ERROR_VXD_INIT = 20008
    DRV_ERROR_ADDRESS = 20009
    DRV_ERROR_PAGELOCK = 20010
    DRV_ERROR_PAGE_UNLOCK = 20011
    DRV_ERROR_BOARDTEST = 20012
    DRV_ERROR_ACK = 20013
    DRV_ERROR_UP_FIFO = 20014
    DRV_ERROR_PATTERN = 20015
    DRV_ACQUISITION_ERRORS = 20017
    DRV_ACQ_BUFFER = 20018
    DRV_ACQ_DOWNFIFO_FULL = 20019
    DRV_PROC_UNKNOWN_INSTRUCTION = 20020
    DRV_ILLEGAL_OP_CODE = 20021
    DRV_KINETIC_TIME_NOT_MET = 20022
    DRV_ACCUM_TIME_NOT_MET = 20023
    DRV_NO_NEW_DATA = 20024
    PCI_DMA_FAIL = 20025
    DRV_SPOOLERROR = 20026
    DRV_SPOOLSETUPERROR = 20027
    SATURATED = 20029
    DRV_TEMPERATURE_CODES = 20033
    DRV_TEMPERATURE_OFF = 20034
    DRV_TEMP_NOT_STABILIZED = 20035
    DRV_TEMPERATURE_STABILIZED = 20036
    DRV_TEMPERATURE_NOT_REACHED = 20037
    DRV_TEMPERATURE_OUT_RANGE = 20038
    DRV_TEMPERATURE_NOT_SUPPORTED = 20039
    DRV_TEMPERATURE_DRIFT = 20040
    DRV_GENERAL_ERRORS = 20049
    DRV_INVALID_AUX = 20050
    DRV_COF_NOTLOADED = 20051
    DRV_FPGAPROG = 20052
    DRV_FLEXERROR = 20053
    DRV_GPIBERROR = 20054
    ERROR_DMA_UPLOAD = 20055
    DRV_DATATYPE = 20064
    DRV_DRIVER_ERRORS = 20065
    DRV_P1INVALID = 20066
    DRV_P2INVALID = 20067
    DRV_P3INVALID = 20068
    DRV_P4INVALID = 20069
    DRV_INIERROR = 20070
    DRV_COFERROR = 20071
    DRV_ACQUIRING = 20072
    DRV_IDLE = 20073
    DRV_TEMPCYCLE = 20074
    DRV_NOT_INITIALIZED = 20075
    DRV_P5INVALID = 20076
    DRV_P6INVALID = 20077
    DRV_INVALID_MODE = 20078
    DRV_INVALID_FILTER = 20079
    DRV_I2CERRORS = 20080
    DRV_DRV_I2CDEVNOTFOUND = 20081
    DRV_I2CTIMEOUT = 20082
    DRV_P7INVALID = 20083
    DRV_USBERROR = 20089
    DRV_IOCERROR = 20090
    DRV_VRMVERSIONERROR = 20091
    DRV_USB_INTERRUPT_ENDPOINT_ERROR = 20093
    DRV_RANDOM_TRACK_ERROR = 20094
    DRV_INVALID_TRIGGER_MODE = 20095
    DRV_LOAD_FIRMWARE_ERROR = 20096
    DRV_DIVIDE_BY_ZERO_ERROR = 20097
    DRV_INVALID_RINGEXPOSURES = 20098
    DRV_BINNING_ERROR = 20099
    DRV_ERROR_NOCAMERA = 20990
    DRV_NOT_SUPPORTED = 20991
    DRV_NOT_AVAILABLE = 20992
    DRV_ERROR_MAP = 20115
    DRV_ERROR_UNMAP = 20116
    DRV_ERROR_MDL = 20117
    DRV_ERROR_UNMDL = 20118
    DRV_ERROR_BUFFSIZE = 20119
    DRV_ERROR_NOHANDLE = 20121
    DRV_GATING_NOT_AVAILABLE = 20130
    DRV_FPGA_VOLTAGE_ERROR = 20131
    DRV_INVALID_AMPLIFIER = 20100
    DRV_INVALID_COUNTCONVERT_MODE = 20101

Ancestors

• enum.Enum

Class variables

var DRV_ACCUM_TIME_NOT_MET

var DRV_ACQUIRING

var DRV_ACQUISITION_ERRORS

var DRV_ACQ_BUFFER

var DRV_ACQ_DOWNFIFO_FULL

var DRV_BINNING_ERROR

var DRV_COFERROR

var DRV_COF_NOTLOADED

var DRV_DATATYPE

var DRV_DIVIDE_BY_ZERO_ERROR

var DRV_DRIVER_ERRORS

var DRV_DRV_I2CDEVNOTFOUND

var DRV_ERROR_ACK

var DRV_ERROR_ADDRESS

var DRV_ERROR_BOARDTEST

var DRV_ERROR_BUFFSIZE

var DRV_ERROR_CHECK_SUM

var DRV_ERROR_CODES

var DRV_ERROR_FILELOAD

var DRV_ERROR_MAP

var DRV_ERROR_MDL

var DRV_ERROR_NOCAMERA

var DRV_ERROR_NOHANDLE

var DRV_ERROR_PAGELOCK

var DRV_ERROR_PAGE_UNLOCK

var DRV_ERROR_PATTERN

var DRV_ERROR_SCAN

var DRV_ERROR_UNMAP

var DRV_ERROR_UNMDL

var DRV_ERROR_UP_FIFO

var DRV_ERROR_VXD_INIT

var DRV_FLEXERROR

var DRV_FPGAPROG

var DRV_FPGA_VOLTAGE_ERROR

var DRV_GATING_NOT_AVAILABLE

var DRV_GENERAL_ERRORS

var DRV_GPIBERROR

var DRV_I2CERRORS

var DRV_I2CTIMEOUT

var DRV_IDLE

var DRV_ILLEGAL_OP_CODE

var DRV_INIERROR

var DRV_INVALID_AMPLIFIER

var DRV_INVALID_AUX

var DRV_INVALID_COUNTCONVERT_MODE

var DRV_INVALID_FILTER

var DRV_INVALID_MODE

var DRV_INVALID_RINGEXPOSURES

var DRV_INVALID_TRIGGER_MODE

var DRV_IOCERROR

var DRV_KINETIC_TIME_NOT_MET

var DRV_LOAD_FIRMWARE_ERROR

var DRV_NOT_AVAILABLE

var DRV_NOT_INITIALIZED

var DRV_NOT_SUPPORTED

var DRV_NO_NEW_DATA

var DRV_P1INVALID

var DRV_P2INVALID

var DRV_P3INVALID

var DRV_P4INVALID

var DRV_P5INVALID

var DRV_P6INVALID

var DRV_P7INVALID

var DRV_PROC_UNKNOWN_INSTRUCTION

var DRV_RANDOM_TRACK_ERROR

var DRV_SPOOLERROR

var DRV_SPOOLSETUPERROR

var DRV_SUCCESS

var DRV_TEMPCYCLE

var DRV_TEMPERATURE_CODES

var DRV_TEMPERATURE_DRIFT

var DRV_TEMPERATURE_NOT_REACHED

var DRV_TEMPERATURE_NOT_SUPPORTED

var DRV_TEMPERATURE_OFF

var DRV_TEMPERATURE_OUT_RANGE

var DRV_TEMPERATURE_STABILIZED

var DRV_TEMP_NOT_STABILIZED

var DRV_UNKNOWN_FUNCTION

var DRV_USBERROR

var DRV_USB_INTERRUPT_ENDPOINT_ERROR

var DRV_VRMVERSIONERROR

var DRV_VXDNOTINSTALLED

var ERROR_DMA_UPLOAD

var PCI_DMA_FAIL

var SATURATED

class ShamrockErrorCode (*args, **kwargs)

Error codes pulled straight from the Shamrock SDK manual. Note that not all of these codes indicate errors, for example DRV_SUCCESS indicates a successful command.

Source code

class ShamrockErrorCode(enum.Enum):
    """
    Error codes pulled straight from the Shamrock SDK manual. Note that not all of these codes indicate errors, for
    example DRV_SUCCESS indicates a successful command.
    """
    SHAMROCK_COMMUNICATION_ERROR = 20201
    SHAMROCK_SUCCESS = 20202
    SHAMROCK_P1INVALID = 20266
    SHAMROCK_P2INVALID = 20267
    SHAMROCK_P3INVALID = 20268
    SHAMROCK_NOT_INITIALIZED = 20275

Ancestors

• enum.Enum

Class variables

var SHAMROCK_COMMUNICATION_ERROR

var SHAMROCK_NOT_INITIALIZED

var SHAMROCK_P1INVALID

var SHAMROCK_P2INVALID

var SHAMROCK_P3INVALID

var SHAMROCK_SUCCESS