OCAM2K EMCCD Camera

Control of the OCAM2K EMCCD Camera. More...

Collaboration diagram for OCAM2K EMCCD Camera:

Modules
	OCAM2K EMCCD Camera Files

Classes
class	MagAOX::app::ocam2KCtrl
struct	MagAOX::app::ocamTemps
	Structure to hold the OCAM camera temperature readings returned by the device. More...

Functions
int	MagAOX::app::parseTemps (ocamTemps &temps, const std::string &tstr)
	Parse the OCAM temp query and fill the ocamTemps structure.
int	MagAOX::app::parseFPS (float &fps, const std::string &fstr)
	Parse the FPS response.
int	MagAOX::app::parseEMGain (unsigned &emGain, const std::string &fstr)
	Parse the EM gain response.

Detailed Description

Control of the OCAM2K EMCCD Camera.

Application Documentation

Function Documentation

parseEMGain()

int MagAOX::app::parseEMGain	(	unsigned &	emGain,
		const std::string &	fstr
	)

Parse the EM gain response.

Example response: "Gain set to 2 \n\n", with the trailing space. Expects gain >=1 and <= 600, otherwise returns an error.

Tests

• Parsing the gain response [test doc]

Returns

0 on success, and emGain set to a value >= 1

-1 on error, and emGain will be set to 0.

Parameters

[out]	emGain	the value of gain returned by the camera
[in]	fstr	the query response from the camera.

Definition at line 131 of file ocamUtils.hpp.

Referenced by MagAOX::app::ocam2KCtrl::getEMGain(), and ocamUtils_test::SCENARIO().

parseFPS()

int MagAOX::app::parseFPS	(	float &	fps,
		const std::string &	fstr
	)

Parse the FPS response.

Parses the OCAM 2K response to the "fps" query.

Returns

0 on success

-1 on error

Todo:

add test for FPS

Parameters

[out]	fps	the fps returned by the camera
[in]	fstr	the response to parse

Definition at line 104 of file ocamUtils.hpp.

Referenced by MagAOX::app::ocam2KCtrl::getFPS().

parseTemps()

int MagAOX::app::parseTemps	(	ocamTemps &	temps,
		const std::string &	tstr
	)

Parse the OCAM temp query and fill the ocamTemps structure.

Tests

• Parsing the temp response [test doc]

Returns

0 on success

-1 on error

Parameters

[out]	temps	the struture of temperature readings
[in]	tstr	the device response to parse.

Definition at line 71 of file ocamUtils.hpp.

Referenced by MagAOX::app::ocam2KCtrl::getTemps(), and ocamUtils_test::SCENARIO().