The MagAO-X PSD-based gain optimizer. More...

#include <modalGainOpt.hpp>

Inheritance diagram for MagAOX::app::modalGainOpt:

Collaboration diagram for MagAOX::app::modalGainOpt:

Public Types
typedef dev::shmimMonitor< modalGainOpt, psdShmimT >	psdShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, freqShmimT >	freqShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, gainFactShmimT >	gainFactShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, multFactShmimT >	multFactShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, pcGainFactShmimT >	pcGainFactShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, pcMultFactShmimT >	pcMultFactShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, numpccoeffShmimT >	numpccoeffShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, acoeffShmimT >	acoeffShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, bcoeffShmimT >	bcoeffShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, gainCalShmimT >	gainCalShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, gainCalFactShmimT >	gainCalFactShmimMonitorT

typedef dev::shmimMonitor< modalGainOpt, tauShmimT >	tauShmimMonitorT

typedef std::chrono::time_point< std::chrono::steady_clock >	timePointT

typedef std::chrono::duration< double >	durationT

typedef logger::logManager< MagAOXApp< _useINDI >, logFileRaw >	logManagerT
	The log manager type.

Public Member Functions
	modalGainOpt ()
	Default c'tor.

	~modalGainOpt () noexcept
	D'tor, declared and defined for noexcept.

virtual void	setupConfig ()

int	loadConfigImpl (mx::app::appConfigurator &_config)
	Implementation of loadConfig logic, separated for testing.

virtual void	loadConfig ()

virtual int	appStartup ()
	Startup function.

virtual int	appLogic ()
	Implementation of the FSM for modalGainOpt.

virtual int	appShutdown ()
	Shutdown the app.

int	allocate (const psdShmimT &)

int	processImage (void *curr_src, const psdShmimT &)

int	allocate (const freqShmimT &)

int	processImage (void *curr_src, const freqShmimT &)

int	allocate (const gainFactShmimT &)

int	processImage (void *curr_src, const gainFactShmimT &)

int	allocate (const multFactShmimT &)

int	processImage (void *curr_src, const multFactShmimT &)

int	allocate (const pcGainFactShmimT &)

int	processImage (void *curr_src, const pcGainFactShmimT &)

int	allocate (const pcMultFactShmimT &)

int	processImage (void *curr_src, const pcMultFactShmimT &)

int	allocate (const numpccoeffShmimT &)

int	processImage (void *curr_src, const numpccoeffShmimT &)

int	allocate (const acoeffShmimT &)

int	processImage (void *curr_src, const acoeffShmimT &)

int	allocate (const bcoeffShmimT &)

int	processImage (void *curr_src, const bcoeffShmimT &)

int	allocate (const gainCalShmimT &)

int	processImage (void *curr_src, const gainCalShmimT &)

int	allocate (const gainCalFactShmimT &)

int	processImage (void *curr_src, const gainCalFactShmimT &)

int	allocate (const tauShmimT &)

int	processImage (void *curr_src, const tauShmimT &)

int	shutdown ()
	Get the value of the shutdown flag.

virtual void	setDefaults (int argc, char **argv)
	Set the paths for config files.

virtual void	setupBasicConfig ()
	The basic MagAO-X configuration setup method. Should not normally be overridden.

virtual void	loadBasicConfig ()
	The basic MagAO-X configuration processing method. Should not normally be overridden.

virtual void	checkConfig ()
	Check for unused and unrecognized config options and settings.

virtual int	execute ()
	The execute method implementing the standard main loop. Should not normally be overridden.

Threads
int	threadStart (std::thread &thrd, bool &thrdInit, pid_t &tpid, pcf::IndiProperty &thProp, int thrdPrio, const std::string &cpuset, const std::string &thrdName, thisPtr *thrdThis, Function &&thrdStart)
	Start a thread, using this class's privileges to set priority, etc.

Member Accessors
std::string	configName ()
	Get the config name.

std::string	configDir ()
	Get the config directory.

std::string	driverInName ()
	Get the INDI input FIFO file name.

std::string	driverOutName ()
	Get the INDI output FIFO file name.

std::string	driverCtrlName ()
	Get the INDI control FIFO file name.

Protected Attributes
bool	m_updateOnce { false }
	Flag to trigger a single update with gain.

bool	m_dump { false }
	Flag to trigger a single update with no gain.

float	m_fps { 0 }

std::vector< mx::AO::analysis::clGainOpt< float > >	m_goptCurrent
	Each mode gets its own gain optimizer.

std::vector< mx::AO::analysis::clGainOpt< float > >	m_goptSI

std::vector< mx::AO::analysis::clGainOpt< float > >	m_goptLP

std::vector< mx::AO::analysis::clAOLinearPredictor< float > >	m_linPred

bool	m_goptUpdated { true }
	Tracks if a parameter has updated requiring updates to the m_gopt entries.

bool	m_pcgoptUpdated { true }
	Tracks if a parameter has updated requiring updates to the m_gopt entries.

bool	m_freqUpdated { true }

float	m_psdTime { 1 }

float	m_psdAvgTime { 10 }

float	m_psdOverlapFraction { 0.5 }

std::vector< float >	m_freq

mx::improc::eigenImage< float >	m_clPSDs

mx::improc::eigenImage< float >	m_clXferCurrent

mx::improc::eigenImage< float >	m_clXferSI

mx::improc::eigenImage< float >	m_clXferLP

std::vector< std::vector< float > >	m_olPSDs

std::vector< std::vector< float > >	m_nPSDs

std::vector< float >	m_optGainSI

std::vector< float >	m_modeVarSI

std::vector< float >	m_optGainLP

std::vector< float >	m_modeVarLP

bool	m_loop { false }

float	m_gain { 0 }

float	m_mult { 1 }

float	m_siGain { 0 }

float	m_siMult { 1 }

float	m_pcGain { 0 }

float	m_pcMult { 0 }

bool	m_pcOn { false }

std::vector< float >	m_gainFacts

std::vector< float >	m_multFacts

std::vector< float >	m_pcGainFacts

std::vector< float >	m_pcMultFacts

std::vector< int >	m_Na

std::vector< int >	m_NaCurrent

std::vector< int >	m_Nb

std::vector< int >	m_NbCurrent

eigenImage< float >	m_as

eigenImage< float >	m_bs

std::vector< float >	m_gmaxLP
	The previously calculated maximum gains for LP.

int	m_nRegCycles { 60 }
	How often to regularize each mode.

std::vector< int >	m_regCounter
	Counters to track when this mode was last regularized.

std::vector< float >	m_regScale
	The regularizatio scale factors for each mode.

std::vector< float >	m_gainCals

std::vector< float >	m_gainCalFacts

std::vector< float >	m_taus

int	m_sinceChange { -1 }

std::string	m_olPSDShmimName

std::string	m_clXferCurrentShmimName

std::string	m_clXferSIShmimName

std::string	m_clXferLPShmimName

std::string	m_optGainShmimName

std::string	m_optGainSIShmimName

std::string	m_optGainLPShmimName

IMAGE *	m_olPSDStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the open loop PSDs.

IMAGE *	m_clXferCurrentStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the SI ETF.

IMAGE *	m_clXferSIStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the SI ETF.

IMAGE *	m_clXferLPStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the LP ETF.

IMAGE *	m_optGainStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the optimal gains.

IMAGE *	m_optGainSIStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the SI optimal gains.

IMAGE *	m_optGainLPStream { nullptr }
	The ImageStreamIO shared memory buffer to publish the LP optimal gains.

std::mutex	m_goptMutex
	Mutex for synchronizing updates.

bool	m_updating { false }
	Flag used to indicate to the goptThread that it should stop calculations ASAP.

std::string	MagAOXPath
	The base path of the MagAO-X system.

std::string	m_configName
	The name of the configuration file (minus .conf).

std::string	m_configDir
	The path to configuration files for MagAOX.

std::string	m_configBase
	The name of a base config class for this app (minus .conf).

std::string	m_calibDir
	The path to calibration files for MagAOX.

std::string	sysPath
	The path to the system directory, for PID file, etc.

std::string	secretsPath
	Path to the secrets directory, where passwords, etc, are stored.

unsigned long	m_loopPause

int	m_shutdown
	Flag to signal it's time to shutdown. When not 0, the main loop exits.

Configurable Parameters
int	m_loopNum { 1 }
	The number of the loop. Used to set shmim names, as in aolN_mgainfact.

std::string	m_loopName
	The name of the loop control INDI device name.

std::string	m_psdDevice

bool	m_autoUpdate { false }
	Flag controlling whether gains are automatically updated.

