DicomObjects.NET.V8
DicomObjects Namespace / DicomImage Class / ReferenceLine Method

The main Image, who's position is to be shown.

Whether the intersection should be used - see remarks for details




In This Topic
    ReferenceLine Method
    In This Topic
    This method returns a new DicomLabel object which represents the position of one DicomImage relative to another.
    Syntax
    'Declaration
     
    Public Function ReferenceLine( _
       ByVal Image As DicomImage, _
       ByVal Intersection As Boolean _
    ) As DicomLabel
    'Usage
     
    Dim instance As DicomImage
    Dim Image As DicomImage
    Dim Intersection As Boolean
    Dim value As DicomLabel
     
    value = instance.ReferenceLine(Image, Intersection)
    public DicomLabel ReferenceLine( 
       DicomImage Image,
       bool Intersection
    )
    public:
    DicomLabel^ ReferenceLine( 
       DicomImage^ Image,
       bool Intersection
    ) 

    Parameters

    Image

    The main Image, who's position is to be shown.

    Intersection

    Whether the intersection should be used - see remarks for details

    Return Value

    Remarks

    This method is used which you wish to show the relative positions of one image on another. It is typically used in CT and MRI to indicate the position of main imaging sections relative to a previously obtained localizer or �scout� image.

    The method is called on the �localizer� image, and the first parameter is the main section who�s position is to be shown. The result is a new DicomLabel object which is designed to be added to the localizer image�s Labels collection. e.Graphics. if �localizer� and �main_image� are defined as DicomObjects, then the following code will add an appropriate reference line to the localizer image:

    NewLabel = localizer.ReferenceLine(main_image, false)
    Localizer.Labels.Add(NewLabel)

    If the images are orthogonal, then the �Intersection� parameter is not used, and the DicomLabel returned will always be of type LabelType.Line, but if they are not, then it controls how this is handled:

    • If true, then the DicomLabel will still be of type LabelType.Line, representing the intersection of the two image planes.
    • If false, then the DicomLabel returned will be of type LabelType.Polygon with 4 vertices, each representing the projection of a corner of the main image onto the plane of the localizer.
    Requirements

    Target Platforms: .NET CLR 4.0 or higher

    See Also