File: test_serialization.cpp

package info (click to toggle)
ismrmrd 1.14.3-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,564 kB
  • sloc: cpp: 6,439; ansic: 2,276; xml: 1,025; sh: 187; python: 72; makefile: 42
file content (359 lines) | stat: -rw-r--r-- 13,058 bytes parent folder | download
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
#include <boost/test/unit_test.hpp>
#include <boost/mpl/vector.hpp>
#include <fstream>
#include <sstream>

#include "ismrmrd/serialization.h"
#include "ismrmrd/serialization_iostream.h"

using namespace ISMRMRD;

BOOST_AUTO_TEST_SUITE(SerialiationTest)

// Some helpers
template <typename T>
T value_from_size_t(size_t i);
template <>
uint16_t value_from_size_t<uint16_t>(size_t i) { return (uint16_t)i; }
template <>
uint32_t value_from_size_t<uint32_t>(size_t i) { return (uint32_t)i; }
template <>
int16_t value_from_size_t<int16_t>(size_t i) { return (int16_t)i; }
template <>
int32_t value_from_size_t<int32_t>(size_t i) { return (int32_t)i; }
template <>
float value_from_size_t<float>(size_t i) { return (float)(i * 1.0f); }
template <>
double value_from_size_t<double>(size_t i) { return (double)(i * 1.0f); }
template <>
std::complex<float> value_from_size_t<std::complex<float> >(size_t i) { return std::complex<float>(1.0f * i, 1.0f * i); }
template <>
std::complex<double> value_from_size_t<std::complex<double> >(size_t i) { return std::complex<double>(1.0f * i, 1.0f * i); }

// Test the serialization of a single acquisition
BOOST_AUTO_TEST_CASE(test_acquisition_serialization) {
    Acquisition acq;
    acq.resize(256, 16, 3);

    // Fill in some data
    for (size_t i = 0; i < acq.getNumberOfDataElements(); i++) {
        acq.getDataPtr()[i] = value_from_size_t<std::complex<float> >(i);
    }

    // Fill trajectory
    for (size_t i = 0; i < acq.getNumberOfTrajElements(); i++) {
        acq.getTrajPtr()[i] = value_from_size_t<float>(i);
    }

    // Test serialization and deserialization
    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
    OStreamView ws(ss);
    IStreamView rs(ss);
    ISMRMRD::serialize(acq, ws);
    Acquisition acq2;
    ISMRMRD::deserialize(acq2, rs);

    // Check that the data is the same
    BOOST_ASSERT(acq.getHead() == acq2.getHead());
    BOOST_CHECK_EQUAL_COLLECTIONS(acq.getDataPtr(), acq.getDataPtr() + acq.getNumberOfDataElements(),
                                  acq2.getDataPtr(), acq2.getDataPtr() + acq2.getNumberOfDataElements());
    BOOST_CHECK_EQUAL_COLLECTIONS(acq.getTrajPtr(), acq.getTrajPtr() + acq.getNumberOfTrajElements(),
                                  acq2.getTrajPtr(), acq2.getTrajPtr() + acq2.getNumberOfTrajElements());
}

typedef boost::mpl::vector<unsigned short, short, unsigned int, int, float, double, std::complex<float>, std::complex<double> > image_types_w_tuples;

