#include <igtlImageMessage2.h>

Inheritance diagram for igtl::ImageMessage2:

Collaboration diagram for igtl::ImageMessage2:

Public Types
enum	{ UNPACK_UNDEF = 0x0000 , UNPACK_HEADER = 0x0001 , UNPACK_BODY = 0x0002 }

enum	{ COORDINATE_RAS =1 , COORDINATE_LPS =2 }

enum	{ ENDIAN_BIG =1 , ENDIAN_LITTLE =2 }

enum	{ DTYPE_SCALAR = 1 , DTYPE_VECTOR = 3 }

enum	{ TYPE_INT8 = 2 , TYPE_UINT8 = 3 , TYPE_INT16 = 4 , TYPE_UINT16 = 5 , TYPE_INT32 = 6 , TYPE_UINT32 = 7 , TYPE_FLOAT32 = 10 , TYPE_FLOAT64 = 11 }

typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef ImageMessage2	Self

typedef MessageBase	Superclass

Public Member Functions
void	AllocateBuffer ()

virtual void	AllocateBuffer (int contentSize)

void	AllocatePack ()

virtual void	AllocateScalars ()

int	CalculateReceiveContentSize ()

virtual igtl::MessageBase::Pointer	Clone ()

int	Copy (const MessageBase *mb)

virtual LightObject::Pointer	CreateAnother () const

virtual void	DebugOff () const

virtual void	DebugOn () const

virtual void	Delete ()

int	GetBodySizeToRead ()

const char *	GetBodyType ()

void *	GetBufferBodyPointer ()

int	GetBufferBodySize ()

void *	GetBufferPointer ()

int	GetBufferSize ()

int	GetCoordinateSystem ()

bool	GetDebug () const

const char *	GetDeviceName ()

std::string	GetDeviceName () const

const char *	GetDeviceType ()

void	GetDimensions (int &i, int &j, int &k)

void	GetDimensions (int s[3])

int	GetEndian ()

unsigned short	GetHeaderVersion () const

int	GetImageSize ()

void	GetMatrix (Matrix4x4 &mat)

std::string	GetMessageType () const

virtual const char *	GetNameOfClass () const

void	GetNormals (float o[3][3])

void	GetNormals (float t[3], float s[3], float n[3])

int	GetNumberOfPackFragments ()

int	GetNumComponents ()

void	GetOrigin (float &px, float &py, float &pz)

void	GetOrigin (float p[3])

void *	GetPackBodyPointer ()

int	GetPackBodySize ()

void *	GetPackFragmentPointer (int id)

int	GetPackFragmentSize (int id)

void *	GetPackPointer ()

int	GetPackSize ()

virtual int	GetReferenceCount () const

virtual void *	GetScalarPointer ()

int	GetScalarSize ()

int	GetScalarSize (int type)

int	GetScalarType ()

void	GetSpacing (float &si, float &sj, float &sk)

void	GetSpacing (float s[3])

void	GetSubVolume (int &dimi, int &dimj, int &dimk, int &offi, int &offj, int &offk)

void	GetSubVolume (int dim[3], int off[3])

int	GetSubVolumeImageSize ()

void	GetTimeStamp (igtl::TimeStamp::Pointer &ts)

int	GetTimeStamp (unsigned int sec, unsigned int frac)

	igtlTypeMacro (Object, LightObject)

void	InitBuffer ()

void	InitPack ()

virtual int	Pack ()

virtual int	PackContent ()

void	Print (std::ostream &os) const

virtual void	Register () const

void	SetCoordinateSystem (int c)

void	SetDebug (bool debugFlag) const

void	SetDeviceName (const char *name)

void	SetDeviceName (const std::string &name)

void	SetDeviceType (const std::string &type)

void	SetDimensions (int i, int j, int k)

void	SetDimensions (int s[3])

void	SetEndian (int e)

void	SetHeaderVersion (unsigned short headerVersion)

void	SetMatrix (Matrix4x4 &mat)

virtual int	SetMessageHeader (const MessageHeader *mb)

void	SetNormals (float o[3][3])

void	SetNormals (float t[3], float s[3], float n[3])

void	SetNumComponents (int num)

void	SetOrigin (float p[3])

void	SetOrigin (float px, float py, float pz)

virtual void	SetReferenceCount (int)

virtual void	SetScalarPointer (void *p)

void	SetScalarType (int t)

void	SetScalarTypeToInt16 ()

void	SetScalarTypeToInt32 ()

void	SetScalarTypeToInt8 ()

void	SetScalarTypeToUint16 ()

void	SetScalarTypeToUint32 ()

void	SetScalarTypeToUint8 ()

void	SetSpacing (float s[3])

void	SetSpacing (float si, float sj, float sk)

int	SetSubVolume (int dim[3], int off[3])

int	SetSubVolume (int dimi, int dimj, int dimk, int offi, int offj, int offk)

void	SetTimeStamp (igtl::TimeStamp::Pointer &ts)

int	SetTimeStamp (unsigned int sec, unsigned int frac)

int	Unpack (int crccheck=0)

