MagAOX::app::modalPSDs Class Reference

Class for application to calculate rolling PSDs of modal amplitudes. More...

#include <modalPSDs.hpp>

Inheritance diagram for MagAOX::app::modalPSDs:

Collaboration diagram for MagAOX::app::modalPSDs:

Public Types
typedef float	realT
typedef std::complex< realT >	complexT
typedef int32_t	cbIndexT
	The index for the circular buffer.
typedef dev::shmimMonitor< modalPSDs >	shmimMonitorT
	The base shmimMonitor type.
typedef mx::sigproc::circularBufferIndex< realT *, cbIndexT, true >	ampCircBuffT
	The amplitude circular buffer type.
typedef XWC_DEFAULT_VERBOSITY	verboseT
typedef logger::logManager< MagAOXApp< _useINDI >, logFileRaw< verboseT > >	logManagerT
	The log manager type.

Public Member Functions
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.
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
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	basePath ()
	Get the.
std::string	configName ()
	Get the config name.
std::string	configDir ()
	Get the config directory.
std::string	configBase ()
	Get the config base file.
std::string	calibDir ()
	Get the calibration directory.
std::string	sysPath ()
	Get the system path.
std::string	secretsPath ()
	Get the secrets path.
std::string	cpusetPath ()
	Get the cpuset path.
unsigned long	loopPause ()
	Get the loop pause time.
int	shutdown ()
	Get the value of the shutdown flag.
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
size_t	m_nModes { 0 }
	the number of modes to calculate PSDs for.
ampCircBuffT	m_ampCircBuff
std::atomic< realT >	m_fps { 0 }
	The current input frame rate used to size PSD windows.
realT	m_df { 1 }
cbIndexT	m_tsSize { 2000 }
	The length of the time series sample over which the PSD is calculated.
cbIndexT	m_tsOverlapSize { 1000 }
	The number of samples in the overlap.
cbIndexT	m_meanSize { 20000 }
	The length of the time series over which to calculate the mean.
std::vector< realT >	m_win
	The window function. By default this is Hann.
std::vector< realT * >	m_tsPtrs
	Snapshot of the latest time-series window pointers for PSD computation.
std::vector< realT * >	m_meanPtrs
	Snapshot of the latest mean-window pointers for PSD computation.
realT *	m_tsWork { nullptr }
size_t	m_tsWorkSize { 0 }
std::complex< realT > *	m_fftWork { nullptr }
size_t	m_fftWorkSize { 0 }
std::vector< realT >	m_psd
mx::math::ft::fftT< realT, std::complex< realT >, 1, 0 >	m_fft
mx::math::ft::fftwEnvironment< realT >	m_fftEnv
std::string	m_basePath
	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	m_sysPath
	The path to the system directory, for PID file, etc.
std::string	m_secretsPath
	Path to the secrets directory, where passwords, etc, are stored.
std::string	m_cpusetPath
	Path to the cpusets mount.
unsigned long	m_loopPause
int	m_shutdown
	Flag to signal it's time to shutdown. When not 0, the main loop exits.
bool	m_getExistingFirst
stateCodes::stateCodeT	m_targetState
shmimMonitorState	m_smState
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
int	m_loopNumber { 1 }
std::string	m_shmimBase
std::string	m_shmimTag { "cl" }
std::string	m_fpsDevice
	Device name for getting fps to set circular buffer length.
std::string	m_fpsProperty { "fps" }
	Property name for getting fps to set circular buffer length.
std::string	m_fpsElement { "current" }
	Element name for getting fps to set circular buffer length.
std::string	m_loopStateDevice
	Optional device name providing loop-state gating updates.
std::string	m_loopStateProperty { "loop_state" }
	Optional property name providing loop-state gating updates.
std::string	m_loopStateElement { "toggle" }
	Element name used to interpret closed-loop state.
bool	m_useLoopState { false }
	Whether PSD ingestion is gated by an external loop-state property.
std::atomic< bool >	m_loopClosed { true }
	Current closed-loop state used to gate PSD ingestion and processing.
realT	m_fpsTol { 0 }
	The tolerance for detecting a change in FPS.
std::atomic< realT >	m_psdTime { 1 }
	The length of time over which to calculate PSDs. The default is 1 sec.
std::atomic< realT >	m_psdAvgTime { 10 }
	The time over which to average PSD estimates. The default is 10 sec.
std::atomic< realT >	m_meanTime
	The time over which to calculate the mean for detrending. The default is 10 sec.
realT	m_psdOverlapFraction { 0.5 }
	The fraction of the sample time to overlap by.
int	m_nPSDHistory { 100 }
	Minimum number of raw PSD estimates to retain in the history stream.
Configurable Parameters
std::string	m_shmimName
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).
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.
bool	m_restart
	Flag indicating tha the shared memory should be reinitialized.

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

Friends
class	modalPSDs_test
class	dev::shmimMonitor< modalPSDs >

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.
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.
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	resetIndiSetPropertyRetry (indiCallBack &callBack)
	Reset retry tracking for a monitored INDI Set-property subscription.
bool	indiSetPropertyShouldRequest (const indiCallBack &callBack, bool all, const std::chrono::steady_clock::time_point &now) const
	Determine whether an unresolved Set-property subscription should be requested now.
void	noteIndiSetPropertyRequested (indiCallBack &callBack, const std::chrono::steady_clock::time_point &now)
	Update retry tracking after sending a GetProperties request for a monitored Set-property.
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 constexpr bool	m_useINDI
	Flag controlling whether INDI is used. If false, then no INDI code executes.
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.
std::mutex	m_indiCallBackMutex
	Mutex for locking INDI callback maps and per-entry callback state.

PSD Calculation Thread
Handling of offloads from the average woofer shape
int	m_psdThreadPrio { 0 }
	Priority of the PSD Calculation thread.
std::string	m_psdThreadCpuset
	The cpuset to use for the PSD Calculation thread.
std::thread	m_psdThread
	The PSD Calculation thread.
bool	m_psdThreadInit { true }
	Initialization flag for the PSD Calculation thread.
std::atomic< bool >	m_psdRestarting { true }
bool	m_psdWaiting { false }
	Synchronization flag protected by m_psdMutex.
std::mutex	m_psdMutex
	Protects restart handoff between allocate() and the PSD thread.
std::condition_variable	m_psdCond
	Coordinates quiescence during restart.
pid_t	m_psdThreadID { 0 }
	PSD Calculation thread PID.
pcf::IndiProperty	m_psdThreadProp
	The property to hold the PSD Calculation thread details.
IMAGE *	m_freqStream { nullptr }
	The ImageStreamIO shared memory buffer to hold the frequency scale.
mx::improc::eigenImage< realT >	m_psdBuffer
std::vector< realT >	m_rawPSDHistory
	Heap-backed overflow history for raw PSD estimates beyond the shmim depth.
uint32_t	m_rawPSDHistoryDepth { 0 }
	Number of overflow PSD estimates currently allocated in m_rawPSDHistory.
uint32_t	m_rawPSDHistoryNext { 0 }
	Next overflow slot to overwrite in m_rawPSDHistory.
uint64_t	m_rawPSDHistoryCount { 0 }
	Number of overflow PSD estimates stored since the last restart.
IMAGE *	m_rawpsdStream { nullptr }
	The ImageStreamIO shared memory buffer to hold the raw psds.
IMAGE *	m_avgpsdStream { nullptr }
	The ImageStreamIO shared memory buffer to hold the average psds.
