mx::improc::milkImage< _dataT > Class Template Reference

template<typename _dataT>
class mx::improc::milkImage< _dataT >

Class to interface with an ImageStreamIO image in shared memory.

Use with Eigen::Map (aliased as mx::improc::eigenMap)

using namespace mx::improc;
milkImage<float> mim("image"); //connects to image.im.shm
eigenMap<float> im(mim); //the conversion operator passes a reference to the internal map
im.setRandom(); // im is now a map pointed at the image data.  Eigen functions are now available.
im(64,64) *= 2000;
im /= 0.2;

Once you have changed something via the Eigen::Map you want to notify others connected to the stream via

mim.post();

Definition at line 146 of file milkImage.hpp.

#include <improc/milkImage.hpp>

Public Types
typedef _dataT	dataT
	The data type.

Public Member Functions
	milkImage ()
	Default c'tor.
	milkImage (const std::string &imname)
	Constructor which opens the specified image, which must already exist in shared memory.
	milkImage (const std::string &imname, uint32_t sz0, uint32_t sz1)
	Constructor which (re-)creates the specified image with the given size.
	milkImage (const std::string &imname, const eigenImage< dataT > &im)
	Constructor which (re-)creates the specified image and copies the provided image to it.
	~milkImage ()
	D'tor.
void	open (const std::string &imname)
	Open and connect to an image, allocating the eigenMap.
void	create (const std::string &imname, uint32_t sz0, uint32_t sz1)
	Create (or re-create) and connect to an image, allocating the eigenMap.
void	create (const std::string &imname, const eigenImage< dataT > &im)
uint32_t	rows ()
	Get the width of the image.
uint32_t	cols ()
	Get the height of the image.
uint32_t	size (unsigned n)
	Get the size of a dimension of the image.
bool	valid ()
	Checks if the image is connected and is still the same format as when connected.
void	reopen ()
	Reopens the image.
eigenMap< dataT > &	operator() ()
	Get an eigenMap.
	operator eigenMap< dataT > ()
	Conversion operator returns an eigenMap.
template<typename eigenT >
milkImage &	operator= (const eigenT &im)
	Copy data from an Eigen Array type to the shared memory stream.
void	setWrite (bool wrflag=true)
	Set the write flag.
void	post ()
	Update the metadata and post all semaphores.

Protected Attributes
std::string	m_name
	The image name, from name.im.shm (the .im.shm should not be given).
IMAGE *	m_image { nullptr }
	Pointer to the ImageStreamIO IMAGE structure.
uint64_t	m_size_0 { 0 }
	The size[0] of the image when last opened.
uint64_t	m_size_1 { 0 }
	The size[1] of the image when last opened.

Member Typedef Documentation

dataT

template<typename _dataT >

typedef _dataT mx::improc::milkImage< _dataT >::dataT

The data type.

Definition at line 149 of file milkImage.hpp.

Constructor & Destructor Documentation

milkImage() [1/4]

template<typename dataT >

mx::improc::milkImage< dataT >::milkImage

(

)

Default c'tor.

Definition at line 309 of file milkImage.hpp.

milkImage() [2/4]

template<typename dataT >

mx::improc::milkImage< dataT >::milkImage

(

const std::string &

imname

)

Constructor which opens the specified image, which must already exist in shared memory.

Parameters

[in]

imname

The image name, from name.im.shm (the .im.shm should not be given).

Definition at line 314 of file milkImage.hpp.

milkImage() [3/4]

template<typename dataT >

mx::improc::milkImage< dataT >::milkImage	(	const std::string &	imname,
		uint32_t	sz0,
		uint32_t	sz1
	)

Constructor which (re-)creates the specified image with the given size.

Parameters

[in]	imname	The image name, from name.im.shm (the .im.shm should not be given).
[in]	sz0	the x size of the image
[in]	sz1	the y size of the image

Definition at line 326 of file milkImage.hpp.

milkImage() [4/4]

template<typename dataT >

mx::improc::milkImage< dataT >::milkImage	(	const std::string &	imname,
		const eigenImage< dataT > &	im
	)

Constructor which (re-)creates the specified image and copies the provided image to it.

Parameters

[in]	imname	The image name, from name.im.shm (the .im.shm should not be given).
[in]	im	An existing eigenImage

Definition at line 320 of file milkImage.hpp.

~milkImage()

template<typename dataT >

mx::improc::milkImage< dataT >::~milkImage

(

)

D'tor.

Definition at line 332 of file milkImage.hpp.

Member Function Documentation

cols()

template<typename dataT >

uint32_t mx::improc::milkImage< dataT >::cols

(

)

Get the height of the image.

Returns

the current value of m_size_1

Definition at line 496 of file milkImage.hpp.

create() [1/2]

template<typename dataT >

void mx::improc::milkImage< dataT >::create	(	const std::string &	imname,
		const eigenImage< dataT > &	im
	)

Create and connect to an image using an existing eigenImage, allocating the eigenMap and copying the image to the shmim.

Exceptions

std::invalid_argument

if the image type_code does not match dataT.

Parameters

