Description

Gets or sets the spatial calibration status flags.

Property type

A mccfCalibFlags enumeration.  

Syntax

object.Flags [= value]

The Flags Property syntax has these parts:

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

Settings

The settings for value are:

ConstantValueDescription
 mccfIsReference1

If set, the calibration is a reference calibration

 mccfIsSystem2

If set, the calibration is the system calibration

 mccfWasDerived256

If set, the calibration was derived from another calibration masks

 mccfUserFlags-65536

Flags for use by user

 mccfAddFlags-65281

All unmasked flags are ignored by AddEx and Flags property assignment

 mccfNoFlags0
 mccfAllFlags-1

Remarks

There are several types of spatial calibrations. Reference calibrations typically correspond to microscope objectives, and are persisted from one application session to the next. The system calibration is the currently selected Reference calibration. Derived calibrations are created by the calibration collection when the system calibration is applied to an image and there is some factor present that modifies the calibration by modifying the effective magnification. Two such factors are Capture Factor, where a single pixel of higher intensity is created by combining several neighboring pixels, and Magnification Modifiers (optics in the light path that change the total system magnification).

The Flags property returns a combination of the mccfCalibFlags flags.

It is not recommended to set the System Calibration by setting the System Calibration flag - use the SystemCalibration property of the calibrations collection instead.