ImageScience 3.0.0

imagescience.transform
Class Crop

java.lang.Object
  extended by imagescience.transform.Crop

public class Crop
extends java.lang.Object

Crops an image.


Field Summary
 Messenger messenger
          The object used for message displaying.
 Progressor progressor
          The object used for progress displaying.
 
Constructor Summary
Crop()
          Default constructor.
 
Method Summary
 Image run(Image image, Coordinates start, Coordinates stop)
          Crops an image.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

messenger

public final Messenger messenger
The object used for message displaying.


progressor

public final Progressor progressor
The object used for progress displaying.

Constructor Detail

Crop

public Crop()
Default constructor.

Method Detail

run

public Image run(Image image,
                 Coordinates start,
                 Coordinates stop)
Crops an image.

Parameters:
image - The image to be cropped.
start - stop - The start and stop (inclusive) coordinates for cropping in every dimension.
Returns:
A new image containing a copy of the input image within the given crop range. The returned image is of the same type as the input image.
Throws:
java.lang.IllegalArgumentException - If any of the start or stop coordinates is out of range, or if the start coordinate is larger than the stop coordinate in any dimension.
java.lang.NullPointerException - If any of the parameters is null.
java.lang.UnknownError - If for any reason the output image can not be created. In most cases this will be due to insufficient free memory.

ImageScience 3.0.0

Copyright (C) Erik Meijering. Permission to use this software and corresponding documentation for educational, research, and not-for-profit purposes, without a fee and without a signed licensing agreement, is granted, subject to the following terms and conditions.

IT IS NOT ALLOWED TO REDISTRIBUTE, SELL, OR LEASE THIS SOFTWARE, OR DERIVATIVE WORKS THEREOF, WITHOUT PERMISSION IN WRITING FROM THE COPYRIGHT HOLDER. THE COPYRIGHT HOLDER IS FREE TO MAKE VERSIONS OF THE SOFTWARE AVAILABLE FOR A FEE OR COMMERCIALLY ONLY.

IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OF ANY KIND WHATSOEVER, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE AND CORRESPONDING DOCUMENTATION IS PROVIDED "AS IS". THE COPYRIGHT HOLDER HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.