ImageScience 3.0.0

imagescience.image
Class Coordinates

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

public class Coordinates
extends java.lang.Object

Contains 5D integer coordinates.


Field Summary
 int c
          The c-coordinate.
 int t
          The t-coordinate.
 int x
          The x-coordinate.
 int y
          The y-coordinate.
 int z
          The z-coordinate.
 
Constructor Summary
Coordinates()
          Default constructor.
Coordinates(Coordinates coords)
          Copy constructor.
Coordinates(int x)
          One-dimensional constructor.
Coordinates(int x, int y)
          Two-dimensional constructor.
Coordinates(int x, int y, int z)
          Three-dimensional constructor.
Coordinates(int x, int y, int z, int t)
          Four-dimensional constructor.
Coordinates(int x, int y, int z, int t, int c)
          Five-dimensional constructor.
 
Method Summary
 Coordinates duplicate()
          Duplicates this object.
 boolean equals(Coordinates coords)
          Indicates whether this object is in the same state as the given object.
 void reset()
          Resets the coordinates to their default values.
 void set(Coordinates coords)
          Sets the coordinates to the given coordinates.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

x

public int x
The x-coordinate. The default value is 0.


y

public int y
The y-coordinate. The default value is 0.


z

public int z
The z-coordinate. The default value is 0.


t

public int t
The t-coordinate. The default value is 0.


c

public int c
The c-coordinate. The default value is 0.

Constructor Detail

Coordinates

public Coordinates()
Default constructor.


Coordinates

public Coordinates(int x)
One-dimensional constructor.

Parameters:
x - The x-coordinate.

Coordinates

public Coordinates(int x,
                   int y)
Two-dimensional constructor.

Parameters:
x - The x-coordinate.
y - The y-coordinate.

Coordinates

public Coordinates(int x,
                   int y,
                   int z)
Three-dimensional constructor.

Parameters:
x - The x-coordinate.
y - The y-coordinate.
z - The z-coordinate.

Coordinates

public Coordinates(int x,
                   int y,
                   int z,
                   int t)
Four-dimensional constructor.

Parameters:
x - The x-coordinate.
y - The y-coordinate.
z - The z-coordinate.
t - The t-coordinate.

Coordinates

public Coordinates(int x,
                   int y,
                   int z,
                   int t,
                   int c)
Five-dimensional constructor.

Parameters:
x - The x-coordinate.
y - The y-coordinate.
z - The z-coordinate.
t - The t-coordinate.
c - The c-coordinate.

Coordinates

public Coordinates(Coordinates coords)
Copy constructor.

Parameters:
coords - The coordinates to be copied.
Method Detail

reset

public void reset()
Resets the coordinates to their default values.


set

public void set(Coordinates coords)
Sets the coordinates to the given coordinates.

Parameters:
coords - The coordinates to be copied.
Throws:
java.lang.NullPointerException - If coords is null.

duplicate

public Coordinates duplicate()
Duplicates this object.

Returns:
A new Coordinates 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(Coordinates coords)
Indicates whether this object is in the same state as the given object.

Parameters:
coords - The object to compare this object with.
Returns:
Value true if the given object is not null and its coordinates are equal to the corresponding coordinates of 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.