Masks (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.Masks

```
public class Masks
extends Object
```
Utility class for working with Masks and RealMasks.

Author:

Curtis Rueden, Alison Walter, Tobias Pietzsch

Constructor Summary

Constructors
Constructor and Description

Masks()

Constructors
Constructor and Description
`Masks()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Mask`	`allMask(int numDims)` Creates a `Mask` which returns `true` for all locations.
`static RealMask`	`allRealMask(int numDims)` Creates a `RealMask` which returns `true` for all locations.
`static MaskInterval`	`and(MaskInterval left, Predicate<? super Localizable> right)`
`static Mask`	`and(Mask left, Predicate<? super Localizable> right)`
`static RealMask`	`and(RealMask left, Predicate<? super RealLocalizable> right)`
`static RealMaskRealInterval`	`and(RealMaskRealInterval left, Predicate<? super RealLocalizable> right)`
`static Interval`	`emptyInterval(int numDims)` Creates an `Interval` which has min > max for all dimensions.
`static Mask`	`emptyMask(int numDims)` Creates a `Mask` which returns `false` for every location.
`static MaskInterval`	`emptyMaskInterval(int numDims)` Creates a `MaskInterval` which returns `false` for every location and has empty interval bounds (i.e.
`static RealInterval`	`emptyRealInterval(int numDims)` Creates an `RealInterval` which has min > max for all dimensions.
`static RealMask`	`emptyRealMask(int numDims)` Creates a `RealMask` which returns `false` for every location.
`static RealMaskRealInterval`	`emptyRealMaskRealInterval(int numDims)` Creates a `RealMaskRealInterval` which returns `false` for every location and has empty interval bounds (i.e.
`static MaskInterval`	`minus(MaskInterval left, Predicate<? super Localizable> right)`
`static Mask`	`minus(Mask left, Predicate<? super Localizable> right)`
`static RealMask`	`minus(RealMask left, Predicate<? super RealLocalizable> right)`
`static RealMaskRealInterval`	`minus(RealMaskRealInterval left, Predicate<? super RealLocalizable> right)`
`static Mask`	`negate(Mask arg)`
`static RealMask`	`negate(RealMask arg)`
`static MaskInterval`	`or(MaskInterval left, MaskInterval right)`
`static Mask`	`or(Mask left, Predicate<? super Localizable> right)`
`static RealMask`	`or(RealMask left, Predicate<? super RealLocalizable> right)`
`static RealMaskRealInterval`	`or(RealMaskRealInterval left, RealMaskRealInterval right)`
`static <T,M extends MaskPredicate<T>> boolean`	`sameTypesAndDimensions(M mask1, M mask2)` Returns true iff the two masks have the same mask type, boundary type and dimensionality.
`static IterableRegion<BoolType>`	`toIterableRegion(MaskInterval mask)` View a `MaskInterval` as an `IterableRegion`, in integer coordinates.
`static IterableRegion<BoolType>`	`toIterableRegion(RealMaskRealInterval mask)` View a `RealMaskRealInterval` as an `IterableRegion`, in integer coordinates.
`static <B extends BooleanType<B>> Mask`	`toMask(RandomAccessible<B> ra)` Wraps the given `RandomAccessible` as a `Mask`.
`static <B extends BooleanType<B>> MaskInterval`	`toMaskInterval(RandomAccessibleInterval<B> rai)` Wraps the given `RandomAccessibleInterval` as a `MaskInterval`.
`static RandomAccessible<BoolType>`	`toRandomAccessible(Mask mask)` Wraps the given `Mask` as a `RandomAccessible` of `BoolType`.
`static RandomAccessibleInterval<BoolType>`	`toRandomAccessibleInterval(MaskInterval mask)` Wraps the given `MaskInterval` as a `RandomAccessibleInterval` of `BoolType`.
`static <B extends BooleanType<B>> RealMask`	`toRealMask(RealRandomAccessible<B> rra)` Wraps the given `RealRandomAccessible` as a `RealMask`.
`static <B extends BooleanType<B>> RealMaskRealInterval`	`toRealMaskRealInterval(RealRandomAccessibleRealInterval<B> rrari)` Wraps the given `RealRandomAccessibleRealInterval` as a `RealMaskRealInterval`.
`static RealRandomAccessible<BoolType>`	`toRealRandomAccessible(RealMask mask)` Wraps the given `RealMask` as a `RealRandomAccessible` of `BoolType`.
`static RealRandomAccessibleRealInterval<BoolType>`	`toRealRandomAccessibleRealInterval(RealMaskRealInterval mask)` Wraps the given `RealMaskRealInterval` as a `RealRandomAccessibleRealInterval` of `BoolType`.
`static MaskInterval`	`xor(MaskInterval left, MaskInterval right)`
`static Mask`	`xor(Mask left, Predicate<? super Localizable> right)`
`static RealMask`	`xor(RealMask left, Predicate<? super RealLocalizable> right)`
`static RealMaskRealInterval`	`xor(RealMaskRealInterval left, RealMaskRealInterval right)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - Masks
```
public Masks()
```
- Method Detail
 - and
```
public static Mask and(Mask left,
 Predicate<? super Localizable> right)
```
 - and
```
public static MaskInterval and(MaskInterval left,
 Predicate<? super Localizable> right)
```
 - or
```
public static Mask or(Mask left,
 Predicate<? super Localizable> right)
```
 - or
```
public static MaskInterval or(MaskInterval left,
 MaskInterval right)
```
 - xor
```
public static Mask xor(Mask left,
 Predicate<? super Localizable> right)
```
 - xor
```
public static MaskInterval xor(MaskInterval left,
 MaskInterval right)
```
 - minus
```
public static Mask minus(Mask left,
 Predicate<? super Localizable> right)
```
 - minus
```
public static MaskInterval minus(MaskInterval left,
 Predicate<? super Localizable> right)
```
 - negate
```
public static Mask negate(Mask arg)
```
 - and
```
public static RealMask and(RealMask left,
 Predicate<? super RealLocalizable> right)
```
 - and
```
public static RealMaskRealInterval and(RealMaskRealInterval left,
 Predicate<? super RealLocalizable> right)
```
 - or
```
public static RealMask or(RealMask left,
 Predicate<? super RealLocalizable> right)
```
 - or
```
public static RealMaskRealInterval or(RealMaskRealInterval left,
 RealMaskRealInterval right)
```
 - xor
```
public static RealMask xor(RealMask left,
 Predicate<? super RealLocalizable> right)
```
 - xor
```
public static RealMaskRealInterval xor(RealMaskRealInterval left,
 RealMaskRealInterval right)
```
 - minus
```
public static RealMask minus(RealMask left,
 Predicate<? super RealLocalizable> right)
```
 - minus
```
public static RealMaskRealInterval minus(RealMaskRealInterval left,
 Predicate<? super RealLocalizable> right)
```
 - negate
```
public static RealMask negate(RealMask arg)
```
 - toRandomAccessible
```
public static RandomAccessible<BoolType> toRandomAccessible(Mask mask)
```
 Wraps the given Mask as a RandomAccessible of BoolType. If the given Mask is a MaskInterval, a RandomAccessibleInterval is returned.
 
 Parameters:
 
 mask - Mask to be wrapped
 
 Returns:
 
 a RandomAccessible equivalent to the given Mask
 - toRandomAccessibleInterval
```
public static RandomAccessibleInterval<BoolType> toRandomAccessibleInterval(MaskInterval mask)
```
 Wraps the given MaskInterval as a RandomAccessibleInterval of BoolType.
 
 Parameters:
 
 mask - MaskInterval to be wrapped
 
 Returns:
 
 RandomAccessibleInterval equivalent to given MaskInterval
 - toRealRandomAccessible
```
public static RealRandomAccessible<BoolType> toRealRandomAccessible(RealMask mask)
```
 Wraps the given RealMask as a RealRandomAccessible of BoolType. If the given RealMask is a RealMaskRealInterval, a RealRandomAccessibleRealInterval is returned.
 
 Parameters:
 
 mask - RealMask to be wrapped
 
 Returns:
 
 RealRandomAccessible equivalent to the given RealMask
 - toRealRandomAccessibleRealInterval
```
public static RealRandomAccessibleRealInterval<BoolType> toRealRandomAccessibleRealInterval(RealMaskRealInterval mask)
```
 Wraps the given RealMaskRealInterval as a RealRandomAccessibleRealInterval of BoolType.
 
 Parameters:
 
 mask - RealMaskRealInterval to be wrapped
 
 Returns:
 
 RealRandomAccessibleRealInterval equivalent to given RealMaskRealInterval
 - toIterableRegion
```
public static IterableRegion<BoolType> toIterableRegion(RealMaskRealInterval mask)
```
 View a RealMaskRealInterval as an IterableRegion, in integer coordinates. This method enables using a RealMaskRealInterval as the ROI to iterate over in a RandomAccessible, in conjunction with Regions.sample(net.imglib2.IterableInterval, RandomAccessible). For example, to iterate the values inside a sphere, do:
```
 final ClosedWritableSphere sphere = ...
 final RandomAccessibleInterval rai = ...

 for ( final T t : Regions.sample( Masks.toIterableRegion( sphere ), rai )
 {
 // Do something with t
 }
 
```
 Parameters:
 
 mask - RealMaskRealInterval to be iterated in in integer coordinates.
 
 Returns:
 
 IterableRegion<BoolType>
 - toIterableRegion
```
public static IterableRegion<BoolType> toIterableRegion(MaskInterval mask)
```
 View a MaskInterval as an IterableRegion, in integer coordinates. This method enables using a MaskInterval as the ROI to iterate over in a RandomAccessible, in conjunction with Regions.sample(net.imglib2.IterableInterval, RandomAccessible). For example, to iterate the values inside a sphere, do:
```
 final ClosedWritableSphere sphere = ...
 final RandomAccessibleInterval rai = ...

 for ( final T t : Regions.sample( Masks.toIterableRegion( sphere ), rai )
 {
 // Do something with t
 }
 
```
 Parameters:
 
 mask - MaskInterval to be iterated.
 
 Returns:
 
 IterableRegion<BoolType>
 - toMask
```
public static > Mask toMask(RandomAccessible ra)
```
 Wraps the given RandomAccessible as a Mask. If the given RandomAccessible is a RandomAccessibleInterval a MaskInterval is returned.
 
 Parameters:
 
 ra - RandomAccessible to be wrapped
 
 Returns:
 
 Mask equivalent to the given RandomAccessible
 - toMaskInterval
```
public static > MaskInterval toMaskInterval(RandomAccessibleInterval rai)
```
 Wraps the given RandomAccessibleInterval as a MaskInterval.
 
 Parameters:
 
 rai - RandomAccessibleInterval to be wrapped
 
 Returns:
 
 MaskInterval equivalent to the given RandomAccessibleInterval
 - toRealMask
```
public static > RealMask toRealMask(RealRandomAccessible rra)
```
 Wraps the given RealRandomAccessible as a RealMask. If the given RealRandomAccessible is a RealRandomAccessibleRealInterval a RealMaskRealInterval is returned.
 
 Parameters:
 
 rra - RealRandomAccessible to be wrapped
 
 Returns:
 
 RealMask equivalent to the given RealRandomAccessible
 - toRealMaskRealInterval
```
public static > RealMaskRealInterval toRealMaskRealInterval(RealRandomAccessibleRealInterval rrari)
```
 Wraps the given RealRandomAccessibleRealInterval as a RealMaskRealInterval.
 
 Parameters:
 
 rrari - RealRandomAccessibleRealInterval to be wrapped
 
 Returns:
 
 RealMaskRealInterval equivalent to the given RealRandomAccessibleRealInterval
 - emptyMask
```
public static Mask emptyMask(int numDims)
```
 Creates a Mask which returns false for every location.
 
 Parameters:
 
 numDims - number of dimensions the resulting Mask should have
 
 Returns:
 
 Mask which returns false for all locations
 - emptyMaskInterval
```
public static MaskInterval emptyMaskInterval(int numDims)
```
 Creates a MaskInterval which returns false for every location and has empty interval bounds (i.e. min > max).
 
 Parameters:
 
 numDims - number of dimensions the resulting MaskInterval should have
 
 Returns:
 
 MaskInterval which returns false for all locations
 - emptyRealMask
```
public static RealMask emptyRealMask(int numDims)
```
 Creates a RealMask which returns false for every location.
 
 Parameters:
 
 numDims - number of dimensions the resulting RealMask should have
 
 Returns:
 
 RealMask which returns false for all locations
 - emptyRealMaskRealInterval
```
public static RealMaskRealInterval emptyRealMaskRealInterval(int numDims)
```
 Creates a RealMaskRealInterval which returns false for every location and has empty interval bounds (i.e. min > max).
 
 Parameters:
 
 numDims - number of dimensions the resulting RealMaskRealInterval should have
 
 Returns:
 
 RealMaskRealInterval which returns false for all locations
 - emptyInterval
```
public static Interval emptyInterval(int numDims)
```
 Creates an Interval which has min > max for all dimensions.
 
 Parameters:
 
 numDims - dimensions of the resulting Interval
 
 Returns:
 
 Interval with min > max
 - emptyRealInterval
```
public static RealInterval emptyRealInterval(int numDims)
```
 Creates an RealInterval which has min > max for all dimensions.
 
 Parameters:
 
 numDims - dimensions of the resulting RealInterval
 
 Returns:
 
 RealInterval with min > max
 - allMask
```
public static Mask allMask(int numDims)
```
 Creates a Mask which returns true for all locations.
 
 Parameters:
 
 numDims - number of dimensions of the Mask
 
 Returns:
 
 Mask which is true for all locations
 - allRealMask
```
public static RealMask allRealMask(int numDims)
```
 Creates a RealMask which returns true for all locations.
 
 Parameters:
 
 numDims - number of dimensions of the RealMask
 
 Returns:
 
 RealMask which is true for all locations
 - sameTypesAndDimensions
```
public static <T,M extends MaskPredicate<T>> boolean sameTypesAndDimensions(M mask1,
 M mask2)
```
 Returns true iff the two masks have the same mask type, boundary type and dimensionality.
 
 Parameters:
 
 mask1 - The first mask to compare.
 
 mask2 - The second mask to compare.
 
 Returns:
 
 True iff mask types and dimensionality match.

Class Masks

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Masks

Method Detail

and

and

or

or

xor

xor

minus

minus

negate

and

and

or

or

xor

xor

minus

minus

negate

toRandomAccessible

toRandomAccessibleInterval

toRealRandomAccessible

toRealRandomAccessibleRealInterval

toIterableRegion

toIterableRegion

toMask

toMaskInterval

toRealMask

toRealMaskRealInterval

emptyMask

emptyMaskInterval

emptyRealMask

emptyRealMaskRealInterval

emptyInterval

emptyRealInterval

allMask

allRealMask

sameTypesAndDimensions