adams.data.jai.flattener
Class Pixels

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.image.AbstractImageFlattener<BufferedImageContainer>
              adams.data.jai.flattener.AbstractJAIFlattener
                  adams.data.jai.flattener.Pixels

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable, Comparable

public class Pixels
extends AbstractJAIFlattener

Gets all the pixels of the image.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

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

-separate-rgb (property: separateRGB)
    Whether to output the RGB values as separate attributes or a single combined 
    one.
 

Version:

$Revision: 4784 $

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

protected boolean

m_SeparateRGB whether to output the RGB values in separate attributes.

Fields inherited from class adams.data.image.AbstractImageFlattener

m_Fields, m_Header, m_Notes

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Pixels()

Method Summary

Instances	createHeader(BufferedImageContainer img) Creates the header from a template image.
void	defineOptions() Adds options to the internal list of options.
Instance[]	doFlatten(BufferedImageContainer img) Performs the actual flattening of the image.
boolean	getSeparateRGB() Returns the setup name.
String	globalInfo() Returns a string describing the object.
String	separateRGBTipText() Returns the tip text for this property.
void	setSeparateRGB(boolean value) Sets whether to separate the RGB values or not.

Methods inherited from class adams.data.jai.flattener.AbstractJAIFlattener

forCommandLine, forName, getFlatteners

Methods inherited from class adams.data.image.AbstractImageFlattener

checkImage, cleanUp, compareTo, destroy, equals, fieldsTipText, flatten, getFields, getNotes, newArray, notesTipText, postProcessHeader, postProcessInstance, reset, setFields, setNotes, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_SeparateRGB

protected boolean m_SeparateRGB

whether to output the RGB values in separate attributes.

Constructor Detail

Pixels

public Pixels()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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 AbstractImageFlattener<BufferedImageContainer>

setSeparateRGB

public void setSeparateRGB(boolean value)

Sets whether to separate the RGB values or not.

Parameters:

value - if true then the RGB values are output as separate values

getSeparateRGB

public boolean getSeparateRGB()

Returns the setup name.

Returns:

the name

separateRGBTipText

public String separateRGBTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

createHeader

public Instances createHeader(BufferedImageContainer img)

Creates the header from a template image.

Specified by:

createHeader in class AbstractImageFlattener<BufferedImageContainer>

Parameters:

img - the image to act as a template

Returns:

the generated header

doFlatten

public Instance[] doFlatten(BufferedImageContainer img)

Performs the actual flattening of the image.

Specified by:

doFlatten in class AbstractImageFlattener<BufferedImageContainer>

Parameters:

img - the image to process

Returns:

the generated array

See Also:

AbstractImageFlattener.m_Header