virtual int	UnpackContent ()

virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()

static Pointer	New ()

Public Attributes
int	coordinate

int	dimensions [3]

int	endian

unsigned char *	m_Image

unsigned char *	m_ImageHeader

int	m_ImageSize

int	m_SelfAllocatedImage

int	m_SelfAllocatedImageHeader

unsigned char *	m_SinglePack

int	m_SinglePackSize

Matrix4x4	matrix

int	numComponents

int	ScalarSizeTable [12]

int	scalarType

float	spacing [3]

int	subDimensions [3]

int	subOffset [3]

Protected Member Functions
virtual void	AllocateUnpack (int bodySizeToRead)

virtual int	CalculateContentBufferSize ()

int	CopyBody (const MessageBase *mb)

int	CopyHeader (const MessageBase *mb)

	ImageMessage2 ()

void	UnpackBody (int crccheck, int &r)

void	UnpackHeader (int &r)

	~ImageMessage2 ()

Protected Attributes
unsigned char *	m_Body

int	m_BodySizeToRead

unsigned char *	m_Content

std::string	m_DeviceName

unsigned char *	m_Header

unsigned short	m_HeaderVersion

bool	m_IsBodyPacked

bool	m_IsBodyUnpacked

bool	m_IsHeaderUnpacked

int	m_MessageSize

std::string	m_ReceiveMessageType

std::string	m_SendMessageType

unsigned int	m_TimeStampSec

unsigned int	m_TimeStampSecFraction

virtual void	PrintSelf (std::ostream &os) const

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

virtual void	PrintHeader (std::ostream &os) const

virtual void	PrintTrailer (std::ostream &os) const

volatile int	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Detailed Description

A class for the IMAGE message type with support for fragmented packing. The IMAGE format supports 2D or 3D images with metric information including image matrix size, voxel size, coordinate system type, position, and orientation. The body section of the IMAGE data consists of two parts: image header to transfer the metric information and image body to transfer the array of pixel or voxel values. The data type of pixel or voxel can be either scalar or vector, and numerical values can be 8-, 16-, 32-bit integer, or 32- or 64-bit floating point. The pixel values can be either big-endian or little-endian, since the sender software can specify the byte order in the image header. The format also supports "partial image transfer", in which a region of the image is transferred instead of the whole image. This mechanism is suitable for real-time applications, in which images are updated region-by-region. The sub-volume must be box-shaped and defined by 6 parameters consisting of the indices for the corner voxel of the sub-volume and matrix size of the sub-volume.

The difference between the ImageMessage and ImageMessage2 classes is that the ImageMessage2 class supports fragmented pack. Fragmeted pack allows allocating memory for each segment independently. The version 1 library assumes that the memory area for entire message pack is allocated at once, causing extra memory copies in some applications. (For example, copying image from source into the pack memory)

Definition at line 79 of file igtlImageMessage2.h.

Member Typedef Documentation

◆ ConstPointer

typedef SmartPointer<const Self> igtl::ImageMessage2::ConstPointer

Definition at line 85 of file igtlImageMessage2.h.

◆ Pointer

typedef SmartPointer<Self> igtl::ImageMessage2::Pointer

Definition at line 84 of file igtlImageMessage2.h.

◆ Self

typedef ImageMessage2 igtl::ImageMessage2::Self

Definition at line 82 of file igtlImageMessage2.h.

◆ Superclass

typedef MessageBase igtl::ImageMessage2::Superclass

Definition at line 83 of file igtlImageMessage2.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Unpack status. They are returned by the Unpack() function.

Enumerator
UNPACK_UNDEF
UNPACK_HEADER
UNPACK_BODY

Definition at line 95 of file igtlMessageBase.h.

◆ anonymous enum

anonymous enum

Coordinate system. Either left-posterior-superior (LPS) or right-anterior-superior (RAS).

Enumerator
COORDINATE_RAS
COORDINATE_LPS

Definition at line 93 of file igtlImageMessage2.h.

◆ anonymous enum

anonymous enum

Endian used in the bite array for the image data.

Enumerator
ENDIAN_BIG
ENDIAN_LITTLE

Definition at line 99 of file igtlImageMessage2.h.

◆ anonymous enum

anonymous enum

Pixel data type either scalar or vector.

Enumerator
DTYPE_SCALAR
DTYPE_VECTOR

Definition at line 105 of file igtlImageMessage2.h.

◆ anonymous enum

anonymous enum

Pixel data type.

Enumerator
TYPE_INT8
TYPE_UINT8
TYPE_INT16
TYPE_UINT16
TYPE_INT32
TYPE_UINT32
TYPE_FLOAT32
TYPE_FLOAT64

Definition at line 111 of file igtlImageMessage2.h.

Constructor & Destructor Documentation

◆ ImageMessage2()

igtl::ImageMessage2::ImageMessage2 ( )

protected

◆ ~ImageMessage2()

igtl::ImageMessage2::~ImageMessage2 ( )

protected

Member Function Documentation

◆ AllocateBuffer() [1/2]

void igtl::MessageBase::AllocateBuffer ( )

inherited

