Package adams.data.opencv.features

Class MultiOpenCVFeatureGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractImageFeatureGenerator<OpenCVImageContainer>

adams.data.opencv.features.AbstractOpenCVFeatureGenerator

adams.data.opencv.features.MultiOpenCVFeatureGenerator

All Implemented Interfaces:

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

public class MultiOpenCVFeatureGenerator
extends AbstractOpenCVFeatureGenerator

Applies multiple generators to the same image and merges the generate a feature vectors side-by-side. If one of the generators should create fewer a feature vectors, missing values are used in that case.

-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.SpreadSheetFeatureConverter -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: 
 

-sub-generator <AbstractOpenCVFeatureGenerator> [-sub-generator ...] (property: subGenerators)
    The feature generators to apply to the image.
    default: 
 

-prefix <java.lang.String> (property: prefix)
    The prefix to use for disambiguating the attribute names of the datasets 
    generated by the generators; use '#' for the 1-based index of the feature 
    generator; example '#-'
    default: 
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractOpenCVFeatureGenerator[]	m_SubGenerators	the generators to use.
protected HeaderDefinition[]	m_SubHeaders	the sub-headers.

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
MultiOpenCVFeatureGenerator()

Method Summary

Modifier and Type	Method	Description
HeaderDefinition	createHeader(OpenCVImageContainer img)	Creates the header from a template image.
protected String	createPrefix(int index)	Generates the prefix for the specified generator.
void	defineOptions()	Adds options to the internal list of options.
List<Object>[]	generateRows(OpenCVImageContainer img)	Performs the actual feature generation.
AbstractOpenCVFeatureGenerator[]	getSubGenerators()	Returns the generators to use.
String	globalInfo()	Returns a string describing the object.
void	setSubGenerators(AbstractOpenCVFeatureGenerator[] value)	Sets the generators to use.
String	subGeneratorsTipText()	Returns the tip text for this property.

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_SubGenerators

protected AbstractOpenCVFeatureGenerator[] m_SubGenerators

the generators to use.

m_SubHeaders

protected HeaderDefinition[] m_SubHeaders

the sub-headers.

Constructor Detail

MultiOpenCVFeatureGenerator

public MultiOpenCVFeatureGenerator()

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<OpenCVImageContainer>

setSubGenerators

public void setSubGenerators(AbstractOpenCVFeatureGenerator[] value)

Sets the generators to use.

Parameters:

value - the generators

getSubGenerators

public AbstractOpenCVFeatureGenerator[] getSubGenerators()

Returns the generators to use.

Returns:

the generators

subGeneratorsTipText

public String subGeneratorsTipText()

Returns the tip text for this property.

Returns:

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

createPrefix

protected String createPrefix(int index)

Generates the prefix for the specified generator.

Parameters:

index - the index of the generator

Returns:

the prefix

createHeader

public HeaderDefinition createHeader(OpenCVImageContainer img)

Creates the header from a template image.

Specified by:

createHeader in class AbstractImageFeatureGenerator<OpenCVImageContainer>

Parameters:

img - the image to act as a template

Returns:

the generated header

generateRows

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

Performs the actual feature generation.

Specified by:

generateRows in class AbstractImageFeatureGenerator<OpenCVImageContainer>

Parameters:

img - the image to process

Returns:

the generated features