float	m_gainGain { 0.1 }
	The gain to use for closed-loop gain updates. Default is 0.1.

cpusets
The path to the cpusets mount is configured by the environment varialbe defined by MAGOX_env_cpuset in environment.hpp. This environment varialbe is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used. This is normally "/opt/MagAOX/cpuset/"
std::string	m_cpusetPath

Private Member Functions
int	clearFSMAlert ()
	Clear the FSM alert state.

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

modalGainOpt &	derived ()

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

Private Attributes
bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

int	m_semaphoreNumber
	The image structure semaphore index.

uint32_t	m_width
	The width of the images in the stream.

uint32_t	m_height
	The height of the images in the stream.

uint32_t	m_depth
	The depth of the circular buffer in the stream.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer.

ino_t	m_inode
	The inode of the image stream file.

Configurable Parameters
std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default.

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00.

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

INDI Interface
For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property.
typedef std::pair< std::string, indiCallBack >	callBackValueType
	Value type of the indiCallBack map.

typedef std::unordered_map< std::string, indiCallBack >::iterator	callBackIterator
	Iterator type of the indiCallBack map.

typedef std::pair< callBackIterator, bool >	callBackInsertResult
	Return type of insert on the indiCallBack map.

std::unordered_map< std::string, indiCallBack >	m_indiNewCallBacks
	Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

std::unordered_map< std::string, indiCallBack >	m_indiSetCallBacks
	Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.

bool	m_allDefsReceived
	Flag indicating that all registered Set properties have been updated since last Get.

std::string	m_driverInName
	Full path name of the INDI driver input FIFO.

std::string	m_driverOutName
	Full path name of the INDI driver output FIFO.

std::string	m_driverCtrlName
	Full path name of the INDI driver control FIFO.

pcf::IndiProperty	m_indiP_state
	indi Property to report the application state.

pcf::IndiProperty	m_indiP_clearFSMAlert
	indi Property to clear an FSM alert.

indiDriver< MagAOXApp > *	m_indiDriver
	The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

std::mutex	m_indiMutex
	Mutex for locking INDI communications.

int	createStandardIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Text property with target and current elements.

int	createROIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &elName, const std::string &propLabel="", const std::string &propGroup="", const std::string &elLabel="")
	Create a standard ReadOnly INDI Text property, with at least one element.

int	createStandardIndiNumber (pcf::IndiProperty &prop, const std::string &name, const T &min, const T &max, const T &step, const std::string &format, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Number property with target and current elements.

int	createROIndiNumber (pcf::IndiProperty &prop, const std::string &propName, const std::string &propLabel="", const std::string &propGroup="")
	Create a ReadOnly INDI Number property.

int	createStandardIndiToggleSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single toggle element.

int	createStandardIndiRequestSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single request element.

int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::vector< std::string > &elementLabels, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.

int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::string &label="", const std::string &group="")

int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop)
	Register an INDI property which is read only.

int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState)
	Register an INDI property which is read only.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, const pcf::IndiProperty::SwitchRuleType &propRule, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for, with a switch rule.

int	registerIndiPropertySet (pcf::IndiProperty &prop, const std::string &devName, const std::string &propName, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is monitored for updates from others.

void	sendGetPropertySetList (bool all=false)

void	handleDefProperty (const pcf::IndiProperty &ipRecv)
	Handler for the DEF INDI properties notification.

void	handleGetProperties (const pcf::IndiProperty &ipRecv)
	Handler for the get INDI properties request.

void	handleNewProperty (const pcf::IndiProperty &ipRecv)
	Handler for the new INDI property request.

void	handleSetProperty (const pcf::IndiProperty &ipRecv)
	Handler for the set INDI property request.

static int	st_newCallBack_clearFSMAlert (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for requesting to clear the FSM alert.

int	createINDIFIFOS ()
	Create the INDI FIFOs.

int	startINDI ()
	Start INDI Communications.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const T &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const char *newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::vector< std::string > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.

void	updateSwitchIfChanged (pcf::IndiProperty &p, const std::string &el, const pcf::IndiElement::SwitchStateType &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI switch element value if it has changed.

void	updatesIfChanged (pcf::IndiProperty &p, const std::vector< const char * > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)

int	indiTargetUpdate (pcf::IndiProperty &localProperty, T &localTarget, const pcf::IndiProperty &remoteProperty, bool setBusy=true)
	Get the target element value from an new property.

int	sendNewProperty (const pcf::IndiProperty &ipSend, const std::string &el, const T &newVal)
	Send a newProperty command to another device (using the INDI Client interface)

int	sendNewProperty (const pcf::IndiProperty &ipSend)
	Send a newProperty command to another device (using the INDI Client interface)

int	sendNewStandardIndiToggle (const std::string &device, const std::string &property, bool onoff)
	Send a new property commmand for a standard toggle switch.

int	newCallBack_clearFSMAlert (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the FSM Alert Clear request.

static constexpr bool	m_useINDI
	Flag controlling whether INDI is used. If false, then no INDI code executes.

Gain Optimization Thread
int	m_goptThreadPrio { 0 }
	Priority of the gain optimization thread.

std::string	m_goptThreadCpuset
	The cpuset to use for the gain optimization thread.

std::thread	m_goptThread
	The gain optimization thread.

bool	m_goptThreadInit { true }
	Initialization flag for the gain optimization thread.

pid_t	m_goptThreadID { 0 }
	gain optimization thread PID.

pcf::IndiProperty	m_goptThreadProp
	The property to hold the gain optimization thread details.

sem_t	m_goptSemaphore
	Semaphore used to synchronize the psdShmim thread and the gopt thread.

static void	goptThreadStart (modalGainOpt *p)
	Gain Optimization thread starter function.

void	goptThreadExec ()
	Gain optimization thread function.

PID Locking
Each MagAOXApp has a PID lock file in the system directory. The app will not startup if it detects that the PID is already locked, preventing duplicates. This is based on the configured name, not the invoked name (argv[0]).
std::string	pidFileName
	The name of the PID file.

pid_t	m_pid
	This process's PID.

int	lockPID ()

int	unlockPID ()
	Remove the PID file.

Power Management
For devices which have remote power management (e.g. from one of the PDUs) we implement a standard power state monitoring and management component for the FSM. This needs to be enabled in the derived app constructor. To stay enabled, m_powerDevice and m_powerChannel must be not empty strings after the configuration. These could be set in the derived app defaults. If power management is enabled, then while power is off, appLogic will not be called. Instead a parrallel set of virtual functions is called, onPowerOff (to allow apps to perform cleanup) and whilePowerOff (to allow apps to keep variables updated, etc). Note that these could merely call appLogic if desired.
bool	m_powerMgtEnabled

std::string	m_powerDevice
	The INDI device name of the power controller.

std::string	m_powerChannel
	The INDI property name of the channel controlling this device's power.

std::string	m_powerElement
	The INDI element name to monitor for this device's power state.

std::string	m_powerTargetElement
	The INDI element name to monitor for this device's power state.

unsigned long	m_powerOnWait
	Time in sec to wait for device to boot after power on.

int	m_powerOnCounter

int	m_powerState
	Current power state, 1=On, 0=Off, -1=Unk.

int	m_powerTargetState
	Current target power state, 1=On, 0=Off, -1=Unk.

pcf::IndiProperty	m_indiP_powerChannel
	INDI property used to communicate power state.

int	powerState ()
	Returns the current power state.

int	powerStateTarget ()
	Returns the target power state.

	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

virtual int	onPowerOff ()
	This method is called when the change to poweroff is detected.

virtual int	whilePowerOff ()
	This method is called while the power is off, once per FSM loop.

bool	powerOnWaitElapsed ()
	This method tests whether the power on wait time has elapsed.

INDI
pcf::IndiProperty	m_indiP_autoUpdate

pcf::IndiProperty	m_indiP_updateOnce

pcf::IndiProperty	m_indiP_dump

pcf::IndiProperty	m_indiP_gainGain

pcf::IndiProperty	m_indiP_fps

pcf::IndiProperty	m_indiP_psdTime

pcf::IndiProperty	m_indiP_psdAvgTime

pcf::IndiProperty	m_indiP_loop

pcf::IndiProperty	m_indiP_siGain

pcf::IndiProperty	m_indiP_siMult

pcf::IndiProperty	m_indiP_pcGain

pcf::IndiProperty	m_indiP_pcMult

pcf::IndiProperty	m_indiP_pcOn

	INDI_NEWCALLBACK_DECL (modalGainOpt, m_indiP_autoUpdate)

	INDI_NEWCALLBACK_DECL (modalGainOpt, m_indiP_updateOnce)

	INDI_NEWCALLBACK_DECL (modalGainOpt, m_indiP_dump)

	INDI_NEWCALLBACK_DECL (modalGainOpt, m_indiP_gainGain)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_fps)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_psdTime)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_psdAvgTime)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_loop)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_siGain)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_siMult)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_pcGain)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_pcMult)

	INDI_SETCALLBACK_DECL (modalGainOpt, m_indiP_pcOn)