AllocatePack() allocates memory for underlying buffer If m_BodySizeToRead > 0, we are allocating for receiving a message

◆ AllocateBuffer() [2/2]

virtual void igtl::ImageMessage2::AllocateBuffer ( int contentSize )

virtual

Allocate memory specifying the body size (used when create a brank package to receive data) (for fragmented pack support)

Reimplemented from igtl::MessageBase.

◆ AllocatePack()

void igtl::MessageBase::AllocatePack ( )

inlineinherited

Definition at line 242 of file igtlMessageBase.h.

◆ AllocateScalars()

virtual void igtl::ImageMessage2::AllocateScalars ( )

virtual

Allocates a memory area for the scalar data based on the dimensions of the subvolume, the number of components, and the scalar type. Note: If FragmentedPack is active, GetScalarPointer() causes extra memory allocation to create a single pack memroy degrading the performance.

◆ AllocateUnpack()

virtual void igtl::MessageBase::AllocateUnpack ( int bodySizeToRead )

protectedvirtualinherited

Allocates memory specifying the unpack content size Size of body to allocate is determined from v1 message header field 'body_size'

◆ BreakOnError()

static void igtl::LightObject::BreakOnError ( )

staticinherited

This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.

◆ CalculateContentBufferSize()

virtual int igtl::ImageMessage2::CalculateContentBufferSize ( )

protectedvirtual

Gets the size of the serialized content.

Reimplemented from igtl::MessageBase.

◆ CalculateReceiveContentSize()

int igtl::MessageBase::CalculateReceiveContentSize ( )

inherited

Calculate the size of the received content data Returns -1 if the extended header has not been properly initialized (meta data size, meta data header size, etc...) Used when receiving data, not sending

◆ Clone()

virtual igtl::MessageBase::Pointer igtl::MessageBase::Clone ( )

virtualinherited

Create a clone of this message, new memory but all internals are preserved.

◆ Copy()

int igtl::MessageBase::Copy ( const MessageBase * mb )

inherited

Copy() copies contents from the specified Massage class. If the type of the specified class is the same as this class, general header and body are copied.

◆ CopyBody()

int igtl::MessageBase::CopyBody ( const MessageBase * mb )

protectedinherited

Copies the serialized body data.

◆ CopyHeader()

int igtl::MessageBase::CopyHeader ( const MessageBase * mb )

protectedinherited

Copies a header from given message.

◆ CreateAnother()

virtual LightObject::Pointer igtl::Object::CreateAnother ( ) const

virtualinherited

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from igtl::LightObject.

◆ DebugOff()

virtual void igtl::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

◆ DebugOn()

virtual void igtl::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

◆ Delete()

virtual void igtl::LightObject::Delete ( )

virtualinherited

Delete an igtl object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

◆ GetBodySizeToRead()

int igtl::MessageBase::GetBodySizeToRead ( )

inherited

GetBodySizeToRead() returns the size of the body to be read. This function must be called after the message header is set.

◆ GetBodyType()

const char * igtl::MessageBase::GetBodyType ( )

inherited

Gets the type of the body.

◆ GetBufferBodyPointer()

void * igtl::MessageBase::GetBufferBodyPointer ( )

inherited

Gets a pointer to the raw byte array for the serialized body data.

◆ GetBufferBodySize()

int igtl::MessageBase::GetBufferBodySize ( )

inherited

Gets the size of the serialized body data.

◆ GetBufferPointer()

void * igtl::ImageMessage2::GetBufferPointer ( )

Gets a pointer to the scalar data (for fragmented pack support).

◆ GetBufferSize()

int igtl::MessageBase::GetBufferSize ( )

inherited

Gets the size of the serialized message data.

◆ GetCoordinateSystem()

int igtl::ImageMessage2::GetCoordinateSystem ( )

inline

Returns coordinate system (COORDINATE_RAS or COORDINATE_LPS)

Definition at line 261 of file igtlImageMessage2.h.

◆ GetDebug()

bool igtl::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

◆ GetDeviceName() [1/2]

const char * igtl::MessageBase::GetDeviceName ( )

inherited

Gets the device name.

◆ GetDeviceName() [2/2]

std::string igtl::MessageBase::GetDeviceName ( ) const

inherited

Gets the device name.

◆ GetDeviceType()

const char * igtl::MessageBase::GetDeviceType ( )

inherited

Gets the device (message) type.

◆ GetDimensions() [1/2]

void igtl::ImageMessage2::GetDimensions	(	int &	i,
		int &	j,
		int &	k
	)

Gets image dimensions as the numbers of pixels in i, j and k directions.

◆ GetDimensions() [2/2]

void igtl::ImageMessage2::GetDimensions ( int s[3] )

Gets image dimensions as an array of the numbers of pixels in i, j and k directions.

◆ GetEndian()

int igtl::ImageMessage2::GetEndian ( )

inline

Gets the Endianess of the image scalars.

Definition at line 250 of file igtlImageMessage2.h.

◆ GetGlobalWarningDisplay()

static bool igtl::Object::GetGlobalWarningDisplay ( )

staticinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

◆ GetHeaderVersion()

unsigned short igtl::MessageBase::GetHeaderVersion ( ) const

inherited

Gets the message version number.

◆ GetImageSize()

int igtl::ImageMessage2::GetImageSize ( )

inline

Gets the size (length) of the byte array for the image data. The size is defined by dimensions[0]*dimensions[1]*dimensions[2]*scalarSize*numComponents.

Definition at line 255 of file igtlImageMessage2.h.

◆ GetMatrix()

void igtl::ImageMessage2::GetMatrix ( Matrix4x4 & mat )

Gets the origin/orientation matrix.

◆ GetMessageType()

std::string igtl::MessageBase::GetMessageType ( ) const

inherited

Gets the message type.

◆ GetNameOfClass()

virtual const char * igtl::LightObject::GetNameOfClass ( ) const

inlinevirtualinherited

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Definition at line 84 of file igtlLightObject.h.

◆ GetNormals() [1/2]

void igtl::ImageMessage2::GetNormals ( float o[3][3] )

Gets the orientation of the image using an array of the normal vectors for the i, j and k indeces.

◆ GetNormals() [2/2]

void igtl::ImageMessage2::GetNormals	(	float	t[3],
		float	s[3],
		float	n[3]
	)

Gets the orientation of the image using the normal vectors for the i, j and k indeces.

◆ GetNumberOfPackFragments()

int igtl::ImageMessage2::GetNumberOfPackFragments ( )

inline

Gets the number of fragments for the packed (serialized) data. Returns 3 consisting of header, image header and image body. (for fragmented pack support)

Definition at line 293 of file igtlImageMessage2.h.

◆ GetNumComponents()

int igtl::ImageMessage2::GetNumComponents ( )

Gets the number of components for each voxel.

◆ GetOrigin() [1/2]

void igtl::ImageMessage2::GetOrigin	(	float &	px,
		float &	py,
		float &	pz
	)

Gets the coordinates of the origin by positions along the first (R or L), second (A or P) and the third (S) axes.

◆ GetOrigin() [2/2]

void igtl::ImageMessage2::GetOrigin ( float p[3] )

Gets the coordinates of the origin using an array of positions along the first (R or L), second (A or P) and the third (S) axes.

◆ GetPackBodyPointer()

void * igtl::MessageBase::GetPackBodyPointer ( )

inlineinherited

Definition at line 218 of file igtlMessageBase.h.

◆ GetPackBodySize()

int igtl::MessageBase::GetPackBodySize ( )

inlineinherited

Definition at line 226 of file igtlMessageBase.h.

◆ GetPackFragmentPointer()

void * igtl::ImageMessage2::GetPackFragmentPointer ( int id )

Gets a pointer to the specified fragment of the packed data. (for fragmented pack support)

◆ GetPackFragmentSize()

int igtl::ImageMessage2::GetPackFragmentSize ( int id )

Gets the size of the specified fragment. (for fragmented pack support)

◆ GetPackPointer()

void * igtl::MessageBase::GetPackPointer ( )

inlineinherited

Definition at line 214 of file igtlMessageBase.h.

◆ GetPackSize()

int igtl::MessageBase::GetPackSize ( )

inlineinherited

Definition at line 222 of file igtlMessageBase.h.

◆ GetReferenceCount()

virtual int igtl::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 110 of file igtlLightObject.h.

◆ GetScalarPointer()

virtual void * igtl::ImageMessage2::GetScalarPointer ( )

virtual

Gets a pointer to the scalar data.

◆ GetScalarSize() [1/2]

int igtl::ImageMessage2::GetScalarSize ( )

inline

Gets the size of the scalar type used in the current image data. (e.g. 1 byte for 8-bit integer)

Definition at line 241 of file igtlImageMessage2.h.

◆ GetScalarSize() [2/2]

int igtl::ImageMessage2::GetScalarSize ( int type )

inline

Gets the size of the specified scalar type. (e.g. 1 byte for 8-bit integer)

Definition at line 244 of file igtlImageMessage2.h.

◆ GetScalarType()

int igtl::ImageMessage2::GetScalarType ( )

inline

Gets the image scalar type.

Definition at line 237 of file igtlImageMessage2.h.

◆ GetSpacing() [1/2]

void igtl::ImageMessage2::GetSpacing	(	float &	si,
		float &	sj,
		float &	sk
	)

Gets spacings using spacing values in i, j and k directions.

◆ GetSpacing() [2/2]

void igtl::ImageMessage2::GetSpacing ( float s[3] )

Gets spacings using an array of spacing values in i, j and k directions.

◆ GetSubVolume() [1/2]

void igtl::ImageMessage2::GetSubVolume	(	int &	dimi,
		int &	dimj,
		int &	dimk,
		int &	offi,
		int &	offj,
		int &	offk
	)

Gets sub-volume dimensions and offset by the dimensions and the offset in i, j and k directions.

◆ GetSubVolume() [2/2]

void igtl::ImageMessage2::GetSubVolume	(	int	dim[3],
		int	off[3]
	)

Gets sub-volume dimensions and offset using arrays of the dimensions and the offset.

◆ GetSubVolumeImageSize()

int igtl::ImageMessage2::GetSubVolumeImageSize ( )

inline

Gets the size (length) of the byte array for the subvolume image data. The size is defined by subDimensions[0]*subDimensions[1]*subDimensions[2]* scalarSize*numComponents.

Definition at line 269 of file igtlImageMessage2.h.

◆ GetTimeStamp() [1/2]

void igtl::MessageBase::GetTimeStamp ( igtl::TimeStamp::Pointer & ts )

inherited

Gets time of message creation.

◆ GetTimeStamp() [2/2]

int igtl::MessageBase::GetTimeStamp	(	unsigned int *	sec,
		unsigned int *	frac
	)

inherited

Gets time of message creation. 'sec' and 'frac' are seconds and fractions of a second respectively.

◆ GlobalWarningDisplayOff()

static void igtl::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Definition at line 116 of file igtlObject.h.

◆ GlobalWarningDisplayOn()

static void igtl::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Definition at line 114 of file igtlObject.h.

◆ igtlTypeMacro()

igtl::Object::igtlTypeMacro	(	Object	,
		LightObject
	)

inherited

Standard part of all igtl objects.

◆ InitBuffer()

void igtl::MessageBase::InitBuffer ( )

inherited

Call InitPack() before receive header. This function simply resets the Unpacked flag for both the header and body pack Only allocate the original 58 byte header

◆ InitPack()

void igtl::MessageBase::InitPack ( )

inlineinherited

Definition at line 249 of file igtlMessageBase.h.

◆ New()

static Pointer igtl::Object::New ( )

staticinherited

Method for creation through the object factory.

◆ Pack()

virtual int igtl::ImageMessage2::Pack ( )

virtual

Pack() serializes the header and body based on the member variables. PackBody() must be implemented in the child class. (for fragmented pack support)

Reimplemented from igtl::MessageBase.

◆ PackContent()

virtual int igtl::ImageMessage2::PackContent ( )

virtual

Packs (serialize) the content. Must be implemented in all child classes.

Reimplemented from igtl::MessageBase.

◆ Print()

void igtl::LightObject::Print ( std::ostream & os ) const

inherited

Cause the object to print itself out.

◆ PrintHeader()

virtual void igtl::LightObject::PrintHeader ( std::ostream & os ) const

protectedvirtualinherited

Number of uses of this object by other objects.

◆ PrintSelf()

virtual void igtl::Object::PrintSelf ( std::ostream & os ) const

protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from igtl::LightObject.

Reimplemented in igtl::ClientSocket, igtl::FastMutexLock, igtl::MultiThreader, igtl::MutexLock, igtl::ObjectFactoryBase, igtl::ServerSocket, igtl::Socket, and igtl::TimeStamp.

◆ PrintTrailer()

virtual void igtl::LightObject::PrintTrailer ( std::ostream & os ) const

protectedvirtualinherited

Number of uses of this object by other objects.

◆ Register()

virtual void igtl::Object::Register ( ) const

virtualinherited

Return this objects modified time.
Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Increase the reference count (mark as used by another object).

Reimplemented from igtl::LightObject.

◆ SetCoordinateSystem()

void igtl::ImageMessage2::SetCoordinateSystem ( int c )

inline

Sets coordinate system (COORDINATE_RAS or COORDINATE_LPS)

Definition at line 264 of file igtlImageMessage2.h.

◆ SetDebug()

void igtl::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

◆ SetDeviceName() [1/2]

void igtl::MessageBase::SetDeviceName ( const char * name )

inherited

Sets the device name.

◆ SetDeviceName() [2/2]

void igtl::MessageBase::SetDeviceName ( const std::string & name )

inherited

Sets the device name.

◆ SetDeviceType()

void igtl::MessageBase::SetDeviceType ( const std::string & type )

inherited

Sets the device (message) type.

◆ SetDimensions() [1/2]

void igtl::ImageMessage2::SetDimensions	(	int	i,
		int	j,
		int	k
	)

Sets image dimensions by the numbers of pixels in i, j and k directions. SetDimensions() should be called prior to SetSubVolume(), since SetDimensions() sets subvolume parameters automatically assuming that subvolume = entire volume.

◆ SetDimensions() [2/2]

void igtl::ImageMessage2::SetDimensions ( int s[3] )

Sets image dimensions by an array of the numbers of pixels in i, j and k directions. SetDimensions() should be called prior to SetSubVolume(), since SetDimensions() sets subvolume parameters automatically assuming that subvolume = entire volume.

◆ SetEndian()

void igtl::ImageMessage2::SetEndian ( int e )

inline

Sets the Endianess of the image scalars. (default is ENDIAN_BIG)

Definition at line 247 of file igtlImageMessage2.h.

◆ SetGlobalWarningDisplay()

static void igtl::Object::SetGlobalWarningDisplay ( bool flag )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

◆ SetHeaderVersion()

void igtl::MessageBase::SetHeaderVersion ( unsigned short headerVersion )

inherited

Sets the message version number.

◆ SetMatrix()

