ImageScience 3.0.0

imagescience.shape
Interface Shape

All Known Implementing Classes:
Circle, Ellipse, Polygon, Rectangle, Region, Spline, Square

public interface Shape

Interface for objects representing closed and bounded geometrical figures up to 5D.


Method Summary
 Image bitmap(boolean binary)
          Computes a bitmapped version of the shape.
 Bounds bounds()
          Computes the bounding box of the shape.
 boolean contains(Point point)
          Indicates the position of a point relative to the shape.
 Shape duplicate()
          Duplicates the shape.
 boolean empty()
          Indicates whether the shape is empty.
 boolean equals(Shape shape)
          Indicates whether this object has the same shape as the given object.
 

Method Detail

bitmap

Image bitmap(boolean binary)
Computes a bitmapped version of the shape.

Parameters:
binary - Determines whether the returned bitmap image is two-valued. If true, image elements whose center positions fall inside the shape are set to 255, and elements whose center positions fall outside the shape are set to 0. If false, additional processing is performed, by which each image element falling partly inside and partly outside the shape is set to 255 times its (approximate) inside-fraction.
Returns:
A new ByteImage object containing a bitmapped version of the shape. The origin of the integer coordinate system of the image corresponds to the position in the shape coordinate system obtained by taking the floor value of the lower bound of the shape in each dimension.

bounds

Bounds bounds()
Computes the bounding box of the shape.

Returns:
A new Bounds object containing the bounding box of the shape.

contains

boolean contains(Point point)
Indicates the position of a point relative to the shape.

Parameters:
point - The point whose position relative to the shape is to be tested.
Returns:
Value true if the point is on or inside the boundary of the shape, or false if this is not the case.
Throws:
java.lang.NullPointerException - If point is null.

duplicate

Shape duplicate()
Duplicates the shape.

Returns:
A new Shape object that is an exact copy of this object. All information is copied and no memory is shared between this and the returned object.

empty

boolean empty()
Indicates whether the shape is empty.

Returns:
Value true if the shape does not enclose any space, or false if it does.

equals

boolean equals(Shape shape)
Indicates whether this object has the same shape as the given object.

Parameters:
shape - The shape to compare this shape with.
Returns:
Value true if shape is not null, and an instance of the same class as this object, with the exact same shape, or false if this is not the case.

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.