Method Detail

• getStructuringElementBoundingBox

  default Interval getStructuringElementBoundingBox(int numDimensions)

  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.

  Parameters:

  numDimensions - dimensions of the Shape

  Returns:

  an Interval that describes the bounding box of a Shape

• neighborhoods

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

  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 neighborhoodsSafe(RandomAccessibleInterval) which returns a new IterableInterval.cursor() every time (but therefore is not recommended if you want to use enhanced for loops).

  Parameters:

  source - source image.

  Returns:

  an IterableInterval that contains all Neighborhoods of the source image.

• neighborhoodsRandomAccessible

  <T> RandomAccessible<Neighborhood<T>> neighborhoodsRandomAccessible(RandomAccessible<T> source)

  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 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).

  Parameters:

  source - source image.

  Returns:

  an RandomAccessibleInterval that contains all Neighborhoods of the source image.

• neighborhoodsSafe

  <T> IterableInterval<Neighborhood<T>> neighborhoodsSafe(RandomAccessibleInterval<T> source)

  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 neighborhoods(RandomAccessibleInterval) which re-uses the same instance every time (but therefore has to be used carefully).

  Parameters:

  source - source image.

  Returns:

  an IterableInterval that contains all Neighborhoods of the source image.

• neighborhoodsRandomAccessibleSafe

  <T> RandomAccessible<Neighborhood<T>> neighborhoodsRandomAccessibleSafe(RandomAccessible<T> source)

  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 neighborhoods(RandomAccessibleInterval) which re-uses the same instance every time (but therefore has to be used carefully).

  Parameters:

  source - source image.

  Returns:

  an RandomAccessibleInterval that contains all Neighborhoods of the source image.