Bounds (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.Bounds<I,B>

Type Parameters:

I - interval type (Interval or RealInterval)

B - recursive type of this Bounds

Direct Known Subclasses:

Bounds.IntBounds, Bounds.RealBounds
```
public abstract class Bounds<I extends RealInterval,B extends Bounds<I,B>>
extends Object
```
Operations on mask bounds. Bounds can be UNBOUNDED, or a (possibly empty) (Real)Interval. Bounds can be composites of other Bounds and change if the underlying Bounds are modified. A Bounds can never go from UNBOUNDED to being an interval or vice versa, though.
Specialized for RealInterval and Interval in nested subclasses Bounds.IntBounds and Bounds.RealBounds.

TODO: explain how empty intervals are determined by min/max and how emptiness property is propagated.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Bounds.AbstractAdaptingInterval` Abstract base class which adapts to changes in source interval, leaving `Interval.min(int)` and `Interval.max(int)` methods to be implemented by derived classes.
`static class`	`Bounds.AbstractAdaptingRealInterval` Abstract base class for bounds which adapt to changes in the source interval, leaving `RealInterval.realMin(int)` and `RealInterval.realMax(int)` methods to be implemented by derived classes.
`static interface`	`Bounds.BinaryBoundsOperator`
`static class`	`Bounds.IntBounds` Implement `Bounds` for integer intervals.
`static class`	`Bounds.IntersectionInterval` The intersection of two intervals.
`static class`	`Bounds.IntersectionRealInterval` The intersection of two intervals.
`static class`	`Bounds.RealBounds` Implement `Bounds` for real intervals.
`static class`	`Bounds.RealTransformRealInterval` The `Bounds` for a transformed source.
`static class`	`Bounds.SmallestContainingInterval` Represents the smallest `Interval` completely containing a specified `RealInterval`.
`static interface`	`Bounds.UnaryBoundsOperator`
`static class`	`Bounds.UnionInterval` The union of two intervals.
`static class`	`Bounds.UnionRealInterval` The union of two intervals.

Field Summary

Fields
Modifier and Type	Field and Description
`static Bounds.BinaryBoundsOperator`	`AND`
`static Bounds.BinaryBoundsOperator`	`MINUS`
`static Bounds.UnaryBoundsOperator`	`NEGATE`
`static Bounds.BinaryBoundsOperator`	`OR`
`static Bounds.BinaryBoundsOperator`	`XOR`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Bounds(I interval)

Constructors
Modifier	Constructor and Description
`protected`	`Bounds(I interval)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`B`	`and(B that)`
`protected abstract B`	`intersectBounded(B arg0, B arg1)` Intersection of two bounded `Bounds`.
`I`	`interval()`
`boolean`	`isUnbounded()`
`B`	`minus(B that)`
`B`	`negate()`
`B`	`or(B that)`
`protected abstract B`	`unbounded()`
`protected abstract B`	`unionBounded(B arg0, B arg1)` Union of two bounded `Bounds`.
`B`	`xor(B that)`

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

Field Detail

AND

public static final Bounds.BinaryBoundsOperator AND

OR

public static final Bounds.BinaryBoundsOperator OR

NEGATE

public static final Bounds.UnaryBoundsOperator NEGATE

XOR

public static final Bounds.BinaryBoundsOperator XOR

MINUS

public static final Bounds.BinaryBoundsOperator MINUS

Constructor Detail
- Bounds
```
protected Bounds(I interval)
```

Method Detail

isUnbounded
```
public boolean isUnbounded()
```

interval
```
public I interval()
```

intersectBounded
```
protected abstract B intersectBounded(B arg0,
                                      B arg1)
```
Intersection of two bounded Bounds.

Parameters:

arg0 - must not be unbounded

arg1 - must not be unbounded

Returns:

intersection (also bounded)

unionBounded
```
protected abstract B unionBounded(B arg0,
                                  B arg1)
```
Union of two bounded Bounds.

Parameters:

arg0 - must not be unbounded

arg1 - must not be unbounded

Returns:

intersection (also bounded)

unbounded
```
protected abstract B unbounded()
```

and
```
public B and(B that)
```

or
```
public B or(B that)
```

negate
```
public B negate()
```

xor
```
public B xor(B that)
```

minus
```
public B minus(B that)
```

Class Bounds<I extends RealInterval,B extends Bounds<I,B>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AND

OR

NEGATE

XOR

MINUS

Constructor Detail

Bounds

Method Detail

isUnbounded

interval

intersectBounded

unionBounded

unbounded

and

or

negate

xor

minus