AbstractWritableSphere (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.roi.geom.real.AbstractWritableSphere

All Implemented Interfaces:

Predicate<RealLocalizable>, EuclideanSpace, RealInterval, Ellipsoid, Sphere, SuperEllipsoid, WritableEllipsoid, WritableSphere, WritableSuperEllipsoid, MaskPredicate<RealLocalizable>, RealMask, RealMaskRealInterval

Direct Known Subclasses:

ClosedWritableSphere, OpenWritableSphere
```
public abstract class AbstractWritableSphere
extends AbstractEuclideanSpace
implements WritableSphere
```
Abstract base class for WritableSphere implementations.

Author:

Alison Walter

Field Summary

Fields
Modifier and Type Field and Description

protected double[] center

protected double radius
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Fields
Modifier and Type	Field and Description
`protected double[]`	`center`
`protected double`	`radius`

Constructor Summary

Constructors
Constructor and Description

AbstractWritableSphere(double[] center, double radius)
Creates an n-d sphere.

Constructors
Constructor and Description
`AbstractWritableSphere(double[] center, double radius)` Creates an n-d sphere.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RealLocalizableRealPositionable`	`center()` Returns the center.
`protected double`	`distancePowered(RealLocalizable l)`
`boolean`	`equals(Object obj)` Determines whether this superellipsoid describes the same region as another one.
`double`	`exponent()` Returns the exponent of this superellipsoid
`int`	`hashCode()`
`double`	`radius()` Returns the radius of this sphere.
`double`	`realMax(int d)` Get the maximum in dimension d.
`double`	`realMin(int d)` Get the minimum in dimension d.
`double`	`semiAxisLength(int d)` Returns the semi-axis length of the superellipsoid in a given dimension d
`void`	`setRadius(double radius)` Sets the radius.
`void`	`setSemiAxisLength(int d, double length)` Sets the radius of this sphere.

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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

Methods inherited from interface net.imglib2.roi.geom.real.WritableEllipsoid
setExponent

Methods inherited from interface net.imglib2.roi.geom.real.SuperEllipsoid
equals, hashCode, maskType

Methods inherited from interface net.imglib2.roi.RealMaskRealInterval
and, isEmpty, minus, or, realMax, realMax, realMin, realMin, transform, xor

Methods inherited from interface net.imglib2.roi.RealMask
negate, or, transform, xor

Methods inherited from interface net.imglib2.roi.MaskPredicate
boundaryType, isAll, knownConstant

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

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

- Field Detail
  - center
```
protected final double[] center
```
  - radius
```
protected double radius
```
- Constructor Detail
  - AbstractWritableSphere
```
public AbstractWritableSphere(double[] center,
                              double radius)
```
    Creates an n-d sphere.
    
    Parameters:
    
    center - Point where the sphere is centered
    
    radius - Radius of the sphere
- Method Detail
  - realMin
```
public double realMin(int d)
```
    Description copied from interface: RealInterval
    
    Get the minimum in dimension d.
    
    Specified by:
    
    realMin in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - realMax
```
public double realMax(int d)
```
    Description copied from interface: RealInterval
    
    Get the maximum in dimension d.
    
    Specified by:
    
    realMax in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - exponent
```
public double exponent()
```
    Description copied from interface: SuperEllipsoid
    
    Returns the exponent of this superellipsoid
    
    Specified by:
    
    exponent in interface SuperEllipsoid
  - semiAxisLength
```
public double semiAxisLength(int d)
```
    Description copied from interface: SuperEllipsoid
    
    Returns the semi-axis length of the superellipsoid in a given dimension d
    
    Specified by:
    
    semiAxisLength in interface SuperEllipsoid
  - center
```
public RealLocalizableRealPositionable center()
```
    Returns the center. Changes to the returned center will mutate the sphere.
    
    Specified by:
    
    center in interface SuperEllipsoid
    
    Specified by:
    
    center in interface WritableSuperEllipsoid
  - radius
```
public double radius()
```
    Description copied from interface: Sphere
    
    Returns the radius of this sphere.
    
    Specified by:
    
    radius in interface Sphere
  - setSemiAxisLength
```
public void setSemiAxisLength(int d,
                              double length)
```
    Sets the radius of this sphere. The dimension, d, is ignored since spheres have the same extension in all dimensions.
    
    Specified by:
    
    setSemiAxisLength in interface WritableSuperEllipsoid
  - setRadius
```
public void setRadius(double radius)
```
    Description copied from interface: WritableSphere
    
    Sets the radius.
    
    Specified by:
    
    setRadius in interface WritableSphere
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: SuperEllipsoid
    
    Determines whether this superellipsoid describes the same region as another one.
    
    Specified by:
    
    equals in interface SuperEllipsoid
    
    Specified by:
    
    equals in interface MaskPredicate<RealLocalizable>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - The superellipsoid to compare with this one.
    
    Returns:
    
    True iff the superellipsoids describe the same region.
    
    See Also:
    
    MaskPredicate.equals(Object), SuperEllipsoid.equals(SuperEllipsoid, SuperEllipsoid)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - distancePowered
```
protected double distancePowered(RealLocalizable l)
```

Class AbstractWritableSphere

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.roi.geom.real.WritableEllipsoid

Methods inherited from interface net.imglib2.roi.geom.real.SuperEllipsoid

Methods inherited from interface net.imglib2.roi.RealMaskRealInterval

Methods inherited from interface net.imglib2.roi.RealMask

Methods inherited from interface net.imglib2.roi.MaskPredicate

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface net.imglib2.RealInterval

Field Detail

center

radius

Constructor Detail

AbstractWritableSphere

Method Detail

realMin

realMax

exponent

semiAxisLength

center

radius

setSemiAxisLength

setRadius

equals

hashCode

distancePowered