com.xinapse.multisliceimage
Enum InterpolationType

java.lang.Object
  java.lang.Enum<InterpolationType>
      com.xinapse.multisliceimage.InterpolationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InterpolationType>

public enum InterpolationType
extends java.lang.Enum<InterpolationType>

An enumeration of the types of interpolation that can be used for resampling images.

Enum Constant Summary

LINEAR
Linear interpolation resampling.

NEAREST_NEIGHBOUR
Nearest neighbour resampling.

SINC
Sinc interpolation resampling.

SINC_IN_PLANE_LINEAR_OTHERWISE
Sinc interpolation for in-plane resampling, and linear interpolation for between plane resampling.

SPLINE
Spline interpolation.

Method Summary

static InterpolationType	get(java.lang.String s) Returns the InterpolationType corresponding to the description supplied in the argument.
java.lang.String	toShortString() Returns a short String describing this interpolation type.
java.lang.String	toString() Returns a String describing this interpolation type.
static InterpolationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InterpolationType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEAREST_NEIGHBOUR

public static final InterpolationType NEAREST_NEIGHBOUR

Nearest neighbour resampling. The intensity at a new grid point is the same as the intensity at the nearest original grid point.

LINEAR

public static final InterpolationType LINEAR

Linear interpolation resampling. The intensity at a new grid point is found by linear interpolation between the nearest two original grid points.

SINC

public static final InterpolationType SINC

Sinc interpolation resampling. The intensity at a new grid point is found by sinc interpolation with a Blackman-Harris apodisation function.

SINC_IN_PLANE_LINEAR_OTHERWISE

public static final InterpolationType SINC_IN_PLANE_LINEAR_OTHERWISE

Sinc interpolation for in-plane resampling, and linear interpolation for between plane resampling. Linear interpolation applies for any dimension that is not in-plane.

SPLINE

public static final InterpolationType SPLINE

Spline interpolation.

Method Detail

values

public static InterpolationType[] 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 (InterpolationType c : InterpolationType.values())
    System.out.println(c);

Returns:

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

valueOf

public static InterpolationType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toShortString

public java.lang.String toShortString()

Returns a short String describing this interpolation type.

Returns:

a short String describing this interpolation type.

toString

public java.lang.String toString()

Returns a String describing this interpolation type.

Overrides:

toString in class java.lang.Enum<InterpolationType>

Returns:

a String describing this interpolation type.

get

public static final InterpolationType get(java.lang.String s)
                                   throws com.xinapse.util.InvalidArgumentException

Returns the InterpolationType corresponding to the description supplied in the argument. s can be:

• "Nearest neighbour", or "nn" for InterpolationType.NEAREST_NEIGHBOUR.
• "Linear" for InterpolationType.LINEAR.
• "Sinc" for InterpolationType.SINC.
• "Sinc in-plane, linear otherwise" or "sinc-linear" for InterpolationType.SINC_IN_PLANE_LINEAR_OTHERWISE.
• "Spline" for InterpolationTypeSPLINE.

Interpretation of s is case-insensitive.

Returns:

the InterpolationType corresponding to the supplied argument.

Throws:

com.xinapse.util.InvalidArgumentException - if the supplied argument cannot be interpreted as an InterpolationType.