Description
Get a filtered copy of the calibration collection.
-
Return Type
-
A McSpatialCalibs object.
A filtered list of calibrations (which may be empty).
-
Syntax
-
object.GetFilteredList (IncludeFlags, ExcludeFlags)
The GetFilteredList Method syntax has these parts: |
| object | An expression evaluating to an object of type McSpatialCalibs. | | IncludeFlags | Required. A mccfCalibFlags enumeration, as described in settings. The flags that should be present on all matching calibrations.
| | ExcludeFlags | Required. A mccfCalibFlags enumeration, as described in settings. The flags that should be absent on all matching calibrations.
|
Settings The settings for IncludeFlags are:
|
 | mccfIsReference | 1 |
If set, the calibration is a reference calibration
|
| mccfIsSystem | 2 |
If set, the calibration is the system calibration
|
| mccfWasDerived | 256 |
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
|
| mccfNoFlags | 0 | |
| mccfAllFlags | -1 | |
The settings for ExcludeFlags are:
|
| mccfIsReference | 1 |
If set, the calibration is a reference calibration
|
| mccfIsSystem | 2 |
If set, the calibration is the system calibration
|
| mccfWasDerived | 256 |
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
|
| mccfNoFlags | 0 | |
| 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. 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. This function will return a collection filtered on your specified required or disallowed calibration flags (see Examples).
| Note: |
The main collection will automatically be updated when a calibration is made a reference or non-reference calibration (by setting the Flags property of the calibration) but any other lists outstanding that have been returned by this function will not be updated. |
Important note: The collection that is returned has all the properties and methods of the main SpatialCalibs collection. However, several of these properties are not useful on any but the main collection. These properties (SystemCalib and MagModifier) are automatically passed on to the main collection for processing:
|
GetFilteredList Method (McSpatialCalibs)
