Class representing the Segmentation Functional Group Macro. More...
Inheritance diagram for FGSegmentation:
Public Member Functions | |
| FGSegmentation () | |
| Constructor, creates empty functional group. | |
| virtual | ~FGSegmentation () |
| Destructor, frees memory. | |
| virtual FGBase * | clone () const |
| Returns a deep copy of this object. More... | |
| virtual DcmFGTypes::E_FGSharedType | getSharedType () const |
| Returns that this functional group can be used shared or per-frame, i.e. both. More... | |
| virtual void | clearData () |
| Clear all data. | |
| OFCondition | check () const |
| Check whether data in this functional group is valid. More... | |
| virtual int | compare (const FGBase &rhs) const |
| Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGSegmentation) to be comparable. More... | |
| virtual OFCondition | getReferencedSegmentNumber (Uint16 &value, const unsigned long pos=0) |
| Get Referenced Segment Number. More... | |
| virtual OFCondition | setReferencedSegmentNumber (const Uint16 &segmentNumber) |
| Set Referenced Segment Number. More... | |
| virtual OFCondition | read (DcmItem &item) |
| Read functional group from item, must contain the Segment Identification Sequence. More... | |
| virtual OFCondition | write (DcmItem &item) |
| Write functional group to item, will write Segment Identification Sequence. More... | |
| Public Member Functions inherited from FGBase | |
| FGBase (const DcmFGTypes::E_FGType fgType) | |
| Constructor, creates new functional group of given type. More... | |
| virtual DcmFGTypes::E_FGType | getType () const |
| Return the type of this functional group. More... | |
| virtual | ~FGBase () |
| Virtual destructor. | |
Private Attributes | |
| DcmUnsignedShort | m_ReferencedSegmentNumber |
| Referenced Segment Number: (US, 1-n, 1) Represents single value within the single permitted item of the Segment Identification Sequence being the data structure the Segmentation FG is made of. | |
Additional Inherited Members | |
| Protected Member Functions inherited from FGBase | |
| virtual OFCondition | getItemFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, const unsigned long itemNum, DcmItem *&result) |
| Get the item containing the payload of a functional group sequence, identified by the functional group's sequence key provided and the desired item number. More... | |
| virtual OFCondition | getNumItemsFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, unsigned long &result) |
| Get number of items in a functional group sequence, identified by the functional group's sequence key. More... | |
| virtual OFCondition | createNewFGSequence (DcmItem &destination, const DcmTagKey &seqKey, const unsigned long numItems, DcmItem *&firstItem) |
| Create functional group sequence specified by given sequence tag key. More... | |
Detailed Description
Class representing the Segmentation Functional Group Macro.
Member Function Documentation
◆ check()
|
virtual |
Check whether data in this functional group is valid.
- Returns
- EC_Normal if data is valid, error otherwise
Implements FGBase.
◆ clone()
|
virtual |
◆ compare()
|
virtual |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGSegmentation) to be comparable.
This function is used in order to decide whether a functional group already exists, or is new. This is used in particular to find out whether a given functional group can be shared (i.e. the same information already exists as shared functional group) or is different from the same shared group. In that case the shared functional group must be distributed into per-frame functional groups, instead. The exact implementation for implementing the comparison is not relevant. However, it must be a comparison by value.
- Parameters
-
rhs the right hand side of the comparison
- Returns
- 0 if the object values are equal. -1 if either the value of the first component that does not match is lower in the rhs object, or all compared components match but the rhs component is shorter. Also returned if this type and rhs type (DcmFGTypes::E_FGType) do not match. 1 if either the value of the first component that does not match is greater in the rhs object, or all compared components match but the rhs component is longer.
Implements FGBase.
◆ getReferencedSegmentNumber()
|
virtual |
Get Referenced Segment Number.
- Parameters
-
value Reference to variable in which the value should be stored pos Index value to get (0..vm-1)
- Returns
- EC_Normal if successful, an error code otherwise
◆ getSharedType()
|
inlinevirtual |
Returns that this functional group can be used shared or per-frame, i.e. both.
- Returns
- Always returns DcmFGTypes::EFGS_BOTH
Implements FGBase.
References DcmFGTypes::EFGS_BOTH.
◆ read()
|
virtual |
Read functional group from item, must contain the Segment Identification Sequence.
- Parameters
-
item The item to read from
- Returns
- EC_Normal if reading was successful, error otherwise
Implements FGBase.
◆ setReferencedSegmentNumber()
|
virtual |
Set Referenced Segment Number.
- Parameters
-
segmentNumber Value to be set
- Returns
- EC_Normal if successful, an error code otherwise
◆ write()
|
virtual |
Write functional group to item, will write Segment Identification Sequence.
- Parameters
-
item The item to write to
- Returns
- EC_Normal if writing was successful, error otherwise
Implements FGBase.
The documentation for this class was generated from the following file:
- dcmfg/include/dcmtk/dcmfg/fgseg.h