AbstractWritableSuperEllipsoid (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Predicate<RealLocalizable>, EuclideanSpace, RealInterval, SuperEllipsoid, WritableSuperEllipsoid, MaskPredicate<RealLocalizable>, RealMask, RealMaskRealInterval

Direct Known Subclasses:

AbstractWritableEllipsoid, ClosedWritableSuperEllipsoid, OpenWritableSuperEllipsoid
```
public abstract class AbstractWritableSuperEllipsoid
extends AbstractEuclideanSpace
implements WritableSuperEllipsoid
```
Abstract base class for WritableSuperEllipsoid implementations.

Author:

Alison Walter

Field Summary

Fields
Modifier and Type Field and Description

protected double[] center

protected double exponent

protected double[] semiAxisLengths
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

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

Constructor Summary

Constructors
Constructor and Description
`AbstractWritableSuperEllipsoid(double[] center, double[] semiAxisLengths, double exponent)` Creates an n-d superellipsoid, where n is determined by the length of the smaller array.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RealLocalizableRealPositionable`	`center()` Returns the center.
`protected double`	`distancePowered(RealLocalizable l)` Computes the unit distance between a given location and the center of the superellipsoid.
`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`	`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`	`setExponent(double exponent)` Sets the exponent.
`void`	`setSemiAxisLength(int d, double length)` Sets the semi-axis length in dimension d.

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.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.EuclideanSpace
numDimensions

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

- Field Detail
  - exponent
```
protected double exponent
```
  - center
```
protected final double[] center
```
  - semiAxisLengths
```
protected final double[] semiAxisLengths
```
- Constructor Detail
  - AbstractWritableSuperEllipsoid
```
public AbstractWritableSuperEllipsoid(double[] center,
                                      double[] semiAxisLengths,
                                      double exponent)
```
    Creates an n-d superellipsoid, where n is determined by the length of the smaller array.
    
    Parameters:
    
    center - position of the superellipsoid in space, given in pixel coordinates
    
    semiAxisLengths - array containing n elements representing half values of width/height/depth/...
    
    exponent - exponent of the superellipsoid
- 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 superellipsoid.
    
    Specified by:
    
    center in interface SuperEllipsoid
    
    Specified by:
    
    center in interface WritableSuperEllipsoid
  - setExponent
```
public void setExponent(double exponent)
```
    Description copied from interface: WritableSuperEllipsoid
    
    Sets the exponent.
    
    Specified by:
    
    setExponent in interface WritableSuperEllipsoid
  - setSemiAxisLength
```
public void setSemiAxisLength(int d,
                              double length)
```
    Description copied from interface: WritableSuperEllipsoid
    
    Sets the semi-axis length in dimension d.
    
    Specified by:
    
    setSemiAxisLength in interface WritableSuperEllipsoid
  - 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)
```
    Computes the unit distance between a given location and the center of the superellipsoid.
    
    Parameters:
    
    l - location to check
    
    Returns:
    
    unit distance powered to exponent

Class AbstractWritableSuperEllipsoid

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.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.EuclideanSpace

Methods inherited from interface net.imglib2.RealInterval

Field Detail

exponent

center

semiAxisLengths

Constructor Detail

AbstractWritableSuperEllipsoid

Method Detail

realMin

realMax

exponent

semiAxisLength

center

setExponent

setSemiAxisLength

equals

hashCode

distancePowered