Unit Property
      
 

Description

Get the calibration unit type.

Property type

A mcSpatialUnit enumeration.  

Syntax

object.Unit [= value]

The Unit Property syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McSpatialCalib.
valueA mcSpatialUnit enumeration, as described in settings.

Settings

The settings for value are:

ConstantValueDescription
 mcsuPixel0
 mcsuOther1
 mcsuNanometer2
 mcsuMicrometer3
 mcsuMillimeter4
 mcsuCentimeter5
 mcsuMeter6
 mcsuKilometer7
 mcsuInch8
 mcsuFoot9
 mcsuYard10
 mcsuMile11

Remarks

 By default, the spatial calibration are expressed in pixel units.
 There are a number of built-in spatial unit types that can
 be used to indicate the calibration units. If the calibration units
 are set by this property to any unit other than mcsuPixel and mcsuOther,
 the calibration will represent an absolute physical size, and will
 be convertable from one physical unit to another. Unit uses mcSpatialUnit
 which is a built-in unit type:

  • mcsuPixel

  • mcsuOther

  • mcsuNanometer

  • mcsuMicrometer

  • mcsuMillimeter

  • mcsuCentimeter

  • mcsuMeter

  • mcsuKilometer

  • mcsuInch

  • mcsuFoot

  • mcsuYard

  • mcsuMile