stdCamera.hpp File Reference

Standard camera interface. More...

#include <string>
#include <unordered_map>
#include <mx/app/application.hpp>
#include "../MagAOXApp.hpp"

Include dependency graph for stdCamera.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	MagAOX::app::dev::cameraConfig
	A camera configuration. More...
class	MagAOX::app::dev::stdCamera< derivedT >
	MagAO-X standard camera interface. More...
struct	MagAOX::app::dev::stdCamera< derivedT >::roi

Namespaces
namespace	MagAOX
namespace	MagAOX::app
namespace	MagAOX::app::dev

Macros
#define	CAMCTRL_E_NOCONFIGS   ( -10 )
#define	STDCAMERA_SETUP_CONFIG(cfig)
	Call stdCameraT::setupConfig with error checking for stdCamera.
#define	STDCAMERA_LOAD_CONFIG(cfig)
	Call stdCameraT::loadConfig with error checking for stdCamera.
#define	STDCAMERA_APP_STARTUP
	Call stdCameraT::appStartup with error checking for stdCamera.
#define	STDCAMERA_APP_LOGIC
	Call stdCameraT::appLogic with error checking for stdCamera.
#define	STDCAMERA_UPDATE_INDI
	Call stdCameraT::updateINDI with error checking for stdCamera.
#define	STDCAMERA_APP_SHUTDOWN
	Call stdCameraT::appShutdown with error checking for stdCamera.

Typedefs
typedef std::unordered_map< std::string, cameraConfig >	MagAOX::app::dev::cameraConfigMap

Functions
int	MagAOX::app::dev::loadCameraConfig (cameraConfigMap &ccmap, mx::app::appConfigurator &config)
	Load the camera configurations contained in the app configuration into a map.

Detailed Description

Standard camera interface.

Author

Jared R. Males (jared.nosp@m.male.nosp@m.s@gma.nosp@m.il.c.nosp@m.om)

Definition in file stdCamera.hpp.

---

Class Documentation

MagAOX::app::dev::cameraConfig

struct MagAOX::app::dev::cameraConfig

A camera configuration.

a.k.a. a mode

Definition at line 31 of file stdCamera.hpp.

Collaboration diagram for MagAOX::app::dev::cameraConfig:

Class Members
unsigned	m_binningX { 0 }
unsigned	m_binningY { 0 }
unsigned	m_centerX { 0 }
unsigned	m_centerY { 0 }
string	m_configFile	The file to use for this mode, e.g. an EDT configuration file.
unsigned	m_digitalBinX { 0 }
unsigned	m_digitalBinY { 0 }
float	m_maxFPS { 0 }
string	m_serialCommand	The command to send to the camera to place it in this mode.
unsigned	m_sizeX { 0 }
unsigned	m_sizeY { 0 }

MagAOX::app::dev::stdCamera::roi

struct MagAOX::app::dev::stdCamera::roi

template<class derivedT>
struct MagAOX::app::dev::stdCamera< derivedT >::roi

Definition at line 416 of file stdCamera.hpp.

Collaboration diagram for MagAOX::app::dev::stdCamera< derivedT >::roi:

Class Members
int	bin_x { 0 }
int	bin_y { 0 }
int	h { 0 }
int	w { 0 }
float	x { 0 }
float	y { 0 }

Macro Definition Documentation

CAMCTRL_E_NOCONFIGS

#define CAMCTRL_E_NOCONFIGS   ( -10 )

Definition at line 26 of file stdCamera.hpp.

STDCAMERA_APP_LOGIC

#define STDCAMERA_APP_LOGIC

Value:

    if( stdCameraT::appLogic() < 0 )                                                                                   \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from stdCameraT::appLogic" } );                   \
    }

Call stdCameraT::appLogic with error checking for stdCamera.

Definition at line 3348 of file stdCamera.hpp.

STDCAMERA_APP_SHUTDOWN

#define STDCAMERA_APP_SHUTDOWN

Value:

    if( stdCameraT::appShutdown() < 0 )                                                                                \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from stdCameraT::appShutdown" } );                \
    }

Call stdCameraT::appShutdown with error checking for stdCamera.

Definition at line 3362 of file stdCamera.hpp.

STDCAMERA_APP_STARTUP

#define STDCAMERA_APP_STARTUP

Value:

    if( stdCameraT::appStartup() < 0 )                                                                                 \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from stdCameraT::appStartup" } );                 \
    }

Call stdCameraT::appStartup with error checking for stdCamera.

Definition at line 3341 of file stdCamera.hpp.

STDCAMERA_LOAD_CONFIG

#define STDCAMERA_LOAD_CONFIG

(

cfig

)

Value:

    if( stdCameraT::loadConfig( cfig ) < 0 )                                                                           \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from stdCameraT::loadConfig" } );                 \
    }

Call stdCameraT::loadConfig with error checking for stdCamera.

This must be inside a function that returns int, e.g. the standard loadConfigImpl.

Parameters

cfig	the application configurator

Definition at line 3334 of file stdCamera.hpp.

STDCAMERA_SETUP_CONFIG

#define STDCAMERA_SETUP_CONFIG

(

cfig

)

Value:

    if( stdCameraT::setupConfig( cfig ) < 0 )                                                                          \
    {                                                                                                                  \
        log<software_error>( { __FILE__, __LINE__, "Error from stdCameraT::setupConfig" } );                           \
        m_shutdown = true;                                                                                             \
        return;                                                                                                        \
    }

Call stdCameraT::setupConfig with error checking for stdCamera.

Parameters

cfig	the application configurator

Definition at line 3322 of file stdCamera.hpp.

STDCAMERA_UPDATE_INDI

#define STDCAMERA_UPDATE_INDI

Value:

    if( stdCameraT::updateINDI() < 0 )                                                                                 \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from stdCameraT::updateINDI" } );                 \
    }

Call stdCameraT::updateINDI with error checking for stdCamera.

Definition at line 3355 of file stdCamera.hpp.