ImageDimensions (Mango Plugin API)

java.lang.Object
- edu.uthscsa.ric.volume.ImageDimensions

All Implemented Interfaces:

Cloneable
```
public class ImageDimensions
extends Object
implements Cloneable
```
ImageDimensions contains information related to image size in columns/rows/slices and x/y/z orientations, as well as timepoints and offset.

Field Summary

Fields
Modifier and Type Field and Description

static int SLICE_DIRECTION_AXIAL

static int SLICE_DIRECTION_CORONAL

static int SLICE_DIRECTION_SAGITTAL

Fields
Modifier and Type	Field and Description
`static int`	`SLICE_DIRECTION_AXIAL`
`static int`	`SLICE_DIRECTION_CORONAL`
`static int`	`SLICE_DIRECTION_SAGITTAL`

Constructor Summary

Constructors
Constructor and Description

ImageDimensions(int cols, int rows, int slices, int seriesPoints)
The only class constructor.

Constructors
Constructor and Description
`ImageDimensions(int cols, int rows, int slices, int seriesPoints)` The only class constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns a copy of this object.
`boolean`	`equals(ImageDimensions obj)` Deprecated.
`boolean`	`equals(Object obj)` Tests equality.
`int`	`getCols()` Gets the number of columns in a volume of this image.
`int`	`getImageOffset()` Gets the image offset.
`int[]`	`getImageOffsets()` Returns an array of image offsets for multi-file images.
`int`	`getImageTrailer()` Returns the number of bytes in the image trailer.
`long`	`getNumVoxels()` Deprecated.
`int`	`getNumVoxelsSlice()` Gets the number of voxels in a slice of this image.
`int`	`getNumVoxelsSlice(int sliceDirection)` Gets the number of voxels in a slice of this image.
`long`	`getNumVoxelsTimeseries()` Gets the number of voxels in this image.
`int`	`getNumVoxelsVolume()` Gets the number of voxels in a volume of this image.
`int`	`getRows()` Gets the number of rows in a volume of this image.
`int`	`getSlices()` Gets the number of slices in a volume of this image.
`int`	`getTimepoints()` Gets the number of timepoints in this image.
`int`	`getX()` Gets the X dimension.
`int`	`getY()` Gets the Y dimension.
`int`	`getZ()` Gets the Z dimension.
`int`	`hashCode()` Computes hash code.
`boolean`	`inRange(Coordinate coord)` Returns true if the specified coordinate is within the range of these dimensions.
`boolean`	`isTiled()` Returns true if the data is tiled (e.g., DICOM mosaic data).
`boolean`	`isValid()` Use to verify that columns, rows, slices, and timepoints have valid values.
`boolean`	`isValid(StringBuffer buf)` Use to verify that columns, rows, slices, and timepoints have valid values.
`void`	`setImageOffset(int num)` Sets the image offset.
`void`	`setImageOffsets(int[] imageOffsets)` Sets an array of image offsets for multi-file images.
`void`	`setImageTrailer(int imageTrailer)` Sets the number of bytes in the image trailer
`void`	`setTiled(boolean tiled)` Set to true if the data is tiled.
`void`	`setTimepoints(int num)` Sets the number of timepoints in this image.
`void`	`setValues(ImageDimensions id)` Set the values of this ImageDimensions to that of another.
`void`	`setValues(ImageDimensions id, boolean updateXYZ)` Set the values of this ImageDimensions to that of another.
`void`	`setX(int num)` Sets the X dimension.
`void`	`setY(int num)` Sets the Y dimension.
`void`	`setZ(int num)` Sets the Z dimension.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SLICE_DIRECTION_AXIAL
```
public static final int SLICE_DIRECTION_AXIAL
```
    See Also:
    Constant Field Values
  - SLICE_DIRECTION_CORONAL
```
public static final int SLICE_DIRECTION_CORONAL
```
    See Also:
    Constant Field Values
  - SLICE_DIRECTION_SAGITTAL
```
public static final int SLICE_DIRECTION_SAGITTAL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ImageDimensions
```
public ImageDimensions(int cols,
               int rows,
               int slices,
               int seriesPoints)
