| DCMTK Version 3.6.9
    OFFIS DICOM Toolkit | 
Class representing a segment from the Segment Identification Sequence, as used within the Segmentation Image Module. More...
| Public Member Functions | |
| virtual | ~DcmSegment () | 
| Destructor, frees memory. | |
| virtual void | clearData () | 
| Clears all data. | |
| OFCondition | write (DcmItem &item) | 
| Write segment to given item which is usually contained within within the Segment Sequence. | |
| OFCondition | read (DcmItem &item, const OFBool clearOldData=OFTrue) | 
| Read segment from given item. | |
| virtual Uint16 | getSegmentNumber () | 
| Get Segment Number. | |
| virtual OFCondition | getSegmentLabel (OFString &value, const signed long pos=0) | 
| Get Segment Label. | |
| virtual OFCondition | getSegmentDescription (OFString &value, const signed long pos=0) | 
| Get Segment Description. | |
| virtual DcmSegTypes::E_SegmentAlgoType | getSegmentAlgorithmType () | 
| Get the Segment Algorithm Type. | |
| virtual OFCondition | getSegmentAlgorithmName (OFString &value, const signed long pos=0) | 
| Get the Segment Algorithm Name. | |
| virtual GeneralAnatomyMacro & | getGeneralAnatomyCode () | 
| Get General Anatomy Code. | |
| virtual CodeSequenceMacro & | getSegmentedPropertyCategoryCode () | 
| Get Segmented Property Category Code. | |
| virtual CodeSequenceMacro & | getSegmentedPropertyTypeCode () | 
| Get Segmented Property Type Code. | |
| virtual OFVector< CodeSequenceMacro * > & | getSegmentedPropertyTypeModifierCode () | 
| Get Segmented Property Type Modifier Code. | |
| virtual AlgorithmIdentificationMacro & | getSegmentationAlgorithmIdentification () | 
| Get Segmentation Algorithm Identification. | |
| virtual OFCondition | getRecommendedDisplayGrayscaleValue (Uint16 &value, const unsigned long pos=0) | 
| Get Recommended Display Grayscale Value. | |
| virtual OFCondition | getRecommendedDisplayCIELabValue (Uint16 &L, Uint16 &a, Uint16 &b) | 
| Returns Recommended Display CIELab Value. | |
| virtual OFCondition | getTrackingID (OFString &value, const signed long pos=0) | 
| Get Tracking ID. | |
| virtual OFCondition | getTrackingUID (OFString &value, const signed long pos=0) | 
| Get Tracking UID. | |
| virtual OFCondition | setSegmentLabel (const OFString &value, const OFBool checkValue=OFTrue) | 
| Set Segment Label. | |
| virtual OFCondition | setSegmentDescription (const OFString &value, const OFBool checkValue=OFTrue) | 
| Set Segment Label. | |
| virtual OFCondition | setSegmentAlgorithm (const DcmSegTypes::E_SegmentAlgoType algoType, const OFString &algoName, const OFBool checkValue=OFTrue) | 
| Set Segment Algorithm. | |
| virtual OFCondition | setSegmentationAlgorithmIdentification (const AlgorithmIdentificationMacro &value, const OFBool checkValue=OFTrue) | 
| Set Segmentation Algorithm Identification. | |
| virtual OFCondition | setRecommendedDisplayGrayscaleValue (const Uint16 value, const OFBool checkValue=OFTrue) | 
| Set Recommended Display Grayscale Value. | |
| virtual OFCondition | setRecommendedDisplayCIELabValue (const Uint16 L, const Uint16 a, const Uint16 b, const OFBool checkValue=OFTrue) | 
| Set Recommended Display CIELab Value. | |
| virtual OFCondition | setTrackingID (const OFString &value, const OFBool checkValue=OFTrue) | 
| Set Tracking ID. | |
| virtual OFCondition | setTrackingUID (const OFString &value, const OFBool checkValue=OFTrue) | 
| Set Tracking UID. | |
| Static Public Member Functions | |
| static OFCondition | create (DcmSegment *&segment, const OFString &segmentLabel, const CodeSequenceMacro &segmentedPropertyCategory, const CodeSequenceMacro &segmentedPropertyType, const DcmSegTypes::E_SegmentAlgoType algoType, const OFString &algoName="") | 
| Factory method to create a Segment that expects the minimal parameters required. | |
| Protected Member Functions | |
| DcmSegment () | |
| Protected default constructor. | |
| virtual void | initIODRules () | 
| Initialize IOD rules for this component. | |
| void | referenceSegmentationDoc (DcmSegmentation *doc) | 
| Set reference to the Segmentation object that this segment belongs to. | |
| Private Member Functions | |
| DcmSegment (const DcmSegment &) | |
| Private undefined copy constructor. | |
| DcmSegment & | operator= (const DcmSegment &) | 
| Private undefined assignment operator. | |
| Private Attributes | |
| DcmSegmentation * | m_SegmentationDoc | 
| The segmentation document where this segment is located in. | |
| SegmentDescriptionMacro | m_SegmentDescription | 
| Segment Description Macro. | |
| DcmLongString | m_SegmentAlgorithmName | 
| Segment Algorithm Name: (LO, 1, 1C) | |
| AlgorithmIdentificationMacro | m_SegmentationAlgorithmIdentification | 
| Segmentation Algorithm Identification (SQ, 1, 3). | |
| DcmUnsignedShort | m_RecommendedDisplayGrayscaleValue | 
| Recommended Display Grayscale Value (US, 1, 3) | |
| DcmUnsignedShort | m_RecommendedDisplayCIELabValue | 
| Recommended Display CIELab Value (US, 3, 3) | |
| DcmUnlimitedText | m_TrackingID | 
| Tracking ID (UT, 1, 1C) | |
| DcmUniqueIdentifier | m_TrackingUID | 
| Tracking UID (UI, 1, 1C) | |
| IODRules | m_Rules | 
| Rules for data elements within this IOD. | |
| Friends | |
| class | DcmIODUtil | 
| The utility class must access the protected default constructor. | |
Class representing a segment from the Segment Identification Sequence, as used within the Segmentation Image Module.
It includes the Segment Description Macro.
| 
 | static | 
Factory method to create a Segment that expects the minimal parameters required.
| segment | Pointer to the resulting segment if creation was successful; memory is allocated by the function | 
| segmentLabel | Free text label for the segment | 
| segmentedPropertyCategory | The segmented property category. Baseline CID 7150 "Segmentation Property Categories" should be used. | 
| segmentedPropertyType | The segmented property type. Baseline CID 7151 "Segmentation Property Types" | 
| algoType | The algorithm type used for segmenting this segment | 
| algoName | Algorithm name (required if algoType is not MANUAL) | 
References DcmSegment().
| 
 | virtual | 
Get General Anatomy Code.
| 
 | virtual | 
Returns Recommended Display CIELab Value.
| L | The L component | 
| a | The a* component | 
| b | The b* component | 
| 
 | virtual | 
Get Recommended Display Grayscale Value.
| value | Reference to variable in which the value should be stored | 
| pos | Index of the value to get (0..vm-1) | 
| 
 | virtual | 
Get the Segment Algorithm Name.
| value | Reference to variable in which the value should be stored | 
| pos | Index of the value to get (0..vm-1), -1 for all components | 
| 
 | virtual | 
Get the Segment Algorithm Type.
| 
 | virtual | 
Get Segmentation Algorithm Identification.
| 
 | virtual | 
Get Segment Description.
| value | Reference to variable in which the value should be stored | 
| pos | Index of the value to get (0..vm-1), -1 for all components | 
| 
 | virtual | 
| 
 | virtual | 
| 
 | virtual | 
| 
 | virtual | 
Get Segment Label.
| value | Reference to variable in which the value should be stored | 
| pos | Index of the value to get (0..vm-1), -1 for all components | 
| 
 | virtual | 
Get Segment Number.
| 
 | virtual | 
Get Tracking ID.
| value | Reference to variable in which the value should be stored | 
| pos | Index of the value to get (0..vm-1), -1 for all components | 
| 
 | virtual | 
Get Tracking UID.
| value | Reference to variable in which the value should be stored | 
| pos | Index of the value to get (0..vm-1), -1 for all components | 
| 
 | private | 
| OFCondition DcmSegment::read | ( | DcmItem & | item, | 
| const OFBool | clearOldData = OFTrue ) | 
Read segment from given item.
| item | The item to read from (must be item as found in the Segment Identification Sequence) | 
| clearOldData | If true, old data is deleted first | 
| 
 | protected | 
Set reference to the Segmentation object that this segment belongs to.
This is used to find the Segment Number this Segment has within the Segmentation.
| doc | Pointer to the Segmentation object | 
| 
 | virtual | 
Set Recommended Display CIELab Value.
| L | L component | 
| a | a component | 
| b | b component | 
| checkValue | Check 'value' for validity if enabled | 
| 
 | virtual | 
Set Recommended Display Grayscale Value.
| value | Value to be set (single value only) or "" for no value | 
| checkValue | Check 'value' for validity if enabled | 
| 
 | virtual | 
Set Segment Algorithm.
| algoType | Algorithm type used to find segment | 
| algoName | Name of the algorithm used (required if algorithm type is not MANUAL | 
| checkValue | If OFTrue, input is checked for validity | 
| 
 | virtual | 
Set Segmentation Algorithm Identification.
| value | The algorithm identification | 
| checkValue | If OFTrue, value undergoes some validity checks | 
| 
 | virtual | 
Set Segment Label.
| value | Value to be set (single value only) or "" for no value | 
| checkValue | Check 'value' for conformance with VR (ST) and VM (1) if enabled | 
| 
 | virtual | 
Set Segment Label.
| value | Value to be set (single value only) or "" for no value | 
| checkValue | Check 'value' for conformance with VR (LO) and VM (1) if enabled | 
| 
 | virtual | 
Set Tracking ID.
| value | Value to be set (single value only) or "" for no value | 
| checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). | 
| 
 | virtual | 
Set Tracking UID.
| value | Value to be set (single value only) or "" for no value | 
| checkValue | Check 'value' for conformance with VR (UI) and VM (1) if enabled | 
| OFCondition DcmSegment::write | ( | DcmItem & | item | ) | 
Write segment to given item which is usually contained within within the Segment Sequence.
| item | The item to write to | 
| 
 | private | 
Segmentation Algorithm Identification (SQ, 1, 3).
This attribute has earlier been named m_SegmentationSurfaceGenerationAlgorithmIdentification representing the related sequence. This has been changed in favor of the Segmentation Algorithm Identification Sequence due to DICOM CP-1597.