DicomObjects.NET.V8
DicomObjects Namespace / DicomLabel Class / GetTickSpacing(Boolean,DicomImage,DicomViewer) Method
If MajorTicks is true, then the value is the spacing between large marks, and if false, it will be the small mark spacing. The large mark spacing is always exactly 2, 5 or 10 time the small mark spacing.
The image from which the pixel data is taken for the calculations
The Viewer in which the image is displayed



GetTickSpacing(Boolean,DicomImage,DicomViewer) Method
Returns the size of the spacing used in a DicomLabel of type Ruler
Syntax
public float GetTickSpacing( 
   bool MajorTicks,
   DicomImage Image,
   DicomViewer Viewer
)
public:
float GetTickSpacing( 
   bool MajorTicks,
   DicomImage^ Image,
   DicomViewer^ Viewer
) 
'Declaration
 
Public Function GetTickSpacing( _
   ByVal MajorTicks As Boolean, _
   ByVal Image As DicomImage, _
   ByVal Viewer As DicomViewer _
) As Single
 
'Usage
 
Dim instance As DicomLabel
Dim MajorTicks As Boolean
Dim Image As DicomImage
Dim Viewer As DicomViewer
Dim value As Single
 
value = instance.GetTickSpacing(MajorTicks, Image, Viewer)

Parameters

MajorTicks
If MajorTicks is true, then the value is the spacing between large marks, and if false, it will be the small mark spacing. The large mark spacing is always exactly 2, 5 or 10 time the small mark spacing.
Image
The image from which the pixel data is taken for the calculations
Viewer
The Viewer in which the image is displayed

Return Value

A float number as the spacing between tick marks on the ruler displayed
Remarks

The value returned is the spacing in nominal mm between tick marks on the ruler displayed. Note that depending on the type of image, these may not be true patient measurements, and the ROIDistanceUnits property should be checked to see whether these are “mm at imager” etc.

If MajorTicks is true, then the value is the spacing between large marks, and if false, it will be the small mark spacing. The large mark spacing is always exactly 2, 5 or 10 time the small mark spacing.

The values returned by this property are highly labile, and will change if the zoom, StretchMode or any other display parameters of the associated image are altered, so if used for display purposes, it may be advisable to update in the “DrawStart” event.

Requirements

Target Platforms: .NET CLR 3.5 or higher

See Also