pcf::IndiProperty	m_indiP_psdTime
pcf::IndiProperty	m_indiP_psdAvgTime
pcf::IndiProperty	m_indiP_meanTime
pcf::IndiProperty	m_indiP_overSize
pcf::IndiProperty	m_indiP_fpsSource
pcf::IndiProperty	m_indiP_loop
pcf::IndiProperty	m_indiP_fps
static void	psdThreadStart (modalPSDs *p)
	PS Calculation thread starter function.
static cbIndexT	latestWindowRefEntry (const ampCircBuffT::snapshotT &sn, cbIndexT count)
	Compute the reference entry for the latest logical window while preserving historical semantics.
static cbIndexT	precedingWindowRefEntry (const ampCircBuffT::snapshotT &sn, cbIndexT refEntry, cbIndexT count)
	Compute the reference entry for a logical window immediately preceding another logical window.
static cbIndexT	circularEntryAdvance (cbIndexT from, cbIndexT to, cbIndexT maxEntries)
	Compute the forward logical advance between two circular-buffer reference entries.
static void	updatePlaneSum (std::vector< double > &planeSum, const realT *addPlane, const realT *removePlane, size_t planeElements)
	Add one raw PSD plane and optionally subtract one outgoing raw PSD plane from the running average sum.
void	psdThreadExec ()
	PSD Calculation thread function.
bool	loadPsdInputWindows (ampCircBuffT::snapshotT &sn)
	Load the PSD and mean pointer windows from a single validated snapshot.
void	recomputeMeanSums (std::vector< double > &meanSums) const
	Recompute the per-mode sums for the full mean window from the currently loaded pointers.
void	rollMeanSums (std::vector< double > &meanSums, const std::vector< realT > &meanHeadCache, cbIndexT advance) const
	Update per-mode mean sums using the cached oldest slice and the newest loaded mean-window slice.
void	cacheMeanHead (std::vector< realT > &meanHeadCache, cbIndexT count) const
	Cache the oldest slice of the currently loaded mean window for the next rolling-mean update.
uint64_t	storedRawPSDCount () const
	Count how many raw PSD planes are currently retained across the published and overflow histories.
const realT *	rawPSDPlaneByAge (uint64_t age, size_t planeElements) const
	Locate a retained raw PSD plane by age, where age 0 is the newest plane.
void	recomputeAveragedPSDSum (std::vector< double > &avgPsdSum, uint64_t windowCount, size_t planeElements) const
	Recompute the averaged-PSD running sum from the newest windowCount retained raw PSD planes.
bool	acceptLoopStateFrame () const
	Determine whether incoming frames should currently be accepted into the PSD history.
int	desiredPSDAverageCount () const
	Calculate how many raw PSD estimates are needed to cover the requested averaging time.
cbIndexT	desiredMeanSampleCount (realT fps) const
	Calculate how many samples are needed for the mean-subtraction window at the current FPS.
cbIndexT	requiredInputHistoryDepth () const
	Calculate the total input-history depth needed to read both windows safely from the fixed-size circular buffer.
uint32_t	rawPSDHistoryDepth () const
	Calculate the additional PSD history depth needed beyond the published raw-PSD shmim.
uint32_t	publishedRawPSDHistoryDepth () const
	Calculate the published raw PSD history depth retained in shared memory.
int	allocate (const dev::shmimT &dummy)
int	allocatePSDStreams ()
int	processImage (void *curr_src, const dev::shmimT &dummy)
	modalPSDs ()
	Default c'tor.
	~modalPSDs () 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 modalPSDs.
virtual int	appShutdown ()
	Shutdown the app.
	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_psdTime)
	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_psdAvgTime)
	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_meanTime)
	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_overSize)
	INDI_SETCALLBACK_DECL (modalPSDs, m_indiP_fpsSource)
	INDI_SETCALLBACK_DECL (modalPSDs, m_indiP_loop)

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
	Default 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.
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.
int	powerState ()
	Returns the current power state.
int	powerStateTarget ()
	Returns the target power state.
	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

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.
static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.
void	smThreadExec ()
	Execute the monitoring thread.
int	create (uint32_t width, uint32_t height, uint32_t depth, uint8_t datatype, void *initData=nullptr)
	Create the image.

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.
int	updateINDI ()
	Update the INDI properties for this device controller.

Logging
static void	configLog (const std::string &name, const int &code, const std::string &value, const std::string &source)
	Callback for config system logging.
void	logMessage (bufferPtrT &b)
	Handle a log message from the logging system.
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.
bool	stateAlert ()
	Get the value of the state alert flag.
bool	gitAlert ()
	Get the value of the git alert flag.
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.

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.

Detailed Description

Class for application to calculate rolling PSDs of modal amplitudes.

Definition at line 43 of file modalPSDs.hpp.

Member Typedef Documentation

ampCircBuffT

typedef mx::sigproc::circularBufferIndex<realT *, cbIndexT, true> MagAOX::app::modalPSDs::ampCircBuffT

The amplitude circular buffer type.

Definition at line 61 of file modalPSDs.hpp.

callBackInsertResult

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

inherited

Return type of insert on the indiCallBack map.

Definition at line 701 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 698 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 695 of file MagAOXApp.hpp.

cbIndexT

typedef int32_t MagAOX::app::modalPSDs::cbIndexT

The index for the circular buffer.

Definition at line 55 of file modalPSDs.hpp.

complexT

typedef std::complex<realT> MagAOX::app::modalPSDs::complexT

Definition at line 53 of file modalPSDs.hpp.

logManagerT

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

inherited

The log manager type.

Definition at line 185 of file MagAOXApp.hpp.

realT

typedef float MagAOX::app::modalPSDs::realT

Definition at line 51 of file modalPSDs.hpp.

shmimMonitorT

typedef dev::shmimMonitor<modalPSDs> MagAOX::app::modalPSDs::shmimMonitorT

The base shmimMonitor type.

Definition at line 58 of file modalPSDs.hpp.

verboseT

typedef XWC_DEFAULT_VERBOSITY MagAOX::app::MagAOXApp< _useINDI >::verboseT

inherited

Definition at line 182 of file MagAOXApp.hpp.

Constructor & Destructor Documentation

modalPSDs()

MagAOX::app::modalPSDs::modalPSDs

(

)

Default c'tor.

Definition at line 329 of file modalPSDs.hpp.

~modalPSDs()

MagAOX::app::modalPSDs::~modalPSDs ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 267 of file modalPSDs.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 404 of file MagAOXApp.hpp.

acceptLoopStateFrame()

bool MagAOX::app::modalPSDs::acceptLoopStateFrame ( ) const

protected

Determine whether incoming frames should currently be accepted into the PSD history.

Definition at line 1287 of file modalPSDs.hpp.

References m_loopClosed, and m_useLoopState.

Referenced by processImage(), and libXWCTest::modalPSDsTest::TEST_CASE().

allocate()

int MagAOX::app::modalPSDs::allocate ( const dev::shmimT &  dummy )

protected

Parameters

[in]

dummy

tag to differentiate shmimMonitor parents.

Definition at line 625 of file modalPSDs.hpp.

References allocatePSDStreams(), desiredMeanSampleCount(), IMAGESTRUCT_FLOAT, MagAOX::app::lock(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_NOTICE, flatlogs::logPrio::LOG_WARNING, m_ampCircBuff, MagAOX::app::dev::shmimMonitor< modalPSDs >::m_dataType, MagAOX::app::dev::shmimMonitor< modalPSDs >::m_depth, m_df, m_fft, m_fftWork, m_fps, m_freqStream, MagAOX::app::dev::shmimMonitor< modalPSDs >::m_height, m_meanPtrs, m_meanSize, m_nModes, m_psd, m_psdCond, m_psdMutex, m_psdOverlapFraction, m_psdRestarting, m_psdTime, m_psdWaiting, m_shmimBase, MagAOX::app::dev::shmimMonitor< modalPSDs >::m_shmimName, m_tsOverlapSize, m_tsPtrs, m_tsSize, m_tsWork, MagAOX::app::dev::shmimMonitor< modalPSDs >::m_width, m_win, requiredInputHistoryDepth(), and MagAOX::app::MagAOXApp< true >::shutdown().

allocatePSDStreams()

int MagAOX::app::modalPSDs::allocatePSDStreams ( )

protected

Definition at line 802 of file modalPSDs.hpp.

References IMAGESTRUCT_FLOAT, MagAOX::app::MagAOXApp< true >::log(), m_avgpsdStream, m_nModes, m_psd, m_psdBuffer, m_rawPSDHistory, m_rawPSDHistoryCount, m_rawPSDHistoryDepth, m_rawPSDHistoryNext, m_rawpsdStream, m_shmimBase, m_shmimTag, publishedRawPSDHistoryDepth(), and rawPSDHistoryDepth().

Referenced by allocate().

appLogic()

int MagAOX::app::modalPSDs::appLogic ( )

virtual

Implementation of the FSM for modalPSDs.

Returns

0 on no critical error

-1 on an error requiring shutdown

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

Definition at line 569 of file modalPSDs.hpp.

References MagAOX::app::lock(), MagAOX::app::MagAOXApp< true >::m_indiMutex, m_psdThread, SHMIMMONITOR_APP_LOGIC, SHMIMMONITOR_UPDATE_INDI, and XWCAPP_THREAD_CHECK.

appShutdown()

int MagAOX::app::modalPSDs::appShutdown ( )

virtual

Shutdown the app.

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

Definition at line 582 of file modalPSDs.hpp.

References MagAOX::app::lock(), MagAOX::app::MagAOXApp< true >::log(), m_avgpsdStream, m_fftWork, m_freqStream, m_psdCond, m_psdMutex, m_psdThread, m_psdWaiting, m_rawpsdStream, m_tsWork, SHMIMMONITOR_APP_SHUTDOWN, and XWCAPP_THREAD_STOP.

appStartup()

int MagAOX::app::modalPSDs::appStartup ( )

virtual

Startup function.

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

Definition at line 522 of file modalPSDs.hpp.

References CREATE_REG_INDI_NEW_NUMBERF, CREATE_REG_INDI_NEW_NUMBERU, CREATE_REG_INDI_RO_NUMBER, MagAOX::app::MagAOXApp< true >::log(), m_fps, m_fpsDevice, m_fpsProperty, m_indiP_fps, m_indiP_fpsSource, m_indiP_loop, m_indiP_meanTime, m_indiP_psdAvgTime, m_indiP_psdTime, m_loopStateDevice, m_loopStateProperty, m_meanTime, m_psdAvgTime, m_psdThread, m_psdThreadCpuset, m_psdThreadID, m_psdThreadInit, m_psdThreadPrio, m_psdThreadProp, m_psdTime, m_useLoopState, MagAOX::app::stateCodes::OPERATING, psdThreadStart(), REG_INDI_SETPROP, SHMIMMONITOR_APP_STARTUP, MagAOX::app::MagAOXApp< true >::state(), and XWCAPP_THREAD_START.

basePath()

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

inherited

Get the.

Returns

the value of m_ *

Definition at line 1251 of file MagAOXApp.hpp.

cacheMeanHead()

void MagAOX::app::modalPSDs::cacheMeanHead ( std::vector< realT > &  meanHeadCache, cbIndexT  count  ) const

protected

Cache the oldest slice of the currently loaded mean window for the next rolling-mean update.

Parameters

[out]	meanHeadCache	storage for the cached oldest slice
[in]	count	number of mean-window samples to cache

Definition at line 1271 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_meanPtrs, and m_nModes.

Referenced by psdThreadExec(), and libXWCTest::modalPSDsTest::TEST_CASE().

calibDir()

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

inherited

Get the calibration directory.

Returns

the value of m_calibDir

Definition at line 1273 of file MagAOXApp.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 278 of file MagAOXApp.hpp.

circularEntryAdvance()

modalPSDs::cbIndexT MagAOX::app::modalPSDs::circularEntryAdvance ( cbIndexT  from, cbIndexT  to, cbIndexT  maxEntries  )

staticprotected

Compute the forward logical advance between two circular-buffer reference entries.

Parameters

[in]	from	earlier logical entry
[in]	to	later logical entry
[in]	maxEntries	circular-buffer capacity

Definition at line 1182 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by psdThreadExec(), and libXWCTest::modalPSDsTest::TEST_CASE().

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 642 of file MagAOXApp.hpp.

configBase()

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

inherited

Get the config base file.

Returns

the value of m_confgBase

Definition at line 1268 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 1263 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 384 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 1257 of file MagAOXApp.hpp.

cpusetPath()

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

inherited

Get the cpuset path.

Returns

the value of m_cpusetPath

Definition at line 1288 of file MagAOXApp.hpp.

create()

int MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::create ( uint32_t  width, uint32_t  height, uint32_t  depth, uint8_t  datatype, void *  initData = nullptr  )

protectedinherited

Create the image.

This will create the shared memory image, erasing an existing. This is independent of the actual shmim monitoring function, which will pick up the new inode change on its own and restart the allocate() and processImage() cycle.

Returns

0 on success

<0 on error

Parameters

[in]	width	width of the new image
[in]	height	height of the new image
[in]	depth	depth of the new image
[in]	datatype	CACAO data type of the new image
[in]	initData	[optional] data to initialize the new image with. Must be of size width*height*depth*sizeof(dataType)

Definition at line 256 of file shmimMonitor.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 960 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 783 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 748 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 762 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 809 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 840 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 822 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 735 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

Definition at line 796 of file MagAOXApp.hpp.

dataType()

const uint8_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::dataType ( ) const

inherited

Definition at line 156 of file shmimMonitor.hpp.

depth()

const uint32_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::depth ( ) const

inherited

Definition at line 154 of file shmimMonitor.hpp.

derived()

modalPSDs & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::derived ( )

inlineprivateinherited

Definition at line 289 of file shmimMonitor.hpp.

desiredMeanSampleCount()

modalPSDs::cbIndexT MagAOX::app::modalPSDs::desiredMeanSampleCount ( realT  fps ) const

protected

Calculate how many samples are needed for the mean-subtraction window at the current FPS.

Parameters

[in]

fps

frame rate used to convert mean time into samples

Definition at line 1376 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), and m_meanTime.

Referenced by allocate(), and libXWCTest::modalPSDsTest::TEST_CASE().

desiredPSDAverageCount()

int MagAOX::app::modalPSDs::desiredPSDAverageCount ( ) const

protected

Calculate how many raw PSD estimates are needed to cover the requested averaging time.

Definition at line 1356 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_psdAvgTime, m_psdOverlapFraction, and m_psdTime.

Referenced by psdThreadExec(), rawPSDHistoryDepth(), and libXWCTest::modalPSDsTest::TEST_CASE().

driverCtrlName()

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

inherited

Get the INDI control FIFO file name.

Returns

the current value of m_driverCtrlName

Definition at line 1317 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 1305 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 1311 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 308 of file MagAOXApp.hpp.

gitAlert()

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

inherited

