Aspose.OMR FOSS for Python
API reference for Aspose.OMR FOSS for Python. 68 public types organized by module.
Api
| Class | Description |
|---|---|
ImageCollection | Append-only, case-sensitive name -> image-bytes map for in-memory images referenced by markup (?image=). |
OmrEngine | The OMR engine: a stateless factory producing generation results and recognizers. |
TemplateProcessor | Processes OMR images against the template it was created from. |
Exceptions
| Class | Description |
|---|---|
ChildOverflowException | Raised when a child element overflows its parent and overflow handling is configured to throw (see OverflowActions / LongWordHandling). |
InvalidConfigurationException | Raised when a template / element configuration is invalid or unsupported. |
MultiselectException | Raised when more than one bubble is marked for a question that does not allow multi-select, and FormValidationLogic.Exception is active. |
OMRException | Base class for every exception raised by the OMR library. |
RuntimeExceptionOMR | Raised on an internal, unrecoverable generation/recognition failure. |
Generation
| Class | Description |
|---|---|
AnswerSheetConfig | Numbered question/answer bubble matrix. |
Arabic | Right-to-left; optionally Eastern-Arabic digits. |
BaseConfig | Root abstraction; the required fields of every OMR element. |
BaseOffset | Base class for generation layout offsets. |
Bengali | Left-to-right; optionally Bengali digits. |
BlockConfig | Bordered/padded box; lays out its non-block children with overflow handling. |
BorderStyle | Describes the border of ONE side of an element. |
CheckBoxConfig | Labeled group of blank boxes accepting any mark, with a tunable fill Threshold (default 3%). |
ChoiceBoxAnswerConfig | One answer bubble + label. |
ChoiceBoxConfig | A single question with a fixed set of option bubbles. |
Clip | Truncate overflowing content at the parent’s border. |
CompositeGridConfig | Flexible grid with custom symbols; marks merge into one value. |
ContainerConfig | Invisible layout element arranging child blocks into columns or a footer. |
ContentConfig | One styled text line inside a parent. |
EmptyLineConfig | Vertical spacer. |
GenerationResult | The result of template generation: the page image(s) plus the .omr template JSON describing element locations. |
GlobalPageSettings | Document-wide defaults applicable to all page elements; per-element overridable. |
GridConfig | Digit matrix (SectionsCount sections x OptionsCount 0-9 bubbles) merged into one value. |
Hebrew | Right-to-left; optionally Hebrew numbering. |
ImageConfig | Picture referenced by name. |
MemoryGenerationResult | Wrapper around GenerationResult exposing outputs as in-memory streams. |
NoClip | Do nothing; overflowing content is drawn past the parent’s border (default). |
OverflowAction | Base class for child-overflow handling algorithms. |
PageConfig | One per physical page. |
ParentConfig | Marks an element that can contain children. |
Persian | Right-to-left; optionally Persian digits. |
PixelOffset | Pixel-unit layout offset (per-edge integer pixel values). |
PositionedBlockConfig | Places children at absolute XPosition/YPosition with optional size. |
ReferencePointsSettings | Corner reference marks + rotation-marker rectangle used for de-skew during recognition. |
TemplateConfig | The document root that contains everything else (normally PageConfigs). |
TextConfig | Top-level multi-line raw text block. |
Urdu | Right-to-left; optionally Urdu digits. |
Western | Default writing system: left-to-right, Western (0-9) digits. |
Wrap | Relocate an overflowing child (column reflow / element splitting). |
WritingSystem | Base writing system (LTR, Western digits). |
Enumerations
| Enumeration | Description |
|---|---|
AlignmentEnum | Horizontal alignment of an element relative to its parent. |
BarcodeType | The symbology used by a BarcodeConfig. |
BubblePositionType | Where the bubble sits relative to its main content (answer text). |
BubbleSize | Answer-bubble size. |
BubbleType | The shape of an answer bubble. |
ConfigType | Discriminator identifying which *Config element a node is. |
ContainerTypeEnum | How a ContainerConfig is placed on the page. |
ContentType | How text content is rendered. |
Directionality | Direction in which elements and text are drawn (RTL/LTR support). |
FontStyle | Flag-like font style; members may be combined. |
GridHeaderTypeEnum | The style of a grid’s header. |
LongWordHandling | Behavior when generation meets a word wider than its parent container. |
Orientation | Enum with 3 members. |
PaperSize | Output page size. |
ParagraphTypeEnum | How a ParagraphConfig arranges its children. |
QRVersion | QR symbol version for a QR-family BarcodeConfig. |
RotationPointPosition | Placement of the orientation (rotation) marker relative to the page. |
ScoreDisplay | Controls whether/how a score value is shown. |
ScoreGroupType | Drawing mode of a score-group element. |
ScoreHeaderType | Role of a column header inside a score group. |
TriggerType | Behavior of a trigger (used by CustomTriggerConfig). |
VerticalAlignment | Vertical positioning of a child element inside its parent. |
Model
| Class | Description |
|---|---|
IOmrElement | The interface for the OMR elements (one recognized question/element). |
RecognitionResult | The result of image recognition. |
Recognition
| Enumeration | Description |
|---|---|
FormValidationLogic | Controls engine behavior when a template validation rule is broken during recognition. |