Constructor Detail

• DiamondShape

  public DiamondShape(long radius)

  Constructor

  Parameters:

  radius - Radius for the diamond shape.

Method Detail

• neighborhoods

  public <T> IterableInterval<Neighborhood<T>> neighborhoods(RandomAccessibleInterval<T> source)

  Description copied from interface: Shape
  Get an IterableInterval that contains all Neighborhoods of the source image.

  A Cursor on the resulting accessible can be used to access the neighborhoods. As usual, when the cursor is moved, a neighborhood obtained previously from the cursor should be considered invalid.

  The neighborhoods that are obtained from the resulting accessible are unsafe in the following sense: Every time, a Cursor is requested (using IterableInterval.cursor() etc) the same Cursor instance is re-used. If you require to have more than one Cursor into the current neighborhood at a given time you have several options:

  1. Sampler.copy() the cursor you obtained using IterableInterval.cursor().
  2. use multiple parent cursors, i.e., cursors on the IterableInterval<Neighborhood>.
  3. use Shape.neighborhoodsSafe(RandomAccessibleInterval) which returns a new IterableInterval.cursor() every time (but therefore is not recommended if you want to use enhanced for loops).

  Specified by:

  neighborhoods in interface Shape

  Parameters:

  source - source image.

  Returns:

  an IterableInterval that contains all Neighborhoods of the source image.

• neighborhoodsRandomAccessible

  public <T> DiamondShape.NeighborhoodsAccessible<T> neighborhoodsRandomAccessible(RandomAccessible<T> source)

  Description copied from interface: Shape
  Get an RandomAccessibleInterval that contains all Neighborhoods of the source image.

  A RandomAccess on the resulting accessible can be used to access the neighborhoods. As usual, when the access is moved, a neighborhood obtained previously from the access should be considered invalid.

  The neighborhoods that are obtained from the resulting accessible are unsafe in the following sense: Every time, a Cursor is requested (using IterableInterval.cursor() etc) the same Cursor instance is re-used. If you require to have more than one Cursor into the current neighborhood at a given time you have several options:

  1. Sampler.copy() the cursor you obtained using IterableInterval.cursor().
  2. use multiple parent RandomAccesses, i.e., accesses on the RandomAccessibleInterval<Neighborhood>.
  3. use Shape.neighborhoodsRandomAccessibleSafe(net.imglib2.RandomAccessible<T>) which returns a new IterableInterval.cursor() every time (but therefore is not recommended if you want to use enhanced for loops).

  Specified by:

  neighborhoodsRandomAccessible in interface Shape

  Parameters:

  source - source image.

  Returns:

  an RandomAccessibleInterval that contains all Neighborhoods of the source image.

• neighborhoodsSafe

  public <T> DiamondShape.NeighborhoodsIterableInterval<T> neighborhoodsSafe(RandomAccessibleInterval<T> source)

  Description copied from interface: Shape
  Get an IterableInterval that contains all Neighborhoods of the source image.

  A Cursor on the resulting accessible can be used to access the neighborhoods. As usual, when the cursor is moved, a neighborhood obtained previously from the cursor should be considered invalid.

  Every time, a Cursor is requested from a Neighborhood (where the neighborhood in turn is obtained from a cursor on the IterableInterval returned by this method) a new Cursor instance is created. If you want to use enhanced for loops on the neighborhoods, consider using Shape.neighborhoods(RandomAccessibleInterval) which re-uses the same instance every time (but therefore has to be used carefully).

  Specified by:

  neighborhoodsSafe in interface Shape

  Parameters:

  source - source image.

  Returns:

  an IterableInterval that contains all Neighborhoods of the source image.

• neighborhoodsRandomAccessibleSafe

  public <T> DiamondShape.NeighborhoodsAccessible<T> neighborhoodsRandomAccessibleSafe(RandomAccessible<T> source)

  Description copied from interface: Shape
  Get an RandomAccessibleInterval that contains all Neighborhoods of the source image.

  A RandomAccess on the resulting accessible can be used to access the neighborhoods. As usual, when the access is moved, a neighborhood obtained previously from the access should be considered invalid.

  Every time, a Cursor is requested from a Neighborhood (where the neighborhood in turn is obtained from a cursor on the IterableInterval returned by this method) a new Cursor instance is created. If you want to use enhanced for loops on the neighborhoods, consider using Shape.neighborhoods(RandomAccessibleInterval) which re-uses the same instance every time (but therefore has to be used carefully).

  Specified by:

  neighborhoodsRandomAccessibleSafe in interface Shape

  Parameters:

  source - source image.

  Returns:

  an RandomAccessibleInterval that contains all Neighborhoods of the source image.

• getRadius

  public long getRadius()

  Returns:

  Radius of this shape.

  See Also:

  DiamondShape(long)

• toString

  public String toString()

  Overrides:

  toString in class Object

• getStructuringElementBoundingBox

  public Interval getStructuringElementBoundingBox(int numDimensions)

  Description copied from interface: Shape
  Get the bounding box for a Shape with numDimensions dimensions.

  Providing numDimensions is required since the input from which neighborhoods are generated is not known yet. The bounding box is described by an Interval with the center of the bounding box located at zero.

  The values of this bounding box should only be used to determine the extent of the Shape, ignoring the absolute min and max values.

  Specified by:

  getStructuringElementBoundingBox in interface Shape

  Parameters:

  numDimensions - dimensions of the Shape

  Returns:

  an Interval that describes the bounding box of a Shape