BarCodeReader Class Reference

BarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes. More...

Inherits BaseJavaClass.

Public Member Functions
def	__init__ (self, image, rectangles, decodeTypes)
	Initializes a new instance of the BarCodeReader :param: image encoded as base64 string or path to image :param: rectangles array of object by type Rectangle :param: decodeTypes the array of objects by DecodeType. More...
def	containsAny (self, decodeTypes)
	Determines whether any of the given decode types is included into :param: ...decodeTypes Types to verify. More...
def	init (self)
def	getTimeout (self)
	Gets the timeout of recognition process in milliseconds. More...
def	setTimeout (self, value)
	Sets the timeout of recognition process in milliseconds. More...
def	abort (self)
def	getFoundBarCodes (self)
	Gets recognized BarCodeResult array. More...
def	getFoundCount (self)
	Gets recognized barcodes count. More...
def	readBarCodes (self)
	Reads BarCodeResult from the image. More...
def	getQualitySettings (self)
	QualitySettings allows to configure recognition quality and speed manually. More...
def	setQualitySettings (self, value)
	QualitySettings allows to configure recognition quality and speed manually. More...
def	getBarcodeSettings (self)
	The main BarCode decoding parameters. More...
def	setBarCodeImage (self, image, areas)
	Sets bitmap image and areas for Recognition. More...
def	setBarCodeReadType (self, types)
	Sets SingleDecodeType type array for Recognition. More...
def	getBarCodeDecodeType (self)
def	exportToXml (self, xmlFile)
	Exports BarCode properties to the xml-file specified :param: xmlFile The name of the file :return: Whether or not export completed successfully. More...
Public Member Functions inherited from BaseJavaClass
def	__init__ (self, javaClass)
def	getJavaClass (self)
def	setJavaClass (self, javaClass)
def	getJavaClassName (self)
def	isNull (self)
def	printJavaClassName (self)

Static Public Member Functions
def	construct (javaClass)
def	convertToBase64Image (image)
def	importFromXml (xmlFile)
	Exports BarCode properties to the xml-file specified :param xmlFile: xmlFile The name of the file :return:Whether or not export completed successfully. More...

Public Attributes
	qualitySettings
	recognizedResults
	barcodeSettings
Public Attributes inherited from BaseJavaClass
	javaClass
	javaClassName

Static Public Attributes
string	javaClassName = "com.aspose.mw.barcode.recognition.MwBarCodeReader"

Detailed Description

BarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes.

This sample shows how to detect Code39 and Code128 barcodes.

reader = Recognition.BarCodeReader("test.png", None,  [DecodeType.CODE_39_STANDARD, DecodeType.CODE_128])
for result in reader.readBarCodes():
      print("BarCode Type: " + result.getCodeTypeName())
      print("BarCode CodeText: " + result.getCodeText())

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			image,
			rectangles,
			decodeTypes
	)

Initializes a new instance of the BarCodeReader :param: image encoded as base64 string or path to image :param: rectangles array of object by type Rectangle :param: decodeTypes the array of objects by DecodeType.

Member Function Documentation

abort()

def abort

(

self

)

construct()

def construct (   javaClass )

static

containsAny()

def containsAny	(		self,
			decodeTypes
	)

Determines whether any of the given decode types is included into :param: ...decodeTypes Types to verify.

:return: bool Value is a true if any types are included into.

convertToBase64Image()

def convertToBase64Image (   image )

static

exportToXml()

def exportToXml	(		self,
			xmlFile
	)

Exports BarCode properties to the xml-file specified :param: xmlFile The name of the file :return: Whether or not export completed successfully.

Returns True in case of success False Otherwise

getBarCodeDecodeType()

def getBarCodeDecodeType

(

self

)

getBarcodeSettings()

def getBarcodeSettings

(

self

)

The main BarCode decoding parameters.

Contains parameters which make influence on recognized data.

return The main BarCode decoding parameters

getFoundBarCodes()

def getFoundBarCodes

(

self

)

Gets recognized BarCodeResult array.

This sample shows how to read barcodes with BarCodeReader

reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
reader.readBarCodes()
for(let i = 0 reader.getFoundCount() > i ++i)
   print("BarCode CodeText: " +  reader.getFoundBarCodes()[i].getCodeText())

Value: The recognized BarCodeResult array

getFoundCount()

def getFoundCount

(

self

)

Gets recognized barcodes count.

---

This sample shows how to read barcodes with BarCodeReader

reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
reader.readBarCodes()
for(let i = 0 reader.getFoundCount() > i ++i)
   print("BarCode CodeText: " + reader.getFoundBarCodes()[i].getCodeText())

Value: The recognized barcodes count

getQualitySettings()

def getQualitySettings

(

self

)

QualitySettings allows to configure recognition quality and speed manually.

You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,

HighQuality, MaxBarCodes or you can manually configure separate options.

Default value of QualitySettings is NormalQuality.