Get the value of the git alert flag.

Returns

the current value of m_gitAlert

Definition at line 613 of file MagAOXApp.hpp.

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 976 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 982 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 992 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 410 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.

Parameters

[in]

ipRecv

The property being changed.

Definition at line 1001 of file MagAOXApp.hpp.

height()

const uint32_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::height ( ) const

inherited

Definition at line 152 of file shmimMonitor.hpp.

INDI_NEWCALLBACK_DECL() [1/4]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_meanTime
	)

INDI_NEWCALLBACK_DECL() [2/4]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_overSize
	)

INDI_NEWCALLBACK_DECL() [3/4]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_psdAvgTime
	)

INDI_NEWCALLBACK_DECL() [4/4]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_psdTime
	)

INDI_SETCALLBACK_DECL() [1/3]

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

inherited

INDI_SETCALLBACK_DECL() [2/3]

MagAOX::app::modalPSDs::INDI_SETCALLBACK_DECL	(	modalPSDs	,
		m_indiP_fpsSource
	)

INDI_SETCALLBACK_DECL() [3/3]

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

indiSetPropertyShouldRequest()

bool MagAOX::app::MagAOXApp< _useINDI >::indiSetPropertyShouldRequest ( const indiCallBack &  callBack, bool  all, const std::chrono::steady_clock::time_point &  now  ) const

inlineinherited

Determine whether an unresolved Set-property subscription should be requested now.

Parameters

[in]	callBack	the subscription retry state to evaluate
[in]	all	if true, force an immediate refresh regardless of retry timing
[in]	now	the current monotonic time for scheduling

Definition at line 944 of file MagAOXApp.hpp.

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 1098 of file MagAOXApp.hpp.

latestWindowRefEntry()

modalPSDs::cbIndexT MagAOX::app::modalPSDs::latestWindowRefEntry ( const ampCircBuffT::snapshotT &  sn, cbIndexT  count  )

staticprotected

Compute the reference entry for the latest logical window while preserving historical semantics.

The returned window ends at the sample immediately preceding snapshot.latest. This matches the longstanding modalPSDs behavior and keeps the writable/latest publication edge out of the PSD window.

Parameters

[in]	sn	the snapshot to use
[in]	count	the requested window length

Definition at line 1161 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by loadPsdInputWindows(), and psdThreadExec().

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 272 of file MagAOXApp.hpp.

loadConfig() [1/2]

void MagAOX::app::modalPSDs::loadConfig ( )

virtual

Definition at line 517 of file modalPSDs.hpp.

References loadConfigImpl().

loadConfig() [2/2]

int MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::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 178 of file shmimMonitor.hpp.

loadConfigImpl()

int MagAOX::app::modalPSDs::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 480 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_fpsDevice, m_fpsElement, m_fpsProperty, m_fpsTol, m_loopClosed, m_loopNumber, m_loopStateDevice, m_loopStateElement, m_loopStateProperty, m_meanTime, m_psdAvgTime, m_psdTime, m_shmimBase, m_shmimTag, m_useLoopState, and SHMIMMONITOR_LOAD_CONFIG.

Referenced by loadConfig().

loadPsdInputWindows()

bool MagAOX::app::modalPSDs::loadPsdInputWindows ( ampCircBuffT::snapshotT &  sn )

protected

Load the PSD and mean pointer windows from a single validated snapshot.

Parameters

[out]

sn

the snapshot used for both windows

Definition at line 1197 of file modalPSDs.hpp.

References latestWindowRefEntry(), MagAOX::app::MagAOXApp< true >::log(), m_ampCircBuff, m_meanPtrs, m_meanSize, m_tsPtrs, m_tsSize, and precedingWindowRefEntry().

Referenced by psdThreadExec(), and libXWCTest::modalPSDsTest::SCENARIO().

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 522 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 355 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 368 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 377 of file MagAOXApp.hpp.

loopPause()

unsigned long MagAOX::app::MagAOXApp< _useINDI >::loopPause ( )

inherited

Get the loop pause time.

Returns

the value of m_loopPause

Definition at line 1293 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 1155 of file MagAOXApp.hpp.

noteIndiSetPropertyRequested()

void MagAOX::app::MagAOXApp< _useINDI >::noteIndiSetPropertyRequested ( indiCallBack &  callBack, const std::chrono::steady_clock::time_point &  now  )

inlineinherited

Update retry tracking after sending a GetProperties request for a monitored Set-property.

Parameters

	callBack	[in/out] the subscription retry state to update
[in]	now	the current monotonic time for scheduling

Definition at line 951 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, MagAOX::app::zaberLowLevel, and MagAOX::app::zaberLowLevelBinary.

Definition at line 1200 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 1216 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 1226 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 1235 of file MagAOXApp.hpp.

precedingWindowRefEntry()

modalPSDs::cbIndexT MagAOX::app::modalPSDs::precedingWindowRefEntry ( const ampCircBuffT::snapshotT &  sn, cbIndexT  refEntry, cbIndexT  count  )

staticprotected

Compute the reference entry for a logical window immediately preceding another logical window.

Parameters

[in]	sn	the snapshot to use
[in]	refEntry	later window reference entry
[in]	count	the requested window length

Definition at line 1172 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by loadPsdInputWindows(), and psdThreadExec().

processImage()

int MagAOX::app::modalPSDs::processImage ( void *  curr_src, const dev::shmimT &  dummy  )

protected

Parameters

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

Definition at line 863 of file modalPSDs.hpp.

References acceptLoopStateFrame(), MagAOX::app::MagAOXApp< true >::log(), and m_ampCircBuff.

psdThreadExec()

void MagAOX::app::modalPSDs::psdThreadExec ( )

protected

PSD Calculation thread function.

Runs until m_shutdown is true.

Definition at line 884 of file modalPSDs.hpp.

References cacheMeanHead(), circularEntryAdvance(), desiredPSDAverageCount(), latestWindowRefEntry(), loadPsdInputWindows(), MagAOX::app::lock(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_WARNING, m_ampCircBuff, m_avgpsdStream, m_df, m_fft, m_fftWork, m_fps, m_meanSize, m_nModes, m_psd, m_psdBuffer, m_psdCond, m_psdMutex, m_psdRestarting, m_psdThreadID, m_psdThreadInit, m_psdWaiting, m_rawPSDHistory, m_rawPSDHistoryCount, m_rawPSDHistoryDepth, m_rawPSDHistoryNext, m_rawpsdStream, m_tsOverlapSize, m_tsPtrs, m_tsSize, m_tsWork, m_win, precedingWindowRefEntry(), rawPSDPlaneByAge(), recomputeAveragedPSDSum(), recomputeMeanSums(), rollMeanSums(), MagAOX::app::MagAOXApp< true >::shutdown(), storedRawPSDCount(), and updatePlaneSum().

Referenced by psdThreadStart().

psdThreadStart()

void MagAOX::app::modalPSDs::psdThreadStart ( modalPSDs *  p )

staticprotected

PS Calculation thread starter function.

Parameters

[in]

p

pointer to this

Definition at line 879 of file modalPSDs.hpp.

References psdThreadExec().

Referenced by appStartup().

publishedRawPSDHistoryDepth()

uint32_t MagAOX::app::modalPSDs::publishedRawPSDHistoryDepth ( ) const

protected

Calculate the published raw PSD history depth retained in shared memory.

Definition at line 1419 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), and m_nPSDHistory.

Referenced by allocatePSDStreams(), rawPSDHistoryDepth(), rawPSDPlaneByAge(), and storedRawPSDCount().

