MeVisLab Toolbox Reference
mlDcmDRTModalityLUTSequenceInterface.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
4 //
5 // NOTE:
6 // This file has been generated automatically by
7 // FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/convertDcmtkToML.py
8 // using the template file
9 // FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/MLDcmtkAccessoriesNew/templates/DcmSequenceInterface.h
10 //
11 // Destination project:
12 // FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessoriesNew/DcmSequenceInterfaces
13 //
14 //----------------------------------------------------------------------------------
16 
21 //----------------------------------------------------------------------------------
22 
23 #ifndef __mlDcmDRTModalityLUTSequenceInterface_H
24 #define __mlDcmDRTModalityLUTSequenceInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTModalityLUTSequenceInterface.h" //DRTModalityLUTSequence
31 
32 
33 // ML includes
34 #ifndef __mlModuleIncludes_H
35 #include "mlModuleIncludes.h"
36 #endif
37 
38 ML_START_NAMESPACE
39 
40 // ------------------------------------------------------------------
42 // ------------------------------------------------------------------
44 {
45  public:
46 
48  {
49  public:
50 
51  Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
52 
53  Item(DCMTree::TreePtr dcmItem) : _dcmItem(dcmItem) {}
54 
55  Item(const Item &copyDcmItem) : _dcmItem(copyDcmItem.getTreePtr()) {}
56 
57  Item &operator=(const Item &copyDcmItem){ _dcmItem = copyDcmItem.getTreePtr(); return *this; }
58 
59  virtual ~Item() {}
60 
61  DCMTree::TreePtr getTreePtr() const { return _dcmItem; }
62 
63  bool isValid() const { return _dcmItem.get() != nullptr; }
64 
65 
66  // LUTDescriptor (0028,3002) vr=US_SS, vm=3, type=1C
67  bool getLUTDescriptor(MLuint16& parameter) const;
68  std::string getLUTDescriptorTag() const { return "(0028,3002)"; }
69  bool setLUTDescriptor(MLuint16 parameter);
70 
71  // LUTExplanation (0028,3003) vr=LO, vm=1, type=3
72  bool getLUTExplanation(std::string& parameter) const;
73  std::string getLUTExplanationTag() const { return "(0028,3003)"; }
74  bool setLUTExplanation(std::string parameter);
75 
76  // ModalityLUTType (0028,3004) vr=LO, vm=1, type=1C
77  bool getModalityLUTType(std::string& parameter) const;
78  std::string getModalityLUTTypeTag() const { return "(0028,3004)"; }
79  bool setModalityLUTType(std::string parameter);
80 
81 
82  private:
83 
84  DCMTree::TreePtr _dcmItem;
85 
86  };
87 
89 
91  DcmDRTModalityLUTSequenceInterface(std::vector<DcmDRTModalityLUTSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
92 
94  for(size_t i=0; i < treePtrSeq.size(); i++)
95  {
96  _itemVec.push_back(DcmDRTModalityLUTSequenceInterface::Item(treePtrSeq[i]));
97  }
98  }
99 
102  // LUTDescriptor (0028,3002) vr=US_SS, vm=3, type=1C
103  bool getLUTDescriptor(unsigned long idx, MLuint16& parameter) const;
104  bool getLUTDescriptor(DCMTree::TreePtr item, MLuint16& parameter) const;
105  std::string getLUTDescriptorTag() const { return "(0028,3002)"; }
106  bool setLUTDescriptor(unsigned long idx, MLuint16 parameter);
107 
108  // LUTExplanation (0028,3003) vr=LO, vm=1, type=3
109  bool getLUTExplanation(unsigned long idx, std::string& parameter) const;
110  bool getLUTExplanation(DCMTree::TreePtr item, std::string& parameter) const;
111  std::string getLUTExplanationTag() const { return "(0028,3003)"; }
112  bool setLUTExplanation(unsigned long idx, std::string parameter);
113 
114  // ModalityLUTType (0028,3004) vr=LO, vm=1, type=1C
115  bool getModalityLUTType(unsigned long idx, std::string& parameter) const;
116  bool getModalityLUTType(DCMTree::TreePtr item, std::string& parameter) const;
117  std::string getModalityLUTTypeTag() const { return "(0028,3004)"; }
118  bool setModalityLUTType(unsigned long idx, std::string parameter);
119 
120 
123  void setSequence(std::vector<DcmDRTModalityLUTSequenceInterface::Item> dcmSequence) {
124  _itemVec = dcmSequence;
125  }
126 
129  std::vector<DcmDRTModalityLUTSequenceInterface::Item> getSequence() const {
130  return _itemVec;
131  }
132 
135  bool hasSequence() const {
136  return (_itemVec.size() != 0);
137  }
138 
142  return static_cast<MLint>(_itemVec.size());
143  }
144 
148  if (_itemVec.size() > idx) {
149  return _itemVec[idx];
150  }
152  }
153 
157  _itemVec.push_back(DcmDRTModalityLUTSequenceInterface::Item());
158  return _itemVec[_itemVec.size()-1];
159  }
160 
162  _itemVec.push_back(newItem);
163  }
164 
167  bool insertItem(const size_t idx) {
168  if (_itemVec.size() > idx) {
169  std::vector<DcmDRTModalityLUTSequenceInterface::Item>::iterator it = _itemVec.begin();
170  std::advance(it, idx);
171  _itemVec.insert(it, DcmDRTModalityLUTSequenceInterface::Item());
172  return true;
173  }
174  return false;
175  }
176 
179  bool removeItem(const size_t idx) {
180  if ( _itemVec.size() > idx ) {
181  std::vector<DcmDRTModalityLUTSequenceInterface::Item>::iterator it = _itemVec.begin();
182  std::advance(it, idx);
183  _itemVec.erase(it);
184  return true;
185  }
186  return false;
187  }
188 
189  protected:
191  std::vector<DcmDRTModalityLUTSequenceInterface::Item> _itemVec;
192 };
193 
194 ML_END_NAMESPACE
195 
196 #endif // __mlDcmDRTModalityLUTSequenceInterface_H
197 
198 /* MeVis-Hidden-Components-Start */
199 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool setModalityLUTType(std::string parameter)
bool getLUTExplanation(std::string &parameter) const
bool getModalityLUTType(std::string &parameter) const
bool getLUTDescriptor(MLuint16 &parameter) const
bool setLUTExplanation(std::string parameter)
Class to provide access to DRTModalityLUTSequence.
DcmDRTModalityLUTSequenceInterface(DCMTree::TreePtrVector treePtrSeq)
DcmDRTModalityLUTSequenceInterface(std::vector< DcmDRTModalityLUTSequenceInterface::Item > dcmSequence)
Default Constructor.
bool setLUTExplanation(unsigned long idx, std::string parameter)
bool getLUTExplanation(unsigned long idx, std::string &parameter) const
void addItem(DcmDRTModalityLUTSequenceInterface::Item newItem)
bool setModalityLUTType(unsigned long idx, std::string parameter)
bool getLUTDescriptor(DCMTree::TreePtr item, MLuint16 &parameter) const
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
std::vector< DcmDRTModalityLUTSequenceInterface::Item > getSequence() const
Return the DRTModalityLUTSequence this interface class provides access to.
bool setLUTDescriptor(unsigned long idx, MLuint16 parameter)
void setSequence(std::vector< DcmDRTModalityLUTSequenceInterface::Item > dcmSequence)
Set the DRTModalityLUTSequence this interface class provides access to.
std::vector< DcmDRTModalityLUTSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
DcmDRTModalityLUTSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool hasSequence() const
Check if the DRTModalityLUTSequence is set.
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool getModalityLUTType(unsigned long idx, std::string &parameter) const
bool getLUTDescriptor(unsigned long idx, MLuint16 &parameter) const
bool getLUTExplanation(DCMTree::TreePtr item, std::string &parameter) const
bool getModalityLUTType(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTModalityLUTSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
virtual ~DcmDRTModalityLUTSequenceInterface()
Default virtual Destructor.
Class collecting some DICOM helper functionality explicitly for dcmtk.
unsigned short MLuint16
Definition: mlTypeDefs.h:148
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition: mlTypeDefs.h:578
std::vector< TreePtr > TreePtrVector
a vector of TreePtr - used for sequences
Definition: DCMTree_Lib.h:85
boost::shared_ptr< Tree > TreePtr
shared pointer to a DCMTree::Tree
Definition: DCMTree_Lib.h:70