Package adams.data.image.features

Class Barcode

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractImageFeatureGenerator<BufferedImageContainer>

adams.data.image.features.AbstractBufferedImageFeatureGenerator

adams.data.image.features.Barcode

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractImageFeatureGenerator>, SizeOfHandler, Serializable, Comparable

public class Barcode
extends AbstractBufferedImageFeatureGenerator

Decodes any barcode in the image.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-converter <adams.data.featureconverter.AbstractFeatureConverter> (property: converter)
    The feature converter to use to produce the output data.
    default: adams.data.featureconverter.SpreadSheet -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet
 

-field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to add to the output.
    default: 
 

-notes <adams.core.base.BaseString> [-notes ...] (property: notes)
    The notes to add as attributes to the generated data, eg 'PROCESS INFORMATION'
    .
    default: 
 

-decoder <adams.data.barcode.decode.AbstractBarcodeDecoder> (property: decoder)
    The decoder algorithm to use.
    default: adams.data.barcode.decode.PassThrough
 

Version:

$Revision: 9196 $

Author:

fracpete (fracpete at waikato dot ac dot nz), Dale (dale at cs dot waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractBarcodeDecoder	m_Decoder	the decoder to use.

Fields inherited from class adams.data.image.AbstractImageFeatureGenerator

m_Converter, m_Fields, m_Notes, m_Prefix

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Barcode()

Method Summary

Modifier and Type	Method	Description
HeaderDefinition	createHeader(BufferedImageContainer img)	Creates the header from a template image.
String	decoderTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
List<Object>[]	generateRows(BufferedImageContainer img)	Performs the actual feature generation.
AbstractBarcodeDecoder	getDecoder()	Returns the decoder in use.
String	globalInfo()	Returns a string describing the object.
void	setDecoder(AbstractBarcodeDecoder value)	Sets the decoder to use.

Methods inherited from class adams.data.image.AbstractImageFeatureGenerator

checkData, cleanUp, compareTo, converterTipText, destroy, equals, fieldsTipText, generate, getConverter, getDatasetFormat, getFields, getNotes, getPrefix, getRowFormat, notesTipText, postProcessHeader, postProcessRow, postProcessRows, prefixTipText, reset, setConverter, setFields, setNotes, setPrefix, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Decoder

protected AbstractBarcodeDecoder m_Decoder

the decoder to use.

Constructor Detail

Barcode

public Barcode()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractImageFeatureGenerator<BufferedImageContainer>

setDecoder

public void setDecoder(AbstractBarcodeDecoder value)

Sets the decoder to use.

Parameters:

value - the decoder to use

getDecoder

public AbstractBarcodeDecoder getDecoder()

Returns the decoder in use.

Returns:

the decoder in use

decoderTipText

public String decoderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

createHeader

public HeaderDefinition createHeader(BufferedImageContainer img)

Creates the header from a template image.

Specified by:

createHeader in class AbstractImageFeatureGenerator<BufferedImageContainer>

Parameters:

img - the image to act as a template

Returns:

the generated header

generateRows

public List<Object>[] generateRows(BufferedImageContainer img)

Performs the actual feature generation.

Specified by:

generateRows in class AbstractImageFeatureGenerator<BufferedImageContainer>

Parameters:

img - the image to process

Returns:

the generated features