This topic contains the following sections.
- Cog2DSymbolTool Record Keys
- Cog2DSymbolVerifyTool Record Keys
- CogAffineTransformTool Record Keys
- CogBarcodeTool Record Keys
- CogBlobTool Record Keys
- CogCNLSearchTool Record Keys
- CogCalibCheckerboardTool Record Keys
- CogCalibNPointToNPointTool Record Keys
- CogCaliperTool Record Keys
- CogCopyRegionTool Record Keys
- CogFindCircleTool Record Keys
- CogFindLineTool Record Keys
- CogFitCircleTool Record Keys
- CogFitEllipseTool Record Keys
- CogFitLineTool Record Keys
- CogFixtureNPointToNPointTool Record Keys
- CogFixtureTool Record Keys
- CogHistogramTool Record Keys
- CogIPOneImageTool Record Keys
- CogIPTwoImageAddTool Record Keys
- CogIPTwoImageMinMaxTool Record Keys
- CogIPTwoImageSubtractTool Record Keys
- CogImageAverageTool Record Keys
- CogImageSharpnessTool Record Keys
- CogOCVTool Record Keys
- CogPDF417Tool Record Keys
- CogPMAlignTool Record Keys
- CogPatInspectTool Record Keys
- CogPolarUnwrapTool Record Keys
- CogSobelEdgeTool Record Keys
Record keys provide access to the data stored in VisionPro tool records.
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | Cog2DSymbolCurrentRecordConstants |
| InputImage | Image | InputImage |
| SearchRegion | Graphic | SearchRegion An interactive shape that depicts the SearchRegion of the image. |
| TrainImage | Image | TrainImage |
| TrainRegion | Graphic | TrainRegion An interactive shape that depicts the TrainRegion of the training image. |
| NominalGrid | Graphic | NominalGrid An interactive CogRectangleAffine that depicts the NominalGrid of the training image. |
| TrainResultGrid | Graphic | TrainResultGrid A noninteractive CogRectangleAffine that depicts the ResultGrid of the training image. |
| TrainedLocatedCenter | Graphic | TrainedLocatedCenter A noninteractive CogPointMarker that depicts the center of the located symbol in the training image. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | Cog2DSymbolLastRunRecordConstants and Cog2DSymbolLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| SearchRegion | Graphic | SearchRegion A shape that depicts the SearchRegion of the image. |
| ResultGrid | Graphic | ResultGrid A noninteractive CogRectangleAffine that depicts the ResultGrid of the input image. |
| LocatedCenter | Graphic | LocatedCenter A CogPointMarker that depicts the center of the located symbol in the input image. |
| TrainImage | Image | TrainImageDeepCopy A copy of the TrainImage. |
| TrainRegion | Graphic | TrainRegion A shape that depicts the TrainRegion of the training image. |
| TrainResultGrid | Graphic | TrainResultGrid A noninteractive CogRectangleAffine that depicts the ResultGrid of the training image. |
| TrainedLocatedCenter | Graphic | TrainedLocatedCenter A CogPointMarker that depicts the center of the located symbol in the training image. |
| TransformedTrainRegionImage | Image | TransformedTrainRegionImage Training image after an affine transform if TrainRegionMode is CogRegionModeConstants. |
| TrainResultGrid | Graphic | TransformedTrainResultGrid A noninteractive CogRectangleAffine that depicts the ResultGrid of the transformed training image. |
| TrainedLocatedCenter | Graphic | TransformedTrainedLocatedCenter A CogPointMarker that depicts the center of the located symbol in the transformed training image. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
| Record Key | ContentType | Cog2DSymbolVerifyCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region An interactive shape that depicts the Region of the image. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
| Record Key | ContentType | Cog2DSymbolVerifyLastRunRecordConstants and Cog2DSymbolVerifyLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | SearchRegion A shape that depicts the Region of the image. |
| IAQGDotLocationMap | Graphic | IAQGDotLocationMap Generate a CreateResultMaskGraphic of the per-dot location grades. |
| IAQGDotSizeMap | Graphic | IAQGDotSizeMap Generate a CreateResultMaskGraphic of the per-dot dot size grades. |
| IAQGDotShapeMap | Graphic | IAQGDotShapeMap Generate a CreateResultMaskGraphic of the per-dot shape grades. |
| IAQGDotCombinedMap | Graphic | IAQGDotCombinedMap Generate a CreateResultMaskGraphic of the per-dot combined grades. |
| IAQGDotLocationContour | Graphic | IAQGDotLocationContour Generate a CreateResultContourGraphic of the per-dot location grades. |
| IAQGDotSizeContour | Graphic | IAQGDotSizeContour Generate a CreateResultContourGraphic of the per-dot dot size grades. |
| IAQGDotShapeContour | Graphic | IAQGDotShapeContour Generate a CreateResultContourGraphic of the per-dot shape grades. |
| IAQGDotCombinedContour | Graphic | IAQGDotCombinedContour Generate a CreateResultContourGraphic of the per-dot combined grades. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogAffineTransformCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogAffineTransformLastRunRecordConstants and CogAffineTransformLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| OutputImage | Image | OutputImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
| Record Key | ContentType | CogBarcodeCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region An interactive shape that depicts the Region of the image. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
| Record Key | ContentType | CogBarcodeLastRunRecordConstants and CogBarcodeLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | CogBarcodeLastRunRecordDiagRegion A shape that depicts the Region of the image. |
| CompositeResultGraphics | Graphics Collection | ResultsBounds ResultsCentersInclude CogPolygon that represent the bounds of each found symbol and the CogPointMarker of each symbol found. |
| TransformedRegionPixels | Image | TransformedRegionPixels The transformed image. |
| CompositeResultGraphics | Graphics Collection | ResultsBounds ResultsCentersInclude CogPolygon that represent the bounds of each found symbol and the CogPointMarker of each symbol found. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Current Record are references to the actual masks and regions used in the tool.
| Record Key | ContentType | CogBlobCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
| InputImageMask | Graphic | InputImageMask |
| SubtractionImage | Image | SubtractionImage Available only if the Mode is CogBlobSegmentationModeConstants. |
| Histogram | Image | Histogram Histogram records are delay constructed and are not mutable. If the state of the tool would require the histogram to change, the affected records are destroyed and new content is created. |
| AddHistogramSpaceCmd | Display Method | Display command record that adds a coordinate space. |
| ChangeHistogramSpaceNameCmd | Display Method | Display command record that sets the coordinate space name. |
| HistogramGraphics | Graphics Collection | CogGraphicCollection that contains the histogram graphics.. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
The CompositeResultGraphic and CompositeResultGraphic2 subrecords are delay constructed and are created by CreateResultGraphics. The GraphicOptions parameter is specified by ORing the constants in CogBlobLastRunRecordConstants.
The CompositeResultGraphics2 subrecord is present if the selected space of the InputImage is # or if the InputImage record is not enabled. Otherwise, the same CompositeResultGraphics record used for the InputImage record is used for the Blob and Segmented images as well. If the selected space of the InputImage was #, the selected space name of the graphics in CompositeResultGraphics2 is "_InputImage#".
| Record Key | ContentType | CogBlobLastRunRecordConstants and CogBlobLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Image | Region |
| CompositeResultGraphics | Graphics Collection | ResultsBoundingBoxPixelAligned ResultsBoundingBoxPrincipalAxis ResultsBoundingBoxExtremaAngle ResultsBoundingBoxSelectedSpace ResultsMedianPixelAligned ResultsMedianPrincipalAxis ResultsMedianExtremaAngle ResultsMedianSelectedSpaceResultsBoundary ResultsCenterOfMass ResultsUnfiltered |
| InputImageMask | Graphic | InputImageMask |
| BlobImageAsGraphic | Graphic | BlobImageAsGraphic ResultsUnfilteredA CogMaskGraphic with an image created by CreateBlobImage. The Filtered parameter is controlled by the ResultsUnfiltered bit. For grey scale ConnectivityMode , holes are drawn in magenta and blobs are drawn in cyan. For labeled connectivity, labeled blobs are drawn in either magenta, cyan, orange, purple, yellow, or blue. If there are more than six labels, a color may be used for more than one label. |
| BlobImage | Image | BlobImage |
| CompositeResultGraphics or CompositeResultGraphics2 | Graphics Collection | ResultsBoundingBoxPixelAligned ResultsBoundingBoxPrincipalAxis ResultsBoundingBoxExtremaAngle ResultsBoundingBoxSelectedSpace ResultsMedianPixelAligned ResultsMedianPrincipalAxis ResultsMedianExtremaAngle ResultsMedianSelectedSpaceResultsBoundary ResultsCenterOfMass ResultsUnfiltered |
| BlobImageUnfiltered | Image | BlobImageUnfiltered |
| CompositeResultGraphics or CompositeResultGraphics2 | Graphics Collection | ResultsBoundingBoxPixelAligned ResultsBoundingBoxPrincipalAxis ResultsBoundingBoxExtremaAngle ResultsBoundingBoxSelectedSpace ResultsMedianPixelAligned ResultsMedianPrincipalAxis ResultsMedianExtremaAngle ResultsMedianSelectedSpaceResultsBoundary ResultsCenterOfMass ResultsUnfiltered |
| SegmentedImage | Image | SegmentedImage |
| CompositeResultGraphics or CompositeResultGraphics2 | Graphics Collection | ResultsBoundingBoxPixelAligned ResultsBoundingBoxPrincipalAxis ResultsBoundingBoxExtremaAngle ResultsBoundingBoxSelectedSpace ResultsMedianPixelAligned ResultsMedianPrincipalAxis ResultsMedianExtremaAngle ResultsMedianSelectedSpaceResultsBoundary ResultsCenterOfMass ResultsUnfiltered |
| SegmentedImageBeforeMasking | Image | SegmentedImageBeforeMasking |
| CompositeResultGraphics or CompositeResultGraphics2 | Graphics Collection | ResultsBoundingBoxPixelAligned ResultsBoundingBoxPrincipalAxis ResultsBoundingBoxExtremaAngle ResultsBoundingBoxSelectedSpace ResultsMedianPixelAligned ResultsMedianPrincipalAxis ResultsMedianExtremaAngle ResultsMedianSelectedSpaceResultsBoundary ResultsCenterOfMass ResultsUnfiltered |
| SegmentedImageBeforeMorphology | Image | SegmentedImageBeforeMorphology |
| CompositeResultGraphics or CompositeResultGraphics2 | Graphics Collection | ResultsBoundingBoxPixelAligned ResultsBoundingBoxPrincipalAxis ResultsBoundingBoxExtremaAngle ResultsBoundingBoxSelectedSpace ResultsMedianPixelAligned ResultsMedianPrincipalAxis ResultsMedianExtremaAngle ResultsMedianSelectedSpaceResultsBoundary ResultsCenterOfMass ResultsUnfiltered |
| SubtractionImage | Image | SubtractionImageByReference The record contains a reference to the actual SubtractionImage. |
| Histogram | Image | Histogram The graphics record contains a reference to the same histogram data as for the Current Record. |
| AddHistogramSpaceCmd | Display Method | Display command record that adds a coordinate space. |
| ChangeHistogramSpaceNameCmd | Display Method | Display command record that sets the coordinate space name. |
| HistogramGraphics | Graphics Collection | CogGraphicCollection that contains the histogram graphics.. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Current Record are references to the actual masks and regions used in the tool.
| Record Key | ContentType | CogCNLSearchCurrentRecordConstants |
| InputImage | Image | InputImage |
| SearchRegion | Graphic | SearchRegion A graphic that contains a reference to the current SearchRegion. This record is available only if SearchPointEnabled is False. |
| SearchPoint | Graphic | SearchPoint A CogPointMarker that indicates the current SearchPointX. This record is available only if SearchPointEnabled is True. |
| TrainImage | Image | TrainImage |
| TrainRegion | Graphic | TrainRegion Contains a reference to the actual TrainRegion. |
| PatternOrigin | Graphic | PatternOrigin An interactive CogPointMarker that contains a reference to the pattern's actual OriginX. |
| TrainImageMask | Graphic | TrainImageMask A CogMaskGraphic that contains a reference to the actual TrainImageMask. Available only when the pattern training Algorithms includes CogCNLSearchAlgorithmConstants. |
| TrainedEdges | Graphic | TrainedEdges A CogMaskGraphic that represents the TrainedEdgeImage. This record is available only when the pattern training Algorithms includes CogCNLSearchAlgorithmConstants. It is not available when the TrainRegionMode is CogRegionModeConstants. |
| TrainedPatternImage | Image | TrainedPatternImage This record is delay constructed by calling GetTrainedPatternImage. |
| TrainedPatternRegion | Graphic | TrainedPatternRegion Contains a noninteractive deep copy of the TrainRegion. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A noninteractive CogPointMarker that represents the pattern's OriginX. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the TrainedPatternImageMask. This graphic is obtained by calling GetTrainedPatternImageMask. Available only when the pattern training Algorithms includes CogCNLSearchAlgorithmConstants. |
| TrainedPatternEdges | Graphic | TrainedPatternEdges A CogMaskGraphic that represents the TrainedEdgeImage. This record is available only when the pattern training Algorithms includes CogCNLSearchAlgorithmConstants. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
The CompositeResultGraphic subrecord is delay constructed and are created by CreateResultGraphics. The GraphicOptions parameter is specified by ORing the constants that begin with CogCNLSearchLastRunRecordConstants.
| Record Key | ContentType | CogCNLSearchLastRunRecordConstants and CogCNLSearchLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| SearchRegion | Graphic | SearchRegion A graphic that contains a copy of SearchRegion. This record is available only if SearchPointEnabled is False. |
| SearchPoint | Graphic | SearchPoint A CogPointMarker that indicates the SearchPointX. This record is available only if SearchPointEnabled is True. |
| CompositeResultGraphics | Graphics Collection | ResultsOrigin ResultsBoundingBoxResultsMatchRegion |
| TransformedRegionImage | Image | TransformedRegionImage The SearchRegion after it has been transformed. This record is available only if the SearchRegionMode is CogRegionModeConstants and the search region is a CogRectangleAffine. This record is not available if SearchPointEnabled is True and Algorithm is CogCNLSearchAlgorithmConstants. |
| CompositeResultGraphics or CompositeResultGraphics2 | Graphics Collection | ResultsOrigin ResultsBoundingBox ResultsMatchRegionIf the selected space name of InputImage is #, the selected space name of the graphics in CompositeResultGraphics2 subrecord is "_InputImage#". If both the InputImage and TransformedRegionImage records are enabled along with the composite graphics subrecords, and the selected space name of InputImage is not #, then both image records have the same CompositeResultGraphics subrecords; otherwise the TransformedRegionImage record has a CompositeResultGraphics2 subrecord. |
| TrainImage | Image | TrainImageDeepCopy Contains a deep copy of the TrainImage. |
| TrainRegion | Graphic | TrainRegion Contains a deep copy of the TrainRegion. |
| PatternOrigin | Graphic | PatternOrigin A noninteractive CogPointMarker that represents the pattern's OriginX. |
| TrainImageMask | Graphic | TrainImageMask A CogMaskGraphic that contains a copy of the TrainImageMask. This record is available only when the pattern training Algorithm includes CogCNLSearchAlgorithmConstants. |
| TrainedEdges | Graphic | TrainedEdges A CogMaskGraphic that represents the TrainedEdgeImage. This record is available only when the pattern training Algorithm includes CogCNLSearchAlgorithmConstants. It is not available when the TrainRegionMode is CogRegionModeConstants. |
| TrainedPatternImage | Image | TrainedPatternImage This record is created by calling GetTrainedPatternImage. |
| TrainedPatternRegion | Graphic | TrainedPatternRegion Contains a deep copy of the TrainRegion. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A noninteractive CogPointMarker that represents the pattern's OriginX. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the TrainedPatternImageMask. This graphic is obtained by calling GetTrainedPatternImageMask. This record is available only when the pattern training Algorithm includes CogCNLSearchAlgorithmConstants. |
| TrainedPatternEdges | Graphic | TrainedPatternEdges A CogMaskGraphic that represents the TrainedEdgeImage. This record is available only when the pattern training Algorithm includes CogCNLSearchAlgorithmConstants. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Current Record are references to the actual masks and regions used in the tool.
| Record Key | ContentType | CogCalibCheckerboardCurrentRecordConstants |
| InputImage | Image | InputImage |
| UncalibratedAxes | Graphic | UncalibratedAxes A noninteractive CogCoordinateAxes that indicates the uncalibrated coordinate space. |
| CalibratedAxes | Graphic | CalibratedAxes A noninteractive CogCoordinateAxes that indicates the calibrated coordinate space. This record is available only if the calibration has been computed to step 2. |
| CalibrationImage | Image | CalibrationImage |
| UncalibratedAxes | Graphic | CalUncalibratedAxes A noninteractive CogCoordinateAxes that indicates the uncalibrated coordinate space of the calibration image. |
| UncalibratedPoints | Graphics Collection | CalUncalibratedPoints CogCompositeShapes that represent the uncalibrated points. |
| CalibratedAxes | Graphic | CalCalibratedAxes An interactive CogCompositeShape that represents and allows adjustment of the axes of the calibrated coordinate space. This record is available only if the calibration has been computed to step 2. |
| RawCalibratedAxes | Graphic | CalRawCalibratedAxes A noninteractive CogCoordinateAxes that represent the raw calibrated coordinate space. This record is available only if the calibration has been computed to step 2. |
| RawCalibratedPoints | Graphics Collection | CalRawCalibratedPoints Noninteractive CogCompositeShapes that represent the raw calibrated points. This record is available only if the calibration has been computed to step 2. |
| UndistortedCalibrationImage | Image | UndistortedCalibrationImage |
| UncalibratedAxes | Graphic | CalUncalibratedAxes A noninteractive CogCoordinateAxes that indicates the uncalibrated coordinate space of the calibration image. |
| UncalibratedPoints | Graphics Collection | CalUncalibratedPoints CogCompositeShapes that represent the uncalibrated points. |
| CalibratedAxes | Graphic | CalCalibratedAxes An interactive CogCompositeShape that represents and allows adjustment of the axes of the calibrated coordinate space. This record is available only if the calibration has been computed to step 2. |
| RawCalibratedAxes | Graphic | CalRawCalibratedAxes A noninteractive CogCoordinateAxes that represent the raw calibrated coordinate space. This record is available only if the calibration has been computed to step 2. |
| RawCalibratedPoints | Graphics Collection | CalRawCalibratedPoints Noninteractive CogCompositeShapes that represent the raw calibrated points. This record is available only if the calibration has been computed to step 2. |
| DestinationRectangle | Graphic | CalDestinationRectangle This record is available if the calibration has been computed to step 3. |
| UndistortedImageMask | Graphic | CalUndistortedImageMask This record is available if the calibration has been computed to step 3. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
| Record Key | ContentType | CogCalibCheckerboardLastRunRecordConstants and CogCalibCheckerboardLastRunRecordDiagConstants |
| OutputImage | Image | OutputImage |
| CalibratedAxes | Graphic | CalibratedAxes A CogCoordinateAxes that represents the calibrated coordinate space. |
| UncalibratedAxes | Graphic | UncalibratedAxes A CogCoordinateAxes that represents the uncalibrated coordinate space. |
| OutputImageMask | Graphic | OutputImageMask |
| InputImage | Image | InputImageByReference |
| CalibratedAxes | Graphic | CalibratedAxes A CogCoordinateAxes that represents the calibrated coordinate space. |
| UncalibratedAxes | Graphic | UncalibratedAxes A CogCoordinateAxes that represents the uncalibrated coordinate space. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogCalibNPointToNPointCurrentRecordConstants |
| InputImage | Image | InputImage |
| UncalibratedAxes | Graphic | UncalibratedAxes A noninteractive CogCoordinateAxes that indicates the uncalibrated coordinate space. |
| CalibratedAxes | Graphic | CalibratedAxes A noninteractive CogCoordinateAxes that indicates the calibrated coordinate space. This record is available only if the calibration has been computed. |
| CalibrationImage | Image | CalibrationImage |
| UncalibratedAxes | Graphic | CalUncalibratedAxes A noninteractive CogCoordinateAxes that indicates the uncalibrated coordinate space of the calibration image. |
| UncalibratedPoints | Graphics Collection | CalUncalibratedPoints Interactive CogCompositeShapes that represent the uncalibrated points. |
| CalibratedAxes | Graphic | CalCalibratedAxes An interactive CogCompositeShape that represents and allows adjustment of the axes of the calibrated coordinate space. This record is available only if the calibration has been computed. |
| RawCalibratedAxes | Graphic | CalRawCalibratedAxes A noninteractive CogCoordinateAxes that represent the raw calibrated coordinate space. This record is available only if the calibration has been computed. |
| RawCalibratedPoints | Graphics Collection | CalRawCalibratedPoints Noninteractive CogCompositeShapes that represent the raw calibrated points. This record is available only if the calibration has been computed. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogCalibNPointToNPointLastRunRecordConstants and CogCalibNPointToNPointLastRunRecordDiagConstants |
| OutputImage | Image | OutputImage |
| CalibratedAxes | Graphic | CalibratedAxes A CogCoordinateAxes that represents the calibrated coordinate space. |
| UncalibratedAxes | Graphic | UncalibratedAxes A CogCoordinateAxes that represents the uncalibrated coordinate space. |
| InputImage | Image | InputImageByReference |
| CalibratedAxes | Graphic | CalibratedAxes A CogCoordinateAxes that represents the calibrated coordinate space. |
| UncalibratedAxes | Graphic | UncalibratedAxes A CogCoordinateAxes that represents the uncalibrated coordinate space. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are references to the actual regions used in the tool.
| Record Key | ContentType | CogCaliperCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogCaliperLastRunRecordConstants and CogCaliperLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| FoundEdges | Graphics Collection | Edges |
| RegionData | Image | If you specify TransformedRegionPixels the record contains an image that depicts the transformed affine region or the entire region if no region was specified. If you also specify Edges2, the edges appear on the transformed image. |
| ProjectionGraph | Graphic | ProjectionGraph A CogCompositeShape that represents the projection graph. If you also specify Edges2, the edges appear on the graph. |
| FilteredProjectionGraph | Graphic | FilteredProjectionGraph A CogCompositeShape that represents the filtered projection graph. If you also specify Edges2, the edges appear on the graph. |
| FoundEdges | Graphics Collection | Edges |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogCopyRegionCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
| DestinationImage | Graphic | DestinationImage |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogCopyRegionLastRunRecordConstants and CogCopyRegionLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| AlignmentPoint | Graphic | AlignmentPoints |
| OutputImage | Image | OutputImage |
| DestinationRegion | Graphic | DestinationRegion |
| AlignmentPoint | Graphic | AlignmentPoints |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and shapes in the Current Record are references to the actual masks and shapes used in the tool.
| Record Key | ContentType | CogFindCircleCurrentRecordConstants |
| InputImage | Image | InputImage |
| ExpectedShapeSegment | Graphic | ExpectedCircularArc An interactive CogCircularArc that denotes the ExpectedCircularArc. |
| CaliperRegions | Graphics Collection | CaliperRegions InteractiveCaliperSizeIf CaliperRegions is set, the record contains a CogGraphicCollection that includes the CogRectangleAffine that depict the calipers and a line segment that indicates the CaliperSearchDirection. If InteractiveCaliperSize is set, the collection includes a CogPointMarker used to resize the calipers. If only InteractiveCaliperSize is set, the collection contains only the center caliper. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
| Record Key | ContentType | CogFindCircleLastRunRecordConstants and CogFindCircleLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| BestFitShape | Graphics Collection | BestFitCircle A CogGraphicCollection that contains the best fit CogCircle and a CogPointMarker that indicates the center of the circle. |
| BestFitShapeSegment | Graphic | BestFitCircularArc A CogCircularArc that represents the best fit arc. |
| CompositeResultGraphics | Graphics Collection | ResultsUsedPointsResultsIgnoredPoints ResultsCaliperEdges ResultsCaliperRegions |
| ExpectedShapeSegment | Graphic | ExpectedCircularArc |
| RegionData_CaliperN | Image | The tool generates a record for each caliper with N ranging from 0 to one less than the number of calipers. If TransformedRegionPixels is selected, this record contains the transformed image of each caliper. |
| ProjectionGraph | Graphic | ProjectionGraph |
| FilteredProjectionGraph | Graphic | FilteredProjectionGraph |
| FoundEdges | Graphic | FoundEdges A CogCompositeShape that represents the found edge on the projection graphs and the transformed image. This record is generated only when at least one of TransformedRegionPixels , ProjectionGraph, or FilteredProjectionGraph is set. |
| InputImage | Tool Defined | The tool uses this record for delayed construction of the transformed image. |
| NoCaliperResults | Graphic | ProjectionGraph FilteredProjectionGraph TransformedRegionPixelsThe content of this record is a CogGraphicLabel that contains the text "No Caliper results available". This may occur when some, but not all, of the caliper regions fall completely off the image. In this case, the RegionData_CaliperN records will contain this subrecord instead of the other subrecords. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and shapes in the Current Record are references to the actual masks and shapes used in the tool.
| Record Key | ContentType | CogFindLineCurrentRecordConstants |
| InputImage | Image | InputImage |
| ExpectedShapeSegment | Graphic | ExpectedLineSegment An interactive CogLineSegment that denotes the ExpectedLineSegment. |
| CaliperRegions | Graphics Collection | CaliperRegions InteractiveCaliperSizeInteractiveCaliperSearchDirectionIf CaliperRegions is set, the record contains a CogGraphicCollection that includes the CogRectangleAffine that depict the calipers and a line segment that indicates the CaliperSearchDirection. If InteractiveCaliperSize is set, the collection includes a CogPointMarker used to resize the calipers. If only InteractiveCaliperSize is set, the collection contains only the center caliper. If InteractiveCaliperSearchDirection is set the line segment that depicts the search direction is interactive. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
| Record Key | ContentType | CogFindLineLastRunRecordConstants and CogFindLineLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| BestFitShape | Graphics Collection | BestFitLine A CogGraphicCollection that contains the best fit CogLine. |
| BestFitShapeSegment | Graphic | BestFitLineSegment A CogLineSegment that represents the best fit segment. |
| CompositeResultGraphics | Graphics Collection | ResultsUsedPointsResultsIgnoredPoints ResultsCaliperEdges ResultsCaliperRegions |
| ExpectedShapeSegment | Graphic | ExpectedLineSegment |
| RegionData_CaliperN | Image | The tool generates a record for each caliper with N ranging from 0 to one less than the number of calipers. If TransformedRegionPixels is selected, this record contains the transformed image of each caliper. |
| ProjectionGraph | Graphic | ProjectionGraph |
| FilteredProjectionGraph | Graphic | FilteredProjectionGraph |
| FoundEdges | Graphic | FoundEdges A CogCompositeShape that represents the found edge on the projection graphs and the transformed image. This record is generated only when at least one of TransformedRegionPixels , ProjectionGraph, or FilteredProjectionGraph is set. |
| InputImage | Tool Defined | The tool uses this record for delayed construction of the transformed image. |
| NoCaliperResults | Graphic | ProjectionGraph FilteredProjectionGraph TransformedRegionPixelsThe content of this record is a CogGraphicLabel that contains the text "No Caliper results available". This may occur when some, but not all, of the caliper regions fall completely off the image. In this case, the RegionData_CaliperN records will contain this subrecord instead of the other subrecords. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFitCircleCurrentRecordConstants |
| InputImage | Image | InputImage |
| InputPoints | Graphics Collection | InputPoints A CogGraphicCollection that contains each of the input points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are interactive. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFitCircleLastRunRecordConstants and CogFitCircleLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| UsedPoints | Graphics Collection | UsedPoints A CogGraphicCollection that contains each of the used points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are not interactive. |
| IgnoredPoints | Graphics Collection | IgnoredPoints A CogGraphicCollection that contains each of the ignored points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are not interactive. |
| Shape | Graphics Collection | Circle A CogGraphicCollection that contains the fitted CogCircle and a CogPointMarker that indicates its center. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFitEllipseCurrentRecordConstants |
| InputImage | Image | InputImage |
| InputPoints | Graphics Collection | InputPoints A CogGraphicCollection that contains each of the input points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are interactive. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFitEllipseLastRunRecordConstants and CogFitEllipseLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| UsedPoints | Graphics Collection | UsedPoints A CogGraphicCollection that contains each of the used points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are not interactive. |
| IgnoredPoints | Graphics Collection | IgnoredPoints A CogGraphicCollection that contains each of the ignored points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are not interactive. |
| Shape | Graphics Collection | Ellipse A CogGraphicCollection that contains the fitted CogEllipse and a CogPointMarker that indicates its center. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFitLineCurrentRecordConstants |
| InputImage | Image | InputImage |
| InputPoints | Graphics Collection | InputPoints A CogGraphicCollection that contains each of the input points. Each of the points is aCogPointMarker enclosed in a CogCompositeShape. The points are interactive. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFitLineLastRunRecordConstants and CogFitLineLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| UsedPoints | Graphics Collection | UsedPoints A CogGraphicCollection that contains each of the used points. Each of the points is aCogPointMarker enclosed in a CogCompositeShape. The points are not interactive. |
| IgnoredPoints | Graphics Collection | IgnoredPoints A CogGraphicCollection that contains each of the ignored points. Each of the points is a CogPointMarker enclosed in a CogCompositeShape. The points are not interactive. |
| Shape | Graphics Collection | Line A CogGraphicCollection that contains the fitted CogLine. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFixtureNPointToNPointCurrentRecordConstants |
| InputImage | Image | InputImage |
| UnfixturedAxes | Graphic | UnfixturedAxes A CogCoordinateAxes that represents the unfixtured coordinate space. |
| UnfixturedPoints | Graphics Collection | UnfixturedPoints A collection of CogCompositeShapes that indicate the unfixtured points. |
| ReferenceImage | Image | RefImage To generate this record ReferenceImageEnabled must be True. |
| RawFixturedAxes | Graphic | RawFixturedAxes A CogCoordinateAxes that represents the raw fixtured coordinate space. |
| RawFixturedPoints | Graphics Collection | RawFixturedPoints A collection of CogCompositeShapes that indicate the raw fixtured points. |
| FixturedAxes | Graphic | FixturedAxes An interactive CogCoordinateAxes that represents and allows you to adjust the fixtured coordinate space. Manipulating these axes changes the RawFixturedFromFixturedTransform property. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFixtureNPointToNPointLastRunRecordConstants and CogFixtureNPointToNPointLastRunRecordDiagConstants |
| OutputImage | Image | OutputImage |
| UnfixturedAxes | Graphic | UnfixturedAxes A CogCoordinateAxes that represents the unfixtured coordinate space. |
| FixturedAxes | Graphic | FixturedAxes A CogCoordinateAxes that represents the fixtured coordinate space. |
| UnfixturedPoints | Graphics Collection | UnfixturedPoints A collection of CogCompositeShapes that indicate the unfixtured points. |
| RawFixturedPoints | Graphics Collection | RawFixturedPoints A collection of CogCompositeShapes that indicate the raw fixtured points. |
| RawFixturedAxes | Graphic | RawFixturedAxes A CogCoordinateAxes that represents the raw fixtured coordinate space. |
| InputImage | Image | InputImageByReference |
| UnfixturedAxes | Graphic | UnfixturedAxes A CogCoordinateAxes that represents the unfixtured coordinate space. |
| FixturedAxes | Graphic | FixturedAxes A CogCoordinateAxes that represents the fixtured coordinate space. |
| UnfixturedPoints | Graphics Collection | UnfixturedPoints A collection of CogCompositeShapes that indicate the unfixtured points. |
| RawFixturedPoints | Graphics Collection | RawFixturedPoints A collection of CogCompositeShapes that indicate the raw fixtured points. |
| RawFixturedAxes | Graphic | RawFixturedAxes A CogCoordinateAxes that represents the raw fixtured coordinate space. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFixtureCurrentRecordConstants |
| InputImage | Image | InputImage |
| FixturedAxes | Graphic | FixturedAxes An interactive CogCoordinateAxes that represents and allows you to adjust the fixtured coordinate space. Manipulating these axes changes the UnfixturedFromFixturedTransform property. |
| UnfixturedAxes | Graphic | UnfixturedAxes A CogCoordinateAxes that represents the unfixtured coordinate space. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogFixtureLastRunRecordConstants and CogFixtureLastRunRecordDiagConstants |
| OutputImage | Image | OutputImage |
| FixturedAxes | Graphic | FixturedAxes A CogCoordinateAxes that represents the fixtured coordinate space. |
| UnfixturedAxes | Graphic | UnfixturedAxes A CogCoordinateAxes that represents the unfixtured coordinate space. |
| InputImage | Image | InputImageByReference |
| FixturedAxes | Graphic | FixturedAxes A CogCoordinateAxes that represents the fixtured coordinate space. |
| UnfixturedAxes | Graphic | UnfixturedAxes A CogCoordinateAxes that represents the unfixtured coordinate space. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogHistogramCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
| InputImageMask | Graphic | InputImageMask A mask that refers to the actual InputImageMask if one is provided. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogHistogramLastRunRecordConstants and CogHistogramLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| InputImageMask | Graphic | InputImageMask A mask that is a copy of the actual InputImageMask if one is provided. |
| Histogram | Image | Histogram Mean CumulativeHistogram MedianThe mean, if enabled, is added as a white line. The median, if enabled, is added as a yellow line. The cumulative histogram graph, if enabled, is added to the histogram. |
| AddHistogramSpaceCmd | Display Method | Display command record that adds a coordinate space. |
| ChangeHistogramSpaceNameCmd | Display Method | Display command record that sets the coordinate space name. |
| HistogramGraphics | Graphics Collection | CogGraphicCollection that contains the histogram graphics.. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogIPOneImageCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogIPOneImageLastRunRecordConstants and CogIPOneImageLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| TransformedRegionImage | Image | TransformedRegionImage InputImage after an affine transform if RegionMode is CogRegionModeConstants. |
| IntermediateImage - n | Image | IntermediateImages The tool creates one intermediate record for each operator except the last one. |
| OutputImage | Image | OutputImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogIPTwoImageAddCurrentRecordConstants |
| InputImageA | Image | InputImages |
| RegionA | Graphic | Regions |
| AlignmentPointA | Graphic | AlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageA if ImageAlignmentEnabled are enabled. |
| InputImageB | Image | InputImages |
| RegionB | Graphic | Regions |
| AlignmentPointB | Graphic | AlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageB if ImageAlignmentEnabled are enabled. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogIPTwoImageAddLastRunRecordConstants and CogIPTwoImageAddLastRunRecordDiagConstants |
| InputImageA | Image | InputImagesByReference or InputImagesDeepCopy |
| RegionA | Graphic | Regions |
| AlignmentPointA | Graphic | ImageAlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageA if ImageAlignmentEnabled are enabled. |
| OverlapMaskA | Graphic | OverlapMasks A CogMaskGraphic that indicates how InputImageB overlaps on InputImageA. Available only if you do not specify a region for InputImageA. |
| TransformedRegionImageA | Image | TransformedRegionImages InputImageA after an affine transform if RegionModeA is CogRegionModeConstants. |
| OverlapMaskA | Graphic | OverlapMasks A CogMaskGraphic that indicates how the transformed InputImageB overlaps on InputImageA. |
| InputImageB | Image | InputImagesByReference or InputImagesDeepCopy |
| RegionB | Graphic | Regions |
| AlignmentPointB | Graphic | ImageAlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageB if ImageAlignmentEnabled are enabled. |
| OverlapMaskB | Graphic | OverlapMasks A CogMaskGraphic that indicates how InputImageA overlaps on InputImageB. Available only if you do not specify a region for InputImageA. |
| TransformedRegionImageB | Image | TransformedRegionImages InputImageB after an affine transform if RegionModeB is CogRegionModeConstants. |
| OverlapMaskB | Graphic | OverlapMasks A CogMaskGraphic that indicates how the transformed InputImageA overlaps on InputImageB. |
| OutputImage | Image | OutputImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogIPTwoImageMinMaxCurrentRecordConstants |
| InputImageA | Image | InputImages |
| RegionA | Graphic | Regions |
| AlignmentPointA | Graphic | AlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageA if ImageAlignmentEnabled are enabled. |
| InputImageB | Image | InputImages |
| RegionB | Graphic | Regions |
| AlignmentPointB | Graphic | AlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageB if ImageAlignmentEnabled are enabled. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogIPTwoImageMinMaxLastRunRecordConstants and CogIPTwoImageMinMaxLastRunRecordDiagConstants |
| InputImageA | Image | InputImagesByReference or InputImagesDeepCopy |
| RegionA | Graphic | Regions |
| AlignmentPointA | Graphic | ImageAlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageA if ImageAlignmentEnabled are enabled. |
| OverlapMaskA | Graphic | OverlapMasks A CogMaskGraphic that indicates how InputImageB overlaps on InputImageA. Available only if you do not specify a region for InputImageA. |
| TransformedRegionImageA | Image | TransformedRegionImages InputImageA after an affine transform if RegionModeA is CogRegionModeConstants. |
| OverlapMaskA | Graphic | OverlapMasks A CogMaskGraphic that indicates how the transformed InputImageB overlaps on InputImageA. |
| InputImageB | Image | InputImagesByReference or InputImagesDeepCopy |
| RegionB | Graphic | Regions |
| AlignmentPointB | Graphic | ImageAlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageB if ImageAlignmentEnabled are enabled. |
| OverlapMaskB | Graphic | OverlapMasks A CogMaskGraphic that indicates how InputImageA overlaps on InputImageB. Available only if you do not specify a region for InputImageA. |
| TransformedRegionImageB | Image | TransformedRegionImages InputImageB after an affine transform if RegionModeB is CogRegionModeConstants. |
| OverlapMaskB | Graphic | OverlapMasks A CogMaskGraphic that indicates how the transformed InputImageA overlaps on InputImageB. |
| OutputImage | Image | OutputImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogIPTwoImageSubtractCurrentRecordConstants |
| InputImageA | Image | InputImages |
| RegionA | Graphic | Regions |
| AlignmentPointA | Graphic | AlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageA if ImageAlignmentEnabled are enabled. |
| InputImageB | Image | InputImages |
| RegionB | Graphic | Regions |
| AlignmentPointB | Graphic | AlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageB if ImageAlignmentEnabled are enabled. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogIPTwoImageSubtractLastRunRecordConstants and CogIPTwoImageSubtractLastRunRecordDiagConstants |
| InputImageA | Image | InputImagesByReference or InputImagesDeepCopy |
| RegionA | Graphic | Regions |
| AlignmentPointA | Graphic | ImageAlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageA if ImageAlignmentEnabled are enabled. |
| OverlapMaskA | Graphic | OverlapMasks A CogMaskGraphic that indicates how InputImageB overlaps on InputImageA. Available only if you do not specify a region for InputImageA. |
| TransformedRegionImageA | Image | TransformedRegionImages InputImageA after an affine transform if RegionModeA is CogRegionModeConstants. |
| OverlapMaskA | Graphic | OverlapMasks A CogMaskGraphic that indicates how the transformed InputImageB overlaps on InputImageA. |
| InputImageB | Image | InputImagesByReference or InputImagesDeepCopy |
| RegionB | Graphic | Regions |
| AlignmentPointB | Graphic | ImageAlignmentPoints A CogCoordinateAxes graphic that represents the alignment point for InputImageB if ImageAlignmentEnabled are enabled. |
| OverlapMaskB | Graphic | OverlapMasks A CogMaskGraphic that indicates how InputImageA overlaps on InputImageB. Available only if you do not specify a region for InputImageA. |
| TransformedRegionImageB | Image | TransformedRegionImages InputImageB after an affine transform if RegionModeB is CogRegionModeConstants. |
| OverlapMaskB | Graphic | OverlapMasks A CogMaskGraphic that indicates how the transformed InputImageA overlaps on InputImageB. |
| OutputImage | Image | OutputImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogImageAverageCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogImageAverageLastRunRecordConstants and CogImageAverageLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| TransformedRegionPixels | Image | TransformedRegionPixels InputImage after an affine transform if RegionMode is CogRegionModeConstants. |
| StandardDeviationImage | Image | StandardDeviationImage |
| AverageImage | Image | AverageImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogImageSharpnessCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogImageSharpnessLastRunRecordConstants and CogImageSharpnessLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogOCVCurrentRecordConstants |
| InputImage | Image | InputImage |
| PatternPosition | Graphic | PatternPositionCoordinateAxes PatternPositionCharacterOrigins PatternPositionCharacterCoordinateAxesPatternPositionCharacterRegionsPatternPositionCharacterLabelsA CogCompositeShape that contains interactive shapes for the pattern's coordinate axes, the characters' origins, the characters' coordinate axes, the characters' regions, and the characters' labels. |
| PatternReferenceImage | Image | PatternReferenceImage |
| PatternOrigin | Graphic | PatternOriginUniform or PatternOriginFreeAn interactive CogCoordinateAxes that indicates the pattern origin. If PatternOriginUniform is set, the character positions move with the origin. If PatternOriginFree is set, the origin moves independently of the character positions. |
| CharacterPositions | Graphics Collection | CharacterPositionsCoordinateAxes CharacterPositionsOriginCharacterPositionsLabelCharacterPositionsRegionA CogGraphicCollection that contains interactive CogCompositeShapes for each of the characters. The constituent subshapes depend on the bits enabled. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record.
| Record Key | ContentType | CogOCVLastRunRecordConstants and CogOCVLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| PatternPosition | Graphic | PatternPosition A CogCoordinateAxes that indicates the found pattern origin. |
| CompositeResultGraphics | Graphics Collection | ResultsOrigin ResultsMatchRegion ResultsCoordinateAxesResultsLabelA CogGraphicCollection that contains CogCompositeShapes for each of the found characters. The constituent subshapes depend on the bits enabled. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogPDF417CurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region An interactive shape that depicts the Region of the image. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogPDF417LastRunRecordConstants and CogPDF417LastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| TransformedRegionImage | Image | TransformedRegionImage InputImage after an affine transform if RegionMode is CogRegionModeConstants. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Current Record are references to the actual masks and regions used in the tool.
| Record Key | ContentType | CogPMAlignCurrentRecordConstants |
| InputImage | Image | InputImage |
| SearchRegion | Graphic | SearchRegion |
| SearchImageMask | Graphic | SearchImageMask A CogMaskGraphic that contains a reference to the actual SearchImageMask. |
| TrainImage | Image | TrainImage |
| TrainRegion | Graphic | TrainRegion Contains a reference to the actual TrainRegion. |
| PatternOrigin | Graphic | PatternOrigin An interactive CogCoordinateAxes that contains a reference to the pattern's actual Origin. |
| FeaturesCoarse | Graphics Collection | PatternFeaturesCoarse This record is delay constructed and created by calling CreateGraphicsCoarse. |
| FeaturesFine | Graphics Collection | PatternFeaturesFine This record is delay constructed and created by calling CreateGraphicsFine. |
| TrainImageMask | Graphic | TrainImageMask A CogMaskGraphic that contains a reference to the actual TrainImageMask. |
| TrainShapeModels | Graphics Collection | TrainShapeModels A CogGraphicCollection of CogShapeModels used to train the pattern. |
| TrainedPatternImage | Image | TrainedPatternImage This record and its subrecord are delay constructed by calling GetTrainedPatternImage. If the selected space of the TrainImage is #, the selected space of all of the graphics in the subrecords of TrainedPatternImage is "_TrainImage#" |
| TrainedPatternRegion | Graphic | TrainedPatternRegion Contains a noninteractive deep copy of the TrainRegion. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A noninteractive CogCoordinateAxes that represents the pattern's Origin. |
| FeaturesCoarse or TrainedPatternFeaturesCoarse | Graphics Collection | TrainedPatternFeaturesCoarse If the selected space of the TrainImage is #, the tool creates the TrainedPatternFeaturesCoarse subrecord. Otherwise it creates the FeaturesCoarse subrecord which is identical to the subrecord of the TrainImage record. |
| FeaturesFine or TrainedPatternFeaturesFine | Graphics Collection | TrainedPatternFeaturesFine If the selected space of the TrainImage is #, the tool creates the TrainedPatternFeaturesFine subrecord. Otherwise it creates the FeaturesFine subrecord which is identical to the subrecord of the TrainImage record. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A noninteractive deep copy of the TrainImageMask. |
| TrainedPatternShapeModels | Graphics Collection | TrainedPatternShapeModels A CogGraphicCollection of CogShapeModels that are within the pixel aligned bounding box of the train region used to train the pattern. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
The CompositeResultGraphic subrecord is delay constructed and are created by CreateResultGraphics. The GraphicOptions parameter is specified by ORing the constants that begin with CogPMAlignLastRunRecordConstants.
| Record Key | ContentType | CogPMAlignLastRunRecordConstants and CogPMAlignLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| SearchRegion | Graphic | SearchRegion |
| CompositeResultGraphics | Graphics Collection | ResultsOrigin ResultsBoundingBox ResultsMatchRegion ResultsCoordinateAxes ResultsMatchShapeModels |
| SearchImageMask | Graphic | SearchImageMask A CogMaskGraphic that contains a reference to a deep copy of the actual SearchImageMask. |
| TrainImage | Image | TrainImageDeepCopy Contains a deep copy of the TrainImage. |
| TrainRegion | Graphic | TrainRegion Contains a deep copy of the TrainRegion. |
| PatternOrigin | Graphic | PatternOrigin A noninteractive CogCoordinateAxes that represents the pattern's Origin. |
| FeaturesCoarse | Graphics Collection | PatternFeaturesCoarse This records is delay constructed and created by calling CreateGraphicsCoarse. |
| FeaturesFine | Graphics Collection | PatternFeaturesFine This records is delay constructed and created by calling CreateGraphicsFine. |
| TrainImageMask | Graphic | TrainImageMask A CogMaskGraphic that contains a reference to a copy of the TrainImageMask. |
| TrainShapeModels | Graphics Collection | TrainShapeModels A CogGraphicCollection of CogShapeModels used to train the pattern. |
| TrainedPatternImage | Image | TrainedPatternImage This record and its subrecord are delay constructed by calling GetTrainedPatternImage. If the selected space of the TrainImage is #, the selected space of all of the graphics in the subrecords of TrainedPatternImage is "_TrainImage#" |
| TrainedPatternRegion | Graphic | TrainedPatternRegion Contains a noninteractive deep copy of the TrainRegion. If the selected space of the TrainImage is not #, the TrainedPatternRegion and TrainRegion records are identical. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A noninteractive CogCoordinateAxes that represents the pattern's Origin. If the selected space of the TrainImage is not #, the TrainedPatternOrigin and PatternOrigin records are identical. |
| TrainedPatternFeaturesCoarse | Graphics Collection | TrainedPatternFeaturesCoarse If the selected space of the TrainImage is not #, the TrainedPatternFeaturesCoarse and FeaturesCoarse records are identical. |
| TrainedPatternFeaturesFine | Graphics Collection | TrainedPatternFeaturesFine If the selected space of the TrainImage is not #, the TrainedPatternFeaturesFine and FeaturesFine records are identical. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the TrainedPatternImageMask. This graphic is obtained by calling GetTrainedPatternImageMask. |
| TrainedPatternShapeModels | Graphics Collection | TrainedPatternShapeModels A CogGraphicCollection of CogShapeModels that are within the pixel aligned bounding box of the train region used to train the pattern. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The masks and regions in the Current Record are references to the actual masks and regions used in the tool.
| Record Key | ContentType | CogPatInspectCurrentRecordConstants |
| InputImage | Image | InputImage |
| Pose | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Region | Graphic | Region A shape that represents the TrainRegion. |
| TrainImage | Image | TrainImage |
| PatternOrigin | Graphic | PatternOrigin A noninteractive CogCoordinateAxes that represents the pattern's Origin. |
| TrainRegion | Graphic | TrainRegion Contains a reference to the actual TrainRegion. |
| TrainImageMask | Graphic | TrainImageMask A CogMaskGraphic that contains a reference to the actual TrainImageMask. |
| TrainedPatternImage | Image | TrainedPatternImage This record is delay constructed by calling GetTrainedPatternImage. |
| TrainedPatternRegion | Graphic | TrainedPatternRegion A shape that represents the TrainRegion on the GetTrainedPatternImage. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A CogCoordinateAxes that represents the pattern's Origin on the GetTrainedPatternImage. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the GetTrainedPatternImageMask on the GetTrainedPatternImage. |
| TrainedThresholdImage | Image | TrainedThresholdImage This record is delay constructed by calling GetTrainedThresholdImage. |
| TrainedPatternRegion | Graphic | TrainedPatternRegion A shape that represents the TrainRegion on the GetTrainedThresholdImage. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A CogCoordinateAxes that represents the pattern's Origin on the GetTrainedThresholdImage. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the GetTrainedPatternImageMask on the GetTrainedThresholdImage. |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
If the selected space name of the InputImage is #, the Region and Pose subrecords of the DifferenceImage... and MatchImage... records are named Region# and Pose#.
The masks and regions in the Last Run Record are deep copies of the masks and regions used in the tool.
| Record Key | ContentType | CogPatInspectLastRunRecordConstants and CogPatInspectLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region A shape that represents the TrainRegion. |
| Pose | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| DifferenceImageAbsolute | Image | DifferenceImages This record is created only if DifferenceImages property includes CogPatInspectDifferenceImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| DifferenceImageBrighter | Image | DifferenceImages This record is created only if DifferenceImages property includes CogPatInspectDifferenceImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| DifferenceImageDarker | Image | DifferenceImages This record is created only if DifferenceImages property includes CogPatInspectDifferenceImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| DifferenceImageRawAbsolute | Image | DifferenceImagesRaw This record is created only if DifferenceImagesRaw property includes CogPatInspectDifferenceImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| DifferenceImageRawBrighter | Image | DifferenceImagesRaw This record is created only if DifferenceImagesRaw property includes CogPatInspectDifferenceImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| DifferenceImageRawDarker | Image | DifferenceImagesRaw This record is created only if DifferenceImagesRaw property includes CogPatInspectDifferenceImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| MatchImage | Image | MatchImages This record is created only if MatchImages property includes CogPatInspectMatchImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| DifferenceImagesAsGraphic | Graphic | DifferenceImagesAsGraphic A CogMaskGraphic that represents the thresholded difference images over the match images. The color of each pixel indicates the magnitude of the grey scale difference: cyan (magnitude = 1) to red (magnitude >= 20). |
| DifferenceImagesRawAsGraphic | Graphic | DifferenceImagesRawAsGraphic A CogMaskGraphic that represents the raw (unthresholded) difference images over the match images. The color of each pixel indicates the magnitude of the grey scale difference: cyan (magnitude = 1) to red (magnitude >= 20). |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| MatchImageNormalized | Image | MatchImages This record is created only if MatchImages property includes CogPatInspectMatchImageConstants |
Region or Region# | Graphic | Region A shape that represents the TrainRegion. |
Pose or Pose# | Graphic | Pose A CogCoordinateAxes that represents the Pose. |
| DifferenceImagesAsGraphic | Graphic | DifferenceImagesAsGraphic A CogMaskGraphic that represents the thresholded difference images over the match images. The color of each pixel indicates the magnitude of the grey scale difference: cyan (magnitude = 1) to red (magnitude >= 20). |
| DifferenceImagesRawAsGraphic | Graphic | DifferenceImagesRawAsGraphic A CogMaskGraphic that represents the raw (unthresholded) difference images over the match images. The color of each pixel indicates the magnitude of the grey scale difference: cyan (magnitude = 1) to red (magnitude >= 20). |
| Mask | Graphic | Mask A CogMaskGraphic that represents the pattern's mask. |
| ClippedMask | Graphic | ClippedMask A CogMaskGraphic that represents the clipped mask. |
| TrainImage | Image | TrainImageDeepCopy Contains a deep copy of the TrainImage. |
| PatternOrigin | Graphic | PatternOrigin An CogCoordinateAxes that represents the pattern's Origin. |
| TrainRegion | Graphic | TrainRegion A deep copy of the TrainRegion. |
| TrainImageMask | Graphic | TrainImageMask A CogMaskGraphic that is a deep copy of the TrainImageMask. |
| TrainedPatternImage | Image | TrainedPatternImage This record is delay constructed by calling GetTrainedPatternImage. If the selected space of the TrainImage is #, the selected space of TrainedPatternRegion and TrainedPatternOrigin is "_TrainImage#". |
| TrainedPatternRegion | Graphic | TrainedPatternRegion Contains a noninteractive deep copy of the TrainRegion. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A noninteractive CogCoordinateAxes that represents the pattern's Origin. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the TrainedPatternImageMask. This graphic is obtained by calling GetTrainedPatternImageMask. |
| TrainedThresholdImage | Image | TrainedThresholdImage This record is delay constructed by calling GetTrainedThresholdImage. |
| TrainedPatternRegion | Graphic | TrainedPatternRegion A shape that represents the TrainRegion on the GetTrainedThresholdImage. |
| TrainedPatternOrigin | Graphic | TrainedPatternOrigin A CogCoordinateAxes that represents the pattern's Origin on the GetTrainedThresholdImage. |
| TrainedPatternImageMask | Graphic | TrainedPatternImageMask A CogMaskGraphic that represents the GetTrainedPatternImageMask on the GetTrainedThresholdImage. |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogPolarUnwrapCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogPolarUnwrapLastRunRecordConstants and CogPolarUnwrapLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| OutputImage | Image | OutputImage |
This section contains the following subsections.
Use CurrentRecordEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateCurrentRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Current Record are the interactive regions used in the tool.
| Record Key | ContentType | CogSobelEdgeCurrentRecordConstants |
| InputImage | Image | InputImage |
| Region | Graphic | Region |
Use LastRunRecordEnable and LastRunRecordDiagEnable to specify which records the tool generates. The default settings appear in bold in the following table. Use CreateLastRunRecord to create the records.
Note: You cannot obtain a subrecord unless you enable its parent record. For example, you cannot get a region record without enabling its parent image record.
The regions in the Last Run Record are deep copies of the regions used in the tool.
| Record Key | ContentType | CogSobelEdgeLastRunRecordConstants and CogSobelEdgeLastRunRecordDiagConstants |
| InputImage | Image | InputImageByReference or InputImageDeepCopy |
| Region | Graphic | Region |
| EdgeAngleImage | Image | EdgeAngleImage |
| EdgeMagnitudeImage | Image | EdgeMagnitudeImage |
| FinalMagnitudeImage | Image | FinalMagnitudeImage |
| TransformedRegionPixels | Image | TransformedRegionPixels InputImage after an affine transform if RegionMode is CogRegionModeConstants. |