Package adams.flow.source

Class NewImage

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class NewImage
extends AbstractSimpleSource
    Generates an empty image with the specified dimensions (Type: RGB or ARBG).

    Input/output:
    - generates:
       adams.data.image.BufferedImageContainer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: NewImage
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -width <int> (property: width)
    The width of the image.
    default: 800
    minimum: 1
 
    -height <int> (property: height)
    The height of the image.
    default: 600
    minimum: 1
 
    -alpha-channel <boolean> (property: alphaChannel)
    If enabled, the alpha channel gets added as well (type is then ARGB instead 
    of RGB).
    default: false
 
    -background <java.awt.Color> (property: background)
    The background color of the image.
    default: #ffffff
 
    -conversion <adams.data.conversion.BufferedImageToOtherFormatConversion> (property: conversion)
    The conversion for turning the adams.data.image.BufferedImageContainer into 
    another format if necessary.
    default: adams.data.conversion.BufferedImageToBufferedImage
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Width

        protected int m_Width
        the width of the image.

      • m_Height

        protected int m_Height
        the height of the image.

      • m_Background

        protected Color m_Background
        the background color.

      • m_AlphaChannel

        protected boolean m_AlphaChannel
        whether to add Alpha channel.

    • Constructor Detail

      • NewImage

        public NewImage()

    • Method Detail

      • getDefaultWidth

        public int getDefaultWidth()
        Returns the default width of the image.
        Returns:
        the default width

      • setWidth

        public void setWidth​(int value)
        Sets the width of the image.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width of the image.
        Returns:
        the width

      • widthTipText

        public String widthTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getDefaultHeight

        public int getDefaultHeight()
        Returns the default height of the image.
        Returns:
        the default height

      • setHeight

        public void setHeight​(int value)
        Sets the height of the image.
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the height of the image.
        Returns:
        the height

      • heightTipText

        public String heightTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAlphaChannel

        public void setAlphaChannel​(boolean value)
        Sets whether to add the alpha channel.
        Parameters:
        value - true if alpha channel

      • getAlphaChannel

        public boolean getAlphaChannel()
        Returns whether to add alpha channel.
        Returns:
        true if alpha channel

      • alphaChannelTipText

        public String alphaChannelTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getDefaultBackground

        public Color getDefaultBackground()
        Returns the default backrgound color of the image.
        Returns:
        the default color

      • setBackground

        public void setBackground​(Color value)
        Sets the background color of the image.
        Parameters:
        value - the color

      • getBackground

        public Color getBackground()
        Returns the background color of the image.
        Returns:
        the color

      • backgroundTipText

        public String backgroundTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • conversionTipText

        public String conversionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generates

        public Class[] generates()
        Returns a string describing the object.
        Returns:
        a description suitable for displaying in the gui

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message