sparkocr.enums#

Classes#

class AdaptiveThresholdingMethod#

Bases: enum.Enum

Method used to determine adaptive threshold for local neighbourhood in

weighted mean image.

• ‘gaussian’: apply gaussian filter

• ‘mean’: apply arithmetic mean filter

• ‘median’: apply median rank filter

GAUSSIAN = 'gaussian'#

MEAN = 'mean'#

MEDIAN = 'median'#

SINGH = 'singh'#

WOLF = 'wolf'#

class AdaptiveThresholdingMode#

Bases: enum.Enum

The mode parameter determines how the array borders are handled, where cval is the value when mode is equal to ‘constant’.

CONSTANT = 'constant'#

MIRROR = 'mirror'#

NEAREST = 'nearest'#

REFLECT = 'reflect'#

WRAP = 'wrap'#

class CellDetectionAlgos#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

CONTOURS = 'contours'#

MORPHOPS = 'morphops'#

class Color#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

aliceblue = (240, 248, 255)#

antiquewhite = (250, 235, 215)#

aqua = (0, 255, 255)#

aquamarine = (127, 255, 212)#

azure = (240, 255, 255)#

beige = (245, 245, 220)#

bisque = (255, 228, 196)#

black = (0, 0, 0)#

blanchedalmond = (255, 235, 205)#

blue = (0, 0, 255)#

blueviolet = (138, 43, 226)#

brown = (165, 42, 42)#

burlywood = (222, 184, 135)#

cadetblue = (95, 158, 160)#

chartreuse = (127, 255, 0)#

chocolate = (210, 105, 30)#

coral = (255, 127, 80)#

cornflowerblue = (100, 149, 237)#

cornsilk = (255, 248, 220)#

crimson = (220, 20, 60)#

cyan = (0, 255, 255)#

darkblue = (0, 0, 139)#

darkcyan = (0, 139, 139)#

darkgoldenrod = (184, 134, 11)#

darkgray = (169, 169, 169)#

darkgreen = (0, 100, 0)#

darkkhaki = (189, 183, 107)#

darkmagenta = (139, 0, 139)#

darkolivegreen = (85, 107, 47)#

darkorange = (255, 140, 0)#

darkorchid = (153, 50, 204)#

darkred = (139, 0, 0)#

darksalmon = (233, 150, 122)#

darkseagreen = (143, 188, 143)#

darkslateblue = (72, 61, 139)#

darkslategray = (47, 79, 79)#

darkturquoise = (0, 206, 209)#

darkviolet = (148, 0, 211)#

deeppink = (255, 20, 147)#

deepskyblue = (0, 191, 255)#

dimgray = (105, 105, 105)#

dodgerblue = (30, 144, 255)#

firebrick = (178, 34, 34)#

floralwhite = (255, 250, 240)#

forestgreen = (34, 139, 34)#

fuchsia = (255, 0, 255)#

gainsboro = (220, 220, 220)#

ghostwhite = (248, 248, 255)#

gold = (255, 215, 0)#

goldenrod = (218, 165, 32)#

gray = (128, 128, 128)#

green = (0, 128, 0)#

greenyellow = (173, 255, 47)#

honeydew = (240, 255, 240)#

hotpink = (255, 105, 180)#

indianred = (205, 92, 92)#

indigo = (75, 0, 130)#

ivory = (255, 255, 240)#

khaki = (240, 230, 140)#

lavender = (230, 230, 250)#

lavenderblush = (255, 240, 245)#

lawngreen = (124, 252, 0)#

lemonchiffon = (255, 250, 205)#

lightblue = (173, 216, 230)#

lightcoral = (240, 128, 128)#

lightcyan = (224, 255, 255)#

lightgoldenrodyellow = (250, 250, 210)#

lightgreen = (144, 238, 144)#

lightgrey = (211, 211, 211)#

lightpink = (255, 182, 193)#

lightsalmon = (255, 160, 122)#

