Nutrient Java SDK/io.nutrient.sdk.settings/OmrSettings

OmrSettings

public final class OmrSettings

Settings for Omr. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document's settings, otherwise the SDK globally when set on SdkSettings.

Functions

getAdaptiveCharacterLevel

public final float getAdaptiveCharacterLevel()

Fraction of the paper level below which ink is as dark as the printed character.

getAdaptiveCharacterVisibleCoverage

public final float getAdaptiveCharacterVisibleCoverage()

Portion of the bubble holding character-dark ink above which the printed character counts as still visible — the signature of an erased mark rather than a deliberate one.

getAdaptiveDeepShadeLevel

public final float getAdaptiveDeepShadeLevel()

Fraction of the paper level below which ink counts as deliberate shading.

getAdaptiveDiscRadius

public final float getAdaptiveDiscRadius()

Radius of the analyzed bubble interior, as a fraction of the field size, chosen to sit inside the printed ring.

getAdaptiveFieldPaperSanity

public final float getAdaptiveFieldPaperSanity()

A field whose own paper reads darker than this fraction of the page's paper is overfilled past its margins; its paper estimate is untrustworthy, so the page's is used instead.

getAdaptiveInkMargin

public final float getAdaptiveInkMargin()

Fraction below a field's paper level at which ink starts counting as a mark.

getAdaptiveMarkDeepCoverage

public final float getAdaptiveMarkDeepCoverage()

Portion of the bubble that deliberate shading must cover for the field to be a mark.

getAdaptiveMarkShadeCoverage

public final float getAdaptiveMarkShadeCoverage()

Portion of the bubble that light shading must cover for the field to be a mark, provided the printed character is also covered.

getAdaptiveMinimumPaper

public final int getAdaptiveMinimumPaper()

Paper darker than this absolute level is not believed to be paper; the page-wide level is used for that field instead.

getAdaptivePaperPercentile

public final int getAdaptivePaperPercentile()

Percentile of a field's pixels taken to represent its paper level.

getEnableAdaptiveBinarization

public final boolean getEnableAdaptiveBinarization()

Indicates whether the black and white reduction threshold applied before mark detection is derived from the image, rather than using a fixed value.

setAdaptiveCharacterLevel

public final void setAdaptiveCharacterLevel(float value)

Fraction of the paper level below which ink is as dark as the printed character.

setAdaptiveCharacterVisibleCoverage

public final void setAdaptiveCharacterVisibleCoverage(float value)

Portion of the bubble holding character-dark ink above which the printed character counts as still visible — the signature of an erased mark rather than a deliberate one.

setAdaptiveDeepShadeLevel

public final void setAdaptiveDeepShadeLevel(float value)

Fraction of the paper level below which ink counts as deliberate shading.

setAdaptiveDiscRadius

public final void setAdaptiveDiscRadius(float value)

Radius of the analyzed bubble interior, as a fraction of the field size, chosen to sit inside the printed ring.

setAdaptiveFieldPaperSanity

public final void setAdaptiveFieldPaperSanity(float value)

A field whose own paper reads darker than this fraction of the page's paper is overfilled past its margins; its paper estimate is untrustworthy, so the page's is used instead.

setAdaptiveInkMargin

public final void setAdaptiveInkMargin(float value)

Fraction below a field's paper level at which ink starts counting as a mark.

setAdaptiveMarkDeepCoverage

public final void setAdaptiveMarkDeepCoverage(float value)

Portion of the bubble that deliberate shading must cover for the field to be a mark.

setAdaptiveMarkShadeCoverage

public final void setAdaptiveMarkShadeCoverage(float value)

Portion of the bubble that light shading must cover for the field to be a mark, provided the printed character is also covered.

setAdaptiveMinimumPaper

public final void setAdaptiveMinimumPaper(int value)

Paper darker than this absolute level is not believed to be paper; the page-wide level is used for that field instead.

setAdaptivePaperPercentile

public final void setAdaptivePaperPercentile(int value)

Percentile of a field's pixels taken to represent its paper level.

setEnableAdaptiveBinarization

public final void setEnableAdaptiveBinarization(boolean value)

Indicates whether the black and white reduction threshold applied before mark detection is derived from the image, rather than using a fixed value.