@ALDAOperator(genericExecutionMode=ALL, level=APPLICATION, shortDescription="Computes the mean of the input double array and optionally makes the data mean-free.") public class ALDCalcMeanArray extends ALDOperator
ALDOperator.HidingMode, ALDOperator.HistoryConstructionMode
Modifier and Type | Field and Description |
---|---|
private Double[] |
data
Input data array.
|
private Boolean |
doMeanFree
Compute mean free data
|
private Double |
mean
Calculated average value.
|
private Double[] |
meanFreeData
Mean free data
|
completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider
Constructor and Description |
---|
ALDCalcMeanArray()
Default constructor.
|
ALDCalcMeanArray(Double[] _data)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getDocumentation()
Full description of the operator, e.g., to be shown as documentation in GUI.
|
Double |
getResultMean()
Returns the calculated mean value.
|
protected void |
operate()
This method does the actual work and needs to be implemented by every
subclass.
|
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, getVerbose, 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, setVerbose, toStringVerbose, unconfiguredItems, validate, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory
@Parameter(label="Input data", required=true, direction=IN, description="Input data.") private Double[] data
@Parameter(label="Compute mean free data", required=false, direction=INOUT, description="Optionally compute mean free data.") private Boolean doMeanFree
@Parameter(label="Mean value", direction=OUT, description="Result.") private Double mean
@Parameter(label="Mean free data", direction=OUT, description="Result.") private Double[] meanFreeData
public ALDCalcMeanArray() throws ALDOperatorException
ALDOperatorException
public ALDCalcMeanArray(Double[] _data) throws ALDOperatorException
_data
- Input data.ALDOperatorException
protected void operate()
ALDOperator
operate
in class ALDOperator
public Double getResultMean()
public 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.