lightseagreen = (32, 178, 170)#

lightskyblue = (135, 206, 250)#

lightslategray = (119, 136, 153)#

lightsteelblue = (176, 196, 222)#

lightyellow = (255, 255, 224)#

lime = (0, 255, 0)#

limegreen = (50, 205, 50)#

linen = (250, 240, 230)#

magenta = (255, 0, 255)#

maroon = (128, 0, 0)#

mediumaquamarine = (102, 205, 170)#

mediumblue = (0, 0, 205)#

mediumorchid = (186, 85, 211)#

mediumpurple = (147, 112, 219)#

mediumseagreen = (60, 179, 113)#

mediumslateblue = (123, 104, 238)#

mediumspringgreen = (0, 250, 154)#

mediumturquoise = (72, 209, 204)#

mediumvioletred = (199, 21, 133)#

midnightblue = (25, 25, 112)#

mintcream = (245, 255, 250)#

mistyrose = (255, 228, 225)#

moccasin = (255, 228, 181)#

navajowhite = (255, 222, 173)#

navy = (0, 0, 128)#

oldlace = (253, 245, 230)#

olive = (128, 128, 0)#

olivedrab = (107, 142, 35)#

orange = (255, 165, 0)#

orangered = (255, 69, 0)#

orchid = (218, 112, 214)#

palegoldenrod = (238, 232, 170)#

palegreen = (152, 251, 152)#

paleturquoise = (175, 238, 238)#

palevioletred = (219, 112, 147)#

papayawhip = (255, 239, 213)#

peachpuff = (255, 218, 185)#

peru = (205, 133, 63)#

pink = (255, 192, 203)#

plum = (221, 160, 221)#

powderblue = (176, 224, 230)#

purple = (128, 0, 128)#

red = (255, 0, 0)#

rosybrown = (188, 143, 143)#

royalblue = (65, 105, 225)#

saddlebrown = (139, 69, 19)#

salmon = (250, 128, 114)#

sandybrown = (244, 164, 96)#

seagreen = (46, 139, 87)#

seashell = (255, 245, 238)#

sienna = (160, 82, 45)#

silver = (192, 192, 192)#

skyblue = (135, 206, 235)#

slateblue = (106, 90, 205)#

slategray = (112, 128, 144)#

snow = (255, 250, 250)#

springgreen = (0, 255, 127)#

steelblue = (70, 130, 180)#

tan = (210, 180, 140)#

teal = (0, 128, 128)#

thistle = (216, 191, 216)#

tomato = (255, 99, 71)#

turquoise = (64, 224, 208)#

violet = (238, 130, 238)#

wheat = (245, 222, 179)#

white = (255, 255, 255)#

whitesmoke = (245, 245, 245)#

yellow = (255, 255, 0)#

yellowgreen = (154, 205, 50)#

class CompressionType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

JPEG = 'JPEG'#

LOSSLESS = 'LOSSLESS'#

class CropSquareType#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

BOTTOM_CENTER = 8#

BOTTOM_LEFT = 7#

BOTTOM_RIGHT = 9#

CENTER = 5#

CENTER_LEFT = 4#

CENTER_RIGHT = 6#

TOP_CENTER = 2#

TOP_LEFT = 1#

TOP_RIGHT = 3#

class DatasetType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

BASIC = 'basic'#

ITERABLE = 'iterable'#

class DetectorOutputFormat#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

HOCR = 'hocr'#

REGIONS = 'regions'#

class DicomCompression#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

JPEGBaseline8Bit = 'JPEGBaseline8Bit'#

JPEGLSLossless = 'JPEGLSLossless'#

RLELossless = 'RLELossless'#

class EngineMode#

Bases: enum.IntEnum

Enum where members are also (and must be) ints

DEFAULT = 3#

LSTM_ONLY = 1#

TESSERACT_LSTM_COMBINED = 2#

TESSERACT_ONLY = 0#

class FontStyle#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

AUTO = 'Auto'#

