DicomObjects.NET10 Documentation
DicomObjects Namespace / DicomLabel Class / ROIDistanceUnits Method / ROIDistanceUnits(DicomViewer,Int32) Method
The Viewer which holds the Image where measurement units is taken from
The Index of the Image in the Viewer's Images Collection



In This Topic
    ROIDistanceUnits(DicomViewer,Int32) Method
    In This Topic
    Distance units for the values returned by ROILength and ROIArea of a None-Image-Tied label
    Syntax
    'Declaration
     
    
    Public Overloads Function ROIDistanceUnits( _
       ByVal Viewer As DicomViewer, _
       ByVal Index As Integer _
    ) As String
    'Usage
     
    
    Dim instance As DicomLabel
    Dim Viewer As DicomViewer
    Dim Index As Integer
    Dim value As String
     
    value = instance.ROIDistanceUnits(Viewer, Index)
    public string ROIDistanceUnits( 
       DicomViewer Viewer,
       int Index
    )
    public:
    String^ ROIDistanceUnits( 
       DicomViewer^ Viewer,
       int Index
    ) 

    Parameters

    Viewer
    The Viewer which holds the Image where measurement units is taken from
    Index
    The Index of the Image in the Viewer's Images Collection

    Return Value

    A String Value of the Distance Units
    Remarks

    The value returned depends on whether distance calibration is present in the image data. The possible values are:

    • "mm"
    • "mm at Imager"
    • "mm at Imaging Plane"
    • "Pixels"
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also