rawPSDHistoryDepth()

uint32_t MagAOX::app::modalPSDs::rawPSDHistoryDepth ( ) const

protected

Calculate the additional PSD history depth needed beyond the published raw-PSD shmim.

Definition at line 1406 of file modalPSDs.hpp.

References desiredPSDAverageCount(), MagAOX::app::MagAOXApp< true >::log(), and publishedRawPSDHistoryDepth().

Referenced by allocatePSDStreams(), and libXWCTest::modalPSDsTest::TEST_CASE().

rawPSDPlaneByAge()

const modalPSDs::realT * MagAOX::app::modalPSDs::rawPSDPlaneByAge ( uint64_t  age, size_t  planeElements  ) const

protected

Locate a retained raw PSD plane by age, where age 0 is the newest plane.

Parameters

[in]	age	age of the requested raw PSD plane
[in]	planeElements	number of elements per raw PSD plane

Definition at line 1297 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_rawPSDHistory, m_rawPSDHistoryCount, m_rawPSDHistoryDepth, m_rawPSDHistoryNext, m_rawpsdStream, and publishedRawPSDHistoryDepth().

Referenced by psdThreadExec(), and recomputeAveragedPSDSum().

recomputeAveragedPSDSum()

void MagAOX::app::modalPSDs::recomputeAveragedPSDSum ( std::vector< double > &  avgPsdSum, uint64_t  windowCount, size_t  planeElements  ) const

protected

Recompute the averaged-PSD running sum from the newest windowCount retained raw PSD planes.

Parameters

[out]	avgPsdSum	running sum over the averaging window
[in]	windowCount	number of raw PSD planes to sum
[in]	planeElements	number of elements per raw PSD plane

Definition at line 1319 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), rawPSDPlaneByAge(), and updatePlaneSum().

Referenced by psdThreadExec().

recomputeMeanSums()

void MagAOX::app::modalPSDs::recomputeMeanSums ( std::vector< double > &  meanSums ) const

protected

Recompute the per-mode sums for the full mean window from the currently loaded pointers.

Parameters

[out]

meanSums

per-mode sums over the full mean window

Definition at line 1236 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_meanPtrs, m_meanSize, and m_nModes.

Referenced by psdThreadExec(), and libXWCTest::modalPSDsTest::TEST_CASE().

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 856 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 866 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 933 of file MagAOXApp.hpp.

requiredInputHistoryDepth()

modalPSDs::cbIndexT MagAOX::app::modalPSDs::requiredInputHistoryDepth ( ) const

protected

Calculate the total input-history depth needed to read both windows safely from the fixed-size circular buffer.

Definition at line 1395 of file modalPSDs.hpp.

References m_meanSize, and m_tsSize.

Referenced by allocate(), and libXWCTest::modalPSDsTest::TEST_CASE().

resetIndiSetPropertyRetry()

void MagAOX::app::MagAOXApp< _useINDI >::resetIndiSetPropertyRetry ( indiCallBack &  callBack )

inlineinherited

Reset retry tracking for a monitored INDI Set-property subscription.

Parameters

callBack

[in/out] the subscription retry state to reset

Definition at line 941 of file MagAOXApp.hpp.

rollMeanSums()

void MagAOX::app::modalPSDs::rollMeanSums ( std::vector< double > &  meanSums, const std::vector< realT > &  meanHeadCache, cbIndexT  advance  ) const

protected

Update per-mode mean sums using the cached oldest slice and the newest loaded mean-window slice.

Parameters

[in,out]	meanSums	per-mode sums to update
[in]	meanHeadCache	cached oldest slice from the prior mean window
[in]	advance	number of samples by which the mean window advanced

Definition at line 1250 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_meanPtrs, m_meanSize, and m_nModes.

Referenced by psdThreadExec(), and libXWCTest::modalPSDsTest::TEST_CASE().

secretsPath()

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

inherited

Get the secrets path.

Returns

the value of m_secretsPath

Definition at line 1283 of file MagAOXApp.hpp.

sendGetPropertySetList()

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

inherited

Definition at line 970 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 1121 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 1111 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 1128 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 250 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 481 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 490 of file MagAOXApp.hpp.

setSigTermHandler()

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

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 401 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 262 of file MagAOXApp.hpp.

setupConfig() [1/2]

void MagAOX::app::modalPSDs::setupConfig ( )

virtual

Definition at line 334 of file modalPSDs.hpp.

References SHMIMMONITOR_SETUP_CONFIG.

setupConfig() [2/2]

int MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::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 168 of file shmimMonitor.hpp.

shmimName()

const std::string & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::shmimName ( ) const

inherited

Definition at line 148 of file shmimMonitor.hpp.

shutdown()

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

inherited

Get the value of the shutdown flag.

Returns

the current value of m_shutdown

Definition at line 1299 of file MagAOXApp.hpp.

smThreadExec()

void MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::smThreadExec ( )

protectedinherited

Execute the monitoring thread.

< The semaphore to monitor for new image data

Todo:

change to naxis?

Todo:

change to naxis?

Definition at line 246 of file shmimMonitor.hpp.

smThreadStart()

void MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::smThreadStart ( shmimMonitor< modalPSDs > *  s )

staticprotectedinherited

Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

Parameters

[in]

s

a pointer to a shmimMonitor instance (normally this)

Definition at line 243 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 1144 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 967 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 591 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 599 of file MagAOXApp.hpp.

stateAlert()

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

inherited

Get the value of the state alert flag.

Returns

the current value of m_stateAlert

Definition at line 607 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 632 of file MagAOXApp.hpp.

storedRawPSDCount()

uint64_t MagAOX::app::modalPSDs::storedRawPSDCount ( ) const

protected

Count how many raw PSD planes are currently retained across the published and overflow histories.

Definition at line 1292 of file modalPSDs.hpp.

References m_rawPSDHistoryDepth, m_rawpsdStream, and publishedRawPSDHistoryDepth().

Referenced by psdThreadExec().

sysPath()

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

inherited

Get the system path.

Returns

the value of m_sysPath

Definition at line 1278 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 556 of file MagAOXApp.hpp.

typeSize()

const size_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::typeSize ( ) const

inherited

Definition at line 158 of file shmimMonitor.hpp.

unlockPID()

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

protectedinherited

Remove the PID file.

Definition at line 525 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 1031 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 1060 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 1014 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 1077 of file MagAOXApp.hpp.

updateINDI()

int MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::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 284 of file shmimMonitor.hpp.

updatePlaneSum()

void MagAOX::app::modalPSDs::updatePlaneSum ( std::vector< double > &  planeSum, const realT *  addPlane, const realT *  removePlane, size_t  planeElements  )

staticprotected

Add one raw PSD plane and optionally subtract one outgoing raw PSD plane from the running average sum.

Parameters

[in,out]	planeSum	running sum to update
[in]	addPlane	newest raw PSD plane to add
[in]	removePlane	outgoing raw PSD plane to subtract, or nullptr
[in]	planeElements	number of elements per raw PSD plane

Definition at line 1337 of file modalPSDs.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by psdThreadExec(), recomputeAveragedPSDSum(), and libXWCTest::modalPSDsTest::TEST_CASE().

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 1085 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 1042 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.

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

Definition at line 1207 of file MagAOXApp.hpp.

width()

const uint32_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::width ( ) const

inherited

Definition at line 150 of file shmimMonitor.hpp.

Friends And Related Symbol Documentation

dev::shmimMonitor< modalPSDs >

friend class dev::shmimMonitor< modalPSDs >

friend

