Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

openigtlinkclient.cpp 18.3 KB
Newer Older
CAMP C++ Builder's avatar
CAMP C++ Builder committed
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
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
// If not explicitly stated otherwise: Copyright (C) 2012-2014, all rights reserved,
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
// 
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
// 
// ================================================================================================

#include "openigtlinkclient.h"

27
28
#include "../datastructures/transformdata.h"
#include "../datastructures/positiondata.h"
CAMP C++ Builder's avatar
CAMP C++ Builder committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

#include <igtlTransformMessage.h>
#include <igtlPositionMessage.h>

#include "core/datastructures/imagedata.h"
#include "core/datastructures/genericimagerepresentationlocal.h"
#include "core/tools/stringutils.h"

namespace campvis {
    const std::string OpenIGTLinkClient::loggerCat_ = "CAMPVis.modules.openigtlink.client";

    OpenIGTLinkClient::OpenIGTLinkClient() 
        : AbstractProcessor()
        , p_address("ServerAddress", "Server Address", "127.0.0.1", StringProperty::BASIC_STRING)
        , p_port("ServerPort", "Server Port", 18944, 1, 65535, 1)
        , p_deviceName("ServerDeviceName", "Device Name (empty to accept all)")
        , p_connect("Connect", "Connect to Server")
        , p_receiveImages("ReceiveImages", "Receive IMAGE Messages", false)
47
        , p_targetImagePrefix("targetImageName", "Target Image Prefix", "IGTL.image.")
CAMP C++ Builder's avatar
CAMP C++ Builder committed
48
        , p_receiveTransforms("ReceiveTransforms", "Receive TRANSFORM Messages", true)
49
        , p_targetTransformPrefix("targetTransformPrefix", "Target Transform Prefix", "IGTL.transform.")
CAMP C++ Builder's avatar
CAMP C++ Builder committed
50
51
        , p_imageOffset("ImageOffset", "Image Offset in mm", tgt::vec3(0.f), tgt::vec3(-10000.f), tgt::vec3(10000.f), tgt::vec3(0.1f))
        , p_voxelSize("VoxelSize", "Voxel Size in mm", tgt::vec3(1.f), tgt::vec3(-100.f), tgt::vec3(100.f), tgt::vec3(0.1f))
CAMP C++ Builder's avatar
CAMP C++ Builder committed
52
        , p_receivePositions("ReceivePositions", "Receive POSITION Messages", true)
53
        , p_targetPositionPrefix("targetPositionsPrefix", "Target Position Prefix", "IGTL.position.")
CAMP C++ Builder's avatar
CAMP C++ Builder committed
54
55
56
57
    {
        addProperty(p_address, VALID);
        addProperty(p_port, VALID);
        addProperty(p_deviceName, VALID);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
58
59
60

        addProperty(p_connect, VALID);

61
62
        addProperty(p_receiveTransforms, INVALID_PROPERTIES);
        addProperty(p_receiveImages, INVALID_PROPERTIES);
63
64
        addProperty(p_targetTransformPrefix, VALID);
        addProperty(p_targetImagePrefix, VALID);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
65
66
        addProperty(p_imageOffset, VALID);
        addProperty(p_voxelSize, VALID);
67
        addProperty(p_receivePositions, INVALID_PROPERTIES);
68
        addProperty(p_targetPositionPrefix, VALID);
69
70

		invalidate(INVALID_PROPERTIES);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
71
72
73
74
75
76
77
    }

    OpenIGTLinkClient::~OpenIGTLinkClient() {

    }

    void OpenIGTLinkClient::init() {
78
        p_connect.s_clicked.connect(this, &OpenIGTLinkClient::connectToServer);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
79
80
81
82
83
84
85
86
87
88
89
    }

    void OpenIGTLinkClient::deinit() {
        p_connect.s_clicked.disconnect(this);
        stop(); //stop the receiving thread
    }

