net.sourceforge.jiu.geometry

Class Crop


public class Crop
extends ImageToImageOperation

Copies a rectangular area of one image to another image that is exactly as large as that rectangular area. Works with all image data classes implementing IntegerImage. Make sure to use zero-based parameters when defining the bounds with setBounds(int,int,int,int)!

Usage example

In this example we assume that the input image is larger than 20 pixels in both directions. Ten pixels will be removed from any of its four borders.
 PixelImage image = ...; // something implementing IntegerImage
 Crop crop = new Crop();
 crop.setInputImage(image);
 crop.setBounds(10, 10, image.getWidth() - 9, image.getHeight() - 9);
 crop.process();
 PixelImage croppedImage = crop.getOutputImage();
 
Author:
Marco Schmidt

Field Summary

private int
x1
private int
x2
private int
y1
private int
y2

Fields inherited from class net.sourceforge.jiu.ops.ImageToImageOperation

canInAndOutBeEqual, inputImage, outputImage

Fields inherited from class net.sourceforge.jiu.ops.Operation

abort, progressListeners

Method Summary

private void
checkBounds()
void
process()
This method does the actual work of the operation.
private void
process(IntegerImage in, IntegerImage out)
void
setBounds(int x1, int y1, int x2, int y2)
Specify the rectangular section of the original image that is to be copied to the output image by this operation.

Methods inherited from class net.sourceforge.jiu.ops.ImageToImageOperation

canInputAndOutputBeEqual, ensureImagesHaveSameResolution, ensureInputImageIsAvailable, ensureOutputImageResolution, getInputImage, getOutputImage, setCanInputAndOutputBeEqual, setInputImage, setOutputImage

Methods inherited from class net.sourceforge.jiu.ops.Operation

addProgressListener, addProgressListeners, getAbort, process, removeProgressListener, setAbort, setProgress, setProgress

Field Details

x1

private int x1

x2

private int x2

y1

private int y1

y2

private int y2

Method Details

checkBounds

private void checkBounds()
            throws WrongParameterException

process

public void process()
            throws MissingParameterException,
                   WrongParameterException
This method does the actual work of the operation. It must be called after all parameters have been given to the operation object.
Overrides:
process in interface Operation
Throws:
WrongParameterException - if at least one of the input parameters was not initialized appropriately (values out of the valid interval, etc.)
MissingParameterException - if any mandatory parameter was not given to the operation

process

private void process(IntegerImage in,
                     IntegerImage out)

setBounds

public void setBounds(int x1,
                      int y1,
                      int x2,
                      int y2)
            throws IllegalArgumentException
Specify the rectangular section of the original image that is to be copied to the output image by this operation. Note that the arguments are not checked directly against any input image that may have been provided to this Crop object, that checking is done later in process(). If any of the arguments provided here are outside of the input image's resolution (e.g. x1 == 100 although the input image's width is only 60), a WrongParameterException will be thrown from within process().

Note that the arguments to this method are zero-based, so the first column and row are 0, the second 1, the third 2, and so on. If you have a image that is 200 pixels wide and 100 pixels high, values from 0 to 199 are valid for the x arguments, and values from 0 to 99 are valid for the vertical direction.

Parameters:
x1 - horizontal position of upper left corner of the rectangle
y1 - vertical position of upper left corner of the rectangle
x2 - horizontal position of lower right corner of the rectangle
y2 - vertical position of lower right corner of the rectangle