OMR Zones are used for Optical Mark Recognition (OMR), to read the state of checkboxes and determine if they are checked or unchecked.
OMR Zones work by measuring the black pixel ratio in each zone.
There are 3 possible configurations for OMR zones:
| Property Name |
Property Type |
Description |
| AutoAlign |
Grooper.OCR.OmrAutoAlignSettings |
If enabled, automatically aligns the zone to the nearest blob which matches a size range. |
| Bounds |
Grooper.RectangleExF |
The location of the zone. |
| ContentType |
Grooper.Core.ContentType |
Returns the ContentType on which this zone is defined. |
| DisplayName |
System.String |
The display name of this object. |
| Field |
Grooper.Core.DataField |
Returns the Data Field object associated with this zone. |
| FieldProfile |
Grooper.Core.FieldProfile |
Returns the Field Profile on which this zone is defined. |
| HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
| HasRegistrationZones |
System.Boolean |
Returns true if this zone has at least one Registration Zone as a child. |
| IpProfile |
Grooper.IP.IpProfile |
The IP Profile to run prior to zonal extraction. This IP Profile performs temporary image cleanup prior to extraction. It does not permanently alter the image. |
| 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. |
| OmrNegativeValue |
System.String |
The value to be stored in the field when an OMR read is negative. The variable '{Ratio}' can be inserted to return the actual black-white pixel ratio of the OMR zone. |
| OmrPositiveValue |
System.String |
The value to be stored in the field when an OMR read is positive. The variable '{Ratio}' can be inserted to return the actual black-white pixel ratio of the OMR zone. |
| OmrThreshold |
System.Double |
The percentage of black pixels above which an OMR zone is considered filled. |
| 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. |
| PageNo |
System.Int32 |
The page number associated with this zone. A negative value indicates on offset starting at the end of the document. For example, -1 indicates the last page of the document
-2 indicates the 2nd to last page of the document, and etc. |
| Root |
Grooper.GrooperRoot |
Returns the root node |
| Method Name |
Description |
| AddRegistrationZone(Zone As CaptureZone) |
Adds a new RegistrationZone as a child of this zone.
|
| Clone() As CaptureZone |
Returns a clone of this object. |
| DeleteRegistrationZone(Id As Guid) |
Deletes a child RegistrationZone.
| Parameters |
| Id |
| Type: Guid |
| The Id of the zone to delete. |
|
| GetLastError() As String |
Returns the message from a previous error. |
| GetProperties() As PropertyDescriptorCollection |
|
| GetReferences() As List(Of GrooperNode) |
Returns list of nodes referenced by this object or its children. |
| GetRegistrationLocations(Source As FieldContainerInstance, RegZones As IEnumerable(Of RegistrationZone)) As List(Of RegistrationLocation) |
Obtains a list of registration locations to be used for this zone.
| Parameters |
| Source |
| Type: FieldContainerInstance |
| The source DataInstance. |
| |
| RegZones |
| Type: IEnumerable`1 |
| |
|
| GetRuntimePageNo(NumPages As Int32) As Int32 |
Generates the runtime page number for a document with N pages.
| Parameters |
| NumPages |
| Type: Int32 |
| The number of pages in the document. |
|
| 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. |
|
| ReadInstance(Location As RegistrationLocation, Source As FieldContainerInstance) As ExtractZoneResult |
Performs extraction for this zone.
| Parameters |
| Location |
| Type: RegistrationLocation |
| The registration location to use. |
| |
| Source |
| Type: FieldContainerInstance |
| The source data instance. |
|
| ReadInstances(Source As FieldContainerInstance, RegZones As IEnumerable(Of RegistrationZone)) As List(Of ExtractZoneResult) |
Performs extraction for this zone.
| Parameters |
| Source |
| Type: FieldContainerInstance |
| The source DataInstance. |
| |
| RegZones |
| Type: IEnumerable`1 |
| A list of shared registration zones |
|
| Serialize() As String |
Serializes the object. |
| SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
| Parameters |
| Database |
| Type: GrooperDb |
| |
|
| SetLastError(Message As String, pa() As Object()) |
| Parameters |
| Message |
| Type: String |
| |
| |
| pa |
| Type: Object |
| |
|
| 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 this object. |