    void OpenIGTLinkClient::updateResult(DataContainer& data) {

        if(p_receiveTransforms.getValue()) 
        {
90
91
92
            _transformMutex.lock();
            for(auto it = _receivedTransforms.begin(), end = _receivedTransforms.end(); it != end; ++it) { 
                TransformData * td = new TransformData(it->second);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
93
        
94
                data.addData(p_targetTransformPrefix.getValue() + it->first, td);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
95
96
97

                LDEBUG("Transform data put into container. ");
            }
98
99
            _receivedTransforms.clear();
            _transformMutex.unlock();
CAMP C++ Builder's avatar
CAMP C++ Builder committed
100
101
102
103
        }

        if(p_receiveImages.getValue()) 
        {
104
105
            _imageMutex.lock();
            for(auto it = _receivedImages.begin(), end = _receivedImages.end(); it != end; ++it)
CAMP C++ Builder's avatar
CAMP C++ Builder committed
106
            {
107
                igtl::ImageMessage::Pointer imageMessage = it->second;    
CAMP C++ Builder's avatar
CAMP C++ Builder committed
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
                WeaklyTypedPointer wtp;
                wtp._pointer = new uint8_t[imageMessage->GetImageSize()];
                LDEBUG("Image has " << imageMessage->GetNumComponents() << " components and is of size " << imageMessage->GetImageSize());
                memcpy(wtp._pointer, imageMessage->GetScalarPointer(), imageMessage->GetImageSize());
                wtp._numChannels = imageMessage->GetNumComponents();

                switch (imageMessage->GetScalarType()) {
                case igtl::ImageMessage::TYPE_INT8:
                    wtp._baseType = WeaklyTypedPointer::INT8; break;
                case igtl::ImageMessage::TYPE_UINT8:
                    wtp._baseType = WeaklyTypedPointer::UINT8; break;
                case igtl::ImageMessage::TYPE_INT16:
                    wtp._baseType = WeaklyTypedPointer::INT16; break;
                case igtl::ImageMessage::TYPE_UINT16:
                    wtp._baseType = WeaklyTypedPointer::UINT16; break;
                case igtl::ImageMessage::TYPE_INT32:
                    wtp._baseType = WeaklyTypedPointer::INT32; break;
                case igtl::ImageMessage::TYPE_UINT32:
                    wtp._baseType = WeaklyTypedPointer::UINT32; break;
                case igtl::ImageMessage::TYPE_FLOAT32:
                    wtp._baseType = WeaklyTypedPointer::FLOAT; break;
                default:
                    LERROR("Error while receiving IGTL IMAGE message: unsupported type: " << imageMessage->GetScalarType());
                    return;
                }

                tgt::vec3 imageOffset(0.f);
                tgt::vec3 voxelSize(1.f);
                tgt::ivec3 size_i(1);
137
138

                imageMessage->GetSpacing(voxelSize.elem);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
139
                imageMessage->GetDimensions(size_i.elem);
140
141
                tgt::svec3 size(size_i);                
                imageMessage->GetOrigin(imageOffset.elem);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
142
143
144
145
146

                size_t dimensionality = (size_i[2] == 1) ? ((size_i[1] == 1) ? 1 : 2) : 3;
                ImageData* image = new ImageData(dimensionality, size, wtp._numChannels);
                ImageRepresentationLocal::create(image, wtp);
                image->setMappingInformation(ImageMappingInformation(size, p_imageOffset.getValue(), voxelSize * p_voxelSize.getValue()));
147
                data.addData(p_targetImagePrefix.getValue() + it->first, image);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
148
            }
149
150
            _receivedImages.clear();
            _imageMutex.unlock();
CAMP C++ Builder's avatar
CAMP C++ Builder committed
151
152
        }

CAMP C++ Builder's avatar
CAMP C++ Builder committed
153
154
        if(p_receivePositions.getValue())
        {
155
156
157
158
159
160
161
162
            _positionMutex.lock();
            for(auto it = _receivedPositions.begin(), end = _receivedPositions.end(); it != end; ++it) 
            {
                PositionData * pd = new PositionData(it->second._position, it->second._quaternion);
                data.addData(p_targetPositionPrefix.getValue() + it->first, pd);
            }
            _receivedPositions.clear();
            _positionMutex.unlock();
CAMP C++ Builder's avatar
CAMP C++ Builder committed
163
164
        }

CAMP C++ Builder's avatar
CAMP C++ Builder committed
165
166
167
168
        validate(INVALID_RESULT);
    }

