jaitools.imageutils
Enum PixelCoordType

java.lang.Object
  extended by java.lang.Enum<PixelCoordType>
      extended by jaitools.imageutils.PixelCoordType
All Implemented Interfaces:
Serializable, Comparable<PixelCoordType>

public enum PixelCoordType
extends Enum<PixelCoordType>

Constants for the type of coordinates to use to index pixels. Options are: CORNER for standard JAI indexing with integer coordinates or CENTER for center coordinates (corner ordinates + 0.5).

Used with classes that honour double precision pixel coordinates such as ROIGeometry.

Since:
1.1
Version:
$Id: PixelCoordType.java 1504 2011-03-05 10:56:10Z michael.bedward $
Author:
Michael Bedward

Enum Constant Summary
CENTER
          Center coordinates (corner ordinates + 0.5).
CORNER
          Standard JAI indexing with integer coordinates.
 
Method Summary
static PixelCoordType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PixelCoordType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CORNER

public static final PixelCoordType CORNER
Standard JAI indexing with integer coordinates.


CENTER

public static final PixelCoordType CENTER
Center coordinates (corner ordinates + 0.5).

Method Detail

values

public static PixelCoordType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (PixelCoordType c : PixelCoordType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static PixelCoordType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2009-2011. All Rights Reserved.