net.imglib2.roi

Class Regions

java.lang.Object

net.imglib2.roi.Regions

public class Regions
extends Object

Constructor Summary

Constructors

Constructor and Description
Regions()

Method Summary

Modifier and Type	Method and Description
static <B extends BooleanType<B>> long	countTrue(RandomAccessibleInterval<B> interval) Counts the number of true pixels in the given region.
static <B extends BooleanType<B>> IterableRegion<B>	iterable(RandomAccessibleInterval<B> region) Obtains an IterableRegion whose iteration consists of only the true pixels of a region (instead of all pixels in bounding box).
static <B extends BooleanType<B>> PositionableIterableRegion<B>	positionable(RandomAccessibleInterval<B> region) Make any RandomAccessibleInterval<BooleanType> into an PositionableIterableRegion.
static <T> IterableInterval<T>	sample(IterableInterval<Void> region, RandomAccessible<T> img) Given a region and an image, return an IterableInterval over the pixels of the image inside the mask.
static <T> IterableInterval<T>	sample(MaskInterval mask, RandomAccessible<T> img) Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.
static <T> IterableInterval<T>	sample(RealMaskRealInterval mask, RandomAccessible<T> img) Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.
static <T> IterableInterval<T>	sampleWithMask(Mask mask, RandomAccessibleInterval<T> img) Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.
static <T,B extends BooleanType<B>> IterableInterval<T>	sampleWithRandomAccessible(RandomAccessible<B> mask, RandomAccessibleInterval<T> img) Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.
static <T> IterableInterval<T>	sampleWithRealMask(RealMask mask, RandomAccessibleInterval<T> img) Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.

Methods inherited from class java.lang.Object

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

Constructor Detail

Regions

public Regions()

Method Detail

sample

public static <T> IterableInterval<T> sample(IterableInterval<Void> region,
                                             RandomAccessible<T> img)

Given a region and an image, return an IterableInterval over the pixels of the image inside the mask.

Parameters:

region - The region that defines which pixels in img to iterate over.

img - The source from which to grab the pixels inside the region.

Returns:

An IterableInterval over the samples of img inside the region.

sample

public static <T> IterableInterval<T> sample(MaskInterval mask,
                                             RandomAccessible<T> img)

Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.

Parameters:

mask - The mask that defines which pixels in img to iterate over.

img - The source from which to grab the pixels inside the mask.

Returns:

An IterableInterval over the samples of img inside the mask.

sample

public static <T> IterableInterval<T> sample(RealMaskRealInterval mask,
                                             RandomAccessible<T> img)

Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.

Parameters:

mask - The mask that defines which pixels in img to iterate over.

img - The source from which to grab the pixels inside the mask.

Returns:

An IterableInterval over the samples of img inside the mask.

sampleWithRandomAccessible

public static <T,B extends BooleanType<B>> IterableInterval<T> sampleWithRandomAccessible(RandomAccessible<B> mask,
                                                                                          RandomAccessibleInterval<T> img)

Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.

Parameters:

mask - The mask that defines which pixels in img to iterate over.

img - The source from which to grab the pixels inside the mask.

Returns:

An IterableInterval over the samples of img inside the mask.

sampleWithMask

public static <T> IterableInterval<T> sampleWithMask(Mask mask,
                                                     RandomAccessibleInterval<T> img)

Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.

Parameters:

mask - The mask that defines which pixels in img to iterate over.

img - The source from which to grab the pixels inside the mask.

Returns:

An IterableInterval over the samples of img inside the mask.

sampleWithRealMask

public static <T> IterableInterval<T> sampleWithRealMask(RealMask mask,
                                                         RandomAccessibleInterval<T> img)

Given a mask and an image, return an IterableInterval over the pixels of the image inside the mask.

Parameters:

mask - The mask that defines which pixels in img to iterate over.

img - The source from which to grab the pixels inside the mask.

Returns:

An IterableInterval over the samples of img inside the mask.

iterable

public static <B extends BooleanType<B>> IterableRegion<B> iterable(RandomAccessibleInterval<B> region)

Obtains an IterableRegion whose iteration consists of only the true pixels of a region (instead of all pixels in bounding box).

If region already is an IterableRegion, return it. Otherwise, wrap it. This is potentially expensive, because it requires iterating region once.

Type Parameters:

B - The BooleanType of the region.

Parameters:

region - The region to filter by its true values.

Returns:

An IterableRegion consisting of true values of the input region.

positionable

public static <B extends BooleanType<B>> PositionableIterableRegion<B> positionable(RandomAccessibleInterval<B> region)

Make any RandomAccessibleInterval<BooleanType> into an PositionableIterableRegion.

If region already is a PositionableIterableRegion, return it. Otherwise, wrap it. This is potentially expensive, because it requires iterating region once, unless it already is an IterableRegion.

Parameters:

region - the region to make iterable and positionable

Returns:

region as an PositionableIterableRegion

countTrue

public static <B extends BooleanType<B>> long countTrue(RandomAccessibleInterval<B> interval)

Counts the number of true pixels in the given region.

Type Parameters:

B - The BooleanType of the region.

Parameters:

interval - The region whose true values should be counted.

Returns:

The number of true values in the region.