de.unihalle.informatik.MiToBo.tools.image

Class ImageDimensionReducer

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.MiToBo.core.operator.MTBOperator

de.unihalle.informatik.MiToBo.tools.image.ImageDimensionReducer

All Implemented Interfaces:

de.unihalle.informatik.Alida.datatypes.ALDConfigurationValidator, de.unihalle.informatik.Alida.operator.events.ALDOperatorExecutionProgressEventListener, EventListener

@ALDAOperator(genericExecutionMode=ALL,
              level=STANDARD)
public class ImageDimensionReducer
extends MTBOperator

Operator to reduce image dimension by projecting multi-dimensional images along selected dimensions.

This operator can for example be applied to generate a maximum projection of a z-stack, or to project images row- or columnwise.

Author:

gress, moeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ImageDimensionReducer.IntObject Internal helper class for iterating over an image dimension.
static class	ImageDimensionReducer.ReducerMethod Methods for dimension reduction/projection.

Nested classes/interfaces inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.Alida.operator.ALDOperator.HidingMode, de.unihalle.informatik.Alida.operator.ALDOperator.HistoryConstructionMode

Field Summary

Fields

Modifier and Type	Field and Description
private MTBImage	inImg Multi-dimensional input image or input stack.
private boolean	projectAlongC Enables/disables projection along c-dimension.
private boolean	projectAlongT Enables/disables projection along t-dimension.
private boolean	projectAlongX Enables/disables projection along x-dimension.
private boolean	projectAlongY Enables/disables projection along y-dimension.
private boolean	projectAlongZ Enables/disables projection along z-dimension.
private ImageDimensionReducer.ReducerMethod	projMode Projection mode.
private MTBImage	resultImg Result image (stack).

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
ImageDimensionReducer() Constructor.
ImageDimensionReducer(MTBImage img, boolean reduceX, boolean reduceY, boolean reduceZ, boolean reduceT, boolean reduceC, ImageDimensionReducer.ReducerMethod method) Constructor with arguments.

Method Summary

Modifier and Type	Method and Description
MTBImage	getResultImg() Get result image.
protected void	operate()
private MTBImage	reduce() Method which implements the dimension reduction.
void	setInImg(MTBImage img) Set input image.
void	setReduceC(boolean value) Enable/disable projection along c-dimension.
protected void	setReduceT(boolean value) Enable/disable projection along t-dimension.
void	setReduceX(boolean value) Enable/disable projection along x-dimension.
void	setReduceY(boolean value) Enable/disable projection along y-dimension.
void	setReduceZ(boolean value) Enable/disable projection along z-dimension.
void	setReductionMode(ImageDimensionReducer.ReducerMethod value) Specify projection mode.

Methods inherited from class de.unihalle.informatik.MiToBo.core.operator.MTBOperator

readResolve

Methods inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getDocumentation, 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, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

inImg

@Parameter(label="Input image",
           required=true,
           dataIOOrder=-1,
           direction=IN,
           mode=STANDARD,
           description="Input image to reduce in dimension.")
private MTBImage inImg

Multi-dimensional input image or input stack.

projMode

@Parameter(label="Reduction Mode",
           required=true,
           direction=IN,
           mode=STANDARD,
           dataIOOrder=0,
           description="Reduction mode.")
private ImageDimensionReducer.ReducerMethod projMode

Projection mode.

projectAlongX

@Parameter(label="Project along x",
           required=true,
           dataIOOrder=1,
           direction=IN,
           mode=STANDARD,
           description="Select for projection along x-dimension.")
private boolean projectAlongX

Enables/disables projection along x-dimension.

projectAlongY

@Parameter(label="Project along y",
           required=true,
           dataIOOrder=2,
           direction=IN,
           mode=STANDARD,
           description="Select for projection along y-dimension.")
private boolean projectAlongY

Enables/disables projection along y-dimension.

projectAlongZ

@Parameter(label="Project along z",
           required=true,
           dataIOOrder=3,
           direction=IN,
           mode=STANDARD,
           description="Select for projection along z-dimension.")
private boolean projectAlongZ

Enables/disables projection along z-dimension.

projectAlongT

@Parameter(label="Project along t",
           required=true,
           dataIOOrder=4,
           direction=IN,
           mode=STANDARD,
           description="Select for projection along t-dimension.")
private boolean projectAlongT

Enables/disables projection along t-dimension.

projectAlongC

@Parameter(label="Project along c",
           required=true,
           dataIOOrder=5,
           direction=IN,
           mode=STANDARD,
           description="Select for projection along c-dimension.")
private boolean projectAlongC

Enables/disables projection along c-dimension.

resultImg

@Parameter(label="Result image",
           dataIOOrder=0,
           direction=OUT,
           mode=STANDARD,
           description="Resulting dimension-reduced image.")
private MTBImage resultImg

Result image (stack).

Constructor Detail

ImageDimensionReducer

public ImageDimensionReducer()
                      throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.

ImageDimensionReducer

public ImageDimensionReducer(MTBImage img,
                             boolean reduceX,
                             boolean reduceY,
                             boolean reduceZ,
                             boolean reduceT,
                             boolean reduceC,
                             ImageDimensionReducer.ReducerMethod method)
                      throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor with arguments.

Parameters:

img - Input image.

reduceX - Flag for x-dimension reduction.

reduceY - Flag for y-dimension reduction.

reduceZ - Flag for z-dimension reduction.

reduceT - Flag for t-dimension reduction.

reduceC - Flag for c-dimension reduction.

method - Reduction method.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.

Method Detail

operate

protected void operate()
                throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Specified by:

operate in class de.unihalle.informatik.Alida.operator.ALDOperator

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

reduce

private MTBImage reduce()

Method which implements the dimension reduction.

Returns:

Dimension-reduced image.

setReduceZ

public void setReduceZ(boolean value)

Enable/disable projection along z-dimension.

Parameters:

value - If true, projection along z is enabled.

setReduceC

public void setReduceC(boolean value)

Enable/disable projection along c-dimension.

Parameters:

value - If true, projection along c is enabled.

setReduceY

public void setReduceY(boolean value)

Enable/disable projection along y-dimension.

Parameters:

value - If true, projection along y is enabled.

setReduceX

public void setReduceX(boolean value)

Enable/disable projection along x-dimension.

Parameters:

value - If true, projection along x is enabled.

setReduceT

protected void setReduceT(boolean value)

Enable/disable projection along t-dimension.

Parameters:

value - If true, projection along t is enabled.

setReductionMode

public void setReductionMode(ImageDimensionReducer.ReducerMethod value)

Specify projection mode.

Parameters:

value - Mode to apply.

setInImg

public void setInImg(MTBImage img)

Set input image.

Parameters:

img - Image to process.

getResultImg

public MTBImage getResultImg()

Get result image.

Returns:

Result image.