MaskPredicate (ImgLib2 Javadocs 0-SNAPSHOT API)

Type Parameters:

T - location in N-space; typically a RealLocalizable or Localizable).

All Superinterfaces:

EuclideanSpace, Predicate<T>

All Known Subinterfaces:

BinaryCompositeMaskPredicate<T>, Box, CompositeMaskPredicate<T>, Ellipsoid, Line, Mask, MaskInterval, PointMask, Polygon2D, Polyline, Polyshape, RealMask, RealMaskRealInterval, RealPointCollection<L>, Sphere, SuperEllipsoid, UnaryCompositeMaskPredicate<T>, WritableBox, WritableEllipsoid, WritableLine, WritablePointMask, WritablePolygon2D, WritablePolyline, WritablePolyshape, WritableRealPointCollection<L>, WritableSphere, WritableSuperEllipsoid

All Known Implementing Classes:

AbstractWritableBox, AbstractWritableEllipsoid, AbstractWritableSphere, AbstractWritableSuperEllipsoid, ClosedWritableBox, ClosedWritableEllipsoid, ClosedWritablePolygon2D, ClosedWritableSphere, ClosedWritableSuperEllipsoid, DefaultBinaryCompositeMask, DefaultBinaryCompositeMaskInterval, DefaultBinaryCompositeRealMask, DefaultBinaryCompositeRealMaskRealInterval, DefaultMask, DefaultMaskInterval, DefaultRealMask, DefaultRealMaskRealInterval, DefaultUnaryCompositeMask, DefaultUnaryCompositeMaskInterval, DefaultUnaryCompositeRealMask, DefaultUnaryCompositeRealMaskRealInterval, DefaultWritableLine, DefaultWritablePointMask, DefaultWritablePolygon2D, DefaultWritablePolyline, DefaultWritableRealPointCollection, KDTreeRealPointCollection, NNSRealPointCollection, OpenWritableBox, OpenWritableEllipsoid, OpenWritablePolygon2D, OpenWritableSphere, OpenWritableSuperEllipsoid, RandomAccessibleAsMask, RandomAccessibleIntervalAsMaskInterval, RealPointSampleListWritableRealPointCollection, RealRandomAccessibleAsRealMask, RealRandomAccessibleRealIntervalAsRealMaskRealInterval, RealTransformUnaryCompositeRealMask, RealTransformUnaryCompositeRealMaskRealInterval
```
public interface MaskPredicate<T>
extends Predicate<T>, EuclideanSpace
```
Base interface for all things that divide an N-space into two parts.

Author:

Alison Walter, Curtis Rueden, Tobias Pietzsch, Christian Dietz

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`MaskPredicate<T>`	`and(Predicate<? super T> other)`
`default BoundaryType`	`boundaryType()` Returns the boundary behavior of this Mask.
`boolean`	`equals(Object obj)` Determines whether two masks describe the same region in the same way.
`default boolean`	`isAll()` Returns true if `Predicate.test(T)` is known to always return true.
`default boolean`	`isEmpty()` Returns true if `Predicate.test(T)` is known to always return false.
`default KnownConstant`	`knownConstant()`
`default Class<?>`	`maskType()` Returns the type of the mask.
`MaskPredicate<T>`	`minus(Predicate<? super T> other)`
`MaskPredicate<T>`	`negate()`
`MaskPredicate<T>`	`or(Predicate<? super T> other)`
`MaskPredicate<T>`	`xor(Predicate<? super T> other)`

Methods inherited from interface java.util.function.Predicate
isEqual, test

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Method Detail
  - maskType
```
default Class<?> maskType()
```
    Returns the type of the mask. Each type of mask has distinct behavior regarding characteristics like equality and hashing.
  - boundaryType
```
default BoundaryType boundaryType()
```
    Returns the boundary behavior of this Mask.
  - knownConstant
```
default KnownConstant knownConstant()
```
  - isEmpty
```
default boolean isEmpty()
```
    Returns true if Predicate.test(T) is known to always return false.
  - isAll
```
default boolean isAll()
```
    Returns true if Predicate.test(T) is known to always return true.
  - equals
```
boolean equals(Object obj)
```
    Determines whether two masks describe the same region in the same way. Each kind of mask has its own semantics:
    - Two masks of the same kind describe the same region when they have the same attributes; for example, two polygon objects are equal if they have the same vertices in the same order at the same locations.
    - Two masks of different kinds are never considered to be describing the same region. For example, a box is not considered "equal" to a polygon even if the polygon's vertices are the four corners of the box, and the two masks have the same boundary type.
    Overrides:
    
    equals in class Object
  - and
```
MaskPredicate<T> and(Predicate<? super T> other)
```
    Specified by:
    
    and in interface Predicate<T>
  - or
```
MaskPredicate<T> or(Predicate<? super T> other)
```
    Specified by:
    
    or in interface Predicate<T>
  - negate
```
MaskPredicate<T> negate()
```
    Specified by:
    
    negate in interface Predicate<T>
  - minus
```
MaskPredicate<T> minus(Predicate<? super T> other)
```
  - xor
```
MaskPredicate<T> xor(Predicate<? super T> other)
```

Interface MaskPredicate<T>

Method Summary

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface net.imglib2.EuclideanSpace

Method Detail

maskType

boundaryType

knownConstant

isEmpty

isAll

equals

and

or

negate

minus

xor