    void OpenIGTLinkClient::updateProperties(DataContainer& dataContainer) {
169
        p_targetImagePrefix.setVisible(p_receiveImages.getValue());
CAMP C++ Builder's avatar
CAMP C++ Builder committed
170
171
172

        p_imageOffset.setVisible(p_receiveImages.getValue());
        p_voxelSize.setVisible(p_receiveImages.getValue());
173
        p_targetTransformPrefix.setVisible(p_receiveImages.getValue() || p_receiveTransforms.getValue());
174
		p_targetPositionPrefix.setVisible(p_receivePositions.getValue());
CAMP C++ Builder's avatar
CAMP C++ Builder committed
175
176
    }

177
    void OpenIGTLinkClient::connectToServer() {
CAMP C++ Builder's avatar
CAMP C++ Builder committed
178
179
180
181
182
183
184
185
186
187
188
189

        if(_socket && _socket->GetConnected()) {
            LWARNING("Already connected!");
            return;
        }


        _socket = igtl::ClientSocket::New();
        int r = _socket->ConnectToServer(p_address.getValue().c_str(), p_port.getValue());

        if (r != 0)
        {
190
191
            LERROR("Cannot connect to the server " << p_address.getValue() << ":" << p_port.getValue());
            _socket = nullptr;
CAMP C++ Builder's avatar
CAMP C++ Builder committed
192
193
194
            return;
        }

195
        LINFO("Connected to server " << p_address.getValue() << ":" << p_port.getValue());
CAMP C++ Builder's avatar
CAMP C++ Builder committed
196
197
198
199
200
201

        start(); //start receiving data in a new thread

        validate(INVALID_RESULT);
    }

202
203
204
205
206
207
    void OpenIGTLinkClient::disconnect() {
        stop();
        _socket = nullptr;
        LINFO("Disconnected.");
    }

CAMP C++ Builder's avatar
CAMP C++ Builder committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    int OpenIGTLinkClient::ReceiveTransform(igtl::Socket * socket, igtl::MessageHeader::Pointer& header)
    {
        LDEBUG("Receiving TRANSFORM data type.");

        // Create a message buffer to receive transform data
        igtl::TransformMessage::Pointer transMsg;
        transMsg = igtl::TransformMessage::New();
        transMsg->SetMessageHeader(header);
        transMsg->AllocatePack();

        // Receive transform data from the socket
        socket->Receive(transMsg->GetPackBodyPointer(), transMsg->GetPackBodySize());

        // Deserialize the transform data
        // If you want to skip CRC check, call Unpack() without argument.
        int c = transMsg->Unpack(1);

        if (c & igtl::MessageHeader::UNPACK_BODY) // if CRC check is OK
        {
227
228
229
230
            tgt::mat4 mtx;
            // Retrieve the transform data (this cast is a bit dubious but should be ok judging from the respective class internals)
            transMsg->GetMatrix(*reinterpret_cast<igtl::Matrix4x4*>(mtx.elem));
            igtl::PrintMatrix(*reinterpret_cast<igtl::Matrix4x4*>(mtx.elem));
CAMP C++ Builder's avatar
CAMP C++ Builder committed
231
232
            std::cerr << std::endl;

233
234
235
            _transformMutex.lock();
            _receivedTransforms[transMsg->GetDeviceName()] = mtx;
            _transformMutex.unlock();
CAMP C++ Builder's avatar
CAMP C++ Builder committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262

            invalidate(INVALID_RESULT);
            return 1;
        }

        return 0;
    }

    int OpenIGTLinkClient::ReceivePosition(igtl::Socket * socket, igtl::MessageHeader::Pointer& header)
    {
        LDEBUG("Receiving POSITION data type.");

        // Create a message buffer to receive position data
        igtl::PositionMessage::Pointer positionMsg;
        positionMsg = igtl::PositionMessage::New();
        positionMsg->SetMessageHeader(header);
        positionMsg->AllocatePack();

        // Receive position position data from the socket
        socket->Receive(positionMsg->GetPackBodyPointer(), positionMsg->GetPackBodySize());

        // Deserialize the transform data
        // If you want to skip CRC check, call Unpack() without argument.
        int c = positionMsg->Unpack(1);

        if (c & igtl::MessageHeader::UNPACK_BODY) // if CRC check is OK
        {
263
264
265
266
267
            PositionMessageData pmd;

            positionMsg->GetPosition(pmd._position.elem);
            positionMsg->GetQuaternion(pmd._quaternion.elem);
            
CAMP C++ Builder's avatar
CAMP C++ Builder committed
268

269
270
271
272
273
274
275
            _positionMutex.lock();
            _receivedPositions[positionMsg->GetDeviceName()] = pmd;
            _positionMutex.unlock();

            std::cerr << "position   = (" << pmd._position[0] << ", " << pmd._position[1] << ", " << pmd._position[2] << ")" << std::endl;
            std::cerr << "quaternion = (" << pmd._quaternion[0] << ", " << pmd._quaternion[1] << ", "
                << pmd._quaternion[2] << ", " << pmd._quaternion[3] << ")" << std::endl << std::endl;
CAMP C++ Builder's avatar
CAMP C++ Builder committed
276

CAMP C++ Builder's avatar
CAMP C++ Builder committed
277
            invalidate(INVALID_RESULT);
CAMP C++ Builder's avatar
CAMP C++ Builder committed
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
            return 1;
        }

        return 0;
    }

