frameGrabber.hpp File Reference

The MagAO-X generic frame grabber. More...

#include <sys/syscall.h>
#include <mx/sigproc/circularBuffer.hpp>
#include <mx/math/vectorUtils.hpp>
#include <mx/improc/imageUtils.hpp>
#include <ImageStreamIO/ImageStruct.h>
#include <ImageStreamIO/ImageStreamIO.h>
#include "../../common/paths.hpp"

Include dependency graph for frameGrabber.hpp:

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

Go to the source code of this file.

Classes
class	MagAOX::app::dev::frameGrabber< derivedT >

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

Macros
#define	FRAMEGRABBER_SETUP_CONFIG(cfig)
	Call frameGrabberT::setupConfig with error checking for frameGrabber. More...
#define	FRAMEGRABBER_LOAD_CONFIG(cfig)
	Call frameGrabberT::loadConfig with error checking for frameGrabber. More...
#define	FRAMEGRABBER_APP_STARTUP
	Call frameGrabberT::appStartup with error checking for frameGrabber. More...
#define	FRAMEGRABBER_APP_LOGIC
	Call frameGrabberT::appLogic with error checking for frameGrabber. More...
#define	FRAMEGRABBER_UPDATE_INDI
	Call frameGrabberT::updateINDI with error checking for frameGrabber. More...
#define	FRAMEGRABBER_APP_SHUTDOWN
	Call frameGrabberT::appShutdown with error checking for frameGrabber. More...

Detailed Description

The MagAO-X generic frame grabber.

Author

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

Definition in file frameGrabber.hpp.

Macro Definition Documentation

FRAMEGRABBER_APP_LOGIC

#define FRAMEGRABBER_APP_LOGIC

Value:

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

Call frameGrabberT::appLogic with error checking for frameGrabber.

Definition at line 872 of file frameGrabber.hpp.

FRAMEGRABBER_APP_SHUTDOWN

#define FRAMEGRABBER_APP_SHUTDOWN

Value:

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

Call frameGrabberT::appShutdown with error checking for frameGrabber.

Definition at line 886 of file frameGrabber.hpp.

FRAMEGRABBER_APP_STARTUP

#define FRAMEGRABBER_APP_STARTUP

Value:

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

Call frameGrabberT::appStartup with error checking for frameGrabber.

Definition at line 865 of file frameGrabber.hpp.

FRAMEGRABBER_LOAD_CONFIG

#define FRAMEGRABBER_LOAD_CONFIG

(

cfig

)

Value:

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

Call frameGrabberT::loadConfig with error checking for frameGrabber.

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

Parameters

cfig	the application configurator

Definition at line 858 of file frameGrabber.hpp.

FRAMEGRABBER_SETUP_CONFIG

#define FRAMEGRABBER_SETUP_CONFIG

(

cfig

)

Value:

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

Call frameGrabberT::setupConfig with error checking for frameGrabber.

Parameters

cfig	the application configurator

Definition at line 846 of file frameGrabber.hpp.

FRAMEGRABBER_UPDATE_INDI

#define FRAMEGRABBER_UPDATE_INDI

Value:

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

Call frameGrabberT::updateINDI with error checking for frameGrabber.

Definition at line 879 of file frameGrabber.hpp.