[in]	imname	The image name, for name.im.shm (the .im.shm should not be given).
[in]	im	An existing eigenImage

Definition at line 437 of file milkImage.hpp.

create() [2/2]

template<typename dataT >

void mx::improc::milkImage< dataT >::create	(	const std::string &	imname,
		uint32_t	sz0,
		uint32_t	sz1
	)

Create (or re-create) and connect to an image, allocating the eigenMap.

Exceptions

std::invalid_argument

if the image type_code does not match dataT.

Parameters

[in]	imname	The image name, for name.im.shm (the .im.shm should not be given).
[in]	sz0	the x size of the image
[in]	sz1	the y size of the image

Definition at line 380 of file milkImage.hpp.

open()

template<typename dataT >

void mx::improc::milkImage< dataT >::open

(

const std::string &

imname

)

Open and connect to an image, allocating the eigenMap.

Exceptions

std::invalid_argument

if the image type_code does not match dataT.

Parameters

[in]

imname

The image name, from name.im.shm (the .im.shm should not be given).

Definition at line 338 of file milkImage.hpp.

operator eigenMap< dataT >()

template<typename dataT >

mx::improc::milkImage< dataT >::operator eigenMap< dataT >

(

)

Conversion operator returns an eigenMap.

Use this like

milkImage<float> mim("imname");
eigenMap<float> im(mim); //you now have an Eigen interface to the image

but with caution:

• there is no way to know if the image has changed
• you should check valid() before using

Returns

an Eigen::Map<Array,-1,-1> object

Exceptions

mx::err::mxException

if the image is not opened

Definition at line 455 of file milkImage.hpp.

operator()()

template<typename dataT >

eigenMap< dataT > & mx::improc::milkImage< dataT >::operator()

(

)

Get an eigenMap.

Use with caution:

• there is no way to know if the image has changed
• you should check valid() before using

Returns

an Eigen::Map<Array,-1,-1> reference

Exceptions

mx::err::mxException

if the image is not opened

Definition at line 444 of file milkImage.hpp.

operator=()

template<typename _dataT >

template<typename eigenT >

milkImage & mx::improc::milkImage< _dataT >::operator=

(

const eigenT &

im

)

Copy data from an Eigen Array type to the shared memory stream.

Sets the write flag, copies using the Eigen assigment to map, unsets the write flag, then posts.

Exceptions

mxException

on an error

Parameters

[in]

im

the eigen array to copy to the stream

post()

template<typename dataT >

void mx::improc::milkImage< dataT >::post

(

)

Update the metadata and post all semaphores.

Todo:

need to set wtime, have a version with atime

Exceptions

mx::err::mxException

if the image is not opened

Definition at line 570 of file milkImage.hpp.

reopen()

template<typename dataT >

void mx::improc::milkImage< dataT >::reopen

(

)

Reopens the image.

Same as

close();
open(m_name);

Definition at line 461 of file milkImage.hpp.

rows()

template<typename dataT >

uint32_t mx::improc::milkImage< dataT >::rows

(

)

Get the width of the image.

Returns

the current value of m_size_0

Definition at line 490 of file milkImage.hpp.

setWrite()

template<typename dataT >

void mx::improc::milkImage< dataT >::setWrite

(

bool

wrflag = true

)

Set the write flag.

The write flag is set to indicate whether or not the the data is being changed. The write flag will be set to false by post().

Exceptions

mx::err::mxException

if the image is not opened

Parameters

[in]

wrflag

[optional] the desired value of the write flag. Default is true.

Definition at line 559 of file milkImage.hpp.

size()

template<typename dataT >

uint32_t mx::improc::milkImage< dataT >::size

(

unsigned

n

)

Get the size of a dimension of the image.

Returns

the current value of m_size_0 or m_size_1 depending on n

Parameters

[in]

n

the dimension to get the size of

Definition at line 502 of file milkImage.hpp.

valid()

template<typename dataT >

bool mx::improc::milkImage< dataT >::valid

(

)

Checks if the image is connected and is still the same format as when connected.

Checks on pointer value, size[], and data_type.

Todo:

check inode!

Returns

true if connected and no changes

false if not connected or something changed. All maps are now invalid.

Definition at line 517 of file milkImage.hpp.

Member Data Documentation

m_image

template<typename _dataT >

IMAGE* mx::improc::milkImage< _dataT >::m_image { nullptr }

protected

Pointer to the ImageStreamIO IMAGE structure.

Definition at line 154 of file milkImage.hpp.

m_name

template<typename _dataT >

std::string mx::improc::milkImage< _dataT >::m_name

protected

The image name, from name.im.shm (the .im.shm should not be given).

Definition at line 152 of file milkImage.hpp.

m_size_0

template<typename _dataT >

uint64_t mx::improc::milkImage< _dataT >::m_size_0 { 0 }

protected

The size[0] of the image when last opened.

Definition at line 160 of file milkImage.hpp.

m_size_1

template<typename _dataT >

uint64_t mx::improc::milkImage< _dataT >::m_size_1 { 0 }

protected

The size[1] of the image when last opened.

Definition at line 162 of file milkImage.hpp.

---

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

• improc/milkImage.hpp