andor3.constants module

Definitions of special values, feature strings, and camera handles used by the Andor SDK.

class andor3.constants.AT_HANDLE(value)

Bases: IntEnum

Enumeration of special camera handle values used by the Andor SDK3.

SYSTEM = 1

UNINITIALISED = -1

andor3.constants.FEATURES = {'AOIBinning': 'Enumerated', 'AOIHBin': 'Integer', 'AOIHeight': 'Integer', 'AOILayout': 'Enumerated', 'AOILeft': 'Integer', 'AOIStride': 'Integer', 'AOITop': 'Integer', 'AOIVBin': 'Integer', 'AOIWidth': 'Integer', 'AccumulateCount': 'Integer', 'AcquiredCount': 'Integer', 'AcquisitionStart': 'Command', 'AcquisitionStop': 'Command', 'AlternatingReadoutDirection': 'Boolean', 'AuxOutSourceTwo': 'Enumerated', 'AuxiliaryOutSource': 'Enumerated', 'BackoffTemperatureOffset': 'Floating Point', 'Baseline': 'Integer', 'BitDepth': 'Enumerated', 'BufferOverflowEvent': 'Event', 'BytesPerPixel': 'Floating Point', 'CameraAcquiring': 'Boolean', 'CameraDump': 'Command', 'CameraFamily': 'String', 'CameraMemory': 'Integer', 'CameraModel': 'String', 'CameraName': 'String', 'CameraPresent': 'Boolean', 'ColourFilter': 'Enumerated', 'ControllerID': 'String', 'CoolerPower': 'Floating Point', 'CycleMode': 'Enumerated', 'DDGIOCEnable': 'Boolean', 'DDGIOCNumberOfPulses': 'Integer', 'DDGIOCPeriod': 'Integer', 'DDGOpticalWidthEnable': 'Boolean', 'DDGOutputDelay': 'Integer', 'DDGOutputEnable': 'Boolean', 'DDGOutputPolarity': 'Enumerated', 'DDGOutputSelector': 'Enumerated', 'DDGOutputStepEnable': 'Boolean', 'DDGOutputWidth': 'Integer', 'DDGStepCount': 'Integer', 'DDGStepDelayCoefficientA': 'Floating Point', 'DDGStepDelayCoefficientB': 'Floating Point', 'DDGStepDelayMode': 'Enumerated', 'DDGStepEnabled': 'Boolean', 'DDGStepUploadModeValues': 'Command', 'DDGStepUploadProgress': 'Integer', 'DDGStepUploadRequired': 'Boolean', 'DDGStepWidthCoefficientA': 'Floating Point', 'DDGStepWidthCoefficientB': 'Floating Point', 'DDGStepWidthMode': 'Enumerated', 'DDR2Type': 'String', 'DeviceCount': 'Integer', 'DeviceVideoIndex': 'Integer', 'DisableShutter': 'Boolean', 'DriverVersion': 'String', 'ElectronicShutteringMode': 'Enumerated', 'EventEnable': 'Boolean', 'EventSelector': 'Enumerated', 'EventsMissedEvent': 'Event', 'ExposedPixelHeight': 'Integer', 'ExposureEndEvent': 'Event', 'ExposureStartEvent': 'Event', 'ExposureTime': 'Floating Point', 'ExternalIOReadout': 'Boolean', 'ExternalTriggerDelay': 'Floating Point', 'FanSpeed': 'Enumerated', 'FastAOIFrameRateEnable': 'Boolean', 'FirmwareVersion': 'String', 'ForceShutterOpen': 'Boolean', 'FrameCount': 'Integer', 'FrameInterval': 'Floating Point', 'FrameIntervalTiming': 'Boolean', 'FrameRate': 'Floating Point', 'FullAOIControl': 'Boolean', 'GateMode': 'Enumerated', 'HeatSinkTemperature': 'Floating Point', 'I2CAddress': 'Integer', 'I2CByte': 'Integer', 'I2CByteCount': 'Integer', 'I2CByteSelector': 'Integer', 'I2CRead': 'Command', 'I2CWrite': 'Command', 'IOControl': 'Enumerated', 'IODirection': 'Enumerated', 'IOInvert': 'Boolean', 'IOSelector': 'Enumerated', 'IOState': 'Boolean', 'IRPreFlashEnable': 'Boolean', 'ImageSizeBytes': 'Integer', 'InputVoltage': 'Floating Point', 'InsertionDelay': 'Enumerated', 'InterfaceType': 'String', 'KeepCleanEnable': 'Boolean', 'KeepCleanPostExposureEnable': 'Boolean', 'LUTIndex': 'Integer', 'LUTValue': 'Integer', 'LineScanSpeed': 'Floating Point', 'MCPGain': 'Integer', 'MCPIntelligate': 'Boolean', 'MCPVoltage': 'Integer', 'MaxInterfaceTransferRate': 'Floating Point', 'MetadataEnable': 'Boolean', 'MetadataFrame': 'Boolean', 'MetadataFrameInfo': 'Boolean', 'MetadataTimestamp': 'Boolean', 'MicrocodeVersion': 'String', 'MultitrackBinned': 'Boolean', 'MultitrackCount': 'Integer', 'MultitrackEnd': 'Integer', 'MultitrackSelector': 'Integer', 'MultitrackStart': 'Integer', 'Overlap': 'Boolean', 'PIVEnable': 'Boolean', 'PixelCorrection': 'Boolean', 'PixelEncoding': 'Enumerated', 'PixelHeight': 'Floating Point', 'PixelReadoutRate': 'Enumerated', 'PixelWidth': 'Floating Point', 'PortSelector': 'Integer', 'PreAmpGain': 'Enumerated', 'PreAmpGainChannel': 'Enumerated', 'PreAmpGainControl': 'Enumerated', 'PreAmpGainSelector': 'Enumerated', 'PreAmpGainValue': 'Integer', 'PreAmpOffsetValue': 'Integer', 'PreTriggerEnable': 'Boolean', 'ReadoutTime': 'Floating Point', 'RollingShutterGlobalClear': 'Boolean', 'RowNExposureEndEvent': 'Event', 'RowNExposureStartEvent': 'Event', 'RowReadTime': 'Floating Point', 'ScanSpeedControlEnable': 'Boolean', 'SensorCooling': 'Boolean', 'SensorHeight': 'Integer', 'SensorModel': 'String', 'SensorReadoutMode': 'Enumerated', 'SensorTemperature': 'Floating Point', 'SensorType': 'String', 'SensorWidth': 'Integer', 'SerialNumber': 'String', 'ShutterAmpControl': 'Boolean', 'ShutterMode': 'Enumerated', 'ShutterOutputMode': 'Enumerated', 'ShutterState': 'Boolean', 'ShutterStrobePeriod': 'Floating Point', 'ShutterStrobePosition': 'Floating Point', 'ShutterTransferTime': 'Floating Point', 'SimplePreAmpGainControl': 'Enumerated', 'SoftwareTrigger': 'Command', 'SoftwareVersion': 'String', 'SpuriousNoiseFilter': 'Boolean', 'StaticBlemishCorrection': 'Boolean', 'SynchronousTriggering': 'Boolean', 'TargetSensorTemperature': 'Floating Point', 'TemperatureControl': 'Enumerated', 'TemperatureStatus': 'Enumerated', 'TimestampClock': 'Integer', 'TimestampClockFrequency': 'Integer', 'TimestampClockReset': 'Command', 'TransmitFrames': 'Boolean', 'TriggerMode': 'Enumerated', 'UsbDeviceId': 'Integer', 'UsbProductId': 'Integer', 'VerticallyCentreAOI': 'Boolean'}

Dictionary containing valid camera feature strings and their corresponding data type.

andor3.constants.INFINITY = 4294967295

Value to indicate an infinite timeout value when waiting on an image buffer.

andor3.constants.STRING_BUFFER_SIZE = 1024

Buffer size to use when sending or receiving strings from the camera.