Definition at line 46 of file modalPSDs.hpp.

modalPSDs_test

friend class modalPSDs_test

friend

Definition at line 46 of file modalPSDs.hpp.

Member Data Documentation

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 716 of file MagAOXApp.hpp.

m_ampCircBuff

ampCircBuffT MagAOX::app::modalPSDs::m_ampCircBuff

protected

Definition at line 105 of file modalPSDs.hpp.

Referenced by allocate(), loadPsdInputWindows(), processImage(), and psdThreadExec().

m_avgpsdStream

IMAGE* MagAOX::app::modalPSDs::m_avgpsdStream { nullptr }

protected

The ImageStreamIO shared memory buffer to hold the average psds.

Definition at line 260 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), appShutdown(), and psdThreadExec().

m_basePath

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

protectedinherited

The base path of the MagAO-X system.

Definition at line 188 of file MagAOXApp.hpp.

m_calibDir

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

protectedinherited

The path to calibration files for MagAOX.

Definition at line 196 of file MagAOXApp.hpp.

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 194 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 192 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 190 of file MagAOXApp.hpp.

m_cpusetPath

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

protectedinherited

Path to the cpusets mount.

The path to the cpusets mount is configured by the environment variable defined by MAGOX_env_cpuset in environment.hpp. This environment variable is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used.

Definition at line 207 of file MagAOXApp.hpp.

m_dataType

uint8_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_dataType

protectedinherited

The ImageStreamIO type code.

Definition at line 140 of file shmimMonitor.hpp.

m_depth

uint32_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_depth

protectedinherited

The depth of the circular buffer in the stream.

Definition at line 138 of file shmimMonitor.hpp.

m_df

realT MagAOX::app::modalPSDs::m_df { 1 }

protected

Definition at line 111 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

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 727 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 719 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 722 of file MagAOXApp.hpp.

m_euidCalled

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidCalled

privateinherited

The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid).

Definition at line 422 of file MagAOXApp.hpp.

m_euidReal

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidReal

privateinherited

The real user id of the proces (i.e. the lower privileged id of the user)

Definition at line 421 of file MagAOXApp.hpp.

m_fft

mx::math::ft::fftT<realT, std::complex<realT>, 1, 0> MagAOX::app::modalPSDs::m_fft

protected

Definition at line 132 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

m_fftEnv

mx::math::ft::fftwEnvironment<realT> MagAOX::app::modalPSDs::m_fftEnv

protected

Definition at line 133 of file modalPSDs.hpp.

m_fftWork

std::complex<realT>* MagAOX::app::modalPSDs::m_fftWork { nullptr }

protected

Definition at line 127 of file modalPSDs.hpp.

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

m_fftWorkSize

size_t MagAOX::app::modalPSDs::m_fftWorkSize { 0 }

protected

Definition at line 128 of file modalPSDs.hpp.

m_fps

std::atomic<realT> MagAOX::app::modalPSDs::m_fps { 0 }

protected

The current input frame rate used to size PSD windows.

Definition at line 109 of file modalPSDs.hpp.

Referenced by allocate(), appStartup(), and psdThreadExec().

m_fpsDevice

std::string MagAOX::app::modalPSDs::m_fpsDevice

protected

Device name for getting fps to set circular buffer length.

Definition at line 75 of file modalPSDs.hpp.

Referenced by appStartup(), and loadConfigImpl().

m_fpsElement

std::string MagAOX::app::modalPSDs::m_fpsElement { "current" }

protected

Element name for getting fps to set circular buffer length.

Definition at line 77 of file modalPSDs.hpp.

Referenced by loadConfigImpl().

m_fpsProperty

std::string MagAOX::app::modalPSDs::m_fpsProperty { "fps" }

protected

Property name for getting fps to set circular buffer length.

Definition at line 76 of file modalPSDs.hpp.

Referenced by appStartup(), and loadConfigImpl().

m_fpsTol

realT MagAOX::app::modalPSDs::m_fpsTol { 0 }

protected

The tolerance for detecting a change in FPS.

Definition at line 87 of file modalPSDs.hpp.

Referenced by loadConfigImpl().

m_freqStream

IMAGE* MagAOX::app::modalPSDs::m_freqStream { nullptr }

protected

The ImageStreamIO shared memory buffer to hold the frequency scale.

Definition at line 246 of file modalPSDs.hpp.

Referenced by allocate(), and appShutdown().

m_getExistingFirst

bool MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::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 127 of file shmimMonitor.hpp.

m_gitAlert

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

privateinherited

Definition at line 582 of file MagAOXApp.hpp.

m_height

uint32_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_height

protectedinherited

The height of the images in the stream.

Definition at line 137 of file shmimMonitor.hpp.

m_imageStream

IMAGE MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_imageStream

protectedinherited

The ImageStreamIO shared memory buffer.

Definition at line 143 of file shmimMonitor.hpp.

m_indiCallBackMutex

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

inherited

Mutex for locking INDI callback maps and per-entry callback state.

Lock ordering policy: 1) Prefer never holding both m_indiMutex and m_indiCallBackMutex at the same time. 2) If both are required in future code, always acquire m_indiMutex before m_indiCallBackMutex.

Definition at line 669 of file MagAOXApp.hpp.

m_indiDriver

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 659 of file MagAOXApp.hpp.

m_indiMutex

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

inherited

Mutex for locking INDI communications.

Definition at line 662 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 707 of file MagAOXApp.hpp.

m_indiP_clearFSMAlert

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

protectedinherited

indi Property to clear an FSM alert.

Definition at line 1137 of file MagAOXApp.hpp.

m_indiP_fps

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_fps

protected

Definition at line 318 of file modalPSDs.hpp.

Referenced by appStartup().

m_indiP_fpsSource

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_fpsSource

protected

Definition at line 316 of file modalPSDs.hpp.

Referenced by appStartup().

m_indiP_frameSize

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_indiP_frameSize

protectedinherited

Property used to report the current frame size.

Definition at line 274 of file shmimMonitor.hpp.

m_indiP_loop

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_loop

protected

Definition at line 317 of file modalPSDs.hpp.

Referenced by appStartup().

m_indiP_meanTime

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_meanTime

protected

Definition at line 314 of file modalPSDs.hpp.

Referenced by appStartup().

m_indiP_overSize

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_overSize

protected

Definition at line 315 of file modalPSDs.hpp.

m_indiP_powerChannel

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

protectedinherited

INDI property used to communicate power state.

Definition at line 1193 of file MagAOXApp.hpp.

m_indiP_psdAvgTime

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_psdAvgTime

protected

Definition at line 313 of file modalPSDs.hpp.

Referenced by appStartup().

m_indiP_psdTime

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_psdTime

protected

Definition at line 312 of file modalPSDs.hpp.

Referenced by appStartup().

m_indiP_shmimName

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_indiP_shmimName

protectedinherited

Property used to report the shmim buffer name.

Definition at line 272 of file shmimMonitor.hpp.

m_indiP_state

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

protectedinherited

indi Property to report the application state.

Definition at line 1134 of file MagAOXApp.hpp.

m_indiSetCallBacks

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

protectedinherited

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

The key for these is device.name

Definition at line 712 of file MagAOXApp.hpp.

m_inode

ino_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_inode

protectedinherited

The inode of the image stream file.

Definition at line 145 of file shmimMonitor.hpp.

m_log

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

staticinherited

Definition at line 345 of file MagAOXApp.hpp.

m_loopClosed

std::atomic<bool> MagAOX::app::modalPSDs::m_loopClosed { true }

