| Property Name |
Property Type |
Description |
| BarcodeDetectionSettings |
Grooper.IP.ReadBarcodes |
Defines the type of barcodes to be detected and options which control the barcode detection process. |
| BinarizationSettings |
Grooper.IP.Binarize |
Defines settings for creating the binarized image used during feature detection. A "binarized" image is an 8 bit-per-pixel black and white version of the input image which is used for feature detection. It is generated from the source image
at runtime using the thresholding settings defined here, with the goal of producing an image where the features to be detected are clearly visible.
This command outputs an diagnostic image named "Binarized" which allows binarization output to be reviewed and tuned. Note that if adaptive thresholding is used, it will be applied to images which are already black and white. Because adaptive thresholding tends to eliminate
dark areas from the document, it can provide useful preprocessing for tasks such as line detection, where dark areas produce many line candidates which must be analyzed
and processed. |
| BorderExpand |
System.String |
The amount to expand detected barcode regions. Adjust this value as needed to ensure that the entire barcode is removed. |
| CommandTypeName |
System.String |
The type of IP command. |
| 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. |
| 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 |
| |
|
| BinarizeImage(Image As GrooperImage, Result As IpCommandResult) As GrooperImage |
Responsible for creating the binarized image which is used during feature detection.
| Parameters |
| Image |
| Type: GrooperImage |
| |
| |
| Result |
| Type: IpCommandResult |
| |
|
| GetMask(Image As GrooperImage, Result As IpCommandResult) As GrooperImage |
| Parameters |
| Image |
| Type: GrooperImage |
| |
| |
| Result |
| Type: IpCommandResult |
| |
|
| GetMaskBinary(BinarizedImage As GrooperImage, OriginalImage As GrooperImage, Result As IpCommandResult) As GrooperImage |
| Parameters |
| BinarizedImage |
| Type: GrooperImage |
| |
| |
| OriginalImage |
| 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. |