Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GitHub license GitHub last commit

Java REST API for OMR Processing

Aspose.OMR for Cloud is a REST API that helps you to perform optical mark recognition in the cloud. We provide a series of SDKs. Along with that, you can get binaries to start working immediately and recognize various OMR forms.

Developers can embed optical recognition in any type of application to extract data from images of tests, exams, questionnaires, surveys, etc. In the repository you can find examples on how to start using Aspose.OMR API in your project.

OMR Processing Features

  • Perform recognition of scanned photos and images for OMR operations.
  • Ability to perform OMR on rotated & perspective (within 25 deg) photos.
  • Extract & recognize human-marked data from scanned tests, exams, surveys, etc.
  • Supports the export of OMR results to CSV file format.
  • Use textual markup to generate OMR templates, generate surveys, and test sheets.
  • Availability of GUI application for managing OMR templates.
  • Specify the number of OMR based questions & answers in the template.
  • Availability of GUI OMR editor as a cloud client.
  • Provide JSON rules to perform OMR answer grading.
  • Clip an area of interest from an image, save it as JPEG & perform OMR on it.
  • Perform highly accurate optical mark recognition (OMR).

Save OMR As

CSV

Read OMR Formats

JPEG, PNG, BMP, TIFF, PDF

Quickstart

You can perform tasks out of the box without writing a single line of code with our GUI client. You can also refer to the client documentation.

Using OMR Cloud API in your Java projects

Requirements

Building the API client library requires Maven to be installed.

GitHub Repository

Source code available in our GitHub repository https://github.com/aspose-omr-cloud/aspose-omr-cloud-java.git

Installation

Clone repository

Clone aspose-omr-cloud with submodules:

git clone https://github.com/aspose-omr-cloud/aspose-omr-cloud-java.git --recurse-submodules

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.aspose</groupId>
    <artifactId>aspose-omr-cloud</artifactId>
    <version>18.8.0</version>
    <scope>compile</scope>
</dependency>

Optional requirements

To take full advantage of Aspose.OMR for Cloud, aspose-cloud-storage is required. You may refer to official Aspose Storage SDK to get more information.

Usage

Receive Cloud Keys

Aspose.Cloud credentials are required to use Aspose.OMR for Cloud API. You can acquire App SID and App Key by registrating at Aspose Cloud Dashboard. It will take only a couple of minutes.

Gradle / Android Studio users

For Gradle v3.0 and up add this dependency to your project's build file:

implementation "com.aspose:aspose-omr-cloud:18.8.0"

For older Gradle projects add this dependency to your project's build file:

compile "com.aspose:aspose-omr-cloud:18.8.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/aspose-omr-cloud-18.8.0.jar
  • target/lib/*.jar

Getting Started

Update submodule

Make sure you've cloned aspose-omr-cloud-demo-data submodule, that contains all data required to run demo. In case you are missing submodules use the following git commands to initialize and update them:

git submodule init
git submodule update --remote --merge

Code example

You can check out OMR Demo project to get started with Aspose.OMR for Cloud.

Documentation for API Endpoints

All URIs are relative to https://api.aspose.cloud/v1.1

Class Method HTTP request Description
OmrApi postRunOmrTask POST /omr/{name}/runOmrTask Run specific OMR task

Documentation for Models

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Authorization

Library uses OAUTH2 internally

Aspose.OMR Cloud SDKs in Popular Languages

.NET Java PHP Python Ruby Node.js
GitHub GitHub GitHub GitHub GitHub GitHub
NuGet Maven Composer PIP GEM NPM

Product Page | Documentation | API Reference | Code Samples | Blog | Free Support | Free Trial|

About

Java library for communicating with the Aspose.OMR Cloud API

Topics

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.