File: Invert.java

package info (click to toggle)
java-imaging-utilities 0.14.3-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,556 kB
  • sloc: java: 31,233; python: 71; xml: 31; makefile: 26; sh: 5
file content (171 lines) | stat: -rw-r--r-- 5,231 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
 * Invert
 * 
 * Copyright (c) 2000, 2001, 2002, 2003, 2004, 2005, 2006 Marco Schmidt.
 * All rights reserved.
 */

package net.sourceforge.jiu.color;

import net.sourceforge.jiu.data.PixelImage;
import net.sourceforge.jiu.data.Palette;
import net.sourceforge.jiu.data.Paletted8Image;
import net.sourceforge.jiu.data.IntegerImage;
import net.sourceforge.jiu.ops.ImageToImageOperation;
import net.sourceforge.jiu.ops.MissingParameterException;
import net.sourceforge.jiu.ops.OperationFailedException;
import net.sourceforge.jiu.ops.WrongParameterException;

/**
 * Creates an inverted (negated) version of an image.
 * This is done by subtracting each sample value of a channel 
 * from the maximum sample for that channel.
 * The maximum sample for a channel is given by 
 * {@link net.sourceforge.jiu.data.IntegerImage#getMaxSample}. 
 * For paletted images, just the palette is treated that way.
 * Supported image types: {@link net.sourceforge.jiu.data.IntegerImage}.
 * Input and output image can be the same object.
 * <h3>Usage</h3>
 * There are two ways of using this class.
 * Either create an Invert object and set all paramters yourself.
 * This lets you reuse image objects or add a progress listener.
 * <pre>
 * Invert invert = new Invert();
 * invert.setInputImage(image);
 * invert.addProgressListener(listener); // this is optional
 * invert.process();
 * PixelImage invertedImage = invert.getOutputImage();
 * </pre>
 * The other method is by sing the static convenience method 
 * <pre>
 * PixelImage invertedImage = Invert.invert(someImage);
 * </pre>
 * You will have to catch the potential exceptions in both cases.
 * @author Marco Schmidt
 */
public class Invert extends ImageToImageOperation
{
	/**
	 * Helper method to return an inverted image from the argument image. 
	 * @param inputImage image to be inverted
	 * @return new image object with inverted image
	 * @throws OperationFailedException on operation errors
	 */
	public static PixelImage invert(PixelImage inputImage) throws OperationFailedException
	{
		Invert invert = new Invert();
		invert.setInputImage(inputImage);
		invert.process();
		return invert.getOutputImage();
	}

	private void prepare(PixelImage in) throws
		MissingParameterException,
		WrongParameterException
	{
		if (in == null)
		{
			throw new MissingParameterException("Missing input image.");
		}
		PixelImage out = getOutputImage();
		if (out == null)
		{
			setOutputImage(in.createCompatibleImage(in.getWidth(), in.getHeight()));
		}
		else
		{
			if (in.getClass() != out.getClass())
			{
				throw new WrongParameterException("Specified output image type must be the same as input image type.");
			}
			if (in.getWidth() != out.getWidth())
			{
				throw new WrongParameterException("Specified output image must have same width as input image.");
			}
			if (in.getHeight() != out.getHeight())
			{
				throw new WrongParameterException("Specified output image must have same height as input image.");
			}
		}
	}

	private void process(Paletted8Image in)
	{
		// prepare(PixelImage) has made sure that we have a compatible output image
		Paletted8Image out = (Paletted8Image)getOutputImage();

		// invert palette of output image
		Palette pal = out.getPalette();
		final int MAX = pal.getMaxValue();
		for (int entryIndex = 0; entryIndex < pal.getNumEntries(); entryIndex++)
		{
			for (int channelIndex = 0; channelIndex < 3; channelIndex++)
			{
				pal.putSample(channelIndex, entryIndex, MAX - pal.getSample(channelIndex, entryIndex));
			}
		}

		// copy image content
		final int WIDTH = in.getWidth();
		final int HEIGHT = in.getHeight();
		for (int y = 0; y < HEIGHT; y++)
		{
			for (int x = 0; x < WIDTH; x++)
			{
				out.putSample(0, x, y, in.getSample(0, x, y));
			}
			setProgress(y, HEIGHT);
		}
	}

	private void process(IntegerImage in)
	{
		IntegerImage out = (IntegerImage)getOutputImage();
		final int WIDTH = in.getWidth();
		final int HEIGHT = in.getHeight();
		final int CHANNELS = in.getNumChannels();
		final int TOTAL_ITEMS = CHANNELS * HEIGHT;
		int processedItems = 0;
		for (int channel = 0; channel < CHANNELS; channel++)
		{
			final int MAX = in.getMaxSample(channel);
			for (int y = 0; y < HEIGHT; y++)
			{
				for (int x = 0; x < WIDTH; x++)
				{
					out.putSample(channel, x, y, MAX - in.getSample(channel, x, y));
				}
				setProgress(processedItems++, TOTAL_ITEMS);
			}
		}
	}

	/**
	 * Inverts the input image, reusing an output image if one has been specified.
	 * For paletted images, inverts the palette.
	 * For all other types, subtracts each sample of each channel from the maximum
	 * value of that channel.
	 * @throws MissingParameterException if the input image is missing
	 * @throws WrongParameterException if any of the specified image parameters are unsupported or of the wrong width or height
	 */
	public void process() throws
		MissingParameterException,
		WrongParameterException
	{
		PixelImage in = getInputImage();
		prepare(in);
		if (in instanceof Paletted8Image)
		{
			process((Paletted8Image)in);
		}
		else
		if (in instanceof IntegerImage)
		{
			process((IntegerImage)in);
		}
		else
		{
			throw new WrongParameterException("Input image type unsupported: " + in.toString());
		}
	}
}