File: DicomDataWriter.hxx

package info (click to toggle)
sight 21.1.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 36,592 kB
  • sloc: cpp: 228,341; xml: 19,066; ansic: 9,854; python: 302; sh: 135; makefile: 32
file content (224 lines) | stat: -rw-r--r-- 7,535 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
/************************************************************************
 *
 * Copyright (C) 2021-2022 IRCAD France
 * Copyright (C) 2017 IHU Strasbourg
 *
 * This file is part of Sight.
 *
 * Sight is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Sight is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sight. If not, see <https://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

#pragma once

#include "io/dicom/config.hpp"
#include "io/dicom/container/DicomCodedAttribute.hpp"

#include <gdcmAttribute.h>
#include <gdcmDataSet.h>
#include <gdcmElement.h>
#include <gdcmSequenceOfItems.h>

namespace sight::io::dicom
{

namespace helper
{

/**
 * @brief This class contains helpers to write information into GDCM datasets.
 */
class IO_DICOM_CLASS_API DicomDataWriter
{
public:

    /**
     * @brief Insert an empty tag in a data set. Useful for empty type 2 tags.
     * @param[in] dataset Data set of tags
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setEmptyTagValue(gdcm::DataSet& dataset)
    {
        gdcm::Attribute<GROUP, ELEMENT> attribute;
        dataset.Insert(attribute.GetAsDataElement());
    }

    /**
     * @brief Insert the value of a tag in a data set.
     * @param[in] value Value to set
     * @param[in] dataset Data set of tags
     * @tparam T Type of value
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<typename T, std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setTagValue(const T& value, gdcm::DataSet& dataset)
    {
        gdcm::Attribute<GROUP, ELEMENT> attribute;
        attribute.SetValue(value);
        dataset.Insert(attribute.GetAsDataElement());
    }

    /**
     * @brief Insert the string value of a tag in a data set.
     * @param[in] value Value to set
     * @param[in] dataset Data set of tags
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setTagValue(const std::string& value, gdcm::DataSet& dataset)
    {
        setTagValue<std::string, GROUP, ELEMENT>(value, dataset);
    }

    /**
     * @brief Insert multiple values of a tag in a data set.
     * @param[in] array An Array.
     * @param[in] size Size of the array.
     * @param[in] dataset Data set of tags.
     * @tparam T Type of pointer.
     * @tparam GROUP Group of the tag.
     * @tparam ELEMENT Element of the tag.
     */
    template<typename T, std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setTagValues(const T* array, const std::size_t size, gdcm::DataSet& dataset)
    {
        gdcm::Attribute<GROUP, ELEMENT> attribute;
        if(array)
        {
            attribute.SetValues(array, static_cast<unsigned int>(size));
        }

        dataset.Insert(attribute.GetAsDataElement());
    }

    /**
     * @brief Set and insert a sequence of items with a tag in the specified data set.
     * @param[in] sequence Sequence of items to insert
     * @param[in] dataset Data set
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setSequenceTagValue(
        gdcm::SmartPointer<gdcm::SequenceOfItems> sequence,
        gdcm::DataSet& dataset
)
    {
        // Create the sequence of items
        gdcm::DataElement dataElement(gdcm::Attribute<GROUP, ELEMENT>::GetTag());
        dataElement.SetVR(gdcm::VR::SQ);
        dataElement.SetValue(*sequence);
        dataElement.SetVL(sequence->GetLength());

        // Insert the sequence of items
        dataset.Insert(dataElement);
    }

    /**
     * @brief Create and set a sequence of items with a tag in the specified data set.
     * @param[in] dataset Data set
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<std::uint16_t GROUP, std::uint16_t ELEMENT>
    static gdcm::SmartPointer<gdcm::SequenceOfItems> createAndSetSequenceTagValue(gdcm::DataSet& dataset)
    {
        gdcm::SmartPointer<gdcm::SequenceOfItems> sequence = new gdcm::SequenceOfItems();
        sequence->SetLengthToUndefined();
        setSequenceTagValue<GROUP, ELEMENT>(sequence, dataset);
        return sequence;
    }

    /**
     * @brief Insert a sequence of items with a tag in the specified data set.
     * If the tag already exists, items of the old and new sequences are added in a new one.
     * @param[in] sequence Sequence of items to insert
     * @param[in] dataset Data set
     *
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setAndMergeSequenceTagValue(
        gdcm::SmartPointer<gdcm::SequenceOfItems> sequence,
        gdcm::DataSet& dataset
)
    {
        // Set or add the SQ
        if(!dataset.FindDataElement(gdcm::Attribute<GROUP, ELEMENT>::GetTag()))
        {
            setSequenceTagValue<GROUP, ELEMENT>(sequence, dataset);
        }
        else
        {
            // Get old SQ
            const gdcm::DataElement& dataElement =
                dataset.GetDataElement(gdcm::Attribute<GROUP, ELEMENT>::GetTag());
            gdcm::SmartPointer<gdcm::SequenceOfItems> oldSequence = dataElement.GetValueAsSQ();

            // Add items of the new SQ to the old SQ
            auto nbItem = sequence->GetNumberOfItems();
            for(decltype(nbItem) i = 1 ; i <= nbItem ; ++i) // WARN : item start at 1
            {
                oldSequence->AddItem(sequence->GetItem(i));
            }
        }
    }

    /**
     * @brief Set tag value for the code sequence.
     * @param[in] attribute attribute to set
     * @param[in] dataset Data set
     *
     * @tparam GROUP Group of the tag
     * @tparam ELEMENT Element of the tag
     */
    template<std::uint16_t GROUP, std::uint16_t ELEMENT>
    static void setCodeSequenceTagValue(
        io::dicom::container::DicomCodedAttribute attribute,
        gdcm::DataSet& dataset
)
    {
        auto sequence = createAndSetSequenceTagValue<GROUP, ELEMENT>(dataset);

        gdcm::Item item;
        item.SetVLToUndefined();
        gdcm::DataSet& itemDataset = item.GetNestedDataSet();

        // Code Value - Type 1C
        setTagValue<0x0008, 0x0100>(attribute.getCodeValue(), itemDataset);

        // Coding Scheme Designator - Type 1C
        setTagValue<0x0008, 0x0102>(attribute.getCodingSchemeDesignator(), itemDataset);

        // Coding Scheme Version - Type 1C
        if(!attribute.getCodingSchemeVersion().empty())
        {
            setTagValue<0x0008, 0x0103>(attribute.getCodingSchemeVersion(), itemDataset);
        }

        // Code Meaning - Type 1
        setTagValue<0x0008, 0x0104>(attribute.getCodeMeaning(), itemDataset);

        sequence->AddItem(item);
    }
};

} // namespace helper

} // namespace sight::io::dicom