Package adams.data.matlab.multimatrixoperation

Class ApplyMask

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.matlab.multimatrixoperation.AbstractMultiMatrixOperation

adams.data.matlab.multimatrixoperation.ApplyMask

All Implemented Interfaces:

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

public class ApplyMask
extends AbstractMultiMatrixOperation

Performs element-wise subtraction and outputs the result as single matrix.

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 us.hebi.matlab.mat.types.Matrix[]	doProcess(us.hebi.matlab.mat.types.Matrix[] matrices)	Performs the actual processing of the matrices.
String	globalInfo()	Returns a string describing the object.
int	maxNumMatricesRequired()	Returns the maximum number of matrices that are required for the operation.
int	minNumMatricesRequired()	Returns the minimum number of matrices that are required for the operation.

Methods inherited from class adams.data.matlab.multimatrixoperation.AbstractMultiMatrixOperation

check, checkSameDimensions, checkSameDimensions, getQuickInfo, 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

minNumMatricesRequired

public int minNumMatricesRequired()

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

Specified by:

minNumMatricesRequired in class AbstractMultiMatrixOperation

Returns:

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

maxNumMatricesRequired

public int maxNumMatricesRequired()

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

Specified by:

maxNumMatricesRequired in class AbstractMultiMatrixOperation

Returns:

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

doProcess

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

Performs the actual processing of the matrices.

Specified by:

doProcess in class AbstractMultiMatrixOperation

Parameters:

matrices - the matrices to process

Returns:

the generated array(s)