BOLD = 'Bold'#

PLAIN = 'Plain'#

class FrameSamplingStrategy#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

CONSECUTIVE = 'Consecutive'#

MIDDLE = 'Middle'#

RANDOM = 'Random'#

STRIDE = 'Stride'#

class ImageSchemaConversion#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

ASSEMBLER = 'assembler'#

INTERNAL = 'internal'#

class ImageType#

Bases: enum.IntEnum

Enum where members are also (and must be) ints

TYPE_3BYTE_BGR = 5#

TYPE_4BYTE_ABGR = 6#

TYPE_BYTE_BINARY = 12#

TYPE_BYTE_GRAY = 10#

TYPE_JPEG = 13#

TYPE_USHORT_GRAY = 11#

class KernelShape#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

DIAMOND = 'diamond'#

DISK = 'disk'#

OCTAGON = 'octagon'#

OCTAHEDRON = 'octahedron'#

SQUARE = 'square'#

STAR = 'star'#

class Language#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

ARA = 'ara'#

CHI = 'chi_sim'#

DAN = 'dan'#

DEU = 'deu'#

ENG = 'eng'#

FRA = 'fra'#

ITA = 'ita'#

KOR = 'kor'#

RUS = 'rus'#

SPA = 'spa'#

TUR = 'tur'#

VIE = 'vie'#

class ModelType#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

BASE = 'base'#

BEST = 'best'#

FAST = 'fast'#

class MorphologyOperationType#

Bases: enum.Enum

The morphological operation type

CLOSING = 'closing'#

DILATION = 'dilation'#

EROSION = 'erosion'#

OPENING = 'opening'#

class NoiseMethod#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

RATIO = 'ratio'#

VARIANCE = 'variance'#

class OcrOutputFormat#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

FORMATTED_TEXT = 'formatted_text'#

HOCR = 'hocr'#

JSON = 'json'#

TEXT = 'text'#

TEXT_WITH_POSITIONS = 'text_with_positions'#

class PageIteratorLevel#

Bases: enum.IntEnum

Enum where members are also (and must be) ints

BLOCK = 0#

PARAGRAPH = 1#

SYMBOL = 4#

TEXTLINE = 2#

WORD = 3#

class PageSegmentationMode#

Bases: enum.IntEnum

Enum where members are also (and must be) ints

AUTO = 3#

AUTO_ONLY = 2#

AUTO_OSD = 1#

CIRCLE_WORD = 9#

OSD_ONLY = 0#

SINGLE_BLOCK = 6#

SINGLE_BLOCK_VERT_TEXT = 5#

SINGLE_CHAR = 10#

SINGLE_COLUMN = 4#

SINGLE_LINE = 7#

SINGLE_WORD = 8#

SPARSE_TEXT = 11#

SPARSE_TEXT_OSD = 12#

class RelationOutputFormat#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

ANNOTATIONS = 'annotations'#

JSON = 'json'#

class SplittingStrategy#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

FIXED_NUMBER_OF_PARTITIONS = 0#

FIXED_SIZE_OF_PARTITION = 1#

class TableOutputFormat#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

CSV = 'csv'#

TABLE = 'table'#

class TextStripperType#

Bases: enum.Enum

Text Stripper Type

PDF_LAYOUT_TEXT_STRIPPER = 'PDFLayoutTextStripper'#

PDF_TEXT_STRIPPER = 'PDFTextStripper'#

class ThresholdingMethod#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

GAUSSIAN = 'gaussian'#

OTSU = 'otsu'#

SAUVOLA = 'sauvola'#

class TokenizerType#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

BASIC = 'basic'#

SIMPLE = 'simple'#

class VisualDocumentProcessorOcrEngines#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

EASYOCR = 'EasyOcr'#

OCRMAC = 'OcrMac'#

RAPIDOCR = 'RapidOcr'#

TESSERACT = 'TesseractOcr'#

TESSERACTCLI = 'TesseractCliOcrOptions'#