IP commands perform image processing work, such as image cleanup, format conversion, or feature detection.
IP Commands are used to construct IP Profiles, and are also used as stand-alone properties on some Grooper types.
Some IP Commands modify the images they process, while other IP Commands simply detect features in an image, without modifying the image in any way.
Each IP Command defines a set of supported pixel formats. If an image with an unsupported pixel format is encountered, the command will take no action.
| Property Name |
Property Type |
Description |
| CommandTypeName |
System.String |
The type of IP command. |
| 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 |
| |
|
| 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. |
|
| ProcessImage(Image As GrooperImage, Commands As IEnumerable(Of IpCommand)) As GrooperImage |
| Parameters |
| Image |
| Type: GrooperImage |
| |
| |
| Commands |
| Type: IEnumerable`1 |
| |
|
| 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. |
| ValidateUnits(PropertyName As String, TextValue As String) As ValidationErrorList |
| Parameters |
| PropertyName |
| Type: String |
| |
| |
| TextValue |
| Type: String |
| |
|