    int OpenIGTLinkClient::ReceiveImage(igtl::Socket * socket, igtl::MessageHeader::Pointer& header)
    {
        LDEBUG("Receiving IMAGE data type.");

        // Create a message buffer to receive transform data
        igtl::ImageMessage::Pointer imgMsg;
        imgMsg = igtl::ImageMessage::New();
        imgMsg->SetMessageHeader(header);
        imgMsg->AllocatePack();

        // Receive image data from the socket
        socket->Receive(imgMsg->GetPackBodyPointer(), imgMsg->GetPackBodySize());

        // Deserialize the transform data
        // If you want to skip CRC check, call Unpack() without argument.
        int c = imgMsg->Unpack(1);

        if (c & igtl::MessageHeader::UNPACK_BODY) // if CRC check is OK
        {
            // put the message pointer into our locked buffer
304
305
306
            _imageMutex.lock();
            _receivedImages[imgMsg->GetDeviceName()] = imgMsg;
            _imageMutex.unlock();
CAMP C++ Builder's avatar
CAMP C++ Builder committed
307
308
309
310
311
312
313
314
315
316
317
318
319

            // Retrieve the image data
            int   size[3];          // image dimension
            float spacing[3];       // spacing (mm/pixel)
            int   svsize[3];        // sub-volume size
            int   svoffset[3];      // sub-volume offset
            int   scalarType;       // scalar type

            scalarType = imgMsg->GetScalarType();
            imgMsg->GetDimensions(size);
            imgMsg->GetSpacing(spacing);
            imgMsg->GetSubVolume(svsize, svoffset);

320
            tgt::mat4 mtx;
CAMP C++ Builder's avatar
CAMP C++ Builder committed
321
            // Retrieve the transform data (this cast is a bit dubious but should be ok judging from the class internals)
322
323
324
325
326
            imgMsg->GetMatrix(*reinterpret_cast<igtl::Matrix4x4*>(mtx.elem));
            
            _transformMutex.lock();
            _receivedTransforms[imgMsg->GetDeviceName()] = mtx;
            _transformMutex.unlock();
CAMP C++ Builder's avatar
CAMP C++ Builder committed
327
328
329
330
331
332
333
334
335
336
337
338

            std::cerr << "Device Name           : " << imgMsg->GetDeviceName() << std::endl;
            std::cerr << "Scalar Type           : " << scalarType << std::endl;
            std::cerr << "Dimensions            : ("
                << size[0] << ", " << size[1] << ", " << size[2] << ")" << std::endl;
            std::cerr << "Spacing               : ("
                << spacing[0] << ", " << spacing[1] << ", " << spacing[2] << ")" << std::endl;
            std::cerr << "Sub-Volume dimensions : ("
                << svsize[0] << ", " << svsize[1] << ", " << svsize[2] << ")" << std::endl;
            std::cerr << "Sub-Volume offset     : ("
                << svoffset[0] << ", " << svoffset[1] << ", " << svoffset[2] << ")" << std::endl << std::endl;

339
340
            igtl::PrintMatrix(*reinterpret_cast<igtl::Matrix4x4*>(mtx.elem));
            std::cout << std::endl;
CAMP C++ Builder's avatar
CAMP C++ Builder committed
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357

            invalidate(INVALID_RESULT);
            return 1;
        }

        return 0;

    }