void igtl::ImageMessage2::SetMatrix ( Matrix4x4 & mat )

Sets the origin/orientation matrix.

◆ SetMessageHeader()

virtual int igtl::MessageBase::SetMessageHeader ( const MessageHeader * mb )

virtualinherited

Sets the message header.

Reimplemented in igtl::PositionMessage.

◆ SetNormals() [1/2]

void igtl::ImageMessage2::SetNormals ( float o[3][3] )

Sets the orientation of the image by an array of the normal vectors for the i, j and k indeces.

◆ SetNormals() [2/2]

void igtl::ImageMessage2::SetNormals	(	float	t[3],
		float	s[3],
		float	n[3]
	)

Sets the orientation of the image by the normal vectors for the i, j and k indeces.

◆ SetNumComponents()

void igtl::ImageMessage2::SetNumComponents ( int num )

Sets the number of components for each voxel.

◆ SetOrigin() [1/2]

void igtl::ImageMessage2::SetOrigin ( float p[3] )

Sets the coordinates of the origin by an array of positions along the first (R or L), second (A or P) and the third (S) axes.

◆ SetOrigin() [2/2]

void igtl::ImageMessage2::SetOrigin	(	float	px,
		float	py,
		float	pz
	)

Sets the coordinates of the origin by positions along the first (R or L), second (A or P) and the third (S) axes.

◆ SetReferenceCount()

virtual void igtl::Object::SetReferenceCount ( int )

virtualinherited

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

◆ SetScalarPointer()

virtual void igtl::ImageMessage2::SetScalarPointer ( void * p )

virtual

Sets the pointer to the scalar data (for fragmented pack support).

◆ SetScalarType()

void igtl::ImageMessage2::SetScalarType ( int t )

inline

Sets the image scalar type.

Definition at line 216 of file igtlImageMessage2.h.

◆ SetScalarTypeToInt16()

void igtl::ImageMessage2::SetScalarTypeToInt16 ( )

inline

Sets the image scalar type to 16-bit integer.

Definition at line 225 of file igtlImageMessage2.h.

◆ SetScalarTypeToInt32()

void igtl::ImageMessage2::SetScalarTypeToInt32 ( )

inline

Sets the image scalar type to 32-bit integer.

Definition at line 231 of file igtlImageMessage2.h.

◆ SetScalarTypeToInt8()

void igtl::ImageMessage2::SetScalarTypeToInt8 ( )

inline

Sets the image scalar type to 8-bit integer.

Definition at line 219 of file igtlImageMessage2.h.

◆ SetScalarTypeToUint16()

void igtl::ImageMessage2::SetScalarTypeToUint16 ( )

inline

Sets the image scalar type to unsigned 16-bit integer.

Definition at line 228 of file igtlImageMessage2.h.

◆ SetScalarTypeToUint32()

void igtl::ImageMessage2::SetScalarTypeToUint32 ( )

inline

Sets the image scalar type to unsigned 32-bit integer.

Definition at line 234 of file igtlImageMessage2.h.

◆ SetScalarTypeToUint8()

void igtl::ImageMessage2::SetScalarTypeToUint8 ( )

inline

Sets the image scalar type to unsigned 8-bit integer.

Definition at line 222 of file igtlImageMessage2.h.

◆ SetSpacing() [1/2]

void igtl::ImageMessage2::SetSpacing ( float s[3] )

Sets spacings by an array of spacing values in i, j and k directions.

◆ SetSpacing() [2/2]

void igtl::ImageMessage2::SetSpacing	(	float	si,
		float	sj,
		float	sk
	)

Sets spacings by spacing values in i, j and k directions.

◆ SetSubVolume() [1/2]

int igtl::ImageMessage2::SetSubVolume	(	int	dim[3],
		int	off[3]
	)

Sets sub-volume dimensions and offset by arrays of the dimensions and the offset. SetSubVolume() should be called after calling SetDiemensions(), since SetDimensions() reset the subvolume parameters automatically. Returns non-zero value if the subvolume is successfully specified. Returns zero, if invalid subvolume is specified.

◆ SetSubVolume() [2/2]

int igtl::ImageMessage2::SetSubVolume	(	int	dimi,
		int	dimj,
		int	dimk,
		int	offi,
		int	offj,
		int	offk
	)

Sets sub-volume dimensions and offset by the dimensions and the offset in i, j and k directions. SetSubVolume() should be called after calling SetDiemensions(), since SetDimensions() reset the subvolume parameters automatically. Returns non-zero value if the subvolume is successfully specified. Returns zero, if invalid subvolume is specified.

◆ SetTimeStamp() [1/2]

void igtl::MessageBase::SetTimeStamp ( igtl::TimeStamp::Pointer & ts )

inherited

Sets time of message creation.

◆ SetTimeStamp() [2/2]

int igtl::MessageBase::SetTimeStamp	(	unsigned int	sec,
		unsigned int	frac
	)

inherited

Sets time of message creation. 'sec' and 'frac' are seconds and fractions of a second respectively.

◆ Unpack()

int igtl::MessageBase::Unpack ( int crccheck = 0 )

