digilib-old: common/src/main/java/digilib/image/DocuImage.java annotate

annotate common/src/main/java/digilib/image/DocuImage.java @ 964:0b5fa035af30

fixed old versions in poms.

author	casties
date	Wed, 25 Jan 2012 16:41:43 +0100
parents	28d007673346
children	4e368c85cce4

rev	line source
1 0ff3ede32060 Initial revision robcast parents: diff changeset	1 /* DocuImage -- General image interface class
0ff3ede32060 Initial revision robcast parents: diff changeset	2
0ff3ede32060 Initial revision robcast parents: diff changeset	3 Digital Image Library servlet components
0ff3ede32060 Initial revision robcast parents: diff changeset	4
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	5 Copyright (C) 2001, 2002, 2003 Robert Casties (robcast@mail.berlios.de)
1 0ff3ede32060 Initial revision robcast parents: diff changeset	6
0ff3ede32060 Initial revision robcast parents: diff changeset	7 This program is free software; you can redistribute it and/or modify it
0ff3ede32060 Initial revision robcast parents: diff changeset	8 under the terms of the GNU General Public License as published by the
0ff3ede32060 Initial revision robcast parents: diff changeset	9 Free Software Foundation; either version 2 of the License, or (at your
0ff3ede32060 Initial revision robcast parents: diff changeset	10 option) any later version.
0ff3ede32060 Initial revision robcast parents: diff changeset	11
0ff3ede32060 Initial revision robcast parents: diff changeset	12 Please read license.txt for the full details. A copy of the GPL
0ff3ede32060 Initial revision robcast parents: diff changeset	13 may be found at http://www.gnu.org/copyleft/lgpl.html
0ff3ede32060 Initial revision robcast parents: diff changeset	14
0ff3ede32060 Initial revision robcast parents: diff changeset	15 You should have received a copy of the GNU General Public License
0ff3ede32060 Initial revision robcast parents: diff changeset	16 along with this program; if not, write to the Free Software
149 04ad64b2137a Servlet version 1.14b1 robcast parents: 122 diff changeset	17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1 0ff3ede32060 Initial revision robcast parents: diff changeset	18
0ff3ede32060 Initial revision robcast parents: diff changeset	19 */
0ff3ede32060 Initial revision robcast parents: diff changeset	20
0ff3ede32060 Initial revision robcast parents: diff changeset	21 package digilib.image;
0ff3ede32060 Initial revision robcast parents: diff changeset	22
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	23 import java.awt.Rectangle;
462 03ff7238c9d4 second try for flashpix support (doesn't work currently...) robcast parents: 278 diff changeset	24 import java.io.IOException;
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	25 import java.io.OutputStream;
463 d76a9e3f1ec9 Servlet version 1.10b robcast parents: 462 diff changeset	26 import java.util.Iterator;
73 3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	27
570 fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	28
73 3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	29 import digilib.io.FileOpException;
566 50f291d808b1 starting stream support robcast parents: 562 diff changeset	30 import digilib.io.ImageInput;
596 2b58d2783ef0 small cleanup robcast parents: 588 diff changeset	31 import digilib.util.ImageSize;
73 3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	32
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	33 /** The basic class for the representation of a digilib image.
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	34 *
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	35 * The actual image object is hidden in the class, only methods for loading,
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	36 * manipulation, and saving are exported. This strategy enables implementations
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	37 * using different toolkits that rely on different image base classes (like
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	38 * JIMI, Java2D and JAI).
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	39 */
1 0ff3ede32060 Initial revision robcast parents: diff changeset	40 public interface DocuImage {
0ff3ede32060 Initial revision robcast parents: diff changeset	41
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	42 /** Loads an image file into the Object.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	43 *
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	44 * @param ii Image File.
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	45 * @throws FileOpException Exception thrown if any error occurs.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	46 */
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	47 public void loadImage(ImageInput ii) throws FileOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	48
566 50f291d808b1 starting stream support robcast parents: 562 diff changeset	49 /** This DocuImage supports the loadSubImage operation.
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	50 *
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	51 * @return boolean
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	52 */
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	53 public boolean isSubimageSupported();
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	54
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	55 /** Load only a subsampled region of the image file.
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	56 *
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	57 * @param ii
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	58 * @param region
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	59 * @param subsample
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	60 * @throws FileOpException
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	61 */
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	62 public void loadSubimage(ImageInput ii, Rectangle region, int subsample)
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	63 throws FileOpException;
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	64
819 a23c4c15a6a8 clean up possible resource leaks. better behaviour with unknown image types. robcast parents: 596 diff changeset	65 /** Writes the current image to an OutputStream.
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	66 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	67 * The image is encoded to the mime-type <code>mt</code> and sent to the output
819 a23c4c15a6a8 clean up possible resource leaks. better behaviour with unknown image types. robcast parents: 596 diff changeset	68 * stream <code>ostream</code>.
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	69 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	70 * Currently only mime-types "image/jpeg" and "image/png" are supported.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	71 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	72 * @param mt mime-type of the image to be sent.
819 a23c4c15a6a8 clean up possible resource leaks. better behaviour with unknown image types. robcast parents: 596 diff changeset	73 * @param ostream OutputStream where the image is sent.
570 fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	74 * @throws ImageOpException Exception in other cases.
906 28d007673346 really works with streams now. robcast parents: 903 diff changeset	75 * @throws FileOpException Exception on sending data
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	76 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	77 public void writeImage(String mt, OutputStream ostream)
906 28d007673346 really works with streams now. robcast parents: 903 diff changeset	78 throws ImageOpException, FileOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	79
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	80 /** The width of the current image in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	81 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	82 * @return Image width in pixels.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	83 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	84 public int getWidth();
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	85
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	86 /** The height of the current image in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	87 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	88 * @return Image height in pixels.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	89 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	90 public int getHeight();
570 fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	91
fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	92 /** The size of the current image in pixel.
fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	93 *
fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	94 * @return
fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	95 */
fd2ef7e46119 more cleanup, set version to 1.8.2 robcast parents: 562 diff changeset	96 public ImageSize getSize();
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	97
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	98 /** The mime-type of the image, i.e. the mime-type of the input that was read.
86 997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	99 *
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	100 * @return String the mime-type of this image.
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	101 */
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	102 public String getMimetype();
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	103
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	104 /** Crops the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	105 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	106 * Cuts out a region of the size <code>width</code> x <code>height</code> at
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	107 * the offset <code>xoff</code>, <code>yoff</code> from the current image
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	108 * and replaces the current image with the result.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	109 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	110 * @param xoff X offset of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	111 * @param yoff Y offset of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	112 * @param width width of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	113 * @param height height of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	114 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	115 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	116 public void crop(int xoff, int yoff, int width, int height)
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	117 throws ImageOpException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	118
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	119 /** Scales the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	120 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	121 * Replaces the current image with an image scaled by the factor
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	122 * <code>scale</code>.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	123 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	124 * @param scale scaling factor
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	125 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	126 */
149 04ad64b2137a Servlet version 1.14b1 robcast parents: 122 diff changeset	127 public void scale(double scaleX, double scaleY) throws ImageOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	128
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	129 /** Crops and scales the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	130 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	131 * The current image is cropped to a rectangle of <code>width</code>,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	132 * <code>height</code> at position <code>x_off</code>, <code>y_off</code>. The
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	133 * resulting image is scaled by the factor <code>scale</code> using the
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	134 * interpolation quality <code>qual</code> (0=worst).
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	135 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	136 * @param x_off x offset of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	137 * @param y_off y offset of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	138 * @param width width of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	139 * @param height height of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	140 * @param scale scaling factor.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	141 * @param qual interpolation quality (0=worst).
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	142 * @throws ImageOpException exception thrown on any error.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	143 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	144 public void cropAndScale(
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	145 int x_off,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	146 int y_off,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	147 int width,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	148 int height,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	149 double scale,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	150 int qual)
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	151 throws ImageOpException;
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	152
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	153 /** Rotates the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	154 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	155 * Replaces the current image with a rotated image. The image is rotated
101 78f52a1876fe digilib V1.9b1 robcast parents: 86 diff changeset	156 * around the center by the <code>angle</code>
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	157 * given in degrees [0, 360] clockwise.
4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	158 * Image size and aspect ratio are likely to change.
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	159 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	160 * @param angle rotation angle in degree
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	161 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	162 public void rotate(double angle) throws ImageOpException;
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	163
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	164 /** Mirrors the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	165 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	166 * Replaces the current image with a mirrored image. The mirror axis goes
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	167 * through the center of the image and is rotated by <code>angle</code>
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	168 * degrees. Currently only horizontal and vertical mirroring (0 and 90
101 78f52a1876fe digilib V1.9b1 robcast parents: 86 diff changeset	169 * degree) are supported.
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	170 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	171 * @param angle angle of mirror axis
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	172 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	173 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	174 public void mirror(double angle) throws ImageOpException;
85 4e6757e8ccd4 New enhanced ImageLoader stuff. robcast parents: 79 diff changeset	175
86 997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	176 /** Enhances brightness and contrast of the current image.
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	177 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	178 * Replaces the current image with a brightness and contrast enhanced image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	179 * Contrast is enhanced by multiplying the pixel value with the constant
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	180 * <code>mult</code>. Brightness is enhanced by adding the constant
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	181 * <code>add</code> to the pixel value. Operation: p1 = (p0*mult)+add.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	182 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	183 * @param mult multiplicative constant for contrast enhancement
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	184 * @param add additive constant for brightness enhancement
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	185 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	186 */
86 997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	187 public void enhance(float mult, float add) throws ImageOpException;
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	188
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	189 /** Manipulates the colors of the current image.
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	190 *
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	191 * Replaces the current image with a color modified image.
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	192 * For the red, green and blue color channels all pixel values are multiplied
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	193 * by the constant
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	194 * <code>m</code> and added to the constant
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	195 * <code>a</code>. Operation: p1 = (p0*m)+a.
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	196 *
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	197 * @param rgbm multiplicative constants for red, green, blue
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	198 * @param rgba additive constant for red, green, blue
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	199 * @throws ImageOpException
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	200 */
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	201 public void enhanceRGB(float[] rgbm, float[] rgba)
997ba69afb81 New version 1.8b1. robcast parents: 85 diff changeset	202 throws ImageOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	203
829 a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	204
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	205 /** Operations for colorOps.
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	206 *
860 fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	207 * GRAYSCALE: cast color image to grayscale
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	208 * NTSC_GRAY: convert color image to grayscale using NTSC formula
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	209 * INVERT: invert colors (every channel separately)
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	210 * MAP_GRAY_BGR: false color image from grayscale (0: blue, 128: green, 255: red)
829 a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	211 *
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	212 */
860 fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	213 public enum ColorOp {GRAYSCALE, NTSC_GRAY, INVERT, MAP_GRAY_BGR};
829 a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	214
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	215 /** Changes the colors of the current image.
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	216 *
860 fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	217 * Changes the colors of the current image. Operations are instances of ColorOp:
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	218 *
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	219 * GRAYSCALE: cast color image to grayscale
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	220 * NTSC_GRAY: convert color image to grayscale using NTSC formula
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	221 * INVERT: invert colors (every channel separately)
fe58284a8dd9 implemented colop= ntsc_gray and map_gray_bgr. robcast parents: 834 diff changeset	222 * MAP_GRAY_BGR: false color image from grayscale (0: blue, 128: green, 255: red)
829 a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	223 *
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	224 * @throws ImageOpException
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	225 */
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	226 public void colorOp(ColorOp op) throws ImageOpException;
a630d0303cce new servlet operation colop=grayscale. robcast parents: 819 diff changeset	227
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	228 /**
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	229 * Returns the interpolation quality.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	230 * @return int
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	231 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	232 public int getQuality();
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	233
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	234 /**
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	235 * Sets the interpolation quality.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	236 * @param quality The quality to set
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	237 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	238 public void setQuality(int quality);
207 1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	239
1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	240 /** Frees all resources bound to the DocuImage.
1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	241 *
1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	242 * Things that should be freed are image objects and open files.
1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	243 *
1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	244 */
1a65d8e43620 Servlet version 1.18b9 -- cleanup and bugfixes robcast parents: 159 diff changeset	245 public void dispose();
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	246
462 03ff7238c9d4 second try for flashpix support (doesn't work currently...) robcast parents: 278 diff changeset	247 /**
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	248 * Check image size and type and store in ImageInput ii
462 03ff7238c9d4 second try for flashpix support (doesn't work currently...) robcast parents: 278 diff changeset	249 */
588 aee436f0549d more work on stream input robcast parents: 573 diff changeset	250 public ImageInput identify(ImageInput ii) throws IOException;
462 03ff7238c9d4 second try for flashpix support (doesn't work currently...) robcast parents: 278 diff changeset	251
463 d76a9e3f1ec9 Servlet version 1.10b robcast parents: 462 diff changeset	252 /**
d76a9e3f1ec9 Servlet version 1.10b robcast parents: 462 diff changeset	253 * Returns a list of supported image formats
d76a9e3f1ec9 Servlet version 1.10b robcast parents: 462 diff changeset	254 */
531 9cedd170b581 * PDF generation works now even with subdirectories robcast parents: 1 diff changeset	255 public Iterator<String> getSupportedFormats();
533 87cb3dc2aa12 improved pdf generation (not done yet) robcast parents: 531 diff changeset	256
87cb3dc2aa12 improved pdf generation (not done yet) robcast parents: 531 diff changeset	257 /**
87cb3dc2aa12 improved pdf generation (not done yet) robcast parents: 531 diff changeset	258 * returns the underlying image as java.awt.Image (if possible, or null)
87cb3dc2aa12 improved pdf generation (not done yet) robcast parents: 531 diff changeset	259 * @return
87cb3dc2aa12 improved pdf generation (not done yet) robcast parents: 531 diff changeset	260 */
87cb3dc2aa12 improved pdf generation (not done yet) robcast parents: 531 diff changeset	261 public java.awt.Image getAwtImage();
463 d76a9e3f1ec9 Servlet version 1.10b robcast parents: 462 diff changeset	262
1 0ff3ede32060 Initial revision robcast parents: diff changeset	263 }

Mercurial > hg > digilib-old

annotate common/src/main/java/digilib/image/DocuImage.java @ 964:0b5fa035af30