Package adams.data.image.features

Class Moment

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.Moment

All Implemented Interfaces:

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

public class Moment
extends AbstractBufferedImageFeatureGenerator

Computes the specified moment.

-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.DefaultSpreadSheet
 

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

-moment <adams.data.image.moments.AbstractBufferedImageMoment> (property: moment)
    The moment to calculate.
    default: adams.data.image.moments.BIMoment
 

Version:

$Revision$

Author:

sjb90

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractBufferedImageMoment	m_Moment	the moment to compute.

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

Method Summary

Modifier and Type	Method	Description
HeaderDefinition	createHeader(BufferedImageContainer img)	Creates the header from a template image.
void	defineOptions()	Adds options to the internal list of options.
List<Object>[]	generateRows(BufferedImageContainer img)	Performs the actual feature genration.
AbstractBufferedImageMoment	getMoment()	Returns the moment algorithm to use.
String	globalInfo()	Returns a string describing the object.
String	momentTipText()	Returns the tip text for this property.
void	setMoment(AbstractBufferedImageMoment value)	Sets the moment algorithm 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_Moment

protected AbstractBufferedImageMoment m_Moment

the moment to compute.

Constructor Detail

Moment

public Moment()

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>

setMoment

public void setMoment(AbstractBufferedImageMoment value)

Sets the moment algorithm to use.

Parameters:

value - the moment

getMoment

public AbstractBufferedImageMoment getMoment()

Returns the moment algorithm to use.

Returns:

the moment

momentTipText

public String momentTipText()

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 genration.

Specified by:

generateRows in class AbstractImageFeatureGenerator<BufferedImageContainer>

Parameters:

img - the image to process

Returns:

the generated features