xrif2shmim Class Reference

A utility to stream MagaO-X images from xrif compressed archives to an ImageStreamIO stream. More...

#include <xrif2shmim.hpp>

Inheritance diagram for xrif2shmim:

Collaboration diagram for xrif2shmim:

Public Member Functions
	~xrif2shmim ()
virtual void	setupConfig ()
virtual void	loadConfig ()
virtual int	execute ()

Protected Attributes
xrif_t	m_xrif { nullptr }
Configurable Parameters
std::string	m_dir
std::vector< std::string >	m_files
	List of files to use. If dir is not empty, it will be pre-pended to each name. More...
size_t	m_numFrames
bool	m_earliest { false }
std::string	m_shmimName
	The name of the shared memory buffer to stream to. Default is "xrif2shmim". More...
uint32_t	m_circBuffLength { 1 }
	The length of the shared memory circular buffer. Default is 1. More...
double	m_fps { 10 }
	The rate, in frames per second, at which to stream images. Default is 10 fps. More...
Image Data
uint32_t	m_width { 0 }
	The width of the image. More...
uint32_t	m_height { 0 }
	The height of the image. More...
mx::improc::eigenCube< uint16_t >	m_frames
uint8_t	m_dataType
	The ImageStreamIO type code. More...
size_t	m_typeSize { 0 }
	The size of the type, in bytes. Result of sizeof. More...
IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer. More...

Detailed Description

A utility to stream MagaO-X images from xrif compressed archives to an ImageStreamIO stream.

Todo:

finish md doc for xrif2shmim

Definition at line 64 of file xrif2shmim.hpp.

Constructor & Destructor Documentation

~xrif2shmim()

xrif2shmim::~xrif2shmim ( )

inline

Definition at line 122 of file xrif2shmim.hpp.

Member Function Documentation

execute()

int xrif2shmim::execute ( void  )

inlinevirtual

Definition at line 211 of file xrif2shmim.hpp.

loadConfig()

void xrif2shmim::loadConfig ( )

inlinevirtual

Definition at line 200 of file xrif2shmim.hpp.

setupConfig()

void xrif2shmim::setupConfig ( )

inlinevirtual

Definition at line 130 of file xrif2shmim.hpp.

Member Data Documentation

m_circBuffLength

uint32_t xrif2shmim::m_circBuffLength { 1 }

protected

The length of the shared memory circular buffer. Default is 1.

Definition at line 87 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_dataType

uint8_t xrif2shmim::m_dataType

protected

The ImageStreamIO type code.

Definition at line 104 of file xrif2shmim.hpp.

Referenced by execute().

m_dir

std::string xrif2shmim::m_dir

protected

The directory to search for files. Can be empty if pull path given in files. If files is empty, all archives in dir will be used.

Definition at line 71 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_earliest

bool xrif2shmim::m_earliest { false }

protected

If true, then the earliest numFrames in the archive are used. By default (if not set) the latest numFrames are used.

Definition at line 81 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_files

std::vector<std::string> xrif2shmim::m_files

protected

List of files to use. If dir is not empty, it will be pre-pended to each name.

Definition at line 75 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_fps

double xrif2shmim::m_fps { 10 }

protected

The rate, in frames per second, at which to stream images. Default is 10 fps.

Definition at line 89 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_frames

mx::improc::eigenCube<uint16_t> xrif2shmim::m_frames

protected

Definition at line 102 of file xrif2shmim.hpp.

Referenced by execute().

m_height

uint32_t xrif2shmim::m_height { 0 }

protected

The height of the image.

Definition at line 100 of file xrif2shmim.hpp.

Referenced by execute().

m_imageStream

IMAGE xrif2shmim::m_imageStream

protected

The ImageStreamIO shared memory buffer.

Definition at line 108 of file xrif2shmim.hpp.

Referenced by execute().

m_numFrames

size_t xrif2shmim::m_numFrames

protected

Initial value:

{
        0 }

The number of frames to store in memory. This defines how many different images will be streamed. If 0 (the default), all frames found using dir and files are loaded and stored.

Definition at line 77 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_shmimName

std::string xrif2shmim::m_shmimName

protected

Initial value:

{
        "xrif2shmim" }

The name of the shared memory buffer to stream to. Default is "xrif2shmim".

Definition at line 84 of file xrif2shmim.hpp.

Referenced by execute(), and loadConfig().

m_typeSize

size_t xrif2shmim::m_typeSize { 0 }

protected

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

Definition at line 106 of file xrif2shmim.hpp.

Referenced by execute().

m_width

uint32_t xrif2shmim::m_width { 0 }

protected

The width of the image.

Definition at line 99 of file xrif2shmim.hpp.

Referenced by execute().

m_xrif

xrif_t xrif2shmim::m_xrif { nullptr }

protected

Definition at line 93 of file xrif2shmim.hpp.

Referenced by ~xrif2shmim(), and execute().

---

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

• utils/xrif2shmim/xrif2shmim.hpp