Modifier and Type | Class and Description |
---|---|
static class |
HorizontalLineShape.NeighborhoodsAccessible<T> |
static class |
HorizontalLineShape.NeighborhoodsIterableInterval<T> |
Constructor and Description |
---|
HorizontalLineShape(long span,
int dim,
boolean skipCenter)
Create a new line shape.
|
public HorizontalLineShape(long span, int dim, boolean skipCenter)
span
- the span of the line in both directions, so that its total
extend is given by 2 x span + 1
.dim
- the dimension along which to lay this line.skipCenter
- if true
, the shape will skip the center point of
the line.public <T> HorizontalLineShape.NeighborhoodsIterableInterval<T> neighborhoods(RandomAccessibleInterval<T> source)
Shape
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:
Sampler.copy()
the cursor you obtained using
IterableInterval.cursor()
.
IterableInterval
<Neighborhood
>.
Shape.neighborhoodsSafe(RandomAccessibleInterval)
which
returns a new IterableInterval.cursor()
every time (but therefore is
not recommended if you want to use enhanced for loops).
neighborhoods
in interface Shape
source
- source image.IterableInterval
that contains all
Neighborhoods
of the source image.public <T> HorizontalLineShape.NeighborhoodsAccessible<T> neighborhoodsRandomAccessible(RandomAccessible<T> source)
Shape
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:
Sampler.copy()
the cursor you obtained using
IterableInterval.cursor()
.
RandomAccesses
, i.e.,
accesses on the
RandomAccessibleInterval
<Neighborhood
>.
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).
neighborhoodsRandomAccessible
in interface Shape
source
- source image.RandomAccessibleInterval
that contains all
Neighborhoods
of the source image.public <T> IterableInterval<Neighborhood<T>> neighborhoodsSafe(RandomAccessibleInterval<T> source)
Shape
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).
neighborhoodsSafe
in interface Shape
source
- source image.IterableInterval
that contains all
Neighborhoods
of the source image.public <T> HorizontalLineShape.NeighborhoodsAccessible<T> neighborhoodsRandomAccessibleSafe(RandomAccessible<T> source)
Shape
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).
neighborhoodsRandomAccessibleSafe
in interface Shape
source
- source image.RandomAccessibleInterval
that contains all
Neighborhoods
of the source image.public boolean isSkippingCenter()
true
if skipCenter
was set to true
during construction, false
otherwise.CenteredRectangleShape(int[], boolean)
public long getSpan()
public int getLineDimension()
public Interval getStructuringElementBoundingBox(int numDimensions)
Shape
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.
getStructuringElementBoundingBox
in interface Shape
numDimensions
- dimensions of the Shape
Interval
that describes the bounding box of a
Shape
Copyright © 2015–2022 ImgLib2. All rights reserved.