javax.media.jai
Interface ImageFunction

public interface ImageFunction

ImageFunction is a common interface for vector-valued functions which are to be evaluated at positions in the X-Y coordinate system. At each position the value of such a function may contain one or more elements each of which may be complex.

Method Summary

void	getElements(double startX, double startY, double deltaX, double deltaY, int countX, int countY, int element, double[] real, double[] imag) Returns all values of a given element for a specified set of coordinates.
void	getElements(float startX, float startY, float deltaX, float deltaY, int countX, int countY, int element, float[] real, float[] imag) Returns all values of a given element for a specified set of coordinates.
int	getNumElements() Returns the number of elements per value at each position.
boolean	isComplex() Returns whether or not each value's elements are complex.

Method Detail

isComplex

public boolean isComplex()

Returns whether or not each value's elements are complex.

getNumElements

public int getNumElements()

Returns the number of elements per value at each position.

getElements

public void getElements(float startX,
                        float startY,
                        float deltaX,
                        float deltaY,
                        int countX,
                        int countY,
                        int element,
                        float[] real,
                        float[] imag)

Returns all values of a given element for a specified set of coordinates. An ArrayIndexOutOfBoundsException may be thrown if the length of the supplied array(s) is insufficient.

Parameters:

startX - The X coordinate of the upper left location to evaluate.

startY - The Y coordinate of the upper left location to evaluate.

deltaX - The horizontal increment.

deltaY - The vertical increment.

countX - The number of points in the horizontal direction.

countY - The number of points in the vertical direction.

real - A pre-allocated float array of length at least countX*countY in which the real parts of all elements will be returned.

imag - A pre-allocated float array of length at least countX*countY in which the imaginary parts of all elements will be returned; may be null for real data, i.e., when isComplex() returns false.

Throws:

ArrayIndexOutOfBoundsException - if the length of the supplied array(s) is insufficient.

getElements

public void getElements(double startX,
                        double startY,
                        double deltaX,
                        double deltaY,
                        int countX,
                        int countY,
                        int element,
                        double[] real,
                        double[] imag)

Returns all values of a given element for a specified set of coordinates. An ArrayIndexOutOfBoundsException may be thrown if the length of the supplied array(s) is insufficient.

Parameters:

startX - The X coordinate of the upper left location to evaluate.

startY - The Y coordinate of the upper left location to evaluate.

deltaX - The horizontal increment.

deltaY - The vertical increment.

countX - The number of points in the horizontal direction.

countY - The number of points in the vertical direction.

real - A pre-allocated double array of length at least countX*countY in which the real parts of all elements will be returned.

imag - A pre-allocated double array of length at least countX*countY in which the imaginary parts of all elements will be returned; may be null for real data, i.e., when isComplex() returns false.

Throws:

ArrayIndexOutOfBoundsException - if the length of the supplied array(s) is insufficient.