/usr/include/openigtlink/igtlImageMetaMessage.h is in libopenigtlink-dev 1.10.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | /*=========================================================================
Program: The OpenIGTLink Library
Language: C++
Web page: http://openigtlink.org/
Copyright (c) Insight Software Consortium. All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __igtlImageMetaMessage_h
#define __igtlImageMetaMessage_h
#include <vector>
#include <string>
#include "igtlObject.h"
#include "igtlMath.h"
#include "igtlMessageBase.h"
#include "igtlTypes.h"
#include "igtlImageMessage.h"
namespace igtl
{
/// A class to manage meta data of images.
class IGTLCommon_EXPORT ImageMetaElement: public Object
{
public:
typedef ImageMetaElement Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
igtlTypeMacro(igtl::ImageMetaElement, igtl::Object);
igtlNewMacro(igtl::ImageMetaElement);
public:
/// Sets the image name/description. The string 'name' must not exceed 64 characters.
int SetName(const char* name);
/// Gets the image name/description.
const char* GetName() { return this->m_Name.c_str(); };
/// Sets the device name (message name). The string 'devname' must not exceed 20
/// characters.
int SetDeviceName(const char* devname);
/// Gets the device name (message name).
const char* GetDeviceName() { return this->m_DeviceName.c_str(); };
/// Sets the name of the image modality (e.g. CT, MRI). The string 'modality' must not
/// exceed 32 characters.
int SetModality(const char* modality);
/// Gets the name of the image modality.
const char* GetModality() { return this->m_Modality.c_str(); };
/// Sets the patient name. The string 'patname' must not exceed 64 characters.
int SetPatientName(const char* patname);
/// Gets the patient name.
const char* GetPatientName() { return this->m_PatientName.c_str(); };
/// Sets the patient ID. The string 'patid' must not exceed 64 characters.
int SetPatientID(const char* patid);
/// Gets the patient ID.
const char* GetPatientID() { return this->m_PatientID.c_str(); }
/// Sets the scan time for the image.
void SetTimeStamp(igtl::TimeStamp::Pointer& time);
/// Gets the scan time for the image.
void GetTimeStamp(igtl::TimeStamp::Pointer& time);
/// Sets the size of the image by an array containing the numbers of voxels in i, j, and k
/// directions.
void SetSize(igtlUint16 size[3]);
/// Sets the size of the image by the numbers of voxels in i, j, and k directions.
void SetSize(igtlUint16 si, igtlUint16 sj, igtlUint16 sk);
/// Gets the size of the image using an array containing the numbers of voxels in i, j, and k
/// directions.
void GetSize(igtlUint16* size);
/// Gets the size of the image by the numbers of voxels in i, j, and k directions.
void GetSize(igtlUint16& si, igtlUint16& sj, igtlUint16& sk);
/// Sets the scalar type of the image
void SetScalarType(igtlUint8 type);
/// Gets the scalar type of the image.
igtlUint8 GetScalarType();
protected:
ImageMetaElement();
~ImageMetaElement();
protected:
/// name / description (<= 64 bytes)
std::string m_Name;
/// device name to query the IMAGE and COLORT
std::string m_DeviceName;
/// modality name (<= 32 bytes)
std::string m_Modality;
/// patient name (<= 64 bytes)
std::string m_PatientName;
/// patient ID (MRN etc.) (<= 64 bytes)
std::string m_PatientID;
/// scan time
TimeStamp::Pointer m_TimeStamp;
/// entire image volume size
igtlUint16 m_Size[3];
/// scalar type. see scalar_type in IMAGE message
igtlUint8 m_ScalarType;
};
/// A class for the GET_IMGMETA message type.
class IGTLCommon_EXPORT GetImageMetaMessage: public MessageBase
{
public:
typedef GetImageMetaMessage Self;
typedef MessageBase Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
igtlTypeMacro(igtl::GetImageMetaMessage, igtl::MessageBase);
igtlNewMacro(igtl::GetImageMetaMessage);
protected:
GetImageMetaMessage() : MessageBase() { this->m_DefaultBodyType = "GET_IMGMETA"; };
~GetImageMetaMessage() {};
protected:
virtual int GetBodyPackSize() { return 0; };
virtual int PackBody() { AllocatePack(); return 1; };
virtual int UnpackBody() { return 1; };
};
/// The IMGMETA message is used to transfer image meta information which are not
/// available in the IMAGE message type, such as patient name, medical record number,
/// modality etc. An IMGMETA message can contain meta data for multiple images.
/// This message type may be used to obtain a list of images available in
/// the remote system, such as image database or commercial image-guided surgery (IGS) system.
class IGTLCommon_EXPORT ImageMetaMessage: public MessageBase
{
public:
typedef ImageMetaMessage Self;
typedef MessageBase Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
igtlTypeMacro(igtl::ImageMetaMessage, igtl::MessageBase);
igtlNewMacro(igtl::ImageMetaMessage);
public:
/// Adds an image meta element to the list. Returns the number of elements after
/// adding the image meta element.
int AddImageMetaElement(ImageMetaElement::Pointer& elem);
/// Clears the all image meta elements in the list.
void ClearImageMetaElement();
/// Gets the number of the image meta elements in the list.
int GetNumberOfImageMetaElement();
/// Gets the image meta data specified by the index.
void GetImageMetaElement(int index, ImageMetaElement::Pointer& elem);
protected:
ImageMetaMessage();
~ImageMetaMessage();
protected:
virtual int GetBodyPackSize();
virtual int PackBody();
virtual int UnpackBody();
/// A list of pointers to image meta data.
std::vector<ImageMetaElement::Pointer> m_ImageMetaList;
};
} // namespace igtl
#endif // _igtlImageMetaMessage_h
|