Interface Strel3D

All Superinterfaces:
Algo
All Known Subinterfaces:
InPlaceStrel, InPlaceStrel3D, SeparableStrel, SeparableStrel3D, Strel
All Known Implementing Classes:
AbstractInPlaceStrel, AbstractInPlaceStrel3D, AbstractSeparableStrel, AbstractSeparableStrel3D, AbstractStrel, AbstractStrel3D, BallStrel, Cross3DStrel, Cross3x3Strel, CubeStrel, CuboidStrel, DiamondStrel, DiskStrel, EllipsoidStrel, ExtrudedStrel, LinearDepthStrel3D, LinearDiagDownStrel, LinearDiagUpStrel, LinearHorizontalStrel, LinearVerticalStrel, OctagonStrel, OrientedLineStrel, SquareStrel

public interface Strel3D
extends Algo
Structuring element that process 3D stack.
Author:
David Legland
  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static class  Strel3D.Shape
    An enumeration of the different possible structuring element shapes.
  • Field Summary

    Fields
    Modifier and Type Field Description
    static int BACKGROUND
    Default value for background pixels.
    static int FOREGROUND
    Default value for foreground pixels.
  • Method Summary

    Modifier and Type Method Description
    ij.ImageStack closing​(ij.ImageStack image)
    Performs a morphological closing of the input image with this structuring element, and returns the result in a new ImageStack.
    ij.ImageStack dilation​(ij.ImageStack image)
    Performs a morphological dilation of the input image with this structuring element, and returns the result in a new ImageStack.
    ij.ImageStack erosion​(ij.ImageStack image)
    Performs an morphological erosion of the input image with this structuring element, and returns the result in a new ImageStack.
    int[][][] getMask3D()
    Returns the structuring element as a mask.
    int[] getOffset()
    Returns the offset in the mask for each direction.
    int[][] getShifts3D()
    Returns the structuring element as a set of shifts.
    int[] getSize()
    Returns the size of the structuring element, as an array of size in each direction.
    ij.ImageStack opening​(ij.ImageStack image)
    Performs a morphological opening of the input image with this structuring element, and returns the result in a new ImageStack.
    Strel3D reverse()
    Returns a reversed (i.e. symmetric wrt the origin) version of this structuring element.
    boolean showProgress()
    Returns a boolean flag indicating whether or not this structuring element should display its progress or not
    void showProgress​(boolean b)
    Specifies if this structuring element should display its progress.

    Methods inherited from interface inra.ijpb.algo.Algo

    addAlgoListener, removeAlgoListener
  • Field Details

    • BACKGROUND

      static final int BACKGROUND
      Default value for background pixels.
      See Also:
      Constant Field Values
    • FOREGROUND

      static final int FOREGROUND
      Default value for foreground pixels.
      See Also:
      Constant Field Values
  • Method Details

    • getSize

      int[] getSize()
      Returns the size of the structuring element, as an array of size in each direction. The first index corresponds to the number of pixels in the x direction.
      Returns:
      the size of the structuring element
    • getMask3D

      int[][][] getMask3D()
      Returns the structuring element as a mask. Each value is either 0 or 255. The first index corresponds to the z position, the second index to the y direction, and the third one to the x position.
      Returns:
      the mask of the structuring element
    • getOffset

      int[] getOffset()
      Returns the offset in the mask for each direction. The first value corresponds to the shift in the x direction.
      Returns:
      the offset in the mask
    • getShifts3D

      int[][] getShifts3D()
      Returns the structuring element as a set of shifts. The size of the result is N-by-3, where N is the number of elements of the structuring element. The first value corresponds to the shift in the x direction.
      Returns:
      a set of shifts
    • reverse

      Strel3D reverse()
      Returns a reversed (i.e. symmetric wrt the origin) version of this structuring element. Implementations can return more specialized type depending on the implemented interfaces.
      Returns:
      the reversed structuring element
    • dilation

      ij.ImageStack dilation​(ij.ImageStack image)
      Performs a morphological dilation of the input image with this structuring element, and returns the result in a new ImageStack.
      Parameters:
      image - the input image
      Returns:
      the result of dilation with this structuring element
      See Also:
      erosion(ij.ImageStack), closing(ij.ImageStack), opening(ij.ImageStack)
    • erosion

      ij.ImageStack erosion​(ij.ImageStack image)
      Performs an morphological erosion of the input image with this structuring element, and returns the result in a new ImageStack.
      Parameters:
      image - the input image
      Returns:
      the result of erosion with this structuring element
      See Also:
      dilation(ij.ImageStack), closing(ij.ImageStack), opening(ij.ImageStack)
    • closing

      ij.ImageStack closing​(ij.ImageStack image)
      Performs a morphological closing of the input image with this structuring element, and returns the result in a new ImageStack. The closing is equivalent in performing a dilation followed by an erosion with the reversed structuring element.
      Parameters:
      image - the input image
      Returns:
      the result of closing with this structuring element
      See Also:
      dilation(ij.ImageStack), erosion(ij.ImageStack), opening(ij.ImageStack), reverse()
    • opening

      ij.ImageStack opening​(ij.ImageStack image)
      Performs a morphological opening of the input image with this structuring element, and returns the result in a new ImageStack. The opening is equivalent in performing an erosion followed by a dilation with the reversed structuring element.
      Parameters:
      image - the input image
      Returns:
      the result of opening with this structuring element
      See Also:
      dilation(ij.ImageStack), erosion(ij.ImageStack), closing(ij.ImageStack), reverse()
    • showProgress

      boolean showProgress()
      Returns a boolean flag indicating whether or not this structuring element should display its progress or not
      Returns:
      a boolean flag with value true if progress should be displayed
    • showProgress

      void showProgress​(boolean b)
      Specifies if this structuring element should display its progress.
      Parameters:
      b - a boolean flag with value true if progress should be displayed