    void OpenIGTLinkClient::run()
    {
        igtl::MessageHeader::Pointer headerMsg;
        igtl::TimeStamp::Pointer ts;

        headerMsg = igtl::MessageHeader::New();
        ts = igtl::TimeStamp::New();

358
        while (!_stopExecution && _socket)
CAMP C++ Builder's avatar
CAMP C++ Builder committed
359
360
361
362
363
364
365
366
367
        {
            // Initialize receive buffer
            headerMsg->InitPack();

            // Receive generic header from the socket
            int r = _socket->Receive(headerMsg->GetPackPointer(), headerMsg->GetPackSize());
            if (r == 0)
            {
                _socket->CloseSocket();
368
                _socket = nullptr;
CAMP C++ Builder's avatar
CAMP C++ Builder committed
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
                LINFO("Socket Connection closed.");
                break;
            }
            if (r != headerMsg->GetPackSize())
            {
                continue;
            }

            // Deserialize the header
            headerMsg->Unpack();

            // Get time stamp
            igtlUint32 sec;
            igtlUint32 nanosec;

            headerMsg->GetTimeStamp(ts);
            ts->GetTimeStamp(&sec, &nanosec);

            /*std::cerr << "Time stamp: "
                << sec << "." << std::setw(9) << std::setfill('0') 
                << nanosec << std::endl;*/

            std::string acceptedName = p_deviceName.getValue();
            
            if (!acceptedName.empty() && strcmp(acceptedName.c_str(), headerMsg->GetDeviceName()) ) 
            {
                _socket->Skip(headerMsg->GetBodySizeToRead(), 0);
                LDEBUG("Ignoring Message from device " << headerMsg->GetDeviceName() << ". Does not match " << acceptedName);
            }
            // Check data type and receive data body
            else if (strcmp(headerMsg->GetDeviceType(), "TRANSFORM") == 0)
            {
                if(p_receiveTransforms.getValue())
                    ReceiveTransform(_socket, headerMsg);
                else
                    _socket->Skip(headerMsg->GetBodySizeToRead(), 0);
            }
CAMP C++ Builder's avatar
CAMP C++ Builder committed
406
            else if (strcmp(headerMsg->GetDeviceType(), "POSITION") == 0)
CAMP C++ Builder's avatar
CAMP C++ Builder committed
407
            {
CAMP C++ Builder's avatar
CAMP C++ Builder committed
408
409
410
411
412
                if(p_receivePositions.getValue())
                    ReceivePosition(_socket, headerMsg);
                else
                    _socket->Skip(headerMsg->GetBodySizeToRead(), 0);
            }
CAMP C++ Builder's avatar
CAMP C++ Builder committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
            else if (strcmp(headerMsg->GetDeviceType(), "IMAGE") == 0)
            {
                if(p_receiveImages.getValue())
                    ReceiveImage(_socket, headerMsg);
                else
                    _socket->Skip(headerMsg->GetBodySizeToRead(), 0);
            }
//            else if (strcmp(headerMsg->GetDeviceType(), "STATUS") == 0)
//            {
//                ReceiveStatus(socket, headerMsg);
//            }
//#if OpenIGTLink_PROTOCOL_VERSION >= 2
//            else if (strcmp(headerMsg->GetDeviceType(), "POINT") == 0)
//            {
//                ReceivePoint(socket, headerMsg);
//            }
//            else if (strcmp(headerMsg->GetDeviceType(), "TRAJ") == 0)
//            {
//                ReceiveTrajectory(socket, headerMsg);
//            }
//            else if (strcmp(headerMsg->GetDeviceType(), "STRING") == 0)
//            {
//                ReceiveString(socket, headerMsg);
//            }
//            else if (strcmp(headerMsg->GetDeviceType(), "TDATA") == 0)
//            {
//                ReceiveTrackingData(socket, headerMsg);
//            }
//            else if (strcmp(headerMsg->GetDeviceType(), "QTDATA") == 0)
//            {
//                ReceiveQuaternionTrackingData(socket, headerMsg);
//            }
//            else if (strcmp(headerMsg->GetDeviceType(), "CAPABILITY") == 0)
//            {
//                ReceiveCapability(socket, headerMsg);;
//            }
//#endif //OpenIGTLink_PROTOCOL_VERSION >= 2
            else
            {
                LDEBUG("Receiving : " << headerMsg->GetDeviceType() << " which is not Handled!");
                _socket->Skip(headerMsg->GetBodySizeToRead(), 0);
            }
        }
456
457
458
        if(_socket)       
            _socket->CloseSocket();
        _socket = nullptr;
CAMP C++ Builder's avatar
CAMP C++ Builder committed
459
460
    }
}