@ALDAOperator(genericExecutionMode=ALL, shortDescription="Convolves an image with a user-specified kernel.") public class LinearFilter extends MTBOperator implements loci.common.StatusReporter
Modifier and Type | Field and Description |
---|---|
private MTBImageWindow.BoundaryPadding |
boundaryPadding |
private MTBImage |
inputImg |
private MTBImage |
kernelImg |
private boolean |
kernelNormalization |
private int[] |
kernelOrigin |
private Vector<loci.common.StatusListener> |
m_statusListeners
vector of installed StatusListeners
|
private MTBImage.MTBImageType |
resultImageType |
private MTBImage |
resultImg |
Constructor and Description |
---|
LinearFilter()
Empty constructor
|
LinearFilter(MTBImage inImg,
MTBImage kernelImg)
Constructor
|
LinearFilter(MTBImage inImg,
MTBImage kernelImg,
int[] kernelOrigin,
boolean kernelNormalization,
MTBImageWindow.BoundaryPadding boundaryPadding)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
addStatusListener(loci.common.StatusListener statuslistener) |
protected MTBImage |
convolve(MTBImage img,
MTBImage kernel,
int[] kernelAnchor,
boolean normalize,
MTBImageWindow.BoundaryPadding boundaryPadding)
Convolve an image with a specified kernel.
|
MTBImageWindow.BoundaryPadding |
getBoundaryPadding()
Get value of Parameter argument boundaryPadding.
|
String |
getDocumentation() |
MTBImage |
getInputImg()
Get input image.
|
MTBImage |
getKernelImg()
Get convolution kernel (image).
|
boolean |
getKernelNormalization()
Get value of Parameter argument kernelNormalization.
|
int[] |
getKernelOrigin()
Get value of Parameter argument kernelOrigin.
|
MTBImage.MTBImageType |
getResultImageType() |
MTBImage |
getResultImg()
Get resulting image.
|
void |
notifyListeners(loci.common.StatusEvent e) |
protected void |
operate() |
void |
removeStatusListener(loci.common.StatusListener statuslistener) |
void |
setBoundaryPadding(MTBImageWindow.BoundaryPadding boundaryPadding)
Set value of Parameter argument boundaryPadding.
|
void |
setInputImg(MTBImage img)
Set input image.
|
void |
setKernelImg(MTBImage kernelImg)
Set convolution kernel (image).
|
void |
setKernelNormalization(boolean kernelNormalization)
Set value of Parameter argument kernelNormalization.
|
void |
setKernelOrigin(int[] kernelOrigin)
Set value of Parameter argument kernelOrigin.
|
void |
setResultImageType(MTBImage.MTBImageType resultImageType) |
void |
validateCustom() |
readResolve
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, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setParameterUnconditioned, setVerbose, toStringVerbose, unconfiguredItems, validate, validateGeneric, writeHistory, writeHistory, writeHistory
private Vector<loci.common.StatusListener> m_statusListeners
@Parameter(label="Input image", required=true, direction=IN, mode=STANDARD, dataIOOrder=1, description="Input image") private MTBImage inputImg
@Parameter(label="Kernel image", required=true, direction=IN, mode=STANDARD, dataIOOrder=2, description="Convolution kernel (image)") private MTBImage kernelImg
@Parameter(label="Kernel origin", required=false, direction=IN, mode=ADVANCED, dataIOOrder=3, description="Coordinate of the kernel\'s origin in the kernel image. If not specified (null) it defaults to the center of the kernel image rounded down.") private int[] kernelOrigin
@Parameter(label="Kernel normalization", required=true, direction=IN, mode=ADVANCED, dataIOOrder=4, description="If true, kernel values are normalized to sum to 1 (Default)") private boolean kernelNormalization
@Parameter(label="Boundary padding", required=true, direction=IN, mode=ADVANCED, dataIOOrder=5, description="Image is padded by the specified method (Default: 0s are assumed outside the image)") private MTBImageWindow.BoundaryPadding boundaryPadding
@Parameter(label="Type of result image", required=true, direction=IN, mode=ADVANCED, dataIOOrder=6, description="Type of result image (Default: MTB_DOUBLE)") private MTBImage.MTBImageType resultImageType
@Parameter(label="Result image", required=true, direction=OUT, mode=STANDARD, dataIOOrder=1, description="Result image") private MTBImage resultImg
public LinearFilter() throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
de.unihalle.informatik.Alida.exceptions.ALDOperatorException
public LinearFilter(MTBImage inImg, MTBImage kernelImg) throws IllegalArgumentException, de.unihalle.informatik.Alida.exceptions.ALDOperatorException
IllegalArgumentException
de.unihalle.informatik.Alida.exceptions.ALDOperatorException
public LinearFilter(MTBImage inImg, MTBImage kernelImg, int[] kernelOrigin, boolean kernelNormalization, MTBImageWindow.BoundaryPadding boundaryPadding) throws IllegalArgumentException, de.unihalle.informatik.Alida.exceptions.ALDOperatorException
IllegalArgumentException
de.unihalle.informatik.Alida.exceptions.ALDOperatorException
public void validateCustom() throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
validateCustom
in class de.unihalle.informatik.Alida.operator.ALDOperator
de.unihalle.informatik.Alida.exceptions.ALDOperatorException
protected void operate() throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
operate
in class de.unihalle.informatik.Alida.operator.ALDOperator
de.unihalle.informatik.Alida.exceptions.ALDOperatorException
protected MTBImage convolve(MTBImage img, MTBImage kernel, int[] kernelAnchor, boolean normalize, MTBImageWindow.BoundaryPadding boundaryPadding)
img
- input imagekernel
- kernel imagekernelAnchor
- array of length 5 to specify the kernel element, under which the result value is stored ([0]=x-position, [1]=y-pos, [2]=z-pos, [3]=t-pos, [4]=c-pos)normalize
- flag for kernel normalization (kernel weights sum to 1)boundaryPadding
- set the padding method outside the boundaries of the underlying image (see static final fields)public int[] getKernelOrigin()
public void setKernelOrigin(int[] kernelOrigin)
int
- array with five elements specifying the image coordinate [x,y,z,t,c] considered as the origin (0,0,0,0,0) of the kernelpublic MTBImageWindow.BoundaryPadding getBoundaryPadding()
public void setBoundaryPadding(MTBImageWindow.BoundaryPadding boundaryPadding)
value
- of boundaryPaddingpublic boolean getKernelNormalization()
public void setKernelNormalization(boolean kernelNormalization)
value
- of kernelNormalizationpublic MTBImage getInputImg()
public void setInputImg(MTBImage img)
public MTBImage getKernelImg()
public void setKernelImg(MTBImage kernelImg)
public MTBImage.MTBImageType getResultImageType()
public void setResultImageType(MTBImage.MTBImageType resultImageType)
resultImageType
- the resultImageType to setpublic MTBImage getResultImg()
public void addStatusListener(loci.common.StatusListener statuslistener)
addStatusListener
in interface loci.common.StatusReporter
public void notifyListeners(loci.common.StatusEvent e)
notifyListeners
in interface loci.common.StatusReporter
public void removeStatusListener(loci.common.StatusListener statuslistener)
removeStatusListener
in interface loci.common.StatusReporter
public String getDocumentation()
getDocumentation
in class de.unihalle.informatik.Alida.operator.ALDOperator
Copyright © 2010–2020 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.