inherited

Unpack() deserializes the header and/or body, extracting data from the byte stream. If the header has already been deserilized, Unpack() deserializes only the body part. UnpackBody() must be implemented to deserialize the body part. Unpack() performs 64-bit CRC check, when crccheck = 1. It returns:

UNPACK_UNDEF : Nothing deserialized UNPACK_HEADER : The header has been deserialized. UNPACK_BODY : The body has been deserialized. If CRC check fails, Unpack() doesn't deserialize the body, thus it doesn't return UNPACK_BODY flag. UNPACK_HEADER|UNPACK_BODY: Both the header and body have been deserialized

◆ UnpackBody()

void igtl::MessageBase::UnpackBody	(	int	crccheck,
		int &	r
	)

protectedinherited

Unpack the body If it's a v3 message, body is ext header + content + metadataheader + metadata<optional>

◆ UnpackContent()

virtual int igtl::ImageMessage2::UnpackContent ( )

virtual

Unpacks (deserialize) the content. Must be implemented in all child classes.

Reimplemented from igtl::MessageBase.

◆ UnpackHeader()

void igtl::MessageBase::UnpackHeader ( int & r )

protectedinherited

Unpack the first 58 bytes.

◆ UnRegister()

virtual void igtl::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.

Member Data Documentation

◆ coordinate

int igtl::ImageMessage2::coordinate

A variable for the scalar type of the voxels.

Definition at line 355 of file igtlImageMessage2.h.

◆ dimensions

int igtl::ImageMessage2::dimensions[3]

A vector containing the numbers of voxels in i, j and k directions.

Definition at line 329 of file igtlImageMessage2.h.

◆ endian

int igtl::ImageMessage2::endian

A variable for the Endian of the scalar values in the image.

Definition at line 346 of file igtlImageMessage2.h.

◆ m_Body

unsigned char* igtl::MessageBase::m_Body

protectedinherited

A pointer to the byte array for the serialized body. To prevent large copy of the byte array in the Pack() function, header byte array is concatenated to the byte array for the header.

Definition at line 308 of file igtlMessageBase.h.

◆ m_BodySizeToRead

int igtl::MessageBase::m_BodySizeToRead

protectedinherited

The size of the body to be read. This function must be called after the message header is set.

Definition at line 315 of file igtlMessageBase.h.

◆ m_Content

unsigned char* igtl::MessageBase::m_Content

protectedinherited

A pointer to the underlying content of a message.

Definition at line 311 of file igtlMessageBase.h.

◆ m_DeviceName

std::string igtl::MessageBase::m_DeviceName

protectedinherited

A character string for the device name (message name).

Definition at line 328 of file igtlMessageBase.h.

◆ m_Header

unsigned char* igtl::MessageBase::m_Header

protectedinherited

A pointer to the byte array for the serialized header. To prevent large copy of the byte array in the Pack() function, header byte array is concatenated to the byte array for the body.

Definition at line 303 of file igtlMessageBase.h.

◆ m_HeaderVersion

unsigned short igtl::MessageBase::m_HeaderVersion

protectedinherited

An unsigned short for the message format version.

Definition at line 325 of file igtlMessageBase.h.

◆ m_Image

unsigned char* igtl::ImageMessage2::m_Image

A pointer to the serialized image data.

Definition at line 361 of file igtlImageMessage2.h.

◆ m_ImageHeader

unsigned char* igtl::ImageMessage2::m_ImageHeader

A pointer to the serialized image header.

Definition at line 358 of file igtlImageMessage2.h.

◆ m_ImageSize

int igtl::ImageMessage2::m_ImageSize

A variable for the memory size of this->m_Image (for backward compatibility with the conventional packing)

Definition at line 372 of file igtlImageMessage2.h.

◆ m_IsBodyPacked

bool igtl::MessageBase::m_IsBodyPacked

protectedinherited

Packing (serialization) status for the body.

Definition at line 345 of file igtlMessageBase.h.

◆ m_IsBodyUnpacked

bool igtl::MessageBase::m_IsBodyUnpacked

protectedinherited

Unpacking (deserialization) status for the body.

Definition at line 342 of file igtlMessageBase.h.

◆ m_IsHeaderUnpacked

bool igtl::MessageBase::m_IsHeaderUnpacked

protectedinherited

Unpacking (deserialization) status for the header.

Definition at line 339 of file igtlMessageBase.h.

◆ m_MessageSize

int igtl::MessageBase::m_MessageSize

protectedinherited

Definition at line 298 of file igtlMessageBase.h.

◆ m_ReceiveMessageType

std::string igtl::MessageBase::m_ReceiveMessageType

protectedinherited

A character string for the device type (message type). This will be used when the header is deserialized from a byte stream received from the network.

Definition at line 322 of file igtlMessageBase.h.

◆ m_ReferenceCount

volatile int igtl::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 131 of file igtlLightObject.h.

◆ m_ReferenceCountLock

SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 134 of file igtlLightObject.h.

◆ m_SelfAllocatedImage

int igtl::ImageMessage2::m_SelfAllocatedImage

