View source for OpenIGTLink/ProtocolV2/Type/NDArray

[[OpenIGTLink/ProtocolV2/Index | &lt;&lt; Version 2 Index Page]]

=Summary=
NDARRAY is a data type, which is designed to transfer N-dimensional numerical array.


=Message Types=
==NDARRAY==

{| border="1" cellpadding="5" cellspacing="0" align="center"
|-
| align="left style="background:#e0e0e0;" | Data
| align="left style="background:#e0e0e0;" | Type
| align="left style="background:#e0e0e0;" | Description
|-
| align="left" | TYPE
| align="left" | UINT8
| align="left" | Scalar type (2:int8 3:uint8 4:int16 5:uint16 6:int32 7:uint32 10:float32 11:float64 13:complex float 64*)
|-
| align="left" | DIM
| align="left" | UINT8
| align="left" | Dimension of array
|-
| align="left" | SIZE
| align="left" | UINT16[DIM]
| align="left" | Size of array
|-
| align="left" | DATA
| align="left" | TYPE[SIZE[0]][SIZE[1]]....[[SIZE[DIM-1]]]
| align="left" | Array data. (Must be in network byte order.)
|-
|}
<font color=red>2/16/2011: Complex number support is added.</font>

*Complex is a 128-bit variable consisting of a real part in the first 64-bit and an imaginal part in the last 64-bit.

===Memory layout of DATA field===
Like multi-dimensional array in C/C++, DATA field is laid out in sequentially in a byte stream. For example, if the value of DATA is defined by:
  
 char data[3][3] = {{1, 2, 3},
                  {4, 5, 6},
                  {7, 8, 9}
                 };

the layout in the byte stream can be visualized as follows:
   +-+-+-+-+-+-+-+-+-+
   |1|2|3|4|5|6|7|8|9|
   +-+-+-+-+-+-+-+-+-+

==GET_NDARRAY==

{| border="1" cellpadding="5" cellspacing="0" align="center"
|-
| align="left style="background:#e0e0e0;" | Data
| align="left style="background:#e0e0e0;" | Type
| align="left style="background:#e0e0e0;" | Description
|-
|}


==STT_NDARRAY==
N/A

==STP_NDARRAY==

N/A

==RTS_NDARRAY==
N / A


=Implementations=

The NDARRAY message type is implemented in the following source code.
<!--
*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlTrackingDataMessage.h igtlTrackingDataMessage.h]
*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlTrackingDataMessage.cxx igtlTrackingDataMessage.cxx]
-->

=Contributors=
Junichi Tokuda, Yuichiro Hayashi

=Comments=