ImageScience 3.0.0

imagescience.image
Class Axes

java.lang.Object
  extended by imagescience.image.Axes

public class Axes
extends java.lang.Object

Contains information about the activity of the coordinate axes of up to 5D image data objects.


Field Summary
 boolean c
          Indicates whether the c-axis is active.
static int C
          The c-axis.
 boolean t
          Indicates whether the t-axis is active.
static int T
          The t-axis.
 boolean x
          Indicates whether the x-axis is active.
static int X
          The x-axis.
 boolean y
          Indicates whether the y-axis is active.
static int Y
          The y-axis.
 boolean z
          Indicates whether the z-axis is active.
static int Z
          The z-axis.
 
Constructor Summary
Axes()
          Default constructor.
Axes(boolean x)
          One-dimensional constructor.
Axes(boolean x, boolean y)
          Two-dimensional constructor.
Axes(boolean x, boolean y, boolean z)
          Three-dimensional constructor.
Axes(boolean x, boolean y, boolean z, boolean t)
          Four-dimensional constructor.
Axes(boolean x, boolean y, boolean z, boolean t, boolean c)
          Five-dimensional constructor.
Axes(int axes)
          Five-dimensional constructor.
 
Method Summary
 Axes duplicate()
          Duplicates this object.
 boolean equals(Axes axes)
          Indicates whether this object is in the same state as the given object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

X

public static final int X
The x-axis.

See Also:
Constant Field Values

Y

public static final int Y
The y-axis.

See Also:
Constant Field Values

Z

public static final int Z
The z-axis.

See Also:
Constant Field Values

T

public static final int T
The t-axis.

See Also:
Constant Field Values

C

public static final int C
The c-axis.

See Also:
Constant Field Values

x

public final boolean x
Indicates whether the x-axis is active. By default it is not active.


y

public final boolean y
Indicates whether the y-axis is active. By default it is not active.


z

public final boolean z
Indicates whether the z-axis is active. By default it is not active.


t

public final boolean t
Indicates whether the t-axis is active. By default it is not active.


c

public final boolean c
Indicates whether the c-axis is active. By default it is not active.

Constructor Detail

Axes

public Axes()
Default constructor.


Axes

public Axes(boolean x)
One-dimensional constructor.

Parameters:
x - The x-axis activity.

Axes

public Axes(boolean x,
            boolean y)
Two-dimensional constructor.

Parameters:
x - The x-axis activity.
y - The y-axis activity.

Axes

public Axes(boolean x,
            boolean y,
            boolean z)
Three-dimensional constructor.

Parameters:
x - The x-axis activity.
y - The y-axis activity.
z - The z-axis activity.

Axes

public Axes(boolean x,
            boolean y,
            boolean z,
            boolean t)
Four-dimensional constructor.

Parameters:
x - The x-axis activity.
y - The y-axis activity.
z - The z-axis activity.
t - The t-axis activity.

Axes

public Axes(boolean x,
            boolean y,
            boolean z,
            boolean t,
            boolean c)
Five-dimensional constructor.

Parameters:
x - The x-axis activity.
y - The y-axis activity.
z - The z-axis activity.
t - The t-axis activity.
c - The c-axis activity.

Axes

public Axes(int axes)
Five-dimensional constructor.

Parameters:
axes - An integer number indicating which axes are active. Must be one or a combination (by addition) of X, Y, Z, T, C.
Throws:
java.lang.IllegalArgumentException - If axes does not correspond to a valid combination of axes.
Method Detail

duplicate

public Axes duplicate()
Duplicates this object.

Returns:
A new Axes object that is an exact copy of this object. All information is copied and no memory is shared between this and the returned object.

equals

public boolean equals(Axes axes)
Indicates whether this object is in the same state as the given object.

Parameters:
axes - The object to compare this object with.
Returns:
Value true if the given object is not null and has the same axes (de)activated as this object, or false if this is not the case.

ImageScience 3.0.0

Copyright (C) Erik Meijering. Permission to use this software and corresponding documentation for educational, research, and not-for-profit purposes, without a fee and without a signed licensing agreement, is granted, subject to the following terms and conditions.

IT IS NOT ALLOWED TO REDISTRIBUTE, SELL, OR LEASE THIS SOFTWARE, OR DERIVATIVE WORKS THEREOF, WITHOUT PERMISSION IN WRITING FROM THE COPYRIGHT HOLDER. THE COPYRIGHT HOLDER IS FREE TO MAKE VERSIONS OF THE SOFTWARE AVAILABLE FOR A FEE OR COMMERCIALLY ONLY.

IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OF ANY KIND WHATSOEVER, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE AND CORRESPONDING DOCUMENTATION IS PROVIDED "AS IS". THE COPYRIGHT HOLDER HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.