Package adams.data.image.features

Class Pixels

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

All Implemented Interfaces:

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

public class Pixels
extends AbstractBufferedImageFeatureGenerator

Gets all the pixels of 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
 

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

-pixel-type <RGB_SINGLE|RGB_SEPARATE|HSB_SEPARATE|LUMINANCE_STANDARD|LUMINANCE_PERCEIVED1|LUMINANCE_PERCEIVED2> (property: pixelType)
    The pixel type to use.
    default: RGB_SINGLE
 

Version:

$Revision$

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Pixels.PixelType	The type of pixel to use.

Field Summary

Fields

Modifier and Type	Field	Description
protected Pixels.PixelType	m_PixelType	how to output the pixels.

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

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 generation.
Pixels.PixelType	getPixelType()	Returns the type of pixel to output.
String	globalInfo()	Returns a string describing the object.
String	pixelTypeTipText()	Returns the tip text for this property.
void	setPixelType(Pixels.PixelType value)	Sets the type of pixel to output.

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_PixelType

protected Pixels.PixelType m_PixelType

how to output the pixels.

Constructor Detail

Pixels

public Pixels()

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>

setPixelType

public void setPixelType(Pixels.PixelType value)

Sets the type of pixel to output.

Parameters:

value - the type

getPixelType

public Pixels.PixelType getPixelType()

Returns the type of pixel to output.

Returns:

the type

pixelTypeTipText

public String pixelTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

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