Logging
void	logMessage (bufferPtrT &b)
	Handle a log message from the logging system.

static void	configLog (const std::string &name, const int &code, const std::string &value, const std::string &source)
	Callback for config system logging.

static logManagerT	m_log

static int	log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.

static int	log (logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.

Application State
stateCodes::stateCodeT	state ()
	Get the current state code.

void	state (const stateCodes::stateCodeT &s, bool stateAlert=false)
	Set the current state code.

int	stateLogged ()
	Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

stateCodes::stateCodeT	m_state

bool	m_stateAlert

bool	m_gitAlert

int	m_stateLogged

Signal Handling
libMagAOX/logger/types/software_log.hpp
static MagAOXApp *	m_self

int	setSigTermHandler ()
	Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

void	handlerSigTerm (int signum, siginfo_t siginf, void ucont)
	Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.

static void	_handlerSigTerm (int signum, siginfo_t siginf, void ucont)
	The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

SIGSEGV & SIGBUS signal handling
These signals occur as a result of a ImageStreamIO source server resetting (e.g. changing frame sizes). When they occur a restart of the shmim monitor thread main loops is triggered.
static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

static shmimMonitor *	m_selfMonitor
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

Privilege Management
uid_t	m_euidReal
	The real user id of the proces (i.e. the lower privileged id of the user)

uid_t	m_euidCalled

uid_t	m_suid
	The save-set user id of the process.

int	setEuidCalled ()
	Set the effective user ID to the called value, i.e. the highest possible.

int	setEuidReal ()
	Set the effective user ID to the real value, i.e. the file owner.

shmimmonitor Thread
This thread actually monitors the shared memory buffer
bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_smThreadID
	The s.m. thread PID.

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details.

std::thread	m_smThread
	A separate thread for the actual monitoring.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

void	smThreadExec ()
	Execute the monitoring thread.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

INDI
pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

int	updateINDI ()
	Update the INDI properties for this device controller.

Detailed Description

The MagAO-X PSD-based gain optimizer.

Definition at line 194 of file modalGainOpt.hpp.

Member Typedef Documentation

◆ acoeffShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, acoeffShmimT> MagAOX::app::modalGainOpt::acoeffShmimMonitorT

Definition at line 233 of file modalGainOpt.hpp.

◆ bcoeffShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, bcoeffShmimT> MagAOX::app::modalGainOpt::bcoeffShmimMonitorT

Definition at line 234 of file modalGainOpt.hpp.

◆ callBackInsertResult

typedef std::pair<callBackIterator, bool> MagAOX::app::MagAOXApp< _useINDI >::callBackInsertResult

inherited

Return type of insert on the indiCallBack map.

Definition at line 567 of file MagAOXApp.hpp.

◆ callBackIterator

typedef std::unordered_map<std::string,indiCallBack>::iterator MagAOX::app::MagAOXApp< _useINDI >::callBackIterator

inherited

Iterator type of the indiCallBack map.

Definition at line 564 of file MagAOXApp.hpp.

◆ callBackValueType

typedef std::pair<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::callBackValueType

inherited

Value type of the indiCallBack map.

Definition at line 561 of file MagAOXApp.hpp.

◆ durationT

typedef std::chrono::duration<double> MagAOX::app::modalGainOpt::durationT

Definition at line 240 of file modalGainOpt.hpp.

◆ freqShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, freqShmimT> MagAOX::app::modalGainOpt::freqShmimMonitorT

Definition at line 227 of file modalGainOpt.hpp.

◆ gainCalFactShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, gainCalFactShmimT> MagAOX::app::modalGainOpt::gainCalFactShmimMonitorT

Definition at line 236 of file modalGainOpt.hpp.

◆ gainCalShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, gainCalShmimT> MagAOX::app::modalGainOpt::gainCalShmimMonitorT

Definition at line 235 of file modalGainOpt.hpp.

◆ gainFactShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, gainFactShmimT> MagAOX::app::modalGainOpt::gainFactShmimMonitorT

Definition at line 228 of file modalGainOpt.hpp.

◆ logManagerT

typedef logger::logManager<MagAOXApp<_useINDI>, logFileRaw> MagAOX::app::MagAOXApp< _useINDI >::logManagerT

inherited

The log manager type.

Definition at line 78 of file MagAOXApp.hpp.

◆ multFactShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, multFactShmimT> MagAOX::app::modalGainOpt::multFactShmimMonitorT

Definition at line 229 of file modalGainOpt.hpp.

◆ numpccoeffShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, numpccoeffShmimT> MagAOX::app::modalGainOpt::numpccoeffShmimMonitorT

Definition at line 232 of file modalGainOpt.hpp.

◆ pcGainFactShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, pcGainFactShmimT> MagAOX::app::modalGainOpt::pcGainFactShmimMonitorT

Definition at line 230 of file modalGainOpt.hpp.

◆ pcMultFactShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, pcMultFactShmimT> MagAOX::app::modalGainOpt::pcMultFactShmimMonitorT

Definition at line 231 of file modalGainOpt.hpp.

◆ psdShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, psdShmimT> MagAOX::app::modalGainOpt::psdShmimMonitorT

Definition at line 226 of file modalGainOpt.hpp.

◆ tauShmimMonitorT

typedef dev::shmimMonitor<modalGainOpt, tauShmimT> MagAOX::app::modalGainOpt::tauShmimMonitorT

Definition at line 237 of file modalGainOpt.hpp.

◆ timePointT

typedef std::chrono::time_point<std::chrono::steady_clock> MagAOX::app::modalGainOpt::timePointT

Definition at line 239 of file modalGainOpt.hpp.

Constructor & Destructor Documentation

◆ modalGainOpt()

MagAOX::app::modalGainOpt::modalGainOpt ( )

Default c'tor.

Definition at line 562 of file modalGainOpt.hpp.

◆ ~modalGainOpt()

MagAOX::app::modalGainOpt::~modalGainOpt ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 372 of file modalGainOpt.hpp.

Member Function Documentation

◆ _handlerSigTerm()

void MagAOX::app::MagAOXApp< _useINDI >::_handlerSigTerm	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

staticprivateinherited

The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

Parameters

[in]	signum	specifies the signal.
[in]	siginf	ignored by MagAOXApp
[in]	ucont	ignored by MagAOXApp

Definition at line 1857 of file modalGainOpt.hpp.

◆ appLogic()

int MagAOX::app::modalGainOpt::appLogic ( )

virtual

Implementation of the FSM for modalGainOpt.

Returns: 0 on no critical error; -1 on an error requiring shutdown

Implements MagAOX::app::MagAOXApp< true >.

Definition at line 782 of file modalGainOpt.hpp.

◆ appShutdown()

int MagAOX::app::modalGainOpt::appShutdown ( )

virtual

Shutdown the app.

Implements MagAOX::app::MagAOXApp< true >.

Definition at line 844 of file modalGainOpt.hpp.

◆ appStartup()

int MagAOX::app::modalGainOpt::appStartup ( )

virtual

Startup function.

Implements MagAOX::app::MagAOXApp< true >.

Definition at line 734 of file modalGainOpt.hpp.

◆ checkConfig()

void MagAOX::app::MagAOXApp< _useINDI >::checkConfig ( )

virtualinherited

Check for unused and unrecognized config options and settings.

Logs the unused targets as warnings. Unrecognized and unused options are logged as critical, and m_shutdown is set. Any command line argument (not an option) will also be critical and cause shutdown.

Definition at line 170 of file MagAOXApp.hpp.

◆ clearFSMAlert()

int MagAOX::app::MagAOXApp< _useINDI >::clearFSMAlert ( )

privateinherited

Clear the FSM alert state.

This can only be done from within this class, and this should only be possible via user action via INDI.

Definition at line 525 of file MagAOXApp.hpp.

◆ configDir()

std::string MagAOX::app::MagAOXApp< _useINDI >::configDir ( )

inherited

Get the config directory.

Returns: the current value of m_configDir

Definition at line 1108 of file MagAOXApp.hpp.

◆ configLog()

void MagAOX::app::MagAOXApp< _useINDI >::configLog	(	const std::string &	name,
		const int &	code,
		const std::string &	value,
		const std::string &	source
	)

staticprotectedinherited

Callback for config system logging.

Called by appConfigurator each time a value is set using the config() operator. You never need to call this directly.

Parameters

[in]	name	The name of the config value
[in]	code	numeric code specifying the type
[in]	value	the value read by the config system
[in]	source	the source of the value.

Definition at line 276 of file MagAOXApp.hpp.

◆ configName()

std::string MagAOX::app::MagAOXApp< _useINDI >::configName ( )

inherited

Get the config name.

Returns: the current value of m_configName

Definition at line 1102 of file MagAOXApp.hpp.

◆ createINDIFIFOS()

int MagAOX::app::MagAOXApp< _useINDI >::createINDIFIFOS ( )

protectedinherited

Create the INDI FIFOs.

Changes permissions to max available and creates the FIFOs at the configured path.

Todo:: make driver FIFO path full configurable.

Definition at line 811 of file MagAOXApp.hpp.

◆ createROIndiNumber()

int MagAOX::app::MagAOXApp< _useINDI >::createROIndiNumber	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	propLabel = `""`,
		const std::string &	propGroup = `""`
	)

inherited

Create a ReadOnly INDI Number property.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	propLabel	[optional] the GUI label suggestion for this property
[in]	propGroup	[optional] the group for this property

Definition at line 649 of file MagAOXApp.hpp.

◆ createROIndiText()

int MagAOX::app::MagAOXApp< _useINDI >::createROIndiText	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	elName,
		const std::string &	propLabel = `""`,
		const std::string &	propGroup = `""`,
		const std::string &	elLabel = `""`
	)

inherited

Create a standard ReadOnly INDI Text property, with at least one element.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	elName	the name of the element
[in]	propLabel	[optional] the GUI label suggestion for this property
[in]	propGroup	[optional] the group for this property
[in]	elLabel	[optional] the GUI label suggestion for the element

Definition at line 614 of file MagAOXApp.hpp.

◆ createStandardIndiNumber()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiNumber	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const T &	min,
		const T &	max,
		const T &	step,
		const std::string &	format,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI Number property with target and current elements.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	min	the minimum value for the elements, applied to both target and current
[in]	max	the minimum value for the elements, applied to both target and current
[in]	step	the step size for the elements, applied to both target and current
[in]	format	the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type.
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 628 of file MagAOXApp.hpp.

◆ createStandardIndiRequestSw()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiRequestSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI switch with a single request element.

This switch is intended to function like a momentary switch.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 675 of file MagAOXApp.hpp.

◆ createStandardIndiSelectionSw() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::vector< std::string > &	elements,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI selection (one of many) switch with vector of elements using the element strings as their own labels This switch is intended to function like drop down menu.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property,
[in]	elements	the element names to give to the switches
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 706 of file MagAOXApp.hpp.

◆ createStandardIndiSelectionSw() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::vector< std::string > &	elements,
		const std::vector< std::string > &	elementLabels,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.

This switch is intended to function like drop down menu.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property,
[in]	elements	the element names to give to the switches
[in]	elementLabels	the element labels to give to the switches
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 688 of file MagAOXApp.hpp.

◆ createStandardIndiText()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiText	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI Text property with target and current elements.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 601 of file MagAOXApp.hpp.

◆ createStandardIndiToggleSw()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiToggleSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI switch with a single toggle element.

This switch is intended to function like an on/off toggle switch.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Get the INDI control FIFO file name.

Returns: the current value of m_driverCtrlName

Definition at line 1126 of file MagAOXApp.hpp.

◆ driverInName()

std::string MagAOX::app::MagAOXApp< _useINDI >::driverInName ( )

inherited

Get the INDI input FIFO file name.

Returns: the current value of m_driverInName

Definition at line 1114 of file MagAOXApp.hpp.

◆ driverOutName()

std::string MagAOX::app::MagAOXApp< _useINDI >::driverOutName ( )

inherited

Get the INDI output FIFO file name.

Returns: the current value of m_driverOutName

Definition at line 1120 of file MagAOXApp.hpp.

◆ execute()

int MagAOX::app::MagAOXApp< _useINDI >::execute ( )

virtualinherited

The execute method implementing the standard main loop. Should not normally be overridden.

Performs final startup steps. That is:

Verifies correct effective user-id by comparison to logs directory.
PID locking lockPID()
log thread startup by logThreadStart()
signal handling installation by setSigTermHandler()
appStartup() is called
INDI communications started by startINDI()
power state is checked, pausing if unknown (if being managed)

Errors in the above steps will cause a process exit.

Then commences the main event loop. Conditions on entry to the main loop:

PID locked
Log thread running
Signal handling installed
appStartup successful
INDI communications started successfully (if being used)
power state known (if being managed)

In the event loop, the power state is checked (if being managed). If power is off, then onPowerOff is called. If power is on, or power is not managed, appLogic is called. These methods are implemented in derived classes, and are called every m_loopPause interval.

If an error is returned by either onPowerOff or appLogic, or a signal is handled, then the shutdown is managed. This includes shutting down INDI, calling appShutdown, and unlocking the PID. The log thread will shutdown.

Todo:: Need a heartbeat update here.

Definition at line 200 of file MagAOXApp.hpp.

◆ goptThreadExec()

void MagAOX::app::modalGainOpt::goptThreadExec ( )

protected

Gain optimization thread function.

Runs until m_shutdown is true.

Definition at line 1924 of file modalGainOpt.hpp.

Referenced by goptThreadStart().

◆ goptThreadStart()

void MagAOX::app::modalGainOpt::goptThreadStart ( modalGainOpt * p )

staticprotected

Gain Optimization thread starter function.

Parameters

[in] p pointer to this

Definition at line 1919 of file modalGainOpt.hpp.

Referenced by appStartup().

◆ handleDefProperty()

void MagAOX::app::MagAOXApp< _useINDI >::handleDefProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the DEF INDI properties notification.

Uses the properties registered in m_indiSetCallBacks to process the notification. This is called by m_indiDriver's indiDriver::handleDefProperties.

Parameters

[in] ipRecv The property being sent.

Definition at line 827 of file MagAOXApp.hpp.

◆ handleGetProperties()

void MagAOX::app::MagAOXApp< _useINDI >::handleGetProperties ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the get INDI properties request.

Uses the properties registered in m_indiCallBacks to respond to the request. This is called by m_indiDriver's indiDriver::handleGetProperties.

Parameters

[in] ipRecv The property being requested.

Definition at line 833 of file MagAOXApp.hpp.

◆ handleNewProperty()

void MagAOX::app::MagAOXApp< _useINDI >::handleNewProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the new INDI property request.

Uses the properties registered in m_indiCallBacks to respond to the request, looking up the callback for this property and calling it.

This is called by m_indiDriver's indiDriver::handleGetProperties.

Todo:: handle errors, are they FATAL?

Parameters

[in] ipRecv The property being changed.

Definition at line 843 of file MagAOXApp.hpp.

◆ handlerSigTerm()

void MagAOX::app::MagAOXApp< _useINDI >::handlerSigTerm	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

privateinherited

Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.

Parameters

[in]	signum	specifies the signal.
[in]	siginf	ignored by MagAOXApp
[in]	ucont	ignored by MagAOXApp

Definition at line 302 of file MagAOXApp.hpp.

◆ handleSetProperty()

void MagAOX::app::MagAOXApp< _useINDI >::handleSetProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the set INDI property request.

This is called by m_indiDriver's indiDriver::handleSetProperties.

Todo:: handle errors, are they FATAL?

Todo:: log an error here because callBack should not be null

Todo:: log invalid SetProperty request.

const uint32_t & MagAOX::app::dev::shmimMonitor< modalGainOpt , tauShmimT >::height ( ) const

inherited

Definition at line 138 of file shmimMonitor.hpp.

◆ INDI_NEWCALLBACK_DECL() [1/4]

MagAOX::app::modalGainOpt::INDI_NEWCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_autoUpdate
	)

◆ INDI_NEWCALLBACK_DECL() [2/4]

MagAOX::app::modalGainOpt::INDI_NEWCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_dump
	)

◆ INDI_NEWCALLBACK_DECL() [3/4]

MagAOX::app::modalGainOpt::INDI_NEWCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_gainGain
	)

◆ INDI_NEWCALLBACK_DECL() [4/4]

MagAOX::app::modalGainOpt::INDI_NEWCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_updateOnce
	)

◆ INDI_SETCALLBACK_DECL() [1/10]

MagAOX::app::MagAOXApp< _useINDI >::INDI_SETCALLBACK_DECL	(	MagAOXApp< true >	,
		m_indiP_powerChannel
	)

inherited

◆ INDI_SETCALLBACK_DECL() [2/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_fps
	)

◆ INDI_SETCALLBACK_DECL() [3/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_loop
	)

◆ INDI_SETCALLBACK_DECL() [4/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_pcGain
	)

◆ INDI_SETCALLBACK_DECL() [5/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_pcMult
	)

◆ INDI_SETCALLBACK_DECL() [6/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_pcOn
	)

◆ INDI_SETCALLBACK_DECL() [7/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_psdAvgTime
	)

◆ INDI_SETCALLBACK_DECL() [8/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_psdTime
	)

◆ INDI_SETCALLBACK_DECL() [9/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_siGain
	)

◆ INDI_SETCALLBACK_DECL() [10/10]

MagAOX::app::modalGainOpt::INDI_SETCALLBACK_DECL	(	modalGainOpt	,
		m_indiP_siMult
	)

◆ indiTargetUpdate()

int MagAOX::app::MagAOXApp< _useINDI >::indiTargetUpdate	(	pcf::IndiProperty &	localProperty,
		T &	localTarget,
		const pcf::IndiProperty &	remoteProperty,
		bool	setBusy = `true`
	)

protectedinherited

Get the target element value from an new property.

Returns: 0 on success; -1 on error

Parameters

[out]	localProperty	The local property to update
[out]	localTarget	The local value to update
[in]	remoteProperty	the new property received
[in]	setBusy	[optional] set property to busy if true

Definition at line 949 of file MagAOXApp.hpp.

◆ loadBasicConfig()

void MagAOX::app::MagAOXApp< _useINDI >::loadBasicConfig ( )

virtualinherited

The basic MagAO-X configuration processing method. Should not normally be overridden.

This method processes the standard MagAO-X key=value pairs.

Though it is virtual, it should not normally be overridden unless you need to depart from the MagAO-X standard.

Processing of app specific config goes in loadConfig() implemented by the derived class.

Definition at line 164 of file MagAOXApp.hpp.

◆ loadConfig() [1/13]

void MagAOX::app::modalGainOpt::loadConfig ( )

virtual

Definition at line 729 of file modalGainOpt.hpp.

◆ loadConfig() [2/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , psdShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [3/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , tauShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [4/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , freqShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [5/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainFactShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [6/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , multFactShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [7/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , pcGainFactShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [8/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , pcMultFactShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [9/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , numpccoeffShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [10/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , acoeffShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [11/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , bcoeffShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [12/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalFactShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfig() [13/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalShmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 164 of file shmimMonitor.hpp.

◆ loadConfigImpl()

int MagAOX::app::modalGainOpt::loadConfigImpl ( mx::app::appConfigurator & _config )

Implementation of loadConfig logic, separated for testing.

This is called by loadConfig().

Parameters

[in] _config an application configuration from which to load values

Definition at line 646 of file modalGainOpt.hpp.

Referenced by loadConfig().

◆ lockPID()

int MagAOX::app::MagAOXApp< _useINDI >::lockPID ( )

protectedinherited

Attempt to lock the PID by writing it to a file. Fails if a process is already running with the same config name. First checks the PID file for an existing PID. If found, interrogates /proc to determine if that process is running and if so if the command line matches. If a matching process is currently running, then this returns an error.

Will not fail if a PID file exists but the stored PID does not correspond to a running process with the same command line name.

Reference: https://linux.die.net/man/3/getpid

Returns: 0 on success.; -1 on any error, including creating the PID file or if this app is already running.

Definition at line 410 of file MagAOXApp.hpp.

◆ log() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::log	(	const typename logT::messageT &	msg,
		logPrioT	level = `logPrio::LOG_DEFAULT`
	)

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in]	msg	the message to log
[in]	level	[optional] the log level. The default is used if not specified.

Definition at line 247 of file MagAOXApp.hpp.

◆ log() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::log ( logPrioT level = logPrio::LOG_DEFAULT )

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in] level [optional] the log level. The default is used if not specified.

Definition at line 260 of file MagAOXApp.hpp.

◆ logMessage()

void MagAOX::app::MagAOXApp< _useINDI >::logMessage ( bufferPtrT & b )

inherited

Handle a log message from the logging system.

This is a callback from the logManager, and is called when the log thread is processing log entries.

Decides whether to display to stderr and whether to send via INDI.

Definition at line 269 of file MagAOXApp.hpp.

◆ newCallBack_clearFSMAlert()

int MagAOX::app::MagAOXApp< _useINDI >::newCallBack_clearFSMAlert ( const pcf::IndiProperty & ipRecv )

protectedinherited

The callback called by the static version, to actually process the FSM Alert Clear request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the new property request.

Definition at line 1006 of file MagAOXApp.hpp.

◆ onPowerOff()

int MagAOX::app::MagAOXApp< _useINDI >::onPowerOff ( )

protectedvirtualinherited

This method is called when the change to poweroff is detected.

Returns: 0 on success.; -1 on any error which means the app should exit.

Reimplemented in MagAOX::app::alpaoCtrl, MagAOX::app::bmcCtrl, MagAOX::app::irisaoCtrl, and MagAOX::app::zaberLowLevel.

Definition at line 1051 of file MagAOXApp.hpp.

◆ powerOnWaitElapsed()

bool MagAOX::app::MagAOXApp< _useINDI >::powerOnWaitElapsed ( )

protectedinherited

This method tests whether the power on wait time has elapsed.

You would call this once per appLogic loop while in state POWERON. While false, you would return 0. Once it becomes true, take post-power-on actions and go on with life.

Returns: true if the time since POWERON is greater than the power-on wait, or if power management is not enabled; false otherwise

Definition at line 1067 of file MagAOXApp.hpp.

◆ powerState()

int MagAOX::app::MagAOXApp< _useINDI >::powerState ( )

inherited

Returns the current power state.

If power management is not enabled, this always returns 1=On.

Returns: -1 if power state is unknown; 0 if power is off; 1 if power is on or m_powerMgtEnabled==false

Definition at line 1077 of file MagAOXApp.hpp.

◆ powerStateTarget()

int MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget ( )

inherited

Returns the target power state.

If power management is not enabled, this always returns 1=On.

Returns: -1 if target power state is unknown; 0 if target power state is off; 1 if target power is on or m_powerMgtEnabled==false

Definition at line 1086 of file MagAOXApp.hpp.

◆ processImage() [1/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const acoeffShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1573 of file modalGainOpt.hpp.

◆ processImage() [2/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const bcoeffShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1656 of file modalGainOpt.hpp.

◆ processImage() [3/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const freqShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1151 of file modalGainOpt.hpp.

◆ processImage() [4/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const gainCalFactShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1802 of file modalGainOpt.hpp.

◆ processImage() [5/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const gainCalShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1740 of file modalGainOpt.hpp.

◆ processImage() [6/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const gainFactShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1222 of file modalGainOpt.hpp.

◆ processImage() [7/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const multFactShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1287 of file modalGainOpt.hpp.

◆ processImage() [8/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const numpccoeffShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1488 of file modalGainOpt.hpp.

◆ processImage() [9/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const pcGainFactShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1355 of file modalGainOpt.hpp.

◆ processImage() [10/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const pcMultFactShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1420 of file modalGainOpt.hpp.

◆ processImage() [11/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const psdShmimT &	dummy
	)

Todo:: update a frame-missed counter

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1101 of file modalGainOpt.hpp.

◆ processImage() [12/12]

int MagAOX::app::modalGainOpt::processImage	(	void *	curr_src,
		const tauShmimT &	dummy
	)

Parameters

[in]	curr_src	pointer to the start of the current frame
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 1864 of file modalGainOpt.hpp.

◆ registerIndiPropertyNew() [1/3]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState,
		const pcf::IndiProperty::SwitchRuleType &	propRule,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for, with a switch rule.

This verison sets up the INDI property according to the arguments.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property
[in]	propRule	the switch rule type

◆ registerIndiPropertyNew() [2/3]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for.

This verison sets up the INDI property according to the arguments.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property

◆ registerIndiPropertyNew() [3/3]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for.

In this version the supplied IndiProperty must be fully set up before passing in.

Returns: 0 on success.; -1 on error.

Parameters

[in] prop the property to register, must be fully set up

◆ registerIndiPropertyReadOnly() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly ( pcf::IndiProperty & prop )

inherited

Register an INDI property which is read only.

This version requires the property be fully set up.

Returns: 0 on success.; -1 on error.

Parameters

[in] prop the property to register, must be completely setup

Definition at line 722 of file MagAOXApp.hpp.

◆ registerIndiPropertyReadOnly() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState
	)

inherited

Register an INDI property which is read only.

This verison sets up the INDI property according to the arguments.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register, will be configured
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property

Definition at line 732 of file MagAOXApp.hpp.

◆ registerIndiPropertySet()

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertySet	(	pcf::IndiProperty &	prop,
		const std::string &	devName,
		const std::string &	propName,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is monitored for updates from others.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register
[in]	devName	the device which owns this property
[in]	propName	the name of the property

Definition at line 799 of file MagAOXApp.hpp.

◆ sendGetPropertySetList()

void MagAOX::app::MagAOXApp< _useINDI >::sendGetPropertySetList ( bool all = false )

inherited

Definition at line 821 of file MagAOXApp.hpp.

◆ sendNewProperty() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty ( const pcf::IndiProperty & ipSend )

protectedinherited

Send a newProperty command to another device (using the INDI Client interface)

Returns: 0 on success.; -1 on an error, which will be logged

Parameters

[in] ipSend The property to send a "new" INDI command for

Definition at line 972 of file MagAOXApp.hpp.

◆ sendNewProperty() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty	(	const pcf::IndiProperty &	ipSend,
		const std::string &	el,
		const T &	newVal
	)

protectedinherited

Send a newProperty command to another device (using the INDI Client interface)

Copies the input IndiProperty, then updates the element with the new value.

Returns: 0 on success.; -1 on an errory.

Parameters

[in]	ipSend	The property to send a "new" INDI command for
[in]	el	The element of the property to change
[in]	newVal	The value to request for the element.

Definition at line 962 of file MagAOXApp.hpp.

◆ sendNewStandardIndiToggle()

int MagAOX::app::MagAOXApp< _useINDI >::sendNewStandardIndiToggle	(	const std::string &	device,
		const std::string &	property,
		bool	onoff
	)

protectedinherited

Send a new property commmand for a standard toggle switch.

Returns: 0 on success; -1 on an error, which will be logged.

Parameters

[in]	device	The device name
[in]	property	The property name
[in]	onoff	Switch state to send: true = on, false = off

Definition at line 979 of file MagAOXApp.hpp.

◆ setDefaults()

void MagAOX::app::MagAOXApp< _useINDI >::setDefaults	(	int	argc,
		char **	argv
	)

virtualinherited

Set the paths for config files.

Replaces the mx::application defaults with the MagAO-X config system.

This function parses the CL for "-n" or "--name".

Do not override this unless you intend to depart from the MagAO-X standard.

Parameters

[in]	argc	standard command line result specifying number of arguments in argv
[in]	argv	standard command line result containing the arguments.

Definition at line 142 of file MagAOXApp.hpp.

◆ setEuidCalled()

int MagAOX::app::MagAOXApp< _useINDI >::setEuidCalled ( )

privateinherited

Set the effective user ID to the called value, i.e. the highest possible.

If setuid is set on the file, this will be super-user privileges.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns: 0 on success; -1 on error from setuid().

Definition at line 369 of file MagAOXApp.hpp.

◆ setEuidReal()

int MagAOX::app::MagAOXApp< _useINDI >::setEuidReal ( )

privateinherited

Set the effective user ID to the real value, i.e. the file owner.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns: 0 on success; -1 on error from setuid().

Definition at line 378 of file MagAOXApp.hpp.

◆ setSigTermHandler()

int MagAOX::app::MagAOXApp< _useINDI >::setSigTermHandler ( )

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 293 of file MagAOXApp.hpp.

◆ setupBasicConfig()

void MagAOX::app::MagAOXApp< _useINDI >::setupBasicConfig ( )

virtualinherited

The basic MagAO-X configuration setup method. Should not normally be overridden.

This method sets up the config system with the standard MagAO-X key=value pairs.

Though it is virtual, it should not normally be overridden unless you need to depart from the MagAO-X standard.

Setting up app specific config goes in setupConfig() implemented in the derived class.

Definition at line 154 of file MagAOXApp.hpp.

◆ setupConfig() [1/13]

void MagAOX::app::modalGainOpt::setupConfig ( )

virtual

Definition at line 580 of file modalGainOpt.hpp.

◆ setupConfig() [2/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , pcGainFactShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [3/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , acoeffShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [4/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , tauShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [5/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , multFactShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [6/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , psdShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [7/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , bcoeffShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [8/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , numpccoeffShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [9/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalFactShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [10/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , pcMultFactShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [11/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , freqShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [12/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainFactShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 154 of file shmimMonitor.hpp.

◆ setupConfig() [13/13]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalShmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Definition at line 132 of file MagAOXApp.hpp.

◆ smThreadExec() [1/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalFactShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [2/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , tauShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [3/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [4/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , acoeffShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [5/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , numpccoeffShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [6/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , bcoeffShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [7/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , pcMultFactShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [8/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , gainFactShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [9/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , multFactShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [10/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , freqShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [11/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , psdShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 231 of file shmimMonitor.hpp.

◆ smThreadExec() [12/12]

void MagAOX::app::dev::shmimMonitor< modalGainOpt , pcGainFactShmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 228 of file shmimMonitor.hpp.

◆ st_newCallBack_clearFSMAlert()

int MagAOX::app::MagAOXApp< _useINDI >::st_newCallBack_clearFSMAlert	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticprotectedinherited

The static callback function to be registered for requesting to clear the FSM alert.

Returns: 0 on success.; -1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to MagAOXApp.
[in]	ipRecv	the INDI property sent with the new property request.

Definition at line 995 of file MagAOXApp.hpp.

◆ startINDI()

int MagAOX::app::MagAOXApp< _useINDI >::startINDI ( )

protectedinherited

Start INDI Communications.

Returns: 0 on success; -1 on error. This is fatal.

Definition at line 818 of file MagAOXApp.hpp.

◆ state() [1/2]

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::state ( )

inherited

Get the current state code.

Returns: m_state

Definition at line 487 of file MagAOXApp.hpp.

◆ state() [2/2]

void MagAOX::app::MagAOXApp< _useINDI >::state	(	const stateCodes::stateCodeT &	s,
		bool	stateAlert = `false`
	)

inherited

Set the current state code.

Todo:: move this to a function in stateCodes

Parameters

[in]	s	The new application state
[in]	stateAlert	[optional] flag to set the alert state of the FSM property.

Definition at line 495 of file MagAOXApp.hpp.

◆ stateLogged()

int MagAOX::app::MagAOXApp< _useINDI >::stateLogged ( )

inherited

Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

This method exists to facilitate logging the reason for a state change once, but not logging it on subsequent event loops. Returns the current value upon entry, but updates before returning so that the next call returns the incremented value. Example usage:

if( connection_failed ) //some condition set this to true
{
   state( stateCodes::NOTCONNECTED );
   if(!stateLogged()) log<text_log>("Not connected");
}

In this example, the log entry is made the first time the state changes. If there are no changes to a different state in the mean time, then when the event loop gets here again and decides it is not connected, the log entry will not be made.

Returns: current value of m_stateLogged, that is the value before it is incremented.

Definition at line 516 of file MagAOXApp.hpp.

◆ threadStart()

int MagAOX::app::MagAOXApp< _useINDI >::threadStart	(	std::thread &	thrd,
		bool &	thrdInit,
		pid_t &	tpid,
		pcf::IndiProperty &	thProp,
		int	thrdPrio,
		const std::string &	cpuset,
		const std::string &	thrdName,
		thisPtr *	thrdThis,
		Function &&	thrdStart
	)

inherited

Start a thread, using this class's privileges to set priority, etc.

The thread initialization synchronizer bool is set to true at the beginning of this function, then is set to false once all initialization is complete. The thread exec function should wait until this is false before doing anything except setting the pid. This is to avoid privilege escalation bugs.

The interface of the thread start function is:

static void impl::myThreadStart( impl * o )
{
   o->myThreadExec(); //A member function which actually executes the thread
}

where impl is the derived class, and mThreadStart and myThreadExec are members of impl.

Returns: 0 on success; -1 on error

Parameters

[out]	thrd	The thread object to start executing
	thrdInit	[in/out] The thread initilization synchronizer.
	tpid	[in/out] The thread pid to be filled in by thrdStart immediately upon call
	thProp	[in/out] The INDI property to publish the thread details
[in]	thrdPrio	The r/t priority to set for this thread
[in]	cpuset	the cpuset to place this thread on. Ignored if "".
[in]	thrdName	The name of the thread (just for logging)
[in]	thrdThis	The `this` pointer to pass to the thread starter function
[in]	thrdStart	The thread starting function, a static function taking a `this` pointer as argument.

Definition at line 144 of file shmimMonitor.hpp.

◆ unlockPID()

int MagAOX::app::MagAOXApp< _useINDI >::unlockPID ( )

protectedinherited

Remove the PID file.

Definition at line 413 of file MagAOXApp.hpp.

◆ updateIfChanged() [1/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const char *	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is a specialization for const char * to std::string.

For a property with multiple elements, you should use the vector version to minimize network traffic. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 882 of file MagAOXApp.hpp.

◆ updateIfChanged() [2/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

Constructs the element names for each value as elX where X is the index of the vector.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	Beginning of each element name
[in]	newVals	the new values
[in]	ipState	[optional] the new state

Definition at line 911 of file MagAOXApp.hpp.

◆ updateIfChanged() [3/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const T &	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

For a property with multiple elements, you should use the vector version to minimize network traffic.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 865 of file MagAOXApp.hpp.

◆ updateIfChanged() [4/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< std::string > &	els,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 928 of file MagAOXApp.hpp.

◆ updateINDI() [1/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , tauShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [2/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , freqShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [3/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalFactShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [4/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , psdShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [5/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , pcMultFactShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [6/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainCalShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [7/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , numpccoeffShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [8/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , bcoeffShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [9/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , gainFactShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [10/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , acoeffShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [11/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , pcGainFactShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updateINDI() [12/12]

int MagAOX::app::dev::shmimMonitor< modalGainOpt , multFactShmimT >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 254 of file shmimMonitor.hpp.

◆ updatesIfChanged()

void MagAOX::app::MagAOXApp< _useINDI >::updatesIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< const char * > &	els,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 936 of file MagAOXApp.hpp.

◆ updateSwitchIfChanged()

void MagAOX::app::MagAOXApp< _useINDI >::updateSwitchIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const pcf::IndiElement::SwitchStateType &	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI switch element value if it has changed.

Will only peform a SetProperty if the new element switch state has changed, or the propery state has changed.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 893 of file MagAOXApp.hpp.

◆ whilePowerOff()

int MagAOX::app::MagAOXApp< _useINDI >::whilePowerOff ( )

protectedvirtualinherited

This method is called while the power is off, once per FSM loop.

Returns: 0 on success.; -1 on any error which means the app should exit.

◆ m_allDefsReceived

bool MagAOX::app::MagAOXApp< _useINDI >::m_allDefsReceived

protectedinherited

Flag indicating that all registered Set properties have been updated since last Get.

Definition at line 582 of file MagAOXApp.hpp.

◆ m_as

eigenImage<float> MagAOX::app::modalGainOpt::m_as

protected

Definition at line 329 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_autoUpdate

bool MagAOX::app::modalGainOpt::m_autoUpdate { false }

IMAGE* MagAOX::app::modalGainOpt::m_clXferCurrentStream { nullptr }

protected

The ImageStreamIO shared memory buffer to publish the SI ETF.

Definition at line 359 of file modalGainOpt.hpp.

Referenced by allocate(), appShutdown(), and goptThreadExec().

◆ m_clXferLP

mx::improc::eigenImage<float> MagAOX::app::modalGainOpt::m_clXferLP

protected

Definition at line 286 of file modalGainOpt.hpp.

Referenced by allocate(), and goptThreadExec().

◆ m_clXferLPShmimName

std::string MagAOX::app::modalGainOpt::m_clXferLPShmimName

protected

Definition at line 352 of file modalGainOpt.hpp.

Referenced by allocate(), and loadConfigImpl().

◆ m_clXferLPStream

IMAGE* MagAOX::app::modalGainOpt::m_clXferLPStream { nullptr }

protected

The ImageStreamIO shared memory buffer to publish the LP ETF.

Definition at line 361 of file modalGainOpt.hpp.

Referenced by allocate(), appShutdown(), and goptThreadExec().

◆ m_clXferSI

mx::improc::eigenImage<float> MagAOX::app::modalGainOpt::m_clXferSI

protected

Definition at line 285 of file modalGainOpt.hpp.

Referenced by allocate(), and goptThreadExec().

◆ m_clXferSIShmimName

std::string MagAOX::app::modalGainOpt::m_clXferSIShmimName

protected

Definition at line 351 of file modalGainOpt.hpp.

Referenced by allocate(), and loadConfigImpl().

◆ m_clXferSIStream

IMAGE* MagAOX::app::modalGainOpt::m_clXferSIStream { nullptr }

protected

The ImageStreamIO shared memory buffer to publish the SI ETF.

Definition at line 360 of file modalGainOpt.hpp.

Referenced by allocate(), appShutdown(), and goptThreadExec().

◆ m_configBase

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configBase

protectedinherited

The name of a base config class for this app (minus .conf).

Definition at line 87 of file MagAOXApp.hpp.

◆ m_configDir

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configDir

protectedinherited

The path to configuration files for MagAOX.

Definition at line 85 of file MagAOXApp.hpp.

◆ m_configName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configName

protectedinherited

The name of the configuration file (minus .conf).

Definition at line 83 of file MagAOXApp.hpp.

uint32_t MagAOX::app::dev::shmimMonitor< modalGainOpt , tauShmimT >::m_depth

protectedinherited

The depth of the circular buffer in the stream.

Definition at line 123 of file shmimMonitor.hpp.

◆ m_driverCtrlName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverCtrlName

protectedinherited

Full path name of the INDI driver control FIFO.

This is currently only used to signal restarts.

Definition at line 593 of file MagAOXApp.hpp.

◆ m_driverInName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverInName

protectedinherited

Full path name of the INDI driver input FIFO.

Definition at line 585 of file MagAOXApp.hpp.

◆ m_driverOutName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverOutName

protectedinherited

Full path name of the INDI driver output FIFO.

Definition at line 588 of file MagAOXApp.hpp.

◆ m_dump

bool MagAOX::app::modalGainOpt::m_dump { false }

◆ m_gain

float MagAOX::app::modalGainOpt::m_gain { 0 }

protected

Definition at line 299 of file modalGainOpt.hpp.

Referenced by goptThreadExec().

◆ m_gainCalFacts

std::vector<float> MagAOX::app::modalGainOpt::m_gainCalFacts

protected

Definition at line 343 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_gainCals

std::vector<float> MagAOX::app::modalGainOpt::m_gainCals

protected

Definition at line 341 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_gainFacts

std::vector<float> MagAOX::app::modalGainOpt::m_gainFacts

protected

Definition at line 313 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_gainGain

float MagAOX::app::modalGainOpt::m_gainGain { 0.1 }

bool MagAOX::app::dev::shmimMonitor< modalGainOpt , acoeffShmimT >::m_getExistingFirst

protectedinherited

If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

Definition at line 117 of file shmimMonitor.hpp.

◆ m_gitAlert

bool MagAOX::app::MagAOXApp< _useINDI >::m_gitAlert

privateinherited

Definition at line 478 of file MagAOXApp.hpp.

◆ m_gmaxLP

std::vector<float> MagAOX::app::modalGainOpt::m_gmaxLP

protected

The previously calculated maximum gains for LP.

Definition at line 333 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_goptCurrent

std::vector<mx::AO::analysis::clGainOpt<float> > MagAOX::app::modalGainOpt::m_goptCurrent

protected

Each mode gets its own gain optimizer.

Definition at line 267 of file modalGainOpt.hpp.

Referenced by goptThreadExec().

◆ m_goptLP

std::vector<mx::AO::analysis::clGainOpt<float> > MagAOX::app::modalGainOpt::m_goptLP

protected

Definition at line 269 of file modalGainOpt.hpp.

Referenced by goptThreadExec().

◆ m_goptMutex

std::mutex MagAOX::app::modalGainOpt::m_goptMutex

protected

Mutex for synchronizing updates.

Definition at line 491 of file modalGainOpt.hpp.

Referenced by allocate(), goptThreadExec(), processImage(), processImage(), processImage(), processImage(), processImage(), processImage(), processImage(), processImage(), processImage(), processImage(), processImage(), and processImage().

◆ m_goptSemaphore

sem_t MagAOX::app::modalGainOpt::m_goptSemaphore

protected

Semaphore used to synchronize the psdShmim thread and the gopt thread.

Definition at line 512 of file modalGainOpt.hpp.

Referenced by appStartup(), goptThreadExec(), and processImage().

indiDriver<MagAOXApp>* MagAOX::app::MagAOXApp< _useINDI >::m_indiDriver

inherited

The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

Todo:: instead of making this public, provide an accessor.

Definition at line 542 of file MagAOXApp.hpp.

◆ m_indiMutex

std::mutex MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex

inherited

Mutex for locking INDI communications.

Definition at line 545 of file MagAOXApp.hpp.

◆ m_indiNewCallBacks

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiNewCallBacks

protectedinherited

Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is the property name.

Definition at line 573 of file MagAOXApp.hpp.

◆ m_indiP_autoUpdate

pcf::IndiProperty MagAOX::app::modalGainOpt::m_indiP_autoUpdate

Definition at line 529 of file modalGainOpt.hpp.

Referenced by appLogic(), and appStartup().

◆ m_indiP_clearFSMAlert

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_clearFSMAlert

protectedinherited

indi Property to clear an FSM alert.

Definition at line 988 of file MagAOXApp.hpp.

◆ m_indiP_dump

pcf::IndiProperty MagAOX::app::modalGainOpt::m_indiP_dump

Definition at line 531 of file modalGainOpt.hpp.

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< modalGainOpt , multFactShmimT >::m_indiP_frameSize

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_powerChannel

protectedinherited

INDI property used to communicate power state.

Definition at line 1044 of file MagAOXApp.hpp.

◆ m_indiP_psdAvgTime

pcf::IndiProperty MagAOX::app::modalGainOpt::m_indiP_psdAvgTime

Definition at line 537 of file modalGainOpt.hpp.

Referenced by appStartup().

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< modalGainOpt , multFactShmimT >::m_indiP_shmimName

protectedinherited

Property used to report the shmim buffer name.

Definition at line 242 of file shmimMonitor.hpp.

◆ m_indiP_siGain

pcf::IndiProperty MagAOX::app::modalGainOpt::m_indiP_siGain

Definition at line 539 of file modalGainOpt.hpp.

Referenced by appStartup().

◆ m_indiP_siMult

pcf::IndiProperty MagAOX::app::modalGainOpt::m_indiP_siMult

Definition at line 540 of file modalGainOpt.hpp.

Referenced by appStartup().

◆ m_indiP_state

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_state

protectedinherited

indi Property to report the application state.

Definition at line 985 of file MagAOXApp.hpp.

◆ m_indiP_updateOnce

pcf::IndiProperty MagAOX::app::modalGainOpt::m_indiP_updateOnce

Definition at line 530 of file modalGainOpt.hpp.

Referenced by appLogic(), and appStartup().

◆ m_indiSetCallBacks

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiSetCallBacks

MagAOXApp< _useINDI >::logManagerT MagAOX::app::MagAOXApp< _useINDI >::m_log

staticinherited

Definition at line 237 of file MagAOXApp.hpp.

int MagAOX::app::modalGainOpt::m_nRegCycles { 60 }

protected

How often to regularize each mode.

Definition at line 335 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_olPSDs

std::vector<std::vector<float> > MagAOX::app::modalGainOpt::m_olPSDs

protected

Definition at line 288 of file modalGainOpt.hpp.

Referenced by allocate(), and goptThreadExec().

◆ m_olPSDShmimName

std::string MagAOX::app::modalGainOpt::m_olPSDShmimName

protected

Definition at line 349 of file modalGainOpt.hpp.

Referenced by allocate(), and loadConfigImpl().

◆ m_olPSDStream

IMAGE* MagAOX::app::modalGainOpt::m_olPSDStream { nullptr }

protected

The ImageStreamIO shared memory buffer to publish the open loop PSDs.

Definition at line 358 of file modalGainOpt.hpp.

Referenced by allocate(), appShutdown(), and goptThreadExec().

◆ m_optGainLP

std::vector<float> MagAOX::app::modalGainOpt::m_optGainLP

protected

Definition at line 294 of file modalGainOpt.hpp.

Referenced by allocate(), and goptThreadExec().

◆ m_optGainLPShmimName

std::string MagAOX::app::modalGainOpt::m_optGainLPShmimName

protected

Definition at line 356 of file modalGainOpt.hpp.

Referenced by allocate(), and loadConfigImpl().

◆ m_optGainLPStream

IMAGE* MagAOX::app::modalGainOpt::m_optGainLPStream { nullptr }

protected

The ImageStreamIO shared memory buffer to publish the LP optimal gains.

Definition at line 365 of file modalGainOpt.hpp.

Referenced by allocate(), appShutdown(), and goptThreadExec().

◆ m_optGainShmimName

std::string MagAOX::app::modalGainOpt::m_optGainShmimName

protected

Definition at line 354 of file modalGainOpt.hpp.

Referenced by allocate(), and loadConfigImpl().

◆ m_optGainSI

std::vector<float> MagAOX::app::modalGainOpt::m_optGainSI

protected

Definition at line 291 of file modalGainOpt.hpp.

Referenced by allocate(), and goptThreadExec().

float MagAOX::app::modalGainOpt::m_pcGain { 0 }

protected

Definition at line 307 of file modalGainOpt.hpp.

Referenced by goptThreadExec().

◆ m_pcGainFacts

std::vector<float> MagAOX::app::modalGainOpt::m_pcGainFacts

protected

Definition at line 317 of file modalGainOpt.hpp.

Referenced by goptThreadExec(), and processImage().

◆ m_pcgoptUpdated

bool MagAOX::app::modalGainOpt::m_pcgoptUpdated { true }

◆ m_psdOverlapFraction

float MagAOX::app::modalGainOpt::m_psdOverlapFraction { 0.5 }

protected

Definition at line 279 of file modalGainOpt.hpp.

Referenced by processImage().

float MagAOX::app::modalGainOpt::m_siGain { 0 }

protected

Definition at line 303 of file modalGainOpt.hpp.

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::m_state

privateinherited

The application's state. Never ever set this directly, use state(const stateCodeT & s).

Definition at line 472 of file MagAOXApp.hpp.

bool MagAOX::app::modalGainOpt::m_updateOnce { false }

protected

Flag to trigger a single update with gain.

Definition at line 260 of file modalGainOpt.hpp.

Referenced by appLogic(), and goptThreadExec().

◆ m_updating

bool MagAOX::app::modalGainOpt::m_updating { false }

apps/modalGainOpt/modalGainOpt.hpp

Friends
class	modalGainOpt_test

class	dev::shmimMonitor< modalGainOpt, psdShmimT >

class	dev::shmimMonitor< modalGainOpt, freqShmimT >

class	dev::shmimMonitor< modalGainOpt, gainFactShmimT >

class	dev::shmimMonitor< modalGainOpt, multFactShmimT >

class	dev::shmimMonitor< modalGainOpt, pcGainFactShmimT >

class	dev::shmimMonitor< modalGainOpt, pcMultFactShmimT >

class	dev::shmimMonitor< modalGainOpt, numpccoeffShmimT >

class	dev::shmimMonitor< modalGainOpt, acoeffShmimT >

class	dev::shmimMonitor< modalGainOpt, bcoeffShmimT >

class	dev::shmimMonitor< modalGainOpt, gainCalShmimT >

class	dev::shmimMonitor< modalGainOpt, gainCalFactShmimT >

class	dev::shmimMonitor< modalGainOpt, tauShmimT >

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

INDI Interface

Gain Optimization Thread

PID Locking

Power Management

INDI

Logging

Application State

Signal Handling

SIGSEGV & SIGBUS signal handling

Privilege Management

shmimmonitor Thread

INDI

Detailed Description

Member Typedef Documentation

◆ acoeffShmimMonitorT

◆ bcoeffShmimMonitorT

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ durationT

◆ freqShmimMonitorT

◆ gainCalFactShmimMonitorT

◆ gainCalShmimMonitorT

◆ gainFactShmimMonitorT

◆ logManagerT

◆ multFactShmimMonitorT

◆ numpccoeffShmimMonitorT

◆ pcGainFactShmimMonitorT

◆ pcMultFactShmimMonitorT

◆ psdShmimMonitorT

◆ tauShmimMonitorT

◆ timePointT

Constructor & Destructor Documentation

◆ modalGainOpt()

◆ ~modalGainOpt()

Member Function Documentation

◆ _handlerSigTerm()

◆ allocate() [1/12]

◆ allocate() [2/12]

◆ allocate() [3/12]

◆ allocate() [4/12]

◆ allocate() [5/12]

◆ allocate() [6/12]

◆ allocate() [7/12]

◆ allocate() [8/12]

◆ allocate() [9/12]

◆ allocate() [10/12]

◆ allocate() [11/12]

◆ allocate() [12/12]

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ checkConfig()

◆ clearFSMAlert()

◆ configDir()

◆ configLog()

◆ configName()

◆ createINDIFIFOS()

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()

◆ dataType() [1/12]

◆ dataType() [2/12]

◆ dataType() [3/12]

◆ dataType() [4/12]

◆ dataType() [5/12]

◆ dataType() [6/12]

◆ dataType() [7/12]

◆ dataType() [8/12]