Resolution (Anchor - merged Javadoc across key repositories. This documentation is a work-in-progress. 0.0.1-SNAPSHOT API)

Object
- Resolution

All Implemented Interfaces:

Serializable
```
public final class Resolution
extends Object
implements Serializable
```
The resolution of an image.
i.e. what a single voxel represents in physical units (meters) in x, y, z dimensions.
This class is immutable.

Author:

Owen Feehan

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Resolution()

Resolution(double x, double y, double z)

Resolution(Tuple3d tuple)
Constructs a resolution from a tuple.

Constructors
Constructor and Description
`Resolution()`
`Resolution(double x, double y, double z)`
`Resolution(Tuple3d tuple)` Constructs a resolution from a tuple.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`distance(Point3d point1, Point3d point2)`
`double`	`distance(Point3i point1, Point3i point2)`
`double`	`distanceSquared(Point3d point1, Point3d point2)` The square of the distance between two points taking account image-resolution.
`double`	`distanceSquared(Point3i point1, Point3i point2)` The square of the distance between two points taking account image-resolution.
`double`	`distanceSquaredZRelative(Point3d point1, Point3d point2)`
`double`	`distanceSquaredZRelative(Point3i point1, Point3i point2)`
`double`	`distanceZRelative(Point3d point1, Point3d point2)`
`Resolution`	`duplicateFlattenZ(int prevZSize)`
`boolean`	`equals(Object o)`
`boolean`	`hasEqualXAndY()`
`int`	`hashCode()`
`double`	`max(boolean do3D)`
`double`	`min(boolean do3D)`
`Resolution`	`scaleXY(ScaleFactor scaleFactor)`
`String`	`toString()`
`double`	`unitArea()`
`UnitConverter`	`unitConvert()` Converts voxelized measurements to/from physical units.
`double`	`unitVolume()`
`double`	`valueByDimension(AxisType axisType)`
`double`	`valueByDimension(int dimIndex)`
`double`	`x()`
`double`	`y()`
`double`	`z()`
`double`	`zRelative()` Assumes x and y has constant resolution, and gives the relative resolution of z to x or y.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- Resolution
```
public Resolution()
```
- Resolution
```
public Resolution(double x,
                  double y,
                  double z)
           throws CreateException
```
  Throws:
  
  CreateException
- Resolution
```
public Resolution(Tuple3d tuple)
           throws CreateException
```
  Constructs a resolution from a tuple.
  Note all dimensions must have positive (i.e. non-zero) resolution.
  X and Y are not allowed have NaN but this is acceptable for the Z-value.
  
  Parameters:
  
  tuple - the resolution for X, Y and Z
  
  Throws:
  
  CreateException

Method Detail

duplicateFlattenZ

public Resolution duplicateFlattenZ(int prevZSize)

x
```
public double x()
```

y
```
public double y()
```

z
```
public double z()
```

unitVolume
```
public double unitVolume()
```

unitArea
```
public double unitArea()
```

scaleXY

public Resolution scaleXY(ScaleFactor scaleFactor)

max
```
public double max(boolean do3D)
```

min
```
public double min(boolean do3D)
```

hasEqualXAndY
```
public boolean hasEqualXAndY()
```

distanceSquared
```
public double distanceSquared(Point3i point1,
                              Point3i point2)
```
The square of the distance between two points taking account image-resolution.

Parameters:

point1 - first point

point2 - second point

Returns:

the square of the distance between the two points

distanceSquared
```
public double distanceSquared(Point3d point1,
                              Point3d point2)
```
The square of the distance between two points taking account image-resolution.

Parameters:

point1 - first point

point2 - second point

Returns:

the square of the distance between the two points

distance

public double distance(Point3d point1,
                       Point3d point2)

distance

public double distance(Point3i point1,
                       Point3i point2)

distanceSquaredZRelative

public double distanceSquaredZRelative(Point3i point1,
                                       Point3i point2)

distanceZRelative

public double distanceZRelative(Point3d point1,
                                Point3d point2)

distanceSquaredZRelative

public double distanceSquaredZRelative(Point3d point1,
                                       Point3d point2)

unitConvert
```
public UnitConverter unitConvert()
```
Converts voxelized measurements to/from physical units.

Returns:

a converter that will perform conversions using current resolution.

zRelative
```
public double zRelative()
```
Assumes x and y has constant resolution, and gives the relative resolution of z to x or y.

Returns:

toString
```
public String toString()
```
Overrides:

toString in class Object

valueByDimension

public final double valueByDimension(int dimIndex)

valueByDimension

public final double valueByDimension(AxisType axisType)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class Resolution

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Resolution

Resolution

Resolution

Method Detail

duplicateFlattenZ

x

y

z

unitVolume

unitArea

scaleXY

max

min

hasEqualXAndY

distanceSquared

distanceSquared

distance

distance

distanceSquaredZRelative

distanceZRelative

distanceSquaredZRelative

unitConvert

zRelative

toString

valueByDimension

valueByDimension

equals

hashCode