dmPokeWFS.hpp File Reference

The MagAO-X DM Poke Centering header file. More...

#include <mx/improc/eigenImage.hpp>
#include <mx/improc/milkImage.hpp>
#include <mx/improc/eigenCube.hpp>
#include "../../ImageStreamIO/pixaccess.hpp"

Include dependency graph for dmPokeWFS.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::dmPokeWFS< derivedT >
	A base class to coordinate poking a deformable mirror's actuators and synchronizedreads of a camera image. More...
struct	MagAOX::app::dev::dmPokeWFS< derivedT >::wfsShmimT
struct	MagAOX::app::dev::dmPokeWFS< derivedT >::darkShmimT

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

Macros
#define	DMPOKEWFS_SETUP_CONFIG(cfig)
	Call dmPokeWFS::setupConfig with error checking. More...
#define	DMPOKEWFS_LOAD_CONFIG(cfig)
	Call dmPokeWFS::loadConfig with error checking. More...
#define	DMPOKEWFS_APP_STARTUP
	Call dmPokeWFS::appStartup with error checking. More...
#define	DMPOKEWFS_APP_LOGIC
	Call dmPokeWFS::appLogic with error checking. More...
#define	DMPOKEWFS_APP_SHUTDOWN
	Call dmPokeWFS::appShutdown with error checking. More...

Functions
template<class derivedT >
	MagAOX::app::dev::INDI_NEWCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_nPokeImages)(const pcf
template<class derivedT >
	MagAOX::app::dev::INDI_NEWCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_nPokeAverage)(const pcf
template<class derivedT >
	MagAOX::app::dev::INDI_NEWCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_poke_amp)(const pcf
template<class derivedT >
	MagAOX::app::dev::INDI_SETCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_wfsFps)(const pcf
template<class derivedT >
	MagAOX::app::dev::INDI_NEWCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_single)(const pcf
template<class derivedT >
	MagAOX::app::dev::INDI_NEWCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_continuous)(const pcf
template<class derivedT >
	MagAOX::app::dev::INDI_NEWCALLBACK_DEFN (dmPokeWFS< derivedT >, m_indiP_stop)(const pcf

Detailed Description

The MagAO-X DM Poke Centering header file.

Definition in file dmPokeWFS.hpp.

Macro Definition Documentation

DMPOKEWFS_APP_LOGIC

#define DMPOKEWFS_APP_LOGIC

Value:

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

Call dmPokeWFS::appLogic with error checking.

Definition at line 1231 of file dmPokeWFS.hpp.

DMPOKEWFS_APP_SHUTDOWN

#define DMPOKEWFS_APP_SHUTDOWN

Value:

    if(dmPokeWFST::appShutdown() < 0)                                                    \
    {                                                                                    \
        log<software_error>({__FILE__, __LINE__, "error from dmPokeWFST::appShutdown"}); \
    }

Call dmPokeWFS::appShutdown with error checking.

Definition at line 1238 of file dmPokeWFS.hpp.

DMPOKEWFS_APP_STARTUP

#define DMPOKEWFS_APP_STARTUP

Value:

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

Call dmPokeWFS::appStartup with error checking.

Definition at line 1224 of file dmPokeWFS.hpp.

DMPOKEWFS_LOAD_CONFIG

#define DMPOKEWFS_LOAD_CONFIG

(

cfig

)

Value:

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

Call dmPokeWFS::loadConfig with error checking.

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

Parameters

cfig	the application configurator

Definition at line 1217 of file dmPokeWFS.hpp.

DMPOKEWFS_SETUP_CONFIG

#define DMPOKEWFS_SETUP_CONFIG

(

cfig

)

Value:

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

Call dmPokeWFS::setupConfig with error checking.

Parameters

cfig	the application configurator

Definition at line 1205 of file dmPokeWFS.hpp.