ImageScience 3.0.0

imagescience.shape
Class Bounds

java.lang.Object
  extended by imagescience.shape.Bounds

public class Bounds
extends java.lang.Object

Contains bounding box information of up to 5D shapes. By design, this class does not prevent making the upper bound less than the lower bound in any dimension.


Field Summary
 Point lower
          Contains the lower bound for each dimension.
 Point upper
          Contains the upper bound for each dimension.
 
Constructor Summary
Bounds()
          Default constructor.
Bounds(Point lower, Point upper)
          Constructor.
 
Method Summary
 Bounds duplicate()
          Duplicates the bounds.
 boolean equals(Bounds bounds)
          Indicates whether this bounding box is the same as the given bounding box.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lower

public final Point lower
Contains the lower bound for each dimension. The default lower bound for each dimension is 0.


upper

public final Point upper
Contains the upper bound for each dimension. The default upper bound for each dimension is 0.

Constructor Detail

Bounds

public Bounds()
Default constructor.


Bounds

public Bounds(Point lower,
              Point upper)
Constructor.

Parameters:
lower - A point whose coordinates define the lower bound for each dimension.
upper - A point whose coordinates define the upper bound for each dimension.
Throws:
java.lang.NullPointerException - If lower or upper is null.
Method Detail

duplicate

public Bounds duplicate()
Duplicates the bounds.

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

equals

public boolean equals(Bounds bounds)
Indicates whether this bounding box is the same as the given bounding box.

Parameters:
bounds - The bounding box to compare with.
Returns:
Value true if bounds is not null and its lower and upper bounds in each dimension are equal to the corresponding lower and upper bounds of this object, 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.