Package adams.data.boofcv.multiimageoperation

Class Diff

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractMultiImageOperation<BoofCVImageContainer>

adams.data.boofcv.multiimageoperation.AbstractBoofCVMultiImageOperation

adams.data.boofcv.multiimageoperation.Diff

All Implemented Interfaces:

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

public class Diff
extends AbstractBoofCVMultiImageOperation

Compares two images and returns a third image with the differences between them

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-threshold <int> (property: threshold)
    The threshold to use, based on absolute difference between pixel values.
    default: 0
    minimum: 0
 

Version:

$Revision$

Author:

sjb90

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Threshold	the threshold at which two pixels are considered different

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

Method Summary

Modifier and Type	Method	Description
protected void	check(BoofCVImageContainer[] images)	Checks the images.
void	defineOptions()	Adds options to the internal list of options.
protected BoofCVImageContainer[]	doProcess(BoofCVImageContainer[] images)	Performs the actual processing of the images.
int	getThreshold()	Returns the threshold.
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	setThreshold(int value)	Sets the threshold to use.
protected int	thresholdEquals(int value1, int value2)	Outputs -1 if the difference between the values is less than the threshold, otherwise 1.
String	thresholdTipText()	Returns the tip text for this property.

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_Threshold

protected int m_Threshold

the threshold at which two pixels are considered different

Constructor Detail

Diff

public Diff()

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

setThreshold

public void setThreshold(int value)

Sets the threshold to use.

Parameters:

value - the threshold

getThreshold

public int getThreshold()

Returns the threshold.

Returns:

the threshold

thresholdTipText

public String thresholdTipText()

Returns the tip text for this property.

Returns:

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

minNumImagesRequired

public int minNumImagesRequired()

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

Specified by:

minNumImagesRequired in class AbstractMultiImageOperation<BoofCVImageContainer>

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

Returns:

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

check

protected void check(BoofCVImageContainer[] images)

Checks the images.

Overrides:

check in class AbstractMultiImageOperation<BoofCVImageContainer>

Parameters:

images - the images to check

thresholdEquals

protected int thresholdEquals(int value1,
                              int value2)

Outputs -1 if the difference between the values is less than the threshold, otherwise 1.

Parameters:

value1 - the two values to compare

Returns:

the difference indicator

doProcess

protected BoofCVImageContainer[] doProcess(BoofCVImageContainer[] images)

Performs the actual processing of the images.

Specified by:

doProcess in class AbstractMultiImageOperation<BoofCVImageContainer>

Parameters:

images - the images to process

Returns:

the generated image(s)