This sample shows how to use QualitySettings with BarCodeReader

reader = Recognition.BarCodeReader("test.png", None, None)
 #set high performance mode
reader.setQualitySettings(QualitySettings.getHighPerformance())
for result in reader.readBarCodes():
  print("BarCode CodeText: " + result.getCodeText())
reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
#normal quality mode is set by default
for result in reader.readBarCodes():
  print("BarCode CodeText: " + result.getCodeText())
reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
#set high performance mode
reader.setQualitySettings(QualitySettings.getHighPerformance())
#set separate options
reader.getQualitySettings().setAllowMedianSmoothing(true)
reader.getQualitySettings().setMedianSmoothingWindowSize(5)
for result in reader.readBarCodes():
  print("BarCode CodeText: " + result.getCodeText())

QualitySettings to configure recognition quality and speed.

getTimeout()

def getTimeout

(

self

)

Gets the timeout of recognition process in milliseconds.

reader = Recognition.BarCodeReader("test.png", None, None)
reader.setTimeout(5000)
for result in reader.readBarCodes():
   print("BarCode CodeText: " + result.getCodeText())

:return: The timeout.

importFromXml()

def importFromXml (   xmlFile )

static

Exports BarCode properties to the xml-file specified :param xmlFile: xmlFile The name of the file :return:Whether or not export completed successfully.

Returns True in case of success; False Otherwise

init()

def init

(

self

)

Reimplemented from BaseJavaClass.

readBarCodes()

def readBarCodes

(

self

)

Reads BarCodeResult from the image.

This sample shows how to read barcodes with BarCodeReader

reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
for result in reader.readBarCodes():
   print("BarCode CodeText: " + result.getCodeText())
reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
reader.readBarCodes()
for(let i = 0 reader.getFoundCount() > i ++i)
   print("BarCode CodeText: " + reader.getFoundBarCodes()[i].getCodeText())

:return: Returns array of recognized

BarCodeResult 

s on the image. If nothing is recognized, zero array is returned.

setBarCodeImage()

def setBarCodeImage	(		self,
			image,
			areas
	)

Sets bitmap image and areas for Recognition.

Must be called before ReadBarCodes() method.

This sample shows how to detect Code39 and Code128 barcodes.

let bmp = "test.png"
reader = Recognition.BarCodeReader()
reader.setBarCodeReadType([ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
var img = Image()
img.src = 'path_to_image'
width = img.width
height = img.height
reader.setBarCodeImage(bmp, [Rectangle(0, 0, width, height)])
for result in results:
   print("BarCode Type: " + result.getCodeTypeName())
   print("BarCode CodeText: " + result.getCodeText())

:param: value The bitmap image for Recognition. :param: areas areas list for recognition

Exceptions

BarCodeException

setBarCodeReadType()

def setBarCodeReadType	(		self,
			types
	)

Sets SingleDecodeType type array for Recognition.

Must be called before readBarCodes() method.

This sample shows how to detect Code39 and Code128 barcodes.

reader = Recognition.BarCodeReader()
reader.setBarCodeReadType([ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
reader.setBarCodeImage("test.png")
for result in reader.readBarCodes():
    print("BarCode Type: " + result.getCodeTypeName())
    print("BarCode CodeText: " + result.getCodeText())

:param: types The SingleDecodeType type array to read.

setQualitySettings()

def setQualitySettings	(		self,
			value
	)

QualitySettings allows to configure recognition quality and speed manually.

You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,

HighQuality, MaxBarCodes or you can manually configure separate options.

Default value of QualitySettings is NormalQuality.

This sample shows how to use QualitySettings with BarCodeReader

reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
#set high performance mode
reader.setQualitySettings(QualitySettings.getHighPerformance())
for result in reader.readBarCodes():
  print("BarCode CodeText: " + result.getCodeText())
reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
#normal quality mode is set by default
for result in reader.readBarCodes():
  print("BarCode CodeText: " + result.getCodeText())
reader = Recognition.BarCodeReader("test.png", None,  [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ])
 #set high performance mode
reader.setQualitySettings(QualitySettings.getHighPerformance())
#set separate options
reader.getQualitySettings().setAllowMedianSmoothing(true)
reader.getQualitySettings().setMedianSmoothingWindowSize(5)
for result in reader.readBarCodes():
  print("BarCode CodeText: " + result.getCodeText())

QualitySettings to configure recognition quality and speed.

setTimeout()

def setTimeout	(		self,
			value
	)

Sets the timeout of recognition process in milliseconds.

reader = Recognition.BarCodeReader("test.png", None, None)
reader.setTimeout(5000)
for result in reader.readBarCodes():
     print("BarCode CodeText: " + result.getCodeText())

:param: value The timeout.

Member Data Documentation

barcodeSettings

barcodeSettings

javaClassName

string javaClassName = "com.aspose.mw.barcode.recognition.MwBarCodeReader"

static

qualitySettings

qualitySettings

recognizedResults

recognizedResults