// Test the serialization of a single image
BOOST_AUTO_TEST_CASE_TEMPLATE(test_image_serialization, T, image_types_w_tuples) {
    Image<T> img;
    img.resize(64, 64, 8, 4);

    //  just one header field, we will validate it and
    //  we are also validating matrix sizes, assume rest
    //  is working. Image does not have an == operator
    img.setImageSeriesIndex(10);

    // Fill in some data
    for (size_t i = 0; i < img.getNumberOfDataElements(); i++) {
        img.getDataPtr()[i] = value_from_size_t<T>(i);
    }

    // set some meta data
    img.setAttributeString("This is my attribute string");

    // Test serialization and deserialization
    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
    OStreamView ws(ss);
    IStreamView rs(ss);
    ISMRMRD::serialize(img, ws);

    Image<T> img2;
    ISMRMRD::deserialize(img2, rs);

    // Check that the data is the same
    BOOST_CHECK_EQUAL(img.getImageSeriesIndex(), img2.getImageSeriesIndex());
    BOOST_CHECK_EQUAL(img.getAttributeString(), img2.getAttributeString());
    BOOST_CHECK_EQUAL_COLLECTIONS(img.getDataPtr(), img.getDataPtr() + img.getNumberOfDataElements(),
                                  img2.getDataPtr(), img2.getDataPtr() + img2.getNumberOfDataElements());
}

// Test the serialization of a single waveform
BOOST_AUTO_TEST_CASE(test_waveform_serialization) {
    Waveform wf(256, 16);
    wf.head.time_stamp = 1234567890;

    // Fill in some data
    std::fill(wf.begin_data(), wf.end_data(), 1);

    // Test serialization and deserialization
    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
    OStreamView ws(ss);
    IStreamView rs(ss);
    ISMRMRD::serialize(wf, ws);
    Waveform wf2;
    ISMRMRD::deserialize(wf2, rs);

    // Check that the data is the same
    BOOST_ASSERT(wf.head.time_stamp == wf2.head.time_stamp);
    BOOST_CHECK_EQUAL_COLLECTIONS(wf.begin_data(), wf.end_data(),
                                  wf2.begin_data(), wf2.end_data());
}

// Test serrialization of const length arrays
BOOST_AUTO_TEST_CASE(test_config_serialization) {
    ConfigFile cfg;

    strcpy(cfg.config, "default.xml");

    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
    OStreamView ws(ss);
    IStreamView rs(ss);

    ISMRMRD::serialize(cfg, ws);

    ConfigFile cfg2;
    ISMRMRD::deserialize(cfg2, rs);
    std::string str2(cfg2.config);
    BOOST_CHECK_EQUAL("default.xml", str2);
}

// Test string serialization
BOOST_AUTO_TEST_CASE(test_string_serialization) {
    std::string str("This can really be any string, including <XML> configuration and unicode characters: 你好");

    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
    OStreamView ws(ss);
    IStreamView rs(ss);

    ISMRMRD::serialize(str, ws);

    std::string str2;
    ISMRMRD::deserialize(str2, rs);
    BOOST_CHECK_EQUAL(str, str2);
}

// Some early iterations used explicit null terminations in strings,
// We are testing here that it doesn't trip us up
BOOST_AUTO_TEST_CASE(test_string_desiralization_with_null_terminators) {
    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);

    std::vector<char> buffer;
    buffer.push_back('h');
    buffer.push_back('e');
    buffer.push_back('l');
    buffer.push_back('l');
    buffer.push_back('o');
    buffer.push_back('\0');

    // Write a config text manually
    uint32_t len = static_cast<uint32_t>(buffer.size());
    BOOST_CHECK_EQUAL(len, 6); // 6 characters with the null terminator
    ss.write(reinterpret_cast<char *>(&len), sizeof(uint32_t));
    ss.write(&buffer[0], len);

    IStreamView rs(ss);

    ConfigText cf;
    ISMRMRD::deserialize(cf.config_text, rs);

    BOOST_CHECK_EQUAL(cf.config_text.size(), 5); // String is 1 shorter
    BOOST_CHECK_EQUAL(cf.config_text, "hello");
}

typedef boost::mpl::vector<unsigned short, short, unsigned int, int, float, double, std::complex<float>, std::complex<double> > array_types_w_tuples;

