icy.type.dimension

Class Dimension5D

java.lang.Object

icy.type.dimension.Dimension5D

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Dimension5D.Double, Dimension5D.Float, Dimension5D.Integer

public abstract class Dimension5D
extends java.lang.Object
implements java.lang.Cloneable

The Dimension5D class is to encapsulate a 4D dimension (X,Y,Z,T).

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dimension5D.Double
static class	Dimension5D.Float
static class	Dimension5D.Integer

Constructor Summary

Constructors

Constructor and Description
Dimension5D()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a new object of the same class as this object.
boolean	equals(java.lang.Object obj)
abstract double	getSizeC() Returns the size of the C dimension in double precision.
abstract double	getSizeT() Returns the size of the T dimension in double precision.
abstract double	getSizeX() Returns the size of the X dimension in double precision.
abstract double	getSizeY() Returns the size of the Y dimension in double precision.
abstract double	getSizeZ() Returns the size of the Z dimension in double precision.
abstract boolean	isInfiniteC() Returns true if the C dimension should be considered as infinite.
abstract boolean	isInfiniteT() Returns true if the T dimension should be considered as infinite.
abstract boolean	isInfiniteX() Returns true if the X dimension should be considered as infinite.
abstract boolean	isInfiniteY() Returns true if the Y dimension should be considered as infinite.
abstract boolean	isInfiniteZ() Returns true if the Z dimension should be considered as infinite.
void	setSize(Dimension5D d) Sets the size of this Dimension5D object to match the specified size.
abstract void	setSize(double sizeX, double sizeY, double sizeZ, double sizeT, double sizeC) Sets the size of this Dimension5D object.
abstract void	setSizeC(double value) Sets the size of the C dimension of this Dimension5D in double precision.
abstract void	setSizeT(double value) Sets the size of the T dimension of this Dimension5D in double precision.
abstract void	setSizeX(double value) Sets the size of the X dimension of this Dimension5D in double precision.
abstract void	setSizeY(double value) Sets the size of the Y dimension of this Dimension5D in double precision.
abstract void	setSizeZ(double value) Sets the size of the Z dimension of this Dimension5D in double precision.
abstract java.awt.geom.Dimension2D	toDimension2D() Convert to 2D dimension.
abstract Dimension3D	toDimension3D() Convert to 3D dimension.
abstract Dimension4D	toDimension4D() Convert to 4D dimension.
Dimension5D.Integer	toInteger() Returns an integer Dimension5D that encloses the double Dimension5D.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Dimension5D

public Dimension5D()

Method Detail

getSizeX

public abstract double getSizeX()

Returns the size of the X dimension in double precision.

Returns:

the size of the X dimension.

getSizeY

public abstract double getSizeY()

Returns the size of the Y dimension in double precision.

Returns:

the size of the Y dimension.

getSizeZ

public abstract double getSizeZ()

Returns the size of the Z dimension in double precision.

Returns:

the size of the Z dimension.

getSizeT

public abstract double getSizeT()

Returns the size of the T dimension in double precision.

Returns:

the size of the T dimension.

getSizeC

public abstract double getSizeC()

Returns the size of the C dimension in double precision.

Returns:

the size of the C dimension.

setSizeX

public abstract void setSizeX(double value)

Sets the size of the X dimension of this Dimension5D in double precision.

setSizeY

public abstract void setSizeY(double value)

Sets the size of the Y dimension of this Dimension5D in double precision.

setSizeZ

public abstract void setSizeZ(double value)

Sets the size of the Z dimension of this Dimension5D in double precision.

setSizeT

public abstract void setSizeT(double value)

Sets the size of the T dimension of this Dimension5D in double precision.

setSizeC

public abstract void setSizeC(double value)

Sets the size of the C dimension of this Dimension5D in double precision.

setSize

public abstract void setSize(double sizeX,
           double sizeY,
           double sizeZ,
           double sizeT,
           double sizeC)

Sets the size of this Dimension5D object.

Parameters:

sizeX - the new size for the X dimension

sizeY - the new size for the Y dimension

sizeZ - the new size for the Z dimension

sizeT - the new size for the T dimension

sizeC - the new size for the C dimension

setSize

public void setSize(Dimension5D d)

Sets the size of this Dimension5D object to match the specified size.

Parameters:

d - the new size for the Dimension5D object

isInfiniteX

public abstract boolean isInfiniteX()

Returns true if the X dimension should be considered as infinite.

isInfiniteY

public abstract boolean isInfiniteY()

Returns true if the Y dimension should be considered as infinite.

isInfiniteZ

public abstract boolean isInfiniteZ()

Returns true if the Z dimension should be considered as infinite.

isInfiniteT

public abstract boolean isInfiniteT()

Returns true if the T dimension should be considered as infinite.

isInfiniteC

public abstract boolean isInfiniteC()

Returns true if the C dimension should be considered as infinite.

toDimension2D

public abstract java.awt.geom.Dimension2D toDimension2D()

Convert to 2D dimension.

toDimension3D

public abstract Dimension3D toDimension3D()

Convert to 3D dimension.

toDimension4D

public abstract Dimension4D toDimension4D()

Convert to 4D dimension.

toInteger

public Dimension5D.Integer toInteger()

Returns an integer Dimension5D that encloses the double Dimension5D.
The returned Dimension5D.Integer might also fail to completely enclose the original double Dimension5D if it overflows the limited range of the integer data type.

Returns:

an integer Dimension5D that completely encloses the actual double Dimension5D.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Creates a new object of the same class as this object.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

Throws:

java.lang.OutOfMemoryError - if there is not enough memory.

See Also:

Cloneable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object