ImageScience 3.0.0

imagescience.image
Class Borders

java.lang.Object
  extended by imagescience.image.Borders

public class Borders
extends java.lang.Object

Contains the dimensions of the borders of up to 5D image data objects.


Field Summary
 int c
          The border size in the c-dimension.
 int t
          The border size in the t-dimension.
 int x
          The border size in the x-dimension.
 int y
          The border size in the y-dimension.
 int z
          The border size in the z-dimension.
 
Constructor Summary
Borders()
          Default constructor.
Borders(int x)
          One-dimensional constructor.
Borders(int x, int y)
          Two-dimensional constructor.
Borders(int x, int y, int z)
          Three-dimensional constructor.
Borders(int x, int y, int z, int t)
          Four-dimensional constructor.
Borders(int x, int y, int z, int t, int c)
          Five-dimensional constructor.
 
Method Summary
 Borders duplicate()
          Duplicates this object.
 boolean equals(Borders borders)
          Indicates whether this object is in the same state as the given object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

x

public final int x
The border size in the x-dimension. The default value is 0.


y

public final int y
The border size in the y-dimension. The default value is 0.


z

public final int z
The border size in the z-dimension. The default value is 0.


t

public final int t
The border size in the t-dimension. The default value is 0.


c

public final int c
The border size in the c-dimension. The default value is 0.

Constructor Detail

Borders

public Borders()
Default constructor.


Borders

public Borders(int x)
One-dimensional constructor.

Parameters:
x - The border size in the x-dimension.
Throws:
java.lang.IllegalArgumentException - If the parameter value is less than 0.

Borders

public Borders(int x,
               int y)
Two-dimensional constructor.

Parameters:
x - The border size in the x-dimension.
y - The border size in the y-dimension.
Throws:
java.lang.IllegalArgumentException - If any of the parameter values is less than 0.

Borders

public Borders(int x,
               int y,
               int z)
Three-dimensional constructor.

Parameters:
x - The border size in the x-dimension.
y - The border size in the y-dimension.
z - The border size in the z-dimension.
Throws:
java.lang.IllegalArgumentException - If any of the parameter values is less than 0.

Borders

public Borders(int x,
               int y,
               int z,
               int t)
Four-dimensional constructor.

Parameters:
x - The border size in the x-dimension.
y - The border size in the y-dimension.
z - The border size in the z-dimension.
t - The border size in the t-dimension.
Throws:
java.lang.IllegalArgumentException - If any of the parameter values is less than 0.

Borders

public Borders(int x,
               int y,
               int z,
               int t,
               int c)
Five-dimensional constructor.

Parameters:
x - The border size in the x-dimension.
y - The border size in the y-dimension.
z - The border size in the z-dimension.
t - The border size in the t-dimension.
c - The border size in the c-dimension.
Throws:
java.lang.IllegalArgumentException - If any of the parameter values is less than 0.
Method Detail

duplicate

public Borders duplicate()
Duplicates this object.

Returns:
A new Borders 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(Borders borders)
Indicates whether this object is in the same state as the given object.

Parameters:
borders - The object to compare this object with.
Returns:
Value true if the given object is not null and has the same border size in each dimension as 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.