// Test the serialization of a single image
BOOST_AUTO_TEST_CASE_TEMPLATE(test_nd_array_serialization, T, array_types_w_tuples) {

    for (uint16_t ndim=1; ndim<=ISMRMRD_NDARRAY_MAXDIM; ndim++)
    {
        std::vector<size_t> dims(ndim, 1);
        for (size_t i=0; i<ndim; i++) dims[i] = std::rand() % 8 + 1;
        NDArray<T> arr;
        arr.resize(dims);

        size_t N = arr.getNumberOfElements();
        T* p_data = arr.getDataPtr();
        for (size_t i=0; i<N; i++) p_data[i] = (T)(( (float)(std::rand()) / RAND_MAX -0.5f) * 2048.0f);

        // Test serialization and deserialization
        std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
        OStreamView ws(ss);
        IStreamView rs(ss);
        ISMRMRD::serialize(arr, ws);

        NDArray<T> arr2;
        ISMRMRD::deserialize(arr2, rs);

        // Check that the data is the same
        BOOST_CHECK_EQUAL(arr.getNDim(), arr2.getNDim());
        BOOST_CHECK_EQUAL(arr.getVersion(), arr2.getVersion());
        BOOST_CHECK_EQUAL(arr.getDataType(), arr2.getDataType());
        BOOST_CHECK_EQUAL(arr.getDataSize(), arr2.getDataSize());
        BOOST_CHECK_EQUAL(arr.getNumberOfElements(), arr2.getNumberOfElements());

        BOOST_CHECK_EQUAL_COLLECTIONS(arr.getDataPtr(), arr.getDataPtr() + arr.getNumberOfElements(),
                                    arr2.getDataPtr(), arr2.getDataPtr() + arr2.getNumberOfElements());
    }
}

BOOST_AUTO_TEST_CASE(test_of_control_plane_protocol_serialization) {
    ConfigFile cfg;
    std::string config_name("test_config.xml");
    strcpy(cfg.config, config_name.c_str());

    ConfigText cfg_txt;
    cfg_txt.config_text = "{{ \"test\": \"test\" }}";

    TextMessage txt_msg;
    txt_msg.message = "This is a test";

    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);
    OStreamView ws(ss);
    IStreamView rs(ss);

    ProtocolSerializer serializer(ws);
    ProtocolDeserializer deserializer(rs);

    serializer.serialize(cfg);
    serializer.serialize(cfg_txt);
    serializer.serialize(txt_msg);

    ConfigFile cfg2;
    deserializer.deserialize(cfg2);
    BOOST_CHECK_EQUAL(cfg2.config, config_name.c_str());

    ConfigText cfg_txt2;
    deserializer.deserialize(cfg_txt2);
    BOOST_CHECK_EQUAL(cfg_txt2.config_text, cfg_txt.config_text);

    TextMessage txt_msg2;
    deserializer.deserialize(txt_msg2);
    BOOST_CHECK_EQUAL(txt_msg2.message, txt_msg.message);
}

BOOST_AUTO_TEST_CASE(test_of_protocol_serialization) {

    // A header
    ISMRMRD::IsmrmrdHeader h;
    h.experimentalConditions.H1resonanceFrequency_Hz = 63500000;
    h.encoding.push_back(ISMRMRD::Encoding());
    h.encoding[0].encodedSpace.matrixSize.x = 256;
    h.encoding[0].encodedSpace.matrixSize.y = 256;
    h.encoding[0].encodedSpace.matrixSize.z = 1;
    h.encoding[0].reconSpace.matrixSize.x = 256;
    h.encoding[0].reconSpace.matrixSize.y = 256;
    h.encoding[0].reconSpace.matrixSize.z = 1;
    h.encoding[0].trajectory = ISMRMRD::TrajectoryType::CARTESIAN;

    // A few Acquisitions
    Acquisition acq1, acq2;
    acq1.resize(256, 16, 3);
    acq2.resize(256, 16, 3);

    // Fill in some data
    for (size_t i = 0; i < acq1.getNumberOfDataElements(); i++) {
        acq1.getDataPtr()[i] = value_from_size_t<std::complex<float> >(i);
        acq2.getDataPtr()[i] = value_from_size_t<std::complex<float> >(2 * i);
    }

    // Fill trajectory
    for (size_t i = 0; i < acq1.getNumberOfTrajElements(); i++) {
        acq1.getTrajPtr()[i] = value_from_size_t<float>(i);
        acq2.getTrajPtr()[i] = value_from_size_t<float>(2 * i);
    }

    // A waveform
    Waveform wf(256, 16);
    wf.head.time_stamp = 1234567890;

    // An image
    Image<float> img;
    img.resize(64, 64, 8, 4);

    //  just one header field, we will validate it and
    //  we are also validating matrix sizes, assume rest
    //  is working. Image does not have an == operator
    img.setImageSeriesIndex(10);

    // Fill in some data
    for (size_t i = 0; i < img.getNumberOfDataElements(); i++) {
        img.getDataPtr()[i] = value_from_size_t<float>(i);
    }

    // set some meta data
    img.setAttributeString("This is my attribute string");

    std::stringstream ss(std::ios::in | std::ios::out | std::ios::binary);

    OStreamView ws(ss);
    IStreamView rs(ss);

    ProtocolSerializer serializer(ws);
    ProtocolDeserializer deserializer(rs);

    serializer.serialize(h);
    serializer.serialize(acq1);
    serializer.serialize(img);
    serializer.serialize(acq2);
    serializer.serialize(wf);

    // Test deserialization
    ISMRMRD::IsmrmrdHeader h2;
    Acquisition acq3, acq4;
    Waveform wf2;
    Image<float> img2;
    deserializer.deserialize(h2);
    deserializer.deserialize(acq3);
    deserializer.deserialize(img2);
    deserializer.deserialize(acq4);
    deserializer.deserialize(wf2);

    // Check that the header is the same
    BOOST_CHECK_EQUAL(h, h2);

    // Check that the data are the same
    BOOST_ASSERT(acq1.getHead() == acq3.getHead());
    BOOST_CHECK_EQUAL_COLLECTIONS(acq1.getDataPtr(), acq1.getDataPtr() + acq1.getNumberOfDataElements(),
                                  acq3.getDataPtr(), acq3.getDataPtr() + acq3.getNumberOfDataElements());
    BOOST_CHECK_EQUAL_COLLECTIONS(acq1.getTrajPtr(), acq1.getTrajPtr() + acq1.getNumberOfTrajElements(),
                                  acq3.getTrajPtr(), acq3.getTrajPtr() + acq3.getNumberOfTrajElements());

    BOOST_ASSERT(acq2.getHead() == acq4.getHead());
    BOOST_CHECK_EQUAL_COLLECTIONS(acq2.getDataPtr(), acq2.getDataPtr() + acq2.getNumberOfDataElements(),
                                  acq4.getDataPtr(), acq4.getDataPtr() + acq4.getNumberOfDataElements());
    BOOST_CHECK_EQUAL_COLLECTIONS(acq2.getTrajPtr(), acq2.getTrajPtr() + acq2.getNumberOfTrajElements(),
                                  acq4.getTrajPtr(), acq4.getTrajPtr() + acq4.getNumberOfTrajElements());

    BOOST_ASSERT(wf.head.time_stamp == wf2.head.time_stamp);
    BOOST_CHECK_EQUAL_COLLECTIONS(wf.begin_data(), wf.end_data(),
                                  wf2.begin_data(), wf2.end_data());

    // Check that the image is the same
    BOOST_CHECK_EQUAL(img.getImageSeriesIndex(), img2.getImageSeriesIndex());
    BOOST_CHECK_EQUAL(img.getAttributeString(), img2.getAttributeString());
    BOOST_CHECK_EQUAL_COLLECTIONS(img.getDataPtr(), img.getDataPtr() + img.getNumberOfDataElements(),
                                  img2.getDataPtr(), img2.getDataPtr() + img2.getNumberOfDataElements());
}

BOOST_AUTO_TEST_SUITE_END()