@ALDAOperator(genericExecutionMode=ALL, level=APPLICATION, shortDescription="Applies the given summarizing operator either row- or column-wise to the input matrix.") public class ApplyToMatrix extends ALDOperator
Modifier and Type | Class and Description |
---|---|
static class |
ApplyToMatrix.SummarizeMode
Choose row or colum wise sum
|
ALDOperator.HidingMode, ALDOperator.HistoryConstructionMode
Modifier and Type | Field and Description |
---|---|
private long |
elapsedTime
Elpased time
|
private Double[][] |
matrix
Input matrix
|
private boolean |
returnElapsedTime
Supplemental to request elapsed time to be returned
|
private Double[] |
summaries
1D Array of summaries.
|
private ApplyToMatrix.SummarizeMode |
summarizeMode
Mode of summarizing
|
private ALDSummarizeArrayOp |
summarizeOp
Summarizing opererator
|
completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider
Constructor and Description |
---|
ApplyToMatrix()
Default constructor.
|
ApplyToMatrix(Double[][] _matrix)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getDocumentation()
Full description of the operator, e.g., to be shown as documentation in GUI.
|
long |
getElapsedTime()
Get value of elapsedTime.
|
Double[][] |
getMatrix()
Get value of matrix.
|
boolean |
getReturnElapsedTime()
Get value of returnElapsedTime.
|
Double[] |
getSummaries()
Get value of summaries.
|
ApplyToMatrix.SummarizeMode |
getSummarizeMode()
Get value of summarizeMode.
|
ALDSummarizeArrayOp |
getSummarizeOp()
Get value of summarizeOp.
|
Boolean |
getVerbose()
Get value of verbose.
|
protected void |
operate()
This method does the actual work and needs to be implemented by every
subclass.
|
void |
setElapsedTime(long value)
Set value of elapsedTime.
|
void |
setMatrix(Double[][] value)
Set value of matrix.
|
void |
setReturnElapsedTime(boolean value)
Set value of returnElapsedTime.
|
void |
setSummaries(Double[] value)
Set value of summaries.
|
void |
setSummarizeMode(ApplyToMatrix.SummarizeMode value)
Set value of summarizeMode.
|
void |
setSummarizeOp(ALDSummarizeArrayOp value)
Set value of summarizeOp.
|
void |
setVerbose(Boolean value)
Set value of verbose.
|
addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getHidingMode, getInactiveParameterNames, getInInoutNames, getInInoutNames, getInNames, getInOutNames, getMissingRequiredInputs, getName, getNumParameters, getOutInoutNames, getOutNames, getParameter, getParameterDescriptor, getParameterDescriptorUnconditioned, getParameterNames, getParameterUnconditioned, getSupplementalNames, getVersion, handleOperatorExecutionProgressEvent, hasInOutParameters, hasParameter, isAnnotatedParameter, isConfigured, print, print, print, printInterface, printInterface, readHistory, readResolve, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setParameterUnconditioned, toStringVerbose, unconfiguredItems, validate, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory
@Parameter(label="Input matrix", required=true, direction=IN, description="Input matrix.") private Double[][] matrix
@Parameter(label="Summarize mode", required=true, direction=IN, description="Sum over columns or rows.") private ApplyToMatrix.SummarizeMode summarizeMode
@Parameter(label="Summarizing operator", required=true, direction=IN, description="Specifies the summarizing operation to apply") private ALDSummarizeArrayOp summarizeOp
@Parameter(label="summaries", direction=OUT, description="Row or column wise summaries") private transient Double[] summaries
@Parameter(label="Return elapsed time", direction=IN, description="Request elapsed time consumed to be returned", supplemental=true) private boolean returnElapsedTime
@Parameter(label="Elapsed time", direction=OUT, description="Elapsed time of operation in milliseconds", supplemental=true) private long elapsedTime
public ApplyToMatrix() throws ALDOperatorException
ALDOperatorException
public ApplyToMatrix(Double[][] _matrix) throws ALDOperatorException
_matrix
- Input matrix.ALDOperatorException
protected void operate() throws ALDOperatorException, ALDProcessingDAGException
ALDOperator
operate
in class ALDOperator
ALDOperatorException
ALDProcessingDAGException
public boolean getReturnElapsedTime()
public void setReturnElapsedTime(boolean value)
value
- New value of returnElapsedTimepublic Boolean getVerbose()
getVerbose
in class ALDOperator
public void setVerbose(Boolean value)
setVerbose
in class ALDOperator
value
- New value of verbosepublic ALDSummarizeArrayOp getSummarizeOp()
public void setSummarizeOp(ALDSummarizeArrayOp value)
value
- New value of summarizeOppublic ApplyToMatrix.SummarizeMode getSummarizeMode()
public void setSummarizeMode(ApplyToMatrix.SummarizeMode value)
value
- New value of summarizeModepublic long getElapsedTime()
public void setElapsedTime(long value)
value
- New value of elapsedTimepublic Double[][] getMatrix()
public void setMatrix(Double[][] value)
value
- New value of matrixpublic Double[] getSummaries()
public void setSummaries(Double[] value)
value
- New value of summariespublic String getDocumentation()
ALDOperator
getDocumentation
in class ALDOperator
Copyright © 2010–2021 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.