In This Topic ▼

calibrate Method

Summary

Sets a specific ruler's calibration scale.

Syntax

TypeScript

JavaScript

AnnPolyRulerObject.prototype.calibrate = function( 
   sourceLength, 
   sourceUnit, 
   destinationLength, 
   destinationUnit 
)

calibrate( 
   sourceLength: LeadLengthD, 
   sourceUnit: AnnUnit, 
   destinationLength: LeadLengthD, 
   destinationUnit: AnnUnit 
): void;

Parameters

sourceLength

Known source length value

sourceUnit

Unit of measure for the sourceLength

destinationLength

Calculated destination length

destinationUnit

Unit of measure for the destinationLength

Remarks

Calibrating a ruler means assigning a specific length to it. This method will use the parameters to calculate a new value for the CalibrationScale of this ruler. This value is used afterwards only by this ruler object.

To globally calibrate all existing and new ruler objects created in this container, use AnnContainerMapper.Calibrate. For example, on a digital X-ray of a hand, you may draw an annotation ruler object along one of the fingers. You know that this distance is supposed to be exactly 6.5 cm. Using the new calibration functionality you can calibrate this ruler, all existing rulers, and all newly created rulers so that they would precisely measure this distance to be 6.5 cm. This is accomplished by first drawing a ruler on the container until it matches exactly the length of the finger - ignoring the values shown - then using Calibrate.

Requirements

Target Platforms

Reference

AnnPolyRulerObject Class

AnnPolyRulerObject Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 22.0.2023.1.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies