Package adams.data.matlab.multimatrixoperation

Class AbstractMultiMatrixOperation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.matlab.multimatrixoperation.AbstractMultiMatrixOperation

All Implemented Interfaces:

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

Direct Known Subclasses:

Add, ApplyMask, Combine, Subtract

public abstract class AbstractMultiMatrixOperation
extends AbstractOptionHandler
implements QuickInfoSupporter

Abstract base class for operations that require multiple matrices.

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

Method Summary

Modifier and Type	Method	Description
protected void	check(us.hebi.matlab.mat.types.Matrix[] matrices)	Checks the matrices.
protected String	checkSameDimensions(us.hebi.matlab.mat.types.Matrix[] matrices)	Checks whether the matrices have the same dimensions.
protected boolean	checkSameDimensions(us.hebi.matlab.mat.types.Matrix array1, us.hebi.matlab.mat.types.Matrix array2)	Checks whether the two matrices have the same dimensions.
protected abstract us.hebi.matlab.mat.types.Matrix[]	doProcess(us.hebi.matlab.mat.types.Matrix[] matrices)	Performs the actual processing of the matrices.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
abstract int	maxNumMatricesRequired()	Returns the maximum number of matrices that are required for the operation.
abstract int	minNumMatricesRequired()	Returns the minimum number of matrices that are required for the operation.
us.hebi.matlab.mat.types.Matrix[]	process(us.hebi.matlab.mat.types.Matrix[] matrices)	Processes the matrices.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

AbstractMultiMatrixOperation

public AbstractMultiMatrixOperation()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

minNumMatricesRequired

public abstract int minNumMatricesRequired()

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

Returns:

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

maxNumMatricesRequired

public abstract int maxNumMatricesRequired()

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

Returns:

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

checkSameDimensions

protected boolean checkSameDimensions(us.hebi.matlab.mat.types.Matrix array1,
                                      us.hebi.matlab.mat.types.Matrix array2)

Checks whether the two matrices have the same dimensions.

Parameters:

array1 - the first array

array2 - the second array

Returns:

true if the same dimensions

checkSameDimensions

protected String checkSameDimensions(us.hebi.matlab.mat.types.Matrix[] matrices)

Checks whether the matrices have the same dimensions.

Parameters:

matrices - the matrices

Returns:

null if the same dimensions, other error message

check

protected void check(us.hebi.matlab.mat.types.Matrix[] matrices)

Checks the matrices.

Default implementation only ensures that matrices are present.

Parameters:

matrices - the matrices to check

doProcess

protected abstract us.hebi.matlab.mat.types.Matrix[] doProcess(us.hebi.matlab.mat.types.Matrix[] matrices)

Performs the actual processing of the matrices.

Parameters:

matrices - the matrices to process

Returns:

the generated array(s)

process

public us.hebi.matlab.mat.types.Matrix[] process(us.hebi.matlab.mat.types.Matrix[] matrices)

Processes the matrices.

Parameters:

matrices - the matrices to process

Returns:

the generated array(s)