Coordinate (Mango Plugin API)

java.lang.Object
- edu.uthscsa.ric.volume.Coordinate

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

Coordinate4D
```
public class Coordinate
extends Object
implements Cloneable, Serializable
```
Coordinate stores information about a point in space.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COORDINATE_TYPE_ATLAS`
`static int`	`COORDINATE_TYPE_INDEX`
`static int`	`COORDINATE_TYPE_MM`
`static int`	`COORDINATE_TYPE_WORLD`
`static double`	`OUT_OF_RANGE`
`double`	`xDbl`
`int`	`xInt`
`double`	`yDbl`
`int`	`yInt`
`double`	`zDbl`
`int`	`zInt`

Constructor Summary

Constructors
Constructor and Description
`Coordinate()` Default constructor.
`Coordinate(Coordinate coor)` Copy constructor.
`Coordinate(double x, double y, double z)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns a copy of this object.
`double`	`distance(Coordinate coor)` Returns the distance between this Coordinate and another.
`boolean`	`equals(Object obj)` Tests equality.
`double[]`	`getValues()` Returns an array of coordinate values.
`int`	`hashCode()` Compute hash code.
`boolean`	`isAllZeros()` This method can be used to check if all values are zero.
`boolean`	`isOutOfRange()` Returns true if any coordinate value is NaN.
`void`	`setValues(Coordinate coor)` Sets the values of this Coordinate to that of another Coordinate
`void`	`setValues(double x, double y, double z)` Sets the values of this Coordinate.
`void`	`setValuesRound(double x, double y, double z)` Sets the values of this Coordinate and rounds the integer values.
`String`	`toString()` Returns a string representation of this object.

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

- Field Detail
  - xDbl
```
public double xDbl
```
  - yDbl
```
public double yDbl
```
  - zDbl
```
public double zDbl
```
  - xInt
```
public int xInt
```
  - yInt
```
public int yInt
```
  - zInt
```
public int zInt
```
  - OUT_OF_RANGE
```
public static final double OUT_OF_RANGE
```
    See Also:
    Constant Field Values
  - COORDINATE_TYPE_ATLAS
```
public static final int COORDINATE_TYPE_ATLAS
```
    See Also:
    Constant Field Values
  - COORDINATE_TYPE_INDEX
```
public static final int COORDINATE_TYPE_INDEX
```
    See Also:
    Constant Field Values
  - COORDINATE_TYPE_MM
```
public static final int COORDINATE_TYPE_MM
```
    See Also:
    Constant Field Values
  - COORDINATE_TYPE_WORLD
```
public static final int COORDINATE_TYPE_WORLD
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Coordinate
```
public Coordinate()
```
    Default constructor.
  - Coordinate
```
public Coordinate(Coordinate coor)
```
    Copy constructor.
    
    Parameters:
    coor - The Coordinate object to copy.
  - Coordinate
```
public Coordinate(double x,
          double y,
          double z)
```
    Constructor.
    
    Parameters:
    x - The X value.
    y - The Y value.
    z - The Z value.
- Method Detail
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    clone object
    
    Throws:
    
    CloneNotSupportedException - clone not supported exception
  - distance
```
public double distance(Coordinate coor)
```
    Returns the distance between this Coordinate and another.
    
    Parameters:
    coor - the other coordinate
    
    Returns:
    The distance between this Coordinate and another.
  - equals
```
public boolean equals(Object obj)
```
    Tests equality.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    true if the objects are equals, false otherwise.
  - getValues
```
public double[] getValues()
```
    Returns an array of coordinate values.
    
    Returns:
    an array of coordinate values
  - hashCode
```
public int hashCode()
```
    Compute hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code
  - isAllZeros
```
public boolean isAllZeros()
```
    This method can be used to check if all values are zero.
    
    Returns:
    Returns true if all values are zero; false otherwise.
  - isOutOfRange
```
public boolean isOutOfRange()
```
    Returns true if any coordinate value is NaN.
    
    Returns:
    true if any coordinate value is NaN
  - setValues
```
public final void setValues(Coordinate coor)
```
    Sets the values of this Coordinate to that of another Coordinate
    
    Parameters:
    coor - The replacement Coordinate.
  - setValues
```
public void setValues(double x,
             double y,
             double z)
```
    Sets the values of this Coordinate.
    
    Parameters:
    x - The X value.
    y - The Y value.
    z - The Z value.
  - setValuesRound
```
public void setValuesRound(double x,
                  double y,
                  double z)
```
    Sets the values of this Coordinate and rounds the integer values.
    
    Parameters:
    x - The X value.
    y - The Y value.
    z - The Z value.
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this object

Class Coordinate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

xDbl

yDbl

zDbl

xInt

yInt

zInt

OUT_OF_RANGE

COORDINATE_TYPE_ATLAS

COORDINATE_TYPE_INDEX

COORDINATE_TYPE_MM

COORDINATE_TYPE_WORLD

Constructor Detail

Coordinate

Coordinate

Coordinate

Method Detail

clone

distance

equals

getValues

hashCode

isAllZeros

isOutOfRange

setValues

setValues

setValuesRound

toString