A flag for the fragmented image pack (allocated by this class).

Definition at line 375 of file igtlImageMessage2.h.

◆ m_SelfAllocatedImageHeader

int igtl::ImageMessage2::m_SelfAllocatedImageHeader

A flag for the fragmented image pack (allocated by this class).

Definition at line 378 of file igtlImageMessage2.h.

◆ m_SendMessageType

std::string igtl::MessageBase::m_SendMessageType

protectedinherited

A character string for the send device type (message type).

Definition at line 318 of file igtlMessageBase.h.

◆ m_SinglePack

unsigned char* igtl::ImageMessage2::m_SinglePack

A pointer to the serialized data (for backward compatibility with the conventional packing)

Definition at line 365 of file igtlImageMessage2.h.

◆ m_SinglePackSize

int igtl::ImageMessage2::m_SinglePackSize

A variable for the memory size of this->m_SinglePack (for backward compatibility with the conventional packing)

Definition at line 369 of file igtlImageMessage2.h.

◆ m_TimeStampSec

unsigned int igtl::MessageBase::m_TimeStampSec

protectedinherited

A time stamp (second) for message creation. It consists of fields for seconds (m_TimeStampSec)and fractions of a second (m_TimeStampSecFraction).

Definition at line 332 of file igtlMessageBase.h.

◆ m_TimeStampSecFraction

unsigned int igtl::MessageBase::m_TimeStampSecFraction

protectedinherited

A time stamp (second) for message creation. It consists of fields for seconds (m_TimeStampSec)and fractions of a second (m_TimeStampSecFraction).

Definition at line 336 of file igtlMessageBase.h.

◆ matrix

Matrix4x4 igtl::ImageMessage2::matrix

A matrix representing the origin and the orientation of the image. The matrix is set to identity by default

Definition at line 343 of file igtlImageMessage2.h.

◆ numComponents

int igtl::ImageMessage2::numComponents

A variable for the number of components.

Definition at line 349 of file igtlImageMessage2.h.

◆ ScalarSizeTable

int igtl::ImageMessage2::ScalarSizeTable[12]

A table to look up the size of a given scalar type.

Definition at line 383 of file igtlImageMessage2.h.

◆ scalarType

int igtl::ImageMessage2::scalarType

A variable for the scalar type of the voxels.

Definition at line 352 of file igtlImageMessage2.h.

◆ spacing

float igtl::ImageMessage2::spacing[3]

A vector containing the spacings of the voxels in i, j and k directions.

Definition at line 332 of file igtlImageMessage2.h.

◆ subDimensions

int igtl::ImageMessage2::subDimensions[3]

A vector containing the numbers of voxels of the subvolume in i, j and k directions.

Definition at line 335 of file igtlImageMessage2.h.

◆ subOffset

int igtl::ImageMessage2::subOffset[3]

A vector containing the offset (number of voxels) of the first voxel of the subvolume from the first voxel of the original image.

Definition at line 339 of file igtlImageMessage2.h.

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

igtlImageMessage2.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ImageMessage2()

◆ ~ImageMessage2()

Member Function Documentation

◆ AllocateBuffer() [1/2]

◆ AllocateBuffer() [2/2]

◆ AllocatePack()

◆ AllocateScalars()

◆ AllocateUnpack()

◆ BreakOnError()

◆ CalculateContentBufferSize()

◆ CalculateReceiveContentSize()

◆ Clone()

◆ Copy()

◆ CopyBody()

◆ CopyHeader()

◆ CreateAnother()

◆ DebugOff()

◆ DebugOn()

◆ Delete()

◆ GetBodySizeToRead()

◆ GetBodyType()

◆ GetBufferBodyPointer()

◆ GetBufferBodySize()

◆ GetBufferPointer()

◆ GetBufferSize()

◆ GetCoordinateSystem()

◆ GetDebug()

◆ GetDeviceName() [1/2]

◆ GetDeviceName() [2/2]

◆ GetDeviceType()

◆ GetDimensions() [1/2]

◆ GetDimensions() [2/2]

◆ GetEndian()

◆ GetGlobalWarningDisplay()

◆ GetHeaderVersion()

◆ GetImageSize()

◆ GetMatrix()

◆ GetMessageType()

◆ GetNameOfClass()

◆ GetNormals() [1/2]

◆ GetNormals() [2/2]

◆ GetNumberOfPackFragments()

◆ GetNumComponents()

◆ GetOrigin() [1/2]

◆ GetOrigin() [2/2]

◆ GetPackBodyPointer()

◆ GetPackBodySize()

◆ GetPackFragmentPointer()

◆ GetPackFragmentSize()

◆ GetPackPointer()

◆ GetPackSize()

◆ GetReferenceCount()

◆ GetScalarPointer()

◆ GetScalarSize() [1/2]

◆ GetScalarSize() [2/2]

◆ GetScalarType()

◆ GetSpacing() [1/2]

◆ GetSpacing() [2/2]

◆ GetSubVolume() [1/2]

◆ GetSubVolume() [2/2]

◆ GetSubVolumeImageSize()