01: /*
02: * @(#) $Header: /cvs/jai-operators/src/main/ca/forklabs/media/jai/SpectralFilter3D.java,v 1.1 2007/07/05 00:06:25 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: import java.awt.RenderingHints;
24: import javax.media.jai.CollectionImage;
25:
26: /**
27: * Interface {@code SpectralFilter3D} is used by operation
28: * <em>spectralhomomorphicfilter</em> in <em>collection</em> mode.
29: * <p>
30: * The lifecycle of this interface is simple. First are called
31: * {@link #setWidth(int)}, {@link #setHeight(int)} and {@link #setDepth(int)} to
32: * set the bounds of the image. Then
33: * {@link #getFilterImage(int, RenderingHints)} is called to get the filter
34: * image.
35: * <p>
36: * The filter image must be complex (have an even number of band, twice that of
37: * the desired number of elements) and centered.
38: *
39: * @author <a href="mailto:forklabs at dev.java.net?subject=ca.forklabs.media.jai.SpectralFilter3D">Daniel Léonard</a>
40: * @version $Revision: 1.1 $
41: */
42: public interface SpectralFilter3D {
43:
44: /**
45: * Sets the width of the filter image.
46: * @param width the desired width.
47: */
48: public void setWidth(int width);
49:
50: /**
51: * Sets the height of the filter image.
52: * @param height the desired height.
53: */
54: public void setHeight(int height);
55:
56: /**
57: * Sets the depth of the filter image.
58: * @param depth the desired depth.
59: */
60: public void setDepth(int depth);
61:
62: /**
63: * Creates the complex filter image. The filter must be centered.
64: * @param elements the desired number of elements.
65: * @param hints inherited rendering hints.
66: * @return the filter image.
67: */
68: public CollectionImage getFilterImage(int elements,
69: RenderingHints hints);
70:
71: }
72:
73: /*
74: * $Log: SpectralFilter3D.java,v $
75: * Revision 1.1 2007/07/05 00:06:25 forklabs
76: * The filter types for operator spectralhomomorphic.
77: *
78: */
|