adams.flow.transformer
Class SetImagePixel

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.SetImagePixel

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class SetImagePixel
extends AbstractTransformer

Obtains information from the picture passing through.

Input/output:
- accepts:
adams.data.image.AbstractImage
- generates:
adams.data.jai.BufferedImageContainer

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
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: SetImagePixel
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-x <int> (property: X)
    The X position of the pixel (1-based).
    default: 1
    minimum: 1
 

-y <int> (property: Y)
    The Y position of the pixel (1-based).
    default: 1
    minimum: 1
 

-type <RGBA|COLOR> (property: type)
    The type of value to use for the pixel.
    default: RGBA
 

-rgba <int> (property: RGBA)
    The RGBA value (>= 0).
    default: 0
    minimum: 0
 

-color <java.awt.Color> (property: color)
    The color of the pixel.
    default: #000000
 

Version:

$Revision: 4829 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

SetImagePixel.PixelValueType Enumeration that determines what value to use for the pixel.

Field Summary

protected Color	m_Color the color of the pixel.
protected int	m_RGBA the RGBA value of the pixel.
protected SetImagePixel.PixelValueType	m_Type what type of value to use for the pixel.
protected int	m_X the X position of the pixel (1-based).
protected int	m_Y the Y position of the pixel (1-based).

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SetImagePixel()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	colorTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
Color	getColor() Returns the color of the pixel.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
int	getRGBA() Returns the RGBA value of the pixel.
SetImagePixel.PixelValueType	getType() Returns the type of value to use.
int	getX() Returns the X position of the pixel.
int	getY() Returns the X position of the pixel.
String	globalInfo() Returns a string describing the object.
String	RGBATipText() Returns the tip text for this property.
void	setColor(Color value) Sets the color of the pixel.
void	setRGBA(int value) Sets the RGBA value of the pixel.
void	setType(SetImagePixel.PixelValueType value) Sets the type of value to use.
void	setX(int value) Sets the X position of the pixel.
void	setY(int value) Sets the Y position of the pixel.
String	typeTipText() Returns the tip text for this property.
String	XTipText() Returns the tip text for this property.
String	YTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

m_X

protected int m_X

the X position of the pixel (1-based).

m_Y

protected int m_Y

the Y position of the pixel (1-based).

m_Type

protected SetImagePixel.PixelValueType m_Type

what type of value to use for the pixel.

m_RGBA

protected int m_RGBA

the RGBA value of the pixel.

m_Color

protected Color m_Color

the color of the pixel.

Constructor Detail

SetImagePixel

public SetImagePixel()

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 AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setX

public void setX(int value)

Sets the X position of the pixel.

Parameters:

value - the position, 1-based

getX

public int getX()

Returns the X position of the pixel.

Returns:

the position, 1-based

XTipText

public String XTipText()

Returns the tip text for this property.

Returns:

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

setY

public void setY(int value)

Sets the Y position of the pixel.

Parameters:

value - the position, 1-based

getY

public int getY()

Returns the X position of the pixel.

Returns:

the position, 1-based

YTipText

public String YTipText()

Returns the tip text for this property.

Returns:

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

setType

public void setType(SetImagePixel.PixelValueType value)

Sets the type of value to use.

Parameters:

value - the type

getType

public SetImagePixel.PixelValueType getType()

Returns the type of value to use.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

setRGBA

public void setRGBA(int value)

Sets the RGBA value of the pixel.

Parameters:

value - the RGBA value

getRGBA

public int getRGBA()

Returns the RGBA value of the pixel.

Returns:

the RGBA value

RGBATipText

public String RGBATipText()

Returns the tip text for this property.

Returns:

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

setColor

public void setColor(Color value)

Sets the color of the pixel.

Parameters:

value - the color

getColor

public Color getColor()

Returns the color of the pixel.

Returns:

the color

colorTipText

public String colorTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the Class of objects that can be processed

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

adams.data.jai.BufferedImageContainer.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message