01: /*
02: * @(#) $Header: /cvs/jai-operators/src/main/ca/forklabs/media/jai/ImageFunction3D.java,v 1.1 2007/07/05 00:05:37 forklabs Exp $
03: *
04: * Copyright (C) 2007 Forklabs Daniel Léonard
05: *
06: * This program is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU General Public License
08: * as published by the Free Software Foundation; either version 2
09: * of the License, or (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19: */
20:
21: package ca.forklabs.media.jai;
22:
23: /**
24: * Interface {@code ImageFunction3D} represents a collection of image that are
25: * rendered according to a ternary function <em>f(x, y, z)</em>.
26: *
27: * @author <a href="mailto:forklabs at dev.java.net?subject=ca.forklabs.media.jai.ImageFunction3D">Daniel Léonard</a>
28: * @version $Revision: 1.1 $
29: */
30: public interface ImageFunction3D {
31:
32: /**
33: * Determines if pixels are complex or not.
34: * @return {@code true} if the pixels are complex, {@code false} otherwise.
35: */
36: public boolean isComplex();
37:
38: /**
39: * Returns the number of bands for each image.
40: * @return the number of bands.
41: */
42: public int getNumBands();
43:
44: /**
45: * Gets one band of one image.
46: * @param band the bamd.
47: * @param slice the image.
48: * @param dimX the size of the band in the <em>x</em> dimension.
49: * @param dimY the size of the band in the <em>y</em> dimension.
50: * @param dimZ the size of the band in the <em>z</em> dimension.
51: * @param real a pre-allocated float array of length at least
52: * <em>dimX * dimY</em> in which the real parts will be
53: * returned.
54: * @param imag a pre-allocated float array of length at least
55: * <em>dimX * dimY</em> in which the imaginary parts will be
56: * returned, {@code null} if {@link #isComplex()} returns
57: * {@code false}.
58: */
59: public void getBand(int band, int slice, int dimX, int dimY,
60: int dimZ, float[] real, float[] imag);
61:
62: /**
63: * Gets one band of one image.
64: * @param band the bamd.
65: * @param slice the image.
66: * @param dimX the size of the band in the <em>x</em> dimension.
67: * @param dimY the size of the band in the <em>y</em> dimension.
68: * @param dimZ the size of the band in the <em>z</em> dimension.
69: * @param real a pre-allocated float array of length at least
70: * <em>dimX * dimY</em> in which the real parts will be
71: * returned.
72: * @param imag a pre-allocated float array of length at least
73: * <em>dimX * dimY</em> in which the imaginary parts will be
74: * returned, {@code null} if {@link #isComplex()} returns
75: * {@code false}.
76: */
77: public void getBand(int band, int slice, int dimX, int dimY,
78: int dimZ, double[] real, double[] imag);
79:
80: }
81:
82: /*
83: * $Log: ImageFunction3D.java,v $
84: * Revision 1.1 2007/07/05 00:05:37 forklabs
85: * The functional description for operator imagefunction3d.
86: *
87: */
|