protected

Current closed-loop state used to gate PSD ingestion and processing.

Definition at line 85 of file modalPSDs.hpp.

Referenced by acceptLoopStateFrame(), and loadConfigImpl().

m_loopNumber

int MagAOX::app::modalPSDs::m_loopNumber { 1 }

protected

Definition at line 68 of file modalPSDs.hpp.

Referenced by loadConfigImpl().

m_loopPause

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_loopPause

protectedinherited

The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X.

Definition at line 209 of file MagAOXApp.hpp.

m_loopStateDevice

std::string MagAOX::app::modalPSDs::m_loopStateDevice

protected

Optional device name providing loop-state gating updates.

Definition at line 79 of file modalPSDs.hpp.

Referenced by appStartup(), and loadConfigImpl().

m_loopStateElement

std::string MagAOX::app::modalPSDs::m_loopStateElement { "toggle" }

protected

Element name used to interpret closed-loop state.

Definition at line 81 of file modalPSDs.hpp.

Referenced by loadConfigImpl().

m_loopStateProperty

std::string MagAOX::app::modalPSDs::m_loopStateProperty { "loop_state" }

protected

Optional property name providing loop-state gating updates.

Definition at line 80 of file modalPSDs.hpp.

Referenced by appStartup(), and loadConfigImpl().

m_meanPtrs

std::vector<realT *> MagAOX::app::modalPSDs::m_meanPtrs

protected

Snapshot of the latest mean-window pointers for PSD computation.

Definition at line 122 of file modalPSDs.hpp.

Referenced by allocate(), cacheMeanHead(), loadPsdInputWindows(), recomputeMeanSums(), and rollMeanSums().

m_meanSize

cbIndexT MagAOX::app::modalPSDs::m_meanSize { 20000 }

protected

The length of the time series over which to calculate the mean.

Definition at line 117 of file modalPSDs.hpp.

Referenced by allocate(), loadPsdInputWindows(), psdThreadExec(), recomputeMeanSums(), requiredInputHistoryDepth(), and rollMeanSums().

m_meanTime

std::atomic<realT> MagAOX::app::modalPSDs::m_meanTime

protected

Initial value:

{
        10 }

The time over which to calculate the mean for detrending. The default is 10 sec.

Definition at line 91 of file modalPSDs.hpp.

Referenced by appStartup(), desiredMeanSampleCount(), and loadConfigImpl().

m_nModes

size_t MagAOX::app::modalPSDs::m_nModes { 0 }

protected

the number of modes to calculate PSDs for.

Definition at line 103 of file modalPSDs.hpp.

Referenced by allocate(), allocatePSDStreams(), cacheMeanHead(), psdThreadExec(), recomputeMeanSums(), and rollMeanSums().

m_nPSDHistory

int MagAOX::app::modalPSDs::m_nPSDHistory { 100 }

protected

Minimum number of raw PSD estimates to retain in the history stream.

Definition at line 99 of file modalPSDs.hpp.

Referenced by publishedRawPSDHistoryDepth().

m_pid

pid_t MagAOX::app::MagAOXApp< _useINDI >::m_pid

protectedinherited

This process's PID.

Definition at line 506 of file MagAOXApp.hpp.

m_powerChannel

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

protectedinherited

The INDI property name of the channel controlling this device's power.

Definition at line 1179 of file MagAOXApp.hpp.

m_powerDevice

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

protectedinherited

The INDI device name of the power controller.

Definition at line 1178 of file MagAOXApp.hpp.

m_powerElement

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

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 1180 of file MagAOXApp.hpp.

m_powerMgtEnabled

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

protectedinherited

Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error.

Definition at line 1173 of file MagAOXApp.hpp.

m_powerOnCounter

int MagAOX::app::MagAOXApp< _useINDI >::m_powerOnCounter

protectedinherited

Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup.

Definition at line 1186 of file MagAOXApp.hpp.

m_powerOnWait

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_powerOnWait

protectedinherited

Default time in sec to wait for device to boot after power on.

Definition at line 1183 of file MagAOXApp.hpp.

m_powerState

int MagAOX::app::MagAOXApp< _useINDI >::m_powerState

protectedinherited

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

Definition at line 1190 of file MagAOXApp.hpp.

m_powerTargetElement

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

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 1181 of file MagAOXApp.hpp.

m_powerTargetState

int MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState

protectedinherited

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

Definition at line 1191 of file MagAOXApp.hpp.

m_psd

std::vector<realT> MagAOX::app::modalPSDs::m_psd

protected

Definition at line 130 of file modalPSDs.hpp.

Referenced by allocate(), allocatePSDStreams(), and psdThreadExec().

m_psdAvgTime

std::atomic<realT> MagAOX::app::modalPSDs::m_psdAvgTime { 10 }

protected

The time over which to average PSD estimates. The default is 10 sec.

Definition at line 90 of file modalPSDs.hpp.

Referenced by appStartup(), desiredPSDAverageCount(), and loadConfigImpl().

m_psdBuffer

mx::improc::eigenImage<realT> MagAOX::app::modalPSDs::m_psdBuffer

protected

Definition at line 248 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), and psdThreadExec().

m_psdCond

std::condition_variable MagAOX::app::modalPSDs::m_psdCond

protected

Coordinates quiescence during restart.

Definition at line 154 of file modalPSDs.hpp.

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

m_psdMutex

std::mutex MagAOX::app::modalPSDs::m_psdMutex

protected

Protects restart handoff between allocate() and the PSD thread.

Definition at line 152 of file modalPSDs.hpp.

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

m_psdOverlapFraction

realT MagAOX::app::modalPSDs::m_psdOverlapFraction { 0.5 }

protected

The fraction of the sample time to overlap by.

Definition at line 97 of file modalPSDs.hpp.

Referenced by allocate(), and desiredPSDAverageCount().

m_psdRestarting

std::atomic<bool> MagAOX::app::modalPSDs::m_psdRestarting { true }

protected

Synchronization flag. This will only become false after a successful call to allocate.

Definition at line 147 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

m_psdThread

std::thread MagAOX::app::modalPSDs::m_psdThread

protected

The PSD Calculation thread.

Definition at line 143 of file modalPSDs.hpp.

Referenced by appLogic(), appShutdown(), and appStartup().

m_psdThreadCpuset

std::string MagAOX::app::modalPSDs::m_psdThreadCpuset

protected

The cpuset to use for the PSD Calculation thread.

Definition at line 141 of file modalPSDs.hpp.

Referenced by appStartup().

m_psdThreadID

pid_t MagAOX::app::modalPSDs::m_psdThreadID { 0 }

protected

PSD Calculation thread PID.

Definition at line 156 of file modalPSDs.hpp.

Referenced by appStartup(), and psdThreadExec().

m_psdThreadInit

bool MagAOX::app::modalPSDs::m_psdThreadInit { true }

protected

Initialization flag for the PSD Calculation thread.

Definition at line 145 of file modalPSDs.hpp.

Referenced by appStartup(), and psdThreadExec().

m_psdThreadPrio

int MagAOX::app::modalPSDs::m_psdThreadPrio { 0 }

protected

Priority of the PSD Calculation thread.

Definition at line 139 of file modalPSDs.hpp.

Referenced by appStartup().

m_psdThreadProp

pcf::IndiProperty MagAOX::app::modalPSDs::m_psdThreadProp

protected

The property to hold the PSD Calculation thread details.

Definition at line 158 of file modalPSDs.hpp.

Referenced by appStartup().

m_psdTime

