Installation

The package is available at nuget.org and it can be installed via package manager console by executing following command:

PM> NuGet\Install-Package Aspose.OMR-Cloud

Perform OMR Operations with Cloud .NET SDK

Aspose.OMR Cloud SDK for .NET allows developers to integrate Optical Mark Recognition (OMR) functionality into their cloud-based applications with ease. It supports the creation of machine-readable forms using customizable text or JSON markup, enabling developers to generate and recognize forms without manual intervention. The SDK supports multiple formats such as PDF, JPG, and PNG for both input and output, and it returns recognition results in popular formats like JSON, XML, and CSV. The OMR Cloud SDK simplifies form generation, personalization, and recognition for various use cases, including surveys, exams, and ballots, ensuring high recognition accuracy even with smartphone photos.

OMR Form Creation

Machine-Readable Form Generation

Generate machine-readable forms using customizable text or JSON markup languages.

Form Personalization

Add logos, barcodes, QR codes, and images to personalize OMR forms.

OMR Processing and Recognition

Automated Form Recognition

Recognize filled OMR forms through API calls without the need for manual processing.

High-Accuracy Recognition

Achieve high recognition accuracy for various types of images, including smartphone photos.

Multi-Page Form Support

Process multi-page forms with consistent recognition results across all pages.

File Format Support

Supported Image Formats

Recognize a variety of image formats, including PDF, JPG, PNG, TIFF, and GIF.

Recognition Result Formats

Return recognition results in formats such as JSON, XML, and CSV for easy integration into databases.

Designing machine-readable forms

Text markup

Lightweight text markup language specifically tailored for Aspose.OMR Cloud.

JSON markup

Describe forms as nested data structures using JSON, the most popular data exchange format.

Text markup

Layout

Arrange other elements and define the appearance and design of machine-readable forms.

Questionnaires

Build surveys, ballots, checklists, and similar forms that are OMR-ready.

Answer sheets

Populate a form with a grid of bubbles representing answers to an exam, test, or assessment.

Barcodes and QR codes

Add barcodes and QR codes to personalize or uniquely identify a form.

Write-ins

Provide a blank field in which the respondent can handwrite some text or draw a picture.

JSON markup

Template Structure

The top-level element of the Aspose.OMR template source must always be an object with a specific structure, including pages and children elements.

Elements

JSON markup includes a wide range of elements like Layout, Questionnaires, and Barcodes, similar to text markup.

Generating machine-readable forms

Form generation

Aspose.OMR Cloud generates a printable OMR form in 3 API calls: get access token, send form source code for rendering, and fetch the form and recognition pattern.

Recognizing machine-readable forms

Recognition Process

Recognize a filled form in 3 API calls: get access token, send the form’s image for recognition, and fetch the recognition results.

Appendices

Color codes

Provides a list of color codes that can be used for form customization.

Font families

Lists supported font families for form generation.

SDK Support

Multi-Language SDKs

Access open-source SDKs for .NET, Java, Python, Node.js, and other languages to simplify API integration.

Cross-Platform Compatibility

Use OMR Cloud SDKs in web-based and on-premise applications across multiple platforms.

Supported File Formats

Template Sources

Printable Forms

Filled Forms

Multi-page PDF and TIFF recognition is not supported as yet; scan each page separately.

Recognition Results

Supported Color Codes

Supported Font Families

System Requirements

Quick Start

1. Sign in and Obtain Credentials

• Log in to the GroupDocs Cloud API Dashboard.
• Go to the Applications page, create cloud storage, and save your application.
• Copy the Client ID and Client Secret for your application.

2. Install Aspose.OMR Cloud SDK for .NET

• You do not need any separate installation. Create an account at Aspose for Cloud and get your application information.

• In Visual Studio, open the Package Manager Console and run:

  Install-Package Aspose.OMR-Cloud
  

• If you want to upgrade to the latest version of the SDK, execute:

  Update-Package Aspose.OMR-Cloud
  

3. Request Access Token

• Use Client ID and Client Secret to request an access token by sending a POST request to https://api.aspose.cloud/connect/token.
• Ensure the parameters grant_type, client_id, and client_secret are correctly filled.

4. Authorize REST API Requests

• Include the access token in the Authorization header for each API request using Bearer authentication.

5. Authorize SDK Requests

• Pass Client ID and Client Secret when initializing the SDK to handle all token and API requests:

  Configuration conf = new Configuration();
  conf.AppSid = "CLIENT-ID-VALUE";
  conf.AppKey = "CLIENT-SECRET-VALUE";
  OmrApi api = new OmrApi(conf);
  

Resizing an OMR Form Template with Aspose.OMR Cloud .NET SDK

Learn how to resize a machine-readable OMR form template using Aspose.OMR Cloud SDK for .NET and fetch high-precision recognition results.

using System;
using Aspose.OMR.Cloud.Sdk.Model.Requests;

public class ResizeTemplateExample
{
    public void ResizeTemplate()
    {
        // Define template name and format
        string templateName = "SampleTemplate.omr";
        string folder = "OMR_Templates"; // Folder where the template is stored

        // Create a request to resize the OMR form
        var request = new ResizeTemplateRequest(templateName, 210, 297, folder); // Resize to A4 dimensions

        // Call the OMR Cloud API to resize the template
        var response = OmrApi.ResizeTemplate(request);

        // Print out success message with new template size
        Console.WriteLine("Template resized successfully. New size: A4");
    }
}

Convert OMR Form Results to CSV Using Aspose.OMR Cloud SDK

Easily convert OMR form recognition results to CSV format with Aspose.OMR Cloud SDK for .NET. Process and export data effortlessly.

using System;
using Aspose.OMR.Cloud.Sdk.Model.Requests;

public class ConvertOMRResultsToCSV
{
    public void ConvertToCSV()
    {
        // Define recognized form image name and format
        string imageName = "FilledForm.jpg"; 
        string folder = "OMR_Results"; // Folder where results are stored

        // Create a request to convert the recognized form results to CSV
        var request = new ConvertOMRResultsRequest(imageName, "CSV", folder);

        // Execute the conversion using OMR Cloud API
        var response = OmrApi.ConvertOMRResults(request);

        // Output the success message
        Console.WriteLine("Recognition results converted to CSV successfully.");
    }
}

Generate Printable OMR Form with Aspose.OMR REST API

Generate high-quality printable OMR forms using Aspose.OMR Cloud SDK for .NET and automate form creation with simple API calls.

using System;
using Aspose.OMR.Cloud.Sdk.Model.Requests;

public class GeneratePrintableOMRForm
{
    public void GenerateForm()
    {
        // Define template source code and the output format
        string templateSource = "SampleTemplate.omr"; 
        string outputFormat = "PDF"; // Output format for the generated form

        // Create a request to generate a printable OMR form
        var request = new GenerateOMRFormRequest(templateSource, outputFormat);

        // Execute the request using the OMR Cloud API
        var response = OmrApi.GenerateOMRForm(request);

        // Save the generated form to cloud storage
        Console.WriteLine("Printable OMR form generated successfully in PDF format.");
    }
}