DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Public Attributes | List of all members
IODSegmentationReference Class Reference

Class representing a reference to a Segmentation. More...

+ Inheritance diagram for IODSegmentationReference:

Public Member Functions

 IODSegmentationReference (const MAX_LEVEL level)
 Constructor allowing to set reference level. More...
 
 IODSegmentationReference ()
 Default constructor, uses level STUDY.
 
virtual IODReferenceclone () const
 Get (deep) clone copy of this reference. More...
 
virtual TYPE getType () const
 Get type (always returns SEGMENT type) More...
 
virtual OFBool readFromFile (const OFString &filename, const OFVector< Uint16 > segmentNumbers)
 Initialize reference from given file. More...
 
virtual ~IODSegmentationReference ()
 Destructor.
 
virtual void clear ()
 Clear reference data.
 
- Public Member Functions inherited from IODReference
 IODReference ()
 Constructor, creates empty reference, default level is "STUDY".
 
 IODReference (const MAX_LEVEL level)
 Constructor, creates empty reference with specified level. More...
 
virtual ~IODReference ()
 Destructor.
 
virtual OFCondition check () const
 Check whether this reference is valid, i.e. More...
 
virtual OFString toString () const
 Returns reference as a one line string. More...
 
virtual OFBool readFromFile (const OFString &filename)
 Initializes this reference from given file, i.e. More...
 
virtual OFBool readFromItem (DcmItem &item)
 Initializes this reference from given item, i.e. More...
 

Public Attributes

OFVector< Uint16 > m_ReferencedSegmentNumber
 Referenced Segment Numbers.
 
- Public Attributes inherited from IODReference
OFString m_PatientID
 Patient ID.
 
OFString m_StudyInstanceUID
 Study Instance UID.
 
OFString m_SeriesInstanceUID
 Series Instance UID.
 
OFString m_SOPClassUID
 SOP Class UID.
 
OFString m_SOPInstanceUID
 SOP Instance UID.
 
MAX_LEVEL m_Level
 Maximum level this reference refers to. More...
 

Additional Inherited Members

- Public Types inherited from IODReference
enum  MAX_LEVEL { LEVEL_INSTANCE, LEVEL_SERIES, LEVEL_STUDY, LEVEL_PATIENT }
 The maximum DICOM entity level that this reference refers to. More...
 
enum  TYPE { GENERIC, IMAGE, SEGMENT }
 Type of reference. More...
 

Detailed Description

Class representing a reference to a Segmentation.

Compared to IODReference, this class also allows to provide references to specific segments by referencing the value of their Segment Number attribute.

Constructor & Destructor Documentation

IODSegmentationReference::IODSegmentationReference ( const MAX_LEVEL  level)

Constructor allowing to set reference level.

Parameters
levelThe maximum level this reference should deal with

Member Function Documentation

virtual IODReference* IODSegmentationReference::clone ( ) const
virtual

Get (deep) clone copy of this reference.

Returns
Returns deep copy of this reference, or NULL in case of error

Reimplemented from IODReference.

virtual TYPE IODSegmentationReference::getType ( ) const
inlinevirtual

Get type (always returns SEGMENT type)

Returns
Returns SEGMENT type

Reimplemented from IODReference.

References IODReference::SEGMENT.

virtual OFBool IODSegmentationReference::readFromFile ( const OFString filename,
const OFVector< Uint16 >  segmentNumbers 
)
virtual

Initialize reference from given file.

Parameters
filenameThe file to read from
segmentNumbersThe segment numbers to reference. It is not checked (so far) whether the referenced image file actually contains such Segment Numbers. First segment is 1.
Returns
OFTrue if initialization was successful, OFFalse otherwise

The documentation for this class was generated from the following file:


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8