```
    The only class constructor.
    
    Parameters:
    cols - number of columns
    rows - number of rows
    slices - number of slices
    seriesPoints - number of timepoints
- Method Detail
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    clone object
    
    Throws:
    
    CloneNotSupportedException - clone not supported exception
  - equals
```
@Deprecated
public boolean equals(ImageDimensions obj)
```
    Deprecated.
    
    Tests equality. This method ignores offset, timepoints, and imageTrailer.
    
    Parameters:
    obj - object to compare
    
    Returns:
    true if the objects are equals, false otherwise
  - equals
```
public boolean equals(Object obj)
```
    Tests equality. This method ignores offset, timepoints, and imageTrailer.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - object to compare
    
    Returns:
    true if the objects are equals, false otherwise
  - getCols
```
public int getCols()
```
    Gets the number of columns in a volume of this image.
    
    Returns:
    number of columns in a volume of this image
  - getImageOffset
```
public int getImageOffset()
```
    Gets the image offset.
    
    Returns:
    size of image offset
  - getImageOffsets
```
public int[] getImageOffsets()
```
    Returns an array of image offsets for multi-file images.
    
    Returns:
    an array of image ofsets
  - getImageTrailer
```
public int getImageTrailer()
```
    Returns the number of bytes in the image trailer.
    
    Returns:
    the number of bytes in the image trailer
  - getNumVoxels
```
@Deprecated
public long getNumVoxels()
```
    Deprecated.
    
    Gets the number of voxels in this image.
    
    Returns:
    number of voxels in this image
  - getNumVoxelsSlice
```
public int getNumVoxelsSlice()
```
    Gets the number of voxels in a slice of this image.
    
    Returns:
    number of voxels in a slice of this image
  - getNumVoxelsSlice
```
public int getNumVoxelsSlice(int sliceDirection)
```
    Gets the number of voxels in a slice of this image.
    
    Parameters:
    sliceDirection - axial, coronal, or sagittal
    
    Returns:
    number of voxels in a slice of this image
  - getNumVoxelsTimeseries
```
public long getNumVoxelsTimeseries()
```
    Gets the number of voxels in this image.
    
    Returns:
    number of voxels in this image
  - getNumVoxelsVolume
```
public int getNumVoxelsVolume()
```
    Gets the number of voxels in a volume of this image.
    
    Returns:
    number of voxels in a volume of this image
  - getRows
```
public int getRows()
```
    Gets the number of rows in a volume of this image.
    
    Returns:
    number of rows in a volume of this image
  - getSlices
```
public int getSlices()
```
    Gets the number of slices in a volume of this image.
    
    Returns:
    number of slices in a volume of this image
  - getTimepoints
```
public int getTimepoints()
```
    Gets the number of timepoints in this image.
    
    Returns:
    number of timepoints in this image
  - getX
```
public int getX()
```
    Gets the X dimension.
    
    Returns:
    size of X dimension
  - getY
```
public int getY()
```
    Gets the Y dimension.
    
    Returns:
    size of Y dimension
  - getZ
```
public int getZ()
```
    Gets the Z dimension.
    
    Returns:
    size of Z dimension
  - hashCode
```
public int hashCode()
```
    Computes hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code
  - inRange
```
public boolean inRange(Coordinate coord)
```
    Returns true if the specified coordinate is within the range of these dimensions.
    
    Parameters:
    coord - the coordinate to test
    
    Returns:
    true if the specified coordinage is within the range of these dimensions
  - isTiled
```
public boolean isTiled()
```
    Returns true if the data is tiled (e.g., DICOM mosaic data).
    
    Returns:
    true if the data is tiled
  - isValid
```
public boolean isValid()
```
    Use to verify that columns, rows, slices, and timepoints have valid values.
    
    Returns:
    true, if valid
  - isValid
```
public boolean isValid(StringBuffer buf)
```
    Use to verify that columns, rows, slices, and timepoints have valid values.
    
    Parameters:
    buf - stores any error messages
    
    Returns:
    true, if valid
  - setImageOffset
```
public void setImageOffset(int num)
```
    Sets the image offset.
    
    Parameters:
    num - size of image offset
  - setImageOffsets
```
public void setImageOffsets(int[] imageOffsets)
```
    Sets an array of image offsets for multi-file images.
    
    Parameters:
    imageOffsets - an array of image offsets
  - setImageTrailer
```
public void setImageTrailer(int imageTrailer)
```
    Sets the number of bytes in the image trailer
    
    Parameters:
    imageTrailer - number of bytes
  - setTiled
```
public void setTiled(boolean tiled)
```
    Set to true if the data is tiled.
    
    Parameters:
    tiled - true if the data is tiles, false otherwise
  - setTimepoints
```
public void setTimepoints(int num)
```
    Sets the number of timepoints in this image.
    
    Parameters:
    num - number of timepoints in this image
  - setValues
```
public void setValues(ImageDimensions id)
```
    Set the values of this ImageDimensions to that of another.
    
    Parameters:
    id - replacement ImageDimensions object
  - setValues
```
public void setValues(ImageDimensions id,
             boolean updateXYZ)
```
    Set the values of this ImageDimensions to that of another.
    
    Parameters:
    id - replacement ImageDimensions object
    updateXYZ - xyz values will be replaced, if true
  - setX
```
public void setX(int num)
```
    Sets the X dimension.
    
    Parameters:
    num - size of X dimension
  - setY
```
public void setY(int num)
```
    Sets the Y dimension.
    
    Parameters:
    num - size of Y dimension
  - setZ
```
public void setZ(int num)
```
    Sets the Z dimension.
    
    Parameters:
    num - size of Z dimension
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this object

Class ImageDimensions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SLICE_DIRECTION_AXIAL

SLICE_DIRECTION_CORONAL

SLICE_DIRECTION_SAGITTAL

Constructor Detail

ImageDimensions

Method Detail

clone

equals

equals

getCols

getImageOffset

getImageOffsets

getImageTrailer

getNumVoxels

getNumVoxelsSlice

getNumVoxelsSlice

getNumVoxelsTimeseries

getNumVoxelsVolume

getRows

getSlices

getTimepoints

getX

getY

getZ

hashCode

inRange

isTiled

isValid

isValid

setImageOffset

setImageOffsets

setImageTrailer

setTiled

setTimepoints

setValues

setValues

setX

setY

setZ

toString