Package adams.data.image.multiimageoperation

Class ApplyMask

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractMultiImageOperation<BufferedImageContainer>

adams.data.image.multiimageoperation.AbstractBufferedImageMultiImageOperation

adams.data.image.multiimageoperation.ApplyMask

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class ApplyMask
extends AbstractBufferedImageMultiImageOperation

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected void	check(BufferedImageContainer[] images)	Checks the images.
protected BufferedImageContainer[]	doProcess(BufferedImageContainer[] images)	Performs the actual processing of the images.
String	globalInfo()	Returns a string describing the object.
int	maxNumImagesRequired()	Returns the maximum number of images that are required for the operation.
int	minNumImagesRequired()	Returns the minimum number of images that are required for the operation.

Methods inherited from class adams.data.image.AbstractMultiImageOperation

checkSameDimensions, checkSameDimensions, process

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

ApplyMask

public ApplyMask()

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

minNumImagesRequired

public int minNumImagesRequired()

Returns the minimum number of images that are required for the operation.

Specified by:

minNumImagesRequired in class AbstractMultiImageOperation<BufferedImageContainer>

Returns:

the number of images that are required, <= 0 means no lower limit

maxNumImagesRequired

public int maxNumImagesRequired()

Returns the maximum number of images that are required for the operation.

Specified by:

maxNumImagesRequired in class AbstractMultiImageOperation<BufferedImageContainer>

Returns:

the number of images that are required, <= 0 means no upper limit

check

protected void check(BufferedImageContainer[] images)

Checks the images.

Overrides:

check in class AbstractMultiImageOperation<BufferedImageContainer>

Parameters:

images - the images to check

doProcess

protected BufferedImageContainer[] doProcess(BufferedImageContainer[] images)

Performs the actual processing of the images.

Specified by:

doProcess in class AbstractMultiImageOperation<BufferedImageContainer>

Parameters:

images - the images to process

Returns:

the generated image(s)