Aspose.OMR for .NET 22.5 Release Notes

What was changed

Known issues and limitations

Public API changes and backwards compatibility

This section lists all public API changes introduced in Aspose.OMR for .NET 22.5 that may affect the code of existing applications.

Added public APIs:

The following public APIs have been introduced in this release:

Aspose.OMR.Api.OmrEngine.GetTemplateProcessor

Added an overload method that accepts the following parameters:

• templateContent - the content of the recognition pattern (.OMR) file as System.IO.MemoryStream object.
• textEncoding - the recognition pattern (.OMR) file encoding (System.Text.Encoding).

Returns Aspose.OMR.Api.TemplateProcessor object.

Aspose.OMR.Model.RecognitionResult.GetCsv

Added an overload method that accepts the following parameters:

• encoding - the actual encoding (System.Text.Encoding) of the returned byte array.

Returns recognition results in CSV format as an array of bytes.

Aspose.OMR.Model.RecognitionResult.GetCsvAsStream

Added a new method that accepts the following parameters:

• encoding - the actual encoding (System.Text.Encoding) of the returned byte array.

Returns recognition results in CSV format as a System.IO.MemoryStream object.

Aspose.OMR.Model.RecognitionResult.GetJson

Added an overload method that accepts the following parameters:

• encoding - the actual encoding (System.Text.Encoding) of the returned byte array.

Returns recognition results in JSON format as an array of bytes.

Aspose.OMR.Model.RecognitionResult.GetJsonAsStream

Added a new method that accepts the following parameters:

• encoding - the actual encoding (System.Text.Encoding) of the returned byte array.

Returns recognition results in JSON format as a System.IO.MemoryStream object.

Aspose.OMR.Model.RecognitionResult.GetXml

Added an overload method that accepts the following parameters:

• encoding - the actual encoding (System.Text.Encoding) of the returned byte array.

Returns recognition results in XML format as an array of bytes.

Aspose.OMR.Model.RecognitionResult.GetXmlAsStream

Added a new method that accepts the following parameters:

• encoding - the actual encoding (System.Text.Encoding) of the returned byte array.

Returns recognition results in XML format as a System.IO.MemoryStream object.

Aspose.OMR.Api.GenerateJSONTemplateFromString

Added a new method that accepts the following parameters:

• jsonString - source code in JSON markup as a string.
• settings - Aspose.OMR.Generation.GlobalPageSettings object. Optional.
• userImages - form images, as Aspose.OMR.Api.ImageCollection object. Optional.

Returns Aspose.OMR.Generation.GenerationResult object.

Aspose.OMR.Api.ImageCollection

Added a new class for loading form images from memory. Works as a collection of key-value pairs where the key contains the image file name and the value contains the binary content (System.IO.MemoryStream) of the image file. Exposes the following methods:

Add

Adds an image to ImageCollection. Accepts the following parameters:

• imageName - image file name, case-sensitive.
  An error occurs if a file with the same name has already been added.
• stream - binary content of the image file, as System.IO.MemoryStream object.

Updated public APIs:

The following public APIs has been updated in this release:

Aspose.OMR.Api.GenerateTemplate(string[], ImageCollection)

Added an optional parameter to the method:

• userImages - form images, as Aspose.OMR.Api.ImageCollection object. Optional.

Aspose.OMR.Api.GenerateTemplate(string[], GlobalPageSettings, ImageCollection)

Added an optional parameter to the method:

• userImages - form images, as Aspose.OMR.Api.ImageCollection object. Optional.

Aspose.OMR.Api.GenerateTemplate(MemoryStream, ImageCollection)

Added an optional parameter to the method:

• userImages - form images, as Aspose.OMR.Api.ImageCollection object. Optional.

Aspose.OMR.Api.GenerateTemplate(MemoryStream, GlobalPageSettings, ImageCollection)

Added an optional parameter to the method:

• userImages - form images, as Aspose.OMR.Api.ImageCollection object. Optional.

