Package adams.data.image.multiimageoperation

Class ReportFieldSubtraction

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

All Implemented Interfaces:

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

public class ReportFieldSubtraction
extends AbstractBufferedImageMultiImageOperation

For each of the specified report fields, the difference between the value from the first report and the second is calculated. The updated report is output with the first 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 create the difference for.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Field[]	m_Fields	the report fields to subtract.

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

Method Summary

Modifier and Type	Method	Description
protected void	check(BufferedImageContainer[] images)	Checks the images.
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doProcess(BufferedImageContainer[] images)	Performs the actual processing of the images.
String	fieldsTipText()	Returns the tip text for this property.
Field[]	getFields()	Returns the fields.
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.
void	setFields(Field[] value)	Sets the fields.

Methods inherited from class adams.data.image.AbstractMultiImageOperation

checkSameDimensions, checkSameDimensions, process

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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

Field Detail

m_Fields

protected Field[] m_Fields

the report fields to subtract.

Constructor Detail

ReportFieldSubtraction

public ReportFieldSubtraction()

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 AbstractOptionHandler

setFields

public void setFields(Field[] value)

Sets the fields.

Parameters:

value - the fields

getFields

public Field[] getFields()

Returns the fields.

Returns:

the fields

fieldsTipText

public String fieldsTipText()

Returns the tip text for this property.

Returns:

tip text for this property 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)