Class BallStrel

java.lang.Object
All Implemented Interfaces:
Algo, Strel3D

public class BallStrel
extends AbstractStrel3D
A 3D structuring element with a ball shape, with same size in each direction.
Author:
dlegland
See Also:
EllipsoidStrel
  • Nested Class Summary

    Nested classes/interfaces inherited from interface inra.ijpb.morphology.Strel3D

    Strel3D.Shape
  • Field Summary

    Fields inherited from interface inra.ijpb.morphology.Strel3D

    BACKGROUND, FOREGROUND
  • Method Summary

    Modifier and Type Method Description
    ij.ImageStack dilation​(ij.ImageStack image)
    Performs dilation with a ball structuring element by calling the ImageJ Filters3D.filter method, using Filters3D.MAX option.
    ij.ImageStack erosion​(ij.ImageStack image)
    Performs erosion with a ball structuring element by calling the ImageJ Filters3D.filter method, using Filters3D.MIN option.
    static BallStrel fromDiameter​(double diam)
    Creates a structuring element with a spherical shape of the given diameter.
    static BallStrel fromRadius​(double radius)
    Creates a structuring element with a spherical shape of the given radius.
    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.
    Strel3D reverse()
    Returns a reversed (i.e. symmetric wrt the origin) version of this structuring element.

    Methods inherited from class inra.ijpb.morphology.strel.AbstractStrel3D

    addBorder, closing, cropBorder, opening, showProgress, showProgress

    Methods inherited from class inra.ijpb.algo.AlgoStub

    addAlgoListener, removeAlgoListener

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface inra.ijpb.algo.Algo

    addAlgoListener, removeAlgoListener
  • Method Details

    • fromRadius

      public static final BallStrel fromRadius​(double radius)
      Creates a structuring element with a spherical shape of the given radius.
      Parameters:
      radius - the radius of the structuring element, in pixels
      Returns:
      a new structuring element with ball shape and specified radius
    • fromDiameter

      public static final BallStrel fromDiameter​(double diam)
      Creates a structuring element with a spherical shape of the given diameter.
      Parameters:
      diam - the diameter of the ball, in pixels
      Returns:
      a new structuring element with ball shape and specified radius
    • getSize

      public int[] getSize()
      Description copied from interface: Strel3D
      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

      public int[][][] getMask3D()
      Description copied from interface: Strel3D
      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

      public int[] getOffset()
      Description copied from interface: Strel3D
      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

      public int[][] getShifts3D()
      Description copied from interface: Strel3D
      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

      public Strel3D reverse()
      Description copied from interface: Strel3D
      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

      public ij.ImageStack dilation​(ij.ImageStack image)
      Performs dilation with a ball structuring element by calling the ImageJ Filters3D.filter method, using Filters3D.MAX option.
      Specified by:
      dilation in interface Strel3D
      Overrides:
      dilation in class AbstractStrel3D
      Parameters:
      image - the 3D stack to process
      Returns:
      the result of dilation with this structuring element
      See Also:
      Strel3D.getShifts3D(), AbstractStrel3D.erosion(ImageStack)
    • erosion

      public ij.ImageStack erosion​(ij.ImageStack image)
      Performs erosion with a ball structuring element by calling the ImageJ Filters3D.filter method, using Filters3D.MIN option.
      Specified by:
      erosion in interface Strel3D
      Overrides:
      erosion in class AbstractStrel3D
      Parameters:
      image - the 3D stack to process
      Returns:
      the result of erosion with this structuring element
      See Also:
      Strel3D.getShifts3D(), AbstractStrel3D.dilation(ImageStack)