Grooper.IP.ShapeRemoval

Detects and removes regions of an image which match one or more trained image templates. Use this command to remove seals, logos, and other arbitrary shapes from an image.


Inherits from: Grooper.IP.FeatureDropout

Constructors

Signature Description
New (Owner As ConnectedObject)
Parameters
Owner
          Type: ConnectedObject
          

Fields

Field Name Field Type Description
Database As Grooper.GrooperDb Grooper.GrooperDb

Properties

Property Name Property Type Description
Binarization Grooper.IP.Binarize Defines settings for binarizing color and grayscale input images. Review the 'Binarized' diagnostic image when tuning this property. The objective is to produce an image where the shape to be removed is clearly visible.
CommandTypeName System.String The type of IP command.
DetectionSettings Grooper.IP.ShapeDetection Specifies settings for shape detection.
DilationFactor System.Int32 The amount by which a matching template image should be dilated during pixel extraction. Dilation helps to account for small variations between an image template and the input image. When one or more matching shapes are detected, the process for creating the Dropout Mask is as follows:
  • A blank 'Shape Mask' image is created.
  • The template image for each shape is copied to the Shape Mask at the detected location, orientation, and scale.
  • The Shape Mask is dilated by the Dilation Factor specified here.
  • All blobs on the input image which intersect a region on the Shape Mask are copied to the Dropout Mask.

>Review the 'Shape Mask' diagnostic image when tuning this property. The objective is to dilate the shape just enough to ensure that all feature pixels are extracted to the Dropout Mask, without dilating it so much that other features in the image are affected.

Dilation helps to account for small variations between the image template and the input image.
Dropout Grooper.IP.DropoutMethod Specifies how masked regions will be removed from the image.
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
Owner Grooper.ConnectedObject Returns the node that owns the connected object, if any.
OwnerNode Grooper.GrooperNode Returns the node that owns the connected object, if any.
Root Grooper.GrooperRoot Returns the root node
SupportedFormats System.String The pixel formats supported by this command.
SupportedPixelFormats System.Collections.Generic.IEnumerable(Of T) Returns a list of supported pixel formats of images that can be processed by the IP Command.

Methods

Method Name Description
Apply(Image As GrooperImage, DiagMode As Boolean) As IpCommandResult
Parameters
Image
          Type: GrooperImage
          
 
DiagMode
          Type: Boolean
          
ApplyAtalaCommand(cmd As ImageCommand, Image As GrooperImage) As AtalaIpResult
Parameters
cmd
          Type: ImageCommand
          
 
Image
          Type: GrooperImage
          
ApplyCommand(Image As GrooperImage) As IpCommandResult
Parameters
Image
          Type: GrooperImage
          
ApplyImage(Image As GrooperImage) As GrooperImage
Parameters
Image
          Type: GrooperImage
          
ApplyMask(Image As GrooperImage, Mask As GrooperImage, Result As IpCommandResult) As GrooperImage
Parameters
Image
          Type: GrooperImage
          
 
Mask
          Type: GrooperImage
          
 
Result
          Type: IpCommandResult
          
GetMask(Image As GrooperImage, Result As IpCommandResult) As GrooperImage
Parameters
Image
          Type: GrooperImage
          
 
Result
          Type: IpCommandResult
          
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) Sets the owner of the connected object with another object that implements the IConnected interface.
Parameters
Owner
          Type: ConnectedObject
          
 
SkipInitialization
          Type: Boolean
          
ToString() As String Returns a string value representation of the connected object.
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.