DicomObjects.NET.8.48 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 System.Integer _
    ) As System.String
    'Usage
     
    
    Dim instance As DicomLabel
    Dim Viewer As DicomViewer
    Dim Index As System.Integer
    Dim value As System.String
     
    value = instance.ROIDistanceUnits(Viewer, Index)
    public System.string ROIDistanceUnits( 
       DicomViewer Viewer,
       System.int Index
    )
    public function ROIDistanceUnits( 
        Viewer: DicomViewer;
        Index: System.Integer
    ): System.String; 
    public function ROIDistanceUnits( 
       Viewer : DicomViewer,
       Index : System.int
    ) : System.String;
    public: System.string* ROIDistanceUnits( 
       DicomViewer* Viewer,
       System.int Index
    ) 
    public:
    System.String^ ROIDistanceUnits( 
       DicomViewer^ Viewer,
       System.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: .NET CLR 4.8 or higher

    See Also