inspect_shape_modelinspect_shape_modelInspectShapeModelInspectShapeModelinspect_shape_model (Operator)

Name

inspect_shape_modelinspect_shape_modelInspectShapeModelInspectShapeModelinspect_shape_model — Create the representation of a shape model.

Signature

inspect_shape_model(Image : ModelImages, ModelRegions : NumLevels, Contrast : )

Herror inspect_shape_model(const Hobject Image, Hobject* ModelImages, Hobject* ModelRegions, const Hlong NumLevels, const Hlong Contrast)

Herror T_inspect_shape_model(const Hobject Image, Hobject* ModelImages, Hobject* ModelRegions, const Htuple NumLevels, const Htuple Contrast)

void InspectShapeModel(const HObject& Image, HObject* ModelImages, HObject* ModelRegions, const HTuple& NumLevels, const HTuple& Contrast)

HImage HImage::InspectShapeModel(HRegion* ModelRegions, Hlong NumLevels, const HTuple& Contrast) const

HImage HImage::InspectShapeModel(HRegion* ModelRegions, Hlong NumLevels, Hlong Contrast) const

static void HOperatorSet.InspectShapeModel(HObject image, out HObject modelImages, out HObject modelRegions, HTuple numLevels, HTuple contrast)

HImage HImage.InspectShapeModel(out HRegion modelRegions, int numLevels, HTuple contrast)

HImage HImage.InspectShapeModel(out HRegion modelRegions, int numLevels, int contrast)

def inspect_shape_model(image: HObject, num_levels: int, contrast: MaybeSequence[int]) -> Tuple[HObject, HObject]

Description

inspect_shape_modelinspect_shape_modelInspectShapeModelInspectShapeModelInspectShapeModelinspect_shape_model creates a representation of a shape model. The operator is particularly useful in order to determine the parameters NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels and ContrastContrastContrastContrastcontrastcontrast, which are used in create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model, quickly and conveniently. The representation of the model is created on multiple image pyramid levels, where the number of levels is determined by NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels. In contrast to create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, and create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model, the model is only created for the rotation and scale of the object in the input image, i.e., 0° and 1. As output, inspect_shape_modelinspect_shape_modelInspectShapeModelInspectShapeModelInspectShapeModelinspect_shape_model creates an image object ModelImagesModelImagesModelImagesModelImagesmodelImagesmodel_images containing the images of the individual levels of the image pyramid as well as a region in ModelRegionsModelRegionsModelRegionsModelRegionsmodelRegionsmodel_regions for each pyramid level that represents the model at the respective pyramid level. The individual objects can be accessed with select_objselect_objSelectObjSelectObjSelectObjselect_obj. If the input image ImageImageImageImageimageimage has one channel the representation of the model is created with the method that is used in create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model for the metrics 'use_polarity'"use_polarity""use_polarity""use_polarity""use_polarity""use_polarity", 'ignore_global_polarity'"ignore_global_polarity""ignore_global_polarity""ignore_global_polarity""ignore_global_polarity""ignore_global_polarity", and 'ignore_local_polarity'"ignore_local_polarity""ignore_local_polarity""ignore_local_polarity""ignore_local_polarity""ignore_local_polarity". If the input image has more than one channel the representation is created with the method that is used for the metric 'ignore_color_polarity'"ignore_color_polarity""ignore_color_polarity""ignore_color_polarity""ignore_color_polarity""ignore_color_polarity". As described for create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, and create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model, the number of pyramid levels should be chosen as large as possible, while taking into account that the model must be recognizable on the highest pyramid level and must have enough model points. The parameter ContrastContrastContrastContrastcontrastcontrast should be chosen such that only the significant features of the template object are used for the model. ContrastContrastContrastContrastcontrastcontrast can also contain a tuple with two values. In this case, the model is segmented using a method similar to the hysteresis threshold method used in edges_imageedges_imageEdgesImageEdgesImageEdgesImageedges_image. Here, the first element of the tuple determines the lower threshold, while the second element determines the upper threshold. For more information about the hysteresis threshold method, see hysteresis_thresholdhysteresis_thresholdHysteresisThresholdHysteresisThresholdHysteresisThresholdhysteresis_threshold. Optionally, ContrastContrastContrastContrastcontrastcontrast can contain a third value as the last element of the tuple. This value determines a threshold for the selection of significant model components based on the size of the components, i.e., components that have fewer points than the minimum size thus specified are suppressed. As the minimum size is applied on the extent of the components, the derived model contours can still be smaller than the specified minimum size. This threshold for the minimum size is divided by two for each successive pyramid level. If small model components should be suppressed, but hysteresis thresholding should not be performed, nevertheless three values must be specified in ContrastContrastContrastContrastcontrastcontrast. In this case, the first two values can simply be set to identical values. In its typical use, inspect_shape_modelinspect_shape_modelInspectShapeModelInspectShapeModelInspectShapeModelinspect_shape_model is called interactively multiple times with different parameters for NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels and ContrastContrastContrastContrastcontrastcontrast, until a satisfactory model is obtained. After this, create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model are called with the parameters thus obtained.

Execution Information

Parameters

ImageImageImageImageimageimage (input_object)  (multichannel-)image objectHImageHObjectHImageHobject (byte / uint2)

Input image.

ModelImagesModelImagesModelImagesModelImagesmodelImagesmodel_images (output_object)  (multichannel-)image-array objectHImageHObjectHImageHobject * (byte / uint2)

Image pyramid of the input image

ModelRegionsModelRegionsModelRegionsModelRegionsmodelRegionsmodel_regions (output_object)  region-array objectHRegionHObjectHRegionHobject *

Model region pyramid

NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of pyramid levels.

Default value: 4

List of values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

ContrastContrastContrastContrastcontrastcontrast (input_control)  number(-array) HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Threshold or hysteresis thresholds for the contrast of the object in the image and optionally minimum size of the object parts.

Default value: 30

Suggested values: 10, 20, 30, 40, 60, 80, 100, 120, 140, 160

Result

If the parameters are valid, the operator inspect_shape_modelinspect_shape_modelInspectShapeModelInspectShapeModelInspectShapeModelinspect_shape_model returns the value TRUE. If necessary an exception is raised.

Possible Predecessors

reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain

Possible Successors

select_objselect_objSelectObjSelectObjSelectObjselect_obj

See also

create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model

Module

Foundation