LImageViewerCell::CalibrateCell

Summary

Calibrates the cell or sub-cell without having to use the annotation ruler, to calibrate using annotation ruler use the LImageViewerCell::CalibrateRuler function.

Syntax

L_INT LImageViewerCell::CalibrateCell(nSubCellIndex, dLength, uUnit, dTargetLength, uTargetUnit, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. This sub-cell will be calibrated. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

L_DOUBLE dLength

Value that represents the old length of the virtual ruler.

L_UINT uUnit

Value that specifies the unit of measure for the virtual ruler length. Possible values are:

L_DOUBLE dTargetLength

Value that represents the length to be assigned to the virtual ruler. The unit of measure for the length is specified by the value of the uTargetUnit parameter.

L_UINT uTargetUnit

Value that specifies the unit of measure for the virtual ruler length. Possible values are:

L_UINT uFlags

Flags that indicate the direction to which the calibration is applied. Possible values are:

The following flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

Returns

Comments

This function does not require that the annotation ruler to be present in order to calibrate the cell.

The user is expected to send a length along with the unit of measure, and then send a new length with the new unit of measure for the cell being calibrated.

To obtain the unit of measure of the viewer, call the LImageViewerCell::GetRulerUnit function.

To change the unit of measure unit of the viewer, call the LImageViewerCell::SetRulerUnit function.

Required DLLs and Libraries

• LTIVW
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• LImageViewer::Create
• LImageViewer::Destroy
• LImageViewerCell::CalibrateRuler
• LImageViewerCell::UpdateCellView
• LImageViewerCell::EndUpdate
• LImageViewerCell::SetRulerUnit
• LImageViewerCell::GetRulerUnit
• LImageViewerCell::SetCellTag
• LImageViewerCell::SetSubCellTag

Topics

• Using the Image Viewer
• Window Control/Image Viewer Functions: Using the Image Viewer

Example

This example calibrates the first frame of the first cell.

L_INT LImageViewer_CalibrateCellExample(LImageViewerCell& ImageViewerCell) 
{ 
   L_INT nRet; 
 
   nRet = ImageViewerCell.CalibrateCell(0, 1, CONTAINER_RULERUNIT_CENTIMETERS, 2, CONTAINER_RULERUNIT_CENTIMETERS, 0); 
 
   return nRet; 
}