CCF Communication Adapter based on the andor SDK. More...

Classes
struct	AndorCtrlEnumKeyHash
	A custom hash function for AndorStatEnumKey, which supports hashing of variant-like types (e.g., std::variant). More...

struct	AndorStatEnumKeyHash

struct	CameraSetup

struct	CameraStatus

class	CommAdapter
	Handles communication and interaction with the Andor camera. More...

class	Config
	Handles configuration of the Andor FrameGrabber application. More...

struct	SetupParam
	The State struct. More...

struct	StatusParam
	The State struct. More...

Typedefs
using	AndorCtrlEnumKey

using	AndorStatEnumKey

Enumerations
enum	CameraType { UNKNOWN = 0 , BALOR = 1 , MARANA = 2 , SIM = 3 }

enum	RpcError : short { PARAM_SETUP_ERROR = -1 }

Functions
void	CopyYaml (const YAML::Node &src, YAML::Node &dst)

YAML::Node	MergeNodes (const YAML::Node &a, const YAML::Node &b)

Variables
const double	CONNECT_TIMEOUT = 10.0

const double	FRAME_REC_THR_SLEEP_TIME = 0.0005

const uint16_t	MAX_NB_OF_RECEP_BUFFERS = 10

const uint16_t	NB_OF_INPUT_BUFFERS = 5

const int32_t	DEFAULT_PACKET_SIZE = 1500

const uint32_t	STREAM_BYTES_PER_SECOND_MIN = 1000000

const uint32_t	STREAM_BYTES_PER_SECOND_MAX = 248000000

const int	TIMEOUTMS = 30000

const short	RPC_SUCCESS = 0

const short	RPC_ERROR = -1

const short	FEATURE_ERROR = -5

const AT_64	ALIGNMENT = 16

constexpr const char *	BALOR_TYPE = "Balor"

constexpr const char *	MARANA_TYPE = "Marana"

constexpr const char *	SIM_TYPE = "Andor SimCam"

constexpr const char *	CAMERA_INTERFACE = "CoaXPress"

constexpr auto	NODE_CAMERA = "Camera"

constexpr auto	NODE_SERVER = "Server"

constexpr auto	FEATURE_SENSOR_COOLING = "SensorCooling"

constexpr auto	FEATURE_TEMPERATURE_CTRL = "TemperatureControl"

constexpr auto	FEATURE_FAN_SPEED = "FanSpeed"

constexpr auto	FEATURE_PIXEL_ENCODING = "PixelEncoding"

constexpr auto	FEATURE_ELECTRONIC_SHUTTERING_MODE = "ElectronicShutteringMode"

constexpr auto	FEATURE_GAIN_MODE = "GainMode"

constexpr auto	FEATURE_METADATA_ENABLE = "MetadataEnable"

constexpr auto	FEATURE_TRIGGER_MODE = "TriggerMode"

constexpr auto	FEATURE_OVERLAP = "Overlap"

constexpr auto	FEATURE_PIXEL_READOUT_RATE = "PixelReadoutRate"

constexpr auto	CTRL_TEMPERATURE_SETPOINT_STR = "ctrl_temperature_setpoint"

constexpr auto	CTRL_FAN_SPEED_STR = "ctrl_fan_speed"

constexpr auto	CTRL_SENSOR_COOLING_STR = "ctrl_sensor_cooling"

constexpr auto	CTRL_GAIN_MODE_STR = "ctrl_gain_mode"

constexpr auto	CTRL_OVERLAP_STR = "ctrl_overlap"

constexpr auto	CTRL_PIXEL_ENCODING_STR = "ctrl_pixel_encoding"

constexpr auto	CTRL_PIXEL_READOUT_RATE_STR = "ctrl_pixel_readout_rate"

constexpr auto	CTRL_ELECTRONIC_SHUTTERING_MODE_STR = "ctrl_electronic_shuttering_mode"

constexpr auto	CTRL_TRIGGER_MODE_STR = "ctrl_trigger_mode"

constexpr auto	STAT_STRIDE_STR = "stride"

constexpr auto	STAT_OVERLAP_STR = "overlap"

constexpr auto	STAT_SENSOR_COOLING_STR = "sensor_cooling"

constexpr auto	STAT_SENSOR_TEMPERATURE_STR = "sensor_temperature"

constexpr auto	STAT_TEMPERATURE_CTRL_STR = "temperature_control"

constexpr auto	STAT_TEMPERATURE_STAT_STR = "temperature_status"

constexpr auto	STAT_PIXEL_ENCODING_STR = "pixel_encoding"

constexpr auto	STAT_PIXEL_READOUT_RATE_STR = "pixel_readout_rate"

constexpr auto	STAT_PRE_AMP_GAIN_CTRL_STR = "pre_amp_gain_control"

constexpr auto	STAT_SIMPLE_PRE_AMP_GAIN_CTRL_STR = "simple_pre_amp_gain_control"

constexpr auto	STAT_CAMERA_STATUS_STR = "camera_status"

constexpr auto	STAT_BIT_DEPTH_STR = "bit_depth"

constexpr auto	STAT_ELECTRONIC_SHUTTERING_MODE_STR = "electronic_shuttering_mode"

constexpr auto	STAT_CMD_ERROR_TEXT_STR = "cmd_error_text"

constexpr auto	STAT_FAN_SPEED_STR = "fan_speed"

constexpr auto	STAT_METADATA_ENABLE_STR = "metadata_enable"

constexpr auto	STAT_TRIGGER_MODE_STR = "trigger_mode"

Detailed Description

CCF Communication Adapter based on the andor SDK.

Frame Grabber Camera Base Class definitions.

Copyright: ESO - European Southern Observatory

Typedef Documentation

◆ AndorCtrlEnumKey

using fgf::andor::AndorCtrlEnumKey

Initial value:

std::variant<fgf::common::SetupParam::ParamEnum,

fgf::andor::SetupParam::ParamEnum>

fgf::andor::SetupParam::ParamEnum

ParamEnum

Definition setupParam.hpp:38

◆ AndorStatEnumKey

using fgf::andor::AndorStatEnumKey

Initial value:

 std::variant<fgf::common::StatusParam::StatusEnum, 
                                         fgf::andor::StatusParam::StatusEnum, 
                                         fgf::common::SetupParam::ParamEnum, 
                                         fgf::andor::SetupParam::ParamEnum>

Enumeration Type Documentation

◆ CameraType

enum fgf::andor::CameraType

Enumerator
UNKNOWN
BALOR
MARANA
SIM

◆ RpcError

enum fgf::andor::RpcError : short

Enumerator
PARAM_SETUP_ERROR

Function Documentation

◆ CopyYaml()

void fgf::andor::CopyYaml	(	const YAML::Node &	src,
		YAML::Node &	dst )

◆ MergeNodes()

YAML::Node fgf::andor::MergeNodes	(	const YAML::Node &	a,
		const YAML::Node &	b )

Variable Documentation

◆ ALIGNMENT

const AT_64 fgf::andor::ALIGNMENT = 16

◆ BALOR_TYPE

constexpr const char* fgf::andor::BALOR_TYPE = "Balor"

constexpr

◆ CAMERA_INTERFACE

constexpr const char* fgf::andor::CAMERA_INTERFACE = "CoaXPress"

constexpr

◆ CONNECT_TIMEOUT

const double fgf::andor::CONNECT_TIMEOUT = 10.0

◆ CTRL_ELECTRONIC_SHUTTERING_MODE_STR

constexpr auto fgf::andor::CTRL_ELECTRONIC_SHUTTERING_MODE_STR = "ctrl_electronic_shuttering_mode"

constexpr

◆ CTRL_FAN_SPEED_STR

constexpr auto fgf::andor::CTRL_FAN_SPEED_STR = "ctrl_fan_speed"

constexpr

◆ CTRL_GAIN_MODE_STR

constexpr auto fgf::andor::CTRL_GAIN_MODE_STR = "ctrl_gain_mode"

constexpr

◆ CTRL_OVERLAP_STR

constexpr auto fgf::andor::CTRL_OVERLAP_STR = "ctrl_overlap"

constexpr

◆ CTRL_PIXEL_ENCODING_STR

constexpr auto fgf::andor::CTRL_PIXEL_ENCODING_STR = "ctrl_pixel_encoding"

constexpr

◆ CTRL_PIXEL_READOUT_RATE_STR

constexpr auto fgf::andor::CTRL_PIXEL_READOUT_RATE_STR = "ctrl_pixel_readout_rate"

constexpr

◆ CTRL_SENSOR_COOLING_STR

constexpr auto fgf::andor::CTRL_SENSOR_COOLING_STR = "ctrl_sensor_cooling"

constexpr

◆ CTRL_TEMPERATURE_SETPOINT_STR

constexpr auto fgf::andor::CTRL_TEMPERATURE_SETPOINT_STR = "ctrl_temperature_setpoint"

constexpr

◆ CTRL_TRIGGER_MODE_STR

constexpr auto fgf::andor::CTRL_TRIGGER_MODE_STR = "ctrl_trigger_mode"

constexpr

◆ DEFAULT_PACKET_SIZE

const int32_t fgf::andor::DEFAULT_PACKET_SIZE = 1500

◆ FEATURE_ELECTRONIC_SHUTTERING_MODE

constexpr auto fgf::andor::FEATURE_ELECTRONIC_SHUTTERING_MODE = "ElectronicShutteringMode"

constexpr

◆ FEATURE_ERROR

const short fgf::andor::FEATURE_ERROR = -5

◆ FEATURE_FAN_SPEED

constexpr auto fgf::andor::FEATURE_FAN_SPEED = "FanSpeed"

constexpr

◆ FEATURE_GAIN_MODE

constexpr auto fgf::andor::FEATURE_GAIN_MODE = "GainMode"

constexpr

◆ FEATURE_METADATA_ENABLE

constexpr auto fgf::andor::FEATURE_METADATA_ENABLE = "MetadataEnable"

constexpr

◆ FEATURE_OVERLAP

constexpr auto fgf::andor::FEATURE_OVERLAP = "Overlap"

constexpr

◆ FEATURE_PIXEL_ENCODING

constexpr auto fgf::andor::FEATURE_PIXEL_ENCODING = "PixelEncoding"

constexpr

◆ FEATURE_PIXEL_READOUT_RATE

constexpr auto fgf::andor::FEATURE_PIXEL_READOUT_RATE = "PixelReadoutRate"

constexpr

◆ FEATURE_SENSOR_COOLING

constexpr auto fgf::andor::FEATURE_SENSOR_COOLING = "SensorCooling"

constexpr

◆ FEATURE_TEMPERATURE_CTRL

constexpr auto fgf::andor::FEATURE_TEMPERATURE_CTRL = "TemperatureControl"

constexpr

◆ FEATURE_TRIGGER_MODE

constexpr auto fgf::andor::FEATURE_TRIGGER_MODE = "TriggerMode"

constexpr

◆ FRAME_REC_THR_SLEEP_TIME

const double fgf::andor::FRAME_REC_THR_SLEEP_TIME = 0.0005

◆ MARANA_TYPE

constexpr const char* fgf::andor::MARANA_TYPE = "Marana"

constexpr

◆ MAX_NB_OF_RECEP_BUFFERS

const uint16_t fgf::andor::MAX_NB_OF_RECEP_BUFFERS = 10

◆ NB_OF_INPUT_BUFFERS

const uint16_t fgf::andor::NB_OF_INPUT_BUFFERS = 5

◆ NODE_CAMERA

constexpr auto fgf::andor::NODE_CAMERA = "Camera"

constexpr

◆ NODE_SERVER

constexpr auto fgf::andor::NODE_SERVER = "Server"

constexpr

◆ RPC_ERROR

const short fgf::andor::RPC_ERROR = -1

◆ RPC_SUCCESS

const short fgf::andor::RPC_SUCCESS = 0

◆ SIM_TYPE

constexpr const char* fgf::andor::SIM_TYPE = "Andor SimCam"

constexpr

◆ STAT_BIT_DEPTH_STR

constexpr auto fgf::andor::STAT_BIT_DEPTH_STR = "bit_depth"

constexpr

◆ STAT_CAMERA_STATUS_STR

constexpr auto fgf::andor::STAT_CAMERA_STATUS_STR = "camera_status"

constexpr

◆ STAT_CMD_ERROR_TEXT_STR

constexpr auto fgf::andor::STAT_CMD_ERROR_TEXT_STR = "cmd_error_text"

constexpr

◆ STAT_ELECTRONIC_SHUTTERING_MODE_STR

constexpr auto fgf::andor::STAT_ELECTRONIC_SHUTTERING_MODE_STR = "electronic_shuttering_mode"

constexpr

◆ STAT_FAN_SPEED_STR

constexpr auto fgf::andor::STAT_FAN_SPEED_STR = "fan_speed"

constexpr

◆ STAT_METADATA_ENABLE_STR

constexpr auto fgf::andor::STAT_METADATA_ENABLE_STR = "metadata_enable"

constexpr

◆ STAT_OVERLAP_STR

constexpr auto fgf::andor::STAT_OVERLAP_STR = "overlap"

constexpr

◆ STAT_PIXEL_ENCODING_STR

constexpr auto fgf::andor::STAT_PIXEL_ENCODING_STR = "pixel_encoding"

constexpr

◆ STAT_PIXEL_READOUT_RATE_STR

constexpr auto fgf::andor::STAT_PIXEL_READOUT_RATE_STR = "pixel_readout_rate"

constexpr

◆ STAT_PRE_AMP_GAIN_CTRL_STR

constexpr auto fgf::andor::STAT_PRE_AMP_GAIN_CTRL_STR = "pre_amp_gain_control"

constexpr

◆ STAT_SENSOR_COOLING_STR

constexpr auto fgf::andor::STAT_SENSOR_COOLING_STR = "sensor_cooling"

constexpr

◆ STAT_SENSOR_TEMPERATURE_STR

constexpr auto fgf::andor::STAT_SENSOR_TEMPERATURE_STR = "sensor_temperature"

constexpr

◆ STAT_SIMPLE_PRE_AMP_GAIN_CTRL_STR

constexpr auto fgf::andor::STAT_SIMPLE_PRE_AMP_GAIN_CTRL_STR = "simple_pre_amp_gain_control"

constexpr

◆ STAT_STRIDE_STR

constexpr auto fgf::andor::STAT_STRIDE_STR = "stride"

constexpr

◆ STAT_TEMPERATURE_CTRL_STR

constexpr auto fgf::andor::STAT_TEMPERATURE_CTRL_STR = "temperature_control"

constexpr

◆ STAT_TEMPERATURE_STAT_STR

constexpr auto fgf::andor::STAT_TEMPERATURE_STAT_STR = "temperature_status"

constexpr

◆ STAT_TRIGGER_MODE_STR

constexpr auto fgf::andor::STAT_TRIGGER_MODE_STR = "trigger_mode"

constexpr

◆ STREAM_BYTES_PER_SECOND_MAX

const uint32_t fgf::andor::STREAM_BYTES_PER_SECOND_MAX = 248000000

◆ STREAM_BYTES_PER_SECOND_MIN

const uint32_t fgf::andor::STREAM_BYTES_PER_SECOND_MIN = 1000000

◆ TIMEOUTMS

const int fgf::andor::TIMEOUTMS = 30000

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ AndorCtrlEnumKey

◆ AndorStatEnumKey

Enumeration Type Documentation

◆ CameraType

◆ RpcError

Function Documentation

◆ CopyYaml()

◆ MergeNodes()

Variable Documentation

◆ ALIGNMENT

◆ BALOR_TYPE

◆ CAMERA_INTERFACE

◆ CONNECT_TIMEOUT

◆ CTRL_ELECTRONIC_SHUTTERING_MODE_STR

◆ CTRL_FAN_SPEED_STR

◆ CTRL_GAIN_MODE_STR

◆ CTRL_OVERLAP_STR

◆ CTRL_PIXEL_ENCODING_STR

◆ CTRL_PIXEL_READOUT_RATE_STR

◆ CTRL_SENSOR_COOLING_STR

◆ CTRL_TEMPERATURE_SETPOINT_STR

◆ CTRL_TRIGGER_MODE_STR

◆ DEFAULT_PACKET_SIZE

◆ FEATURE_ELECTRONIC_SHUTTERING_MODE

◆ FEATURE_ERROR

◆ FEATURE_FAN_SPEED

◆ FEATURE_GAIN_MODE

◆ FEATURE_METADATA_ENABLE

◆ FEATURE_OVERLAP

◆ FEATURE_PIXEL_ENCODING

◆ FEATURE_PIXEL_READOUT_RATE

◆ FEATURE_SENSOR_COOLING

◆ FEATURE_TEMPERATURE_CTRL

◆ FEATURE_TRIGGER_MODE

◆ FRAME_REC_THR_SLEEP_TIME

◆ MARANA_TYPE

◆ MAX_NB_OF_RECEP_BUFFERS

◆ NB_OF_INPUT_BUFFERS

◆ NODE_CAMERA

◆ NODE_SERVER

◆ RPC_ERROR

◆ RPC_SUCCESS

◆ SIM_TYPE

◆ STAT_BIT_DEPTH_STR

◆ STAT_CAMERA_STATUS_STR

◆ STAT_CMD_ERROR_TEXT_STR

◆ STAT_ELECTRONIC_SHUTTERING_MODE_STR

◆ STAT_FAN_SPEED_STR

◆ STAT_METADATA_ENABLE_STR

◆ STAT_OVERLAP_STR

◆ STAT_PIXEL_ENCODING_STR

◆ STAT_PIXEL_READOUT_RATE_STR

◆ STAT_PRE_AMP_GAIN_CTRL_STR

◆ STAT_SENSOR_COOLING_STR

◆ STAT_SENSOR_TEMPERATURE_STR

◆ STAT_SIMPLE_PRE_AMP_GAIN_CTRL_STR

◆ STAT_STRIDE_STR

◆ STAT_TEMPERATURE_CTRL_STR

◆ STAT_TEMPERATURE_STAT_STR

◆ STAT_TRIGGER_MODE_STR

◆ STREAM_BYTES_PER_SECOND_MAX

◆ STREAM_BYTES_PER_SECOND_MIN

◆ TIMEOUTMS