Calibrates an LAnnRuler annotation object.
L_INT LAnnotation::CalibrateRuler(dCalibrateLength, uCalibrateUnit, dDpiRatioXtoY)
Length to be assigned to the ruler.
Unit of measurement. Possible values are:
The ratio of the horizontal resolution (dots per inch or DPI) to the vertical resolution. It must be in the range of 1/100 to 100 inclusive. For most images, the ratio is 1.
|SUCCESS||The function was successful.|
|< 1||An error occurred. Refer to Return Codes.|
Call this function to calibrate an LAnnRuler object. This function is used to assign any existing LAnnRuler object to a specific length.
Note that this function only works on LAnnRuler objects, but can be used to indirectly calibrate other objects.
This function must be enabled by passing OPTIONS_NEW_ CALIBRATE_RULER to the LAnnotation::SetOptions function before calling LAnnotation::CalibrateRuler. For more information, refer to Key Annotation Features.
The dDpiRatioXtoY is the ratio of the horizontal resolution of the image (dots per inch or DPI) to the vertical resolution of the image. For most images, the horizontal resolution and the vertical resolution are the same, so this value will be 1.0. However for some fax images, the horizontal resolution is twice the vertical resolution (this would correspond to a dDpiRatioXtoY of 2.0). The dDpiRatioXtoY must be between (1/100) and 100 inclusive.
While this function only works on LAnnRuler objects, it can be used indirectly to calibrate any or all ruler objects, including LAnnPolyRuler, LAnnProtractor, and LAnnCrossProduct. To do this, calibrate an LAnnRuler object, get the resulting resolutions, and assign this resolution to all objects in the container. The example illustrates how to do this.
If you pass a negative value to the dDpiRatioXtoY parameter, the ERROR_INV_PARAMETER error will be returned.
Note to the documentation team: Using Rulers in Annotation Objects is a fairly new programming topic (the edits adding this topic were completed in May of this year.)
L_INT LAnnotation_CalibrateRulerExample(LAnnContainer anncont, LAnnAutomation annauto, LAnnRuler annruler)
// This example calibrates a ruler object
// so that it measures 10 inches with a DPI ratio of 1:1
// Note that ruler object must be of type LAnnRuler
L_INT nRet = SUCCESS;
L_UINT uObjectType = 0;
L_DOUBLE dDpiX = 0;
L_DOUBLE dDpiY = 0;
uObjectType = annruler.GetType();
if (uObjectType < ANNOBJECT_CONTAINER)
if (uObjectType!= ANNOBJECT_RULER)
MessageBox(NULL, TEXT("Error: CalibrateRuler only works on ANNOBJECT_RULER objects"), TEXT("Error"), MB_OK);
return FAILURE ;
nRet = annruler.CalibrateRuler(10, ANNUNIT_INCHES, 1.0);
if (nRet != SUCCESS)
MessageBox(NULL, TEXT("Ruler has been calibrated to have a length of 10 inches. Now all existing and newly created ruler objects will be matched to this calibration."), TEXT("Error"), MB_OK);
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries