API

The MagAO-X generic deformable mirror controller. More...

#include <mx/improc/eigenImage.hpp>
#include <mx/ioutils/fits/fitsFile.hpp>
#include <boost/filesystem/operations.hpp>
#include "../../ImageStreamIO/ImageStruct.hpp"
Include dependency graph for dm.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::dm< derivedT, realT >
 

Namespaces

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

Macros

#define DM_SETUP_CONFIG(cfig)
 Call dmT::setupConfig with error checking for dm. More...
 
#define DM_LOAD_CONFIG(cfig)
 Call dmT::loadConfig with error checking for dm. More...
 
#define DM_APP_STARTUP
 Call shmimMonitorT::appStartup with error checking for dm. More...
 
#define DM_APP_LOGIC
 Call dmT::appLogic with error checking for dm. More...
 
#define DM_UPDATE_INDI
 Call dmT::updateINDI with error checking for dm. More...
 
#define DM_APP_SHUTDOWN
 Call dmT::appShutdown with error checking for dm. More...
 

Functions

template<typename typeT >
constexpr uint8_t MagAOX::app::dev::ImageStreamTypeCode ()
 
template<>
constexpr uint8_t MagAOX::app::dev::ImageStreamTypeCode< float > ()
 
template<>
constexpr uint8_t MagAOX::app::dev::ImageStreamTypeCode< double > ()
 

Detailed Description

The MagAO-X generic deformable mirror controller.

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

Definition in file dm.hpp.

Macro Definition Documentation

◆ DM_APP_LOGIC

#define DM_APP_LOGIC
Value:
if (dmT::appLogic() < 0) \
{ \
return log<software_error, -1>({__FILE__, __LINE__, "Error from dmT::appLogic"}); \
}

Call dmT::appLogic with error checking for dm.

Definition at line 2351 of file dm.hpp.

◆ DM_APP_SHUTDOWN

#define DM_APP_SHUTDOWN
Value:
if (dmT::appShutdown() < 0) \
{ \
return log<software_error, -1>({__FILE__, __LINE__, "Error from dmT::appShutdown"}); \
}

Call dmT::appShutdown with error checking for dm.

Definition at line 2365 of file dm.hpp.

◆ DM_APP_STARTUP

#define DM_APP_STARTUP
Value:
if (dmT::appStartup() < 0) \
{ \
return log<software_error, -1>({__FILE__, __LINE__, "Error from dmT::appStartup"}); \
}

Call shmimMonitorT::appStartup with error checking for dm.

Definition at line 2344 of file dm.hpp.

◆ DM_LOAD_CONFIG

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

Call dmT::loadConfig with error checking for dm.

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

Parameters
cfigthe application configurator

Definition at line 2337 of file dm.hpp.

◆ DM_SETUP_CONFIG

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

Call dmT::setupConfig with error checking for dm.

Parameters
cfigthe application configurator

Definition at line 2325 of file dm.hpp.

◆ DM_UPDATE_INDI

#define DM_UPDATE_INDI
Value:
if (dmT::updateINDI() < 0) \
{ \
return log<software_error, -1>({__FILE__, __LINE__, "Error from dmT::updateINDI"}); \
}

Call dmT::updateINDI with error checking for dm.

Definition at line 2358 of file dm.hpp.