Aspose.OMR.Api.GenerateTemplate(TemplateConfig, GlobalPageSettings, ImageCollection)

Added an optional parameter to the method:

• userImages - form images, as Aspose.OMR.Api.ImageCollection object. Optional.

Removed public APIs:

No changes.

Changes in application logic

This section lists any changes to the program architecture and form processing algorithms introduced in Aspose.OMR for .NET 22.5 that may affect the behavior of existing applications.

CompositeGrid recognition

In previous versions of Aspose.OMR for .NET, it was possible to mark more than one bubble per grid row or column (depending on the element’s orientation). The values from all marked bubbles were merged into one result, which may result in a response longer than the element’s columns_count property.

Starting with Aspose.OMR for .NET 22.5, only one bubble per row or column is allowed to be marked. If the respondent marks more than one bubble, the affected CompositeGrid element will not be recognized and an error will be written to the recognition results.

Usage examples

See the examples below to learn more about the changes introduced in this release:

Providing the recognition pattern from memory

string recognitionPattern = File.ReadAllText(@"C:\Template\form.omr");
var buffer = Encoding.UTF8.GetBytes(recognitionPattern);
OmrEngine omrEngine = new OmrEngine();
TemplateProcessor templateProcessor = null;
using(MemoryStream stream = new MemoryStream(buffer))
{
	templateProcessor = omrEngine.omrEngine.GetTemplateProcessor(stream, Encoding.UTF8);
}
RecognitionResult result = templateProcessor.RecognizeImage(@"survey\form20220520.png");

Storing recognition results in different object types

OmrEngine omrEngine = new OmrEngine();
TemplateProcessor templateProcessor = omrEngine.GetTemplateProcessor(@"C:\Template\form.omr");
RecognitionResult recognitionResult = templateProcessor.RecognizeImage(@"survey\form20220520.png");
string resultString = recognitionResult.GetCsv();
byte[] resultArray = recognitionResult.GetCsv(Encoding.UTF8);
MemoryStream resultStream = recognitionResult.GetCsvAsStream(Encoding.UTF8);

Generating a form with images

Form source code:

?image=aspose-logo.png
	align=center
?text=Customer Satisfaction Survey
	align=center
	font_size=16
	font_style=bold
?image=vignette.png
	align=center

Generator:

// Read source code
string sourceCode = File.ReadAllText(@"form\source.txt");
var buffer = Encoding.UTF8.GetBytes(sourceCode);
// Load image files
ImageCollection images = new ImageCollection();
images.Add("aspose-logo.png", new MemoryStream(File.ReadAllBytes(@"form\images\aspose-logo.png")));
images.Add("vignette.png", new MemoryStream(File.ReadAllBytes(@"C:\Users\Public\Pictures\vignette.png")));
// Generate form
OmrEngine omrEngine = new OmrEngine();
using(MemoryStream source = new MemoryStream(buffer))
{
	GenerationResult generationResult = omrEngine.GenerateTemplate(source, images);
	generationResult.Save(@"C:\result\", "OMR-Form");
}

Generating form from JSON source code provided as string

string sourceCode = File.ReadAllText(@"form\source.json");
OmrEngine omrEngine = new OmrEngine();
GenerationResult generationResult = omrEngine.GenerateJSONTemplateFromString(sourceCode);
generationResult.Save(@"C:\result\", "OMR-Form");

Rounded element borders

Text markup

?container=
?block=
	border=square
?content=SQUARE
&block
?block=
	border=rounded
?content=ROUND
&block
&container

JSON markup

{
	"element_type": "Template",
	"children": [
		{
			"element_type": "Page",
			"children": [
				{
					"element_type": "Container",
					"name": "Example",
					"children": [
						{
							"element_type": "Block",
							"border": "square",
							"children": [
								{
									"element_type": "Content",
									"name": "SQUARE"
								}
							]
						},
						{
							"element_type": "Block",
							"border": "rounded",
							"children": [
								{
									"element_type": "Content",
									"name": "ROUND"
								}
							]
						}
					]
				}
			]
		}
	]
}

Result