ImageScience 3.0.0

imagescience.image
Class Aspects

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

public class Aspects
extends java.lang.Object

Contains aspect ratio or size information of up to 5D image elements.


Field Summary
 double c
          The absolute or relative aspect size in the c-dimension.
 double t
          The absolute or relative aspect size in the t-dimension.
 double x
          The absolute or relative aspect size in the x-dimension.
 double y
          The absolute or relative aspect size in the y-dimension.
 double z
          The absolute or relative aspect size in the z-dimension.
 
Constructor Summary
Aspects()
          Default constructor.
Aspects(double x)
          One-dimensional constructor.
Aspects(double x, double y)
          Two-dimensional constructor.
Aspects(double x, double y, double z)
          Three-dimensional constructor.
Aspects(double x, double y, double z, double t)
          Four-dimensional constructor.
Aspects(double x, double y, double z, double t, double c)
          Five-dimensional constructor.
 
Method Summary
 Aspects duplicate()
          Duplicates this object.
 boolean equals(Aspects aspects)
          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 double x
The absolute or relative aspect size in the x-dimension. The default value is 1.


y

public final double y
The absolute or relative aspect size in the y-dimension. The default value is 1.


z

public final double z
The absolute or relative aspect size in the z-dimension. The default value is 1.


t

public final double t
The absolute or relative aspect size in the t-dimension. The default value is 1.


c

public final double c
The absolute or relative aspect size in the c-dimension. The default value is 1.

Constructor Detail

Aspects

public Aspects()
Default constructor. The aspect size in each dimension is set to its default value.


Aspects

public Aspects(double x)
One-dimensional constructor.

Parameters:
x - The aspect size in the x-dimension.

Aspects

public Aspects(double x,
               double y)
Two-dimensional constructor.

Parameters:
x - The aspect size in the x-dimension.
y - The aspect size in the y-dimension.

Aspects

public Aspects(double x,
               double y,
               double z)
Three-dimensional constructor.

Parameters:
x - The aspect size in the x-dimension.
y - The aspect size in the y-dimension.
z - The aspect size in the z-dimension.

Aspects

public Aspects(double x,
               double y,
               double z,
               double t)
Four-dimensional constructor.

Parameters:
x - The aspect size in the x-dimension.
y - The aspect size in the y-dimension.
z - The aspect size in the z-dimension.
t - The aspect size in the t-dimension.

Aspects

public Aspects(double x,
               double y,
               double z,
               double t,
               double c)
Five-dimensional constructor.

Parameters:
x - The aspect size in the x-dimension.
y - The aspect size in the y-dimension.
z - The aspect size in the z-dimension.
t - The aspect size in the t-dimension.
c - The aspect size in the c-dimension.
Method Detail

duplicate

public Aspects duplicate()
Duplicates this object.

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

Parameters:
aspects - The object to compare this object with.
Returns:
Value true if the given object is not null and its aspect size in each dimension is equal to the corresponding aspect size 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.