Description
Adds a derived calibration to the calibration collection.
-
Return Type
-
A McSpatialCalib object.
The derived calibration.
-
Syntax
-
object.AddDerived (pCalib, XBinning, YBinning, [bIgnoreMagModifier])
The AddDerived Method syntax has these parts: |
| object | An expression evaluating to an object of type McSpatialCalibs. | | pCalib | Required. A McSpatialCalib object. [in]
| | XBinning | Required. A Double value. | | YBinning | Required. A Double value. | | bIgnoreMagModifier | Optional. A Boolean value. [out, retval]
|
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. 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 binning, 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).
This function creates a derived calibration that compensates for the horizontal and vertical factors specified (use a value of 1 to specify no change) and the current MagModifier (if you do not specify to ignore the MagModifier). If the current MagModifier is ignored or 1.0 and the X and Y factors are specified as 1.0, the original calibration will be returned.
| Note: |
This function can also be used to create calibrations that compensate for linear changes of the image size, e.g. due to resizing the image. Specify IgnoreMagModifer TRUE and pass in the ratio of the new size to the old size in the X and Y factors. |
|
AddDerived Method