std::atomic<realT> MagAOX::app::modalPSDs::m_psdTime { 1 }

protected

The length of time over which to calculate PSDs. The default is 1 sec.

Definition at line 89 of file modalPSDs.hpp.

Referenced by allocate(), appStartup(), desiredPSDAverageCount(), and loadConfigImpl().

m_psdWaiting

bool MagAOX::app::modalPSDs::m_psdWaiting { false }

protected

Synchronization flag protected by m_psdMutex.

Definition at line 150 of file modalPSDs.hpp.

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

m_rawPSDHistory

std::vector<realT> MagAOX::app::modalPSDs::m_rawPSDHistory

protected

Heap-backed overflow history for raw PSD estimates beyond the shmim depth.

Definition at line 250 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), psdThreadExec(), and rawPSDPlaneByAge().

m_rawPSDHistoryCount

uint64_t MagAOX::app::modalPSDs::m_rawPSDHistoryCount { 0 }

protected

Number of overflow PSD estimates stored since the last restart.

Definition at line 256 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), psdThreadExec(), and rawPSDPlaneByAge().

m_rawPSDHistoryDepth

uint32_t MagAOX::app::modalPSDs::m_rawPSDHistoryDepth { 0 }

protected

Number of overflow PSD estimates currently allocated in m_rawPSDHistory.

Definition at line 252 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), psdThreadExec(), rawPSDPlaneByAge(), and storedRawPSDCount().

m_rawPSDHistoryNext

uint32_t MagAOX::app::modalPSDs::m_rawPSDHistoryNext { 0 }

protected

Next overflow slot to overwrite in m_rawPSDHistory.

Definition at line 254 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), psdThreadExec(), and rawPSDPlaneByAge().

m_rawpsdStream

IMAGE* MagAOX::app::modalPSDs::m_rawpsdStream { nullptr }

protected

The ImageStreamIO shared memory buffer to hold the raw psds.

Definition at line 258 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), appShutdown(), psdThreadExec(), rawPSDPlaneByAge(), and storedRawPSDCount().

m_restart

bool MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_restart

protectedinherited

Flag indicating tha the shared memory should be reinitialized.

Definition at line 224 of file shmimMonitor.hpp.

m_secretsPath

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

protectedinherited

Path to the secrets directory, where passwords, etc, are stored.

Definition at line 200 of file MagAOXApp.hpp.

m_self

MagAOXApp< _useINDI > * MagAOX::app::MagAOXApp< _useINDI >::m_self

staticprivateinherited

Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers.

Definition at line 397 of file MagAOXApp.hpp.

m_semaphoreNumber

int MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_semaphoreNumber

protectedinherited

The image structure semaphore index.

Definition at line 134 of file shmimMonitor.hpp.

m_shmimBase

std::string MagAOX::app::modalPSDs::m_shmimBase

protected

The base name for the PSD shmims. If empty, the default, then aolN where N is the loop number is used

Definition at line 70 of file modalPSDs.hpp.

Referenced by allocate(), allocatePSDStreams(), and loadConfigImpl().

m_shmimName

std::string MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_shmimName

protectedinherited

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

Definition at line 118 of file shmimMonitor.hpp.

m_shmimTag

std::string MagAOX::app::modalPSDs::m_shmimTag { "cl" }

protected

The tag to apply to the front of psds in the shmim name. Default is cl.

Definition at line 73 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), and loadConfigImpl().

m_shutdown

int MagAOX::app::MagAOXApp< _useINDI >::m_shutdown

protectedinherited

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

Definition at line 214 of file MagAOXApp.hpp.

m_smCpuset

std::string MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smCpuset

protectedinherited

The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

Definition at line 123 of file shmimMonitor.hpp.

m_smState

shmimMonitorState MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smState

protectedinherited

Definition at line 132 of file shmimMonitor.hpp.

m_smThread

std::thread MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smThread

protectedinherited

A separate thread for the actual monitoring.

Definition at line 240 of file shmimMonitor.hpp.

m_smThreadID

pid_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smThreadID

protectedinherited

The s.m. thread PID.

Definition at line 236 of file shmimMonitor.hpp.

m_smThreadInit

bool MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smThreadInit

protectedinherited

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

Definition at line 234 of file shmimMonitor.hpp.

m_smThreadPrio

int MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smThreadPrio

protectedinherited

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

Definition at line 121 of file shmimMonitor.hpp.

m_smThreadProp

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_smThreadProp

protectedinherited

The property to hold the s.m. thread details.

Definition at line 238 of file shmimMonitor.hpp.

m_state

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 576 of file MagAOXApp.hpp.

m_stateAlert

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

privateinherited

Definition at line 579 of file MagAOXApp.hpp.

m_stateLogged

int MagAOX::app::MagAOXApp< _useINDI >::m_stateLogged

privateinherited

Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().

Definition at line 584 of file MagAOXApp.hpp.

m_suid

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_suid

privateinherited

The save-set user id of the process.

Definition at line 424 of file MagAOXApp.hpp.

m_sysPath

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

protectedinherited

The path to the system directory, for PID file, etc.

Definition at line 198 of file MagAOXApp.hpp.

m_targetState

stateCodes::stateCodeT MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_targetState

protectedinherited

Definition at line 130 of file shmimMonitor.hpp.

m_tsOverlapSize

cbIndexT MagAOX::app::modalPSDs::m_tsOverlapSize { 1000 }

protected

The number of samples in the overlap.

Definition at line 115 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

m_tsPtrs

std::vector<realT *> MagAOX::app::modalPSDs::m_tsPtrs

protected

Snapshot of the latest time-series window pointers for PSD computation.

Definition at line 121 of file modalPSDs.hpp.

Referenced by allocate(), loadPsdInputWindows(), and psdThreadExec().

m_tsSize

cbIndexT MagAOX::app::modalPSDs::m_tsSize { 2000 }

protected

The length of the time series sample over which the PSD is calculated.

Definition at line 113 of file modalPSDs.hpp.

Referenced by allocate(), loadPsdInputWindows(), psdThreadExec(), and requiredInputHistoryDepth().

m_tsWork

realT* MagAOX::app::modalPSDs::m_tsWork { nullptr }

protected

Definition at line 124 of file modalPSDs.hpp.

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

m_tsWorkSize

size_t MagAOX::app::modalPSDs::m_tsWorkSize { 0 }

protected

Definition at line 125 of file modalPSDs.hpp.

m_typeSize

size_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_typeSize

protectedinherited

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

Definition at line 141 of file shmimMonitor.hpp.

m_useINDI

constexpr bool MagAOX::app::MagAOXApp< _useINDI >::m_useINDI

staticconstexprprotectedinherited

Flag controlling whether INDI is used. If false, then no INDI code executes.

Definition at line 654 of file MagAOXApp.hpp.

m_useLoopState

bool MagAOX::app::modalPSDs::m_useLoopState { false }

protected

Whether PSD ingestion is gated by an external loop-state property.

Definition at line 83 of file modalPSDs.hpp.

Referenced by acceptLoopStateFrame(), appStartup(), and loadConfigImpl().

m_width

uint32_t MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::m_width

protectedinherited

The width of the images in the stream.

Definition at line 136 of file shmimMonitor.hpp.

m_win

std::vector<realT> MagAOX::app::modalPSDs::m_win

protected

The window function. By default this is Hann.

Definition at line 119 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

pidFileName

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

protectedinherited

The name of the PID file.

Definition at line 504 of file MagAOXApp.hpp.

---

The documentation for this class was generated from the following file:

• apps/modalPSDs/modalPSDs.hpp