VoxelDimensions (Mango Plugin API)

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

All Implemented Interfaces:

Cloneable
```
public class VoxelDimensions
extends Object
implements Cloneable
```
VoxelDimensions contains information related to voxel size in column/row/slice and x/y/z orientations, as well as temporal resolution and units.

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`UNIT_STRING`
`static short`	`UNITS_HZ`
`static short`	`UNITS_METER`
`static short`	`UNITS_MICRON`
`static short`	`UNITS_MM`
`static short`	`UNITS_MSEC`
`static short`	`UNITS_PPM`
`static short`	`UNITS_RADS`
`static short`	`UNITS_SEC`
`static short`	`UNITS_UNKNOWN`
`static short`	`UNITS_USEC`

Constructor Summary

Constructors
Constructor and Description
`VoxelDimensions(double colSize, double rowSize, double sliceThickness, double TR)` The only class constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearNegativeVoxelSizes()` Replaces any stored negative voxel sizes with their absolute value.
`Object`	`clone()` Returns a copy of this object.
`boolean`	`equals(Object obj)` Tests equality.
`boolean`	`equals(VoxelDimensions obj)` Deprecated.
`double`	`getAxialArea()` Returns the area of a voxel in the axial plane.
`double`	`getColSize(boolean abs)` Returns the size of a voxel's column dimension.
`double`	`getCoronalArea()` Returns the area of a voxel in the coronal plane.
`double`	`getRowSize(boolean abs)` Returns the size of a voxel's row dimension.
`double`	`getSagittalArea()` Returns the area of a voxel in the sagittal plane.
`double`	`getSliceThickness(boolean abs)` Returns the size of a voxel's slice dimension.
`int`	`getSpatialUnit()` Returns the spatial unit code.
`double`	`getSpatialUnitMultiplier()` Returns a multiplier to convert units to mm.
`double`	`getTE1()` Returns the TE1.
`double`	`getTE2()` Returns the TE2.
`int`	`getTemporalUnit()` Returns the temporal unit code.
`double`	`getTemporalUnitMultiplier()` Returns a multiplier to convert units to seconds.
`double`	`getTR()` Returns the TR.
`float[]`	`getVariableSpacing()` Returns an array of variable slice spacings.
`float[]`	`getVariableTiming()` Returns an array of variable volume durations.
`double`	`getVolume()` Returns the volume of a voxel.
`double`	`getXSize()` Returns the size of a voxel along the X dimension.
`double`	`getYSize()` Returns the size of a voxel along the Y dimension.
`double`	`getZSize()` Returns the size of a voxel along the Z dimension.
`int`	`hashCode()` Compute hash code.
`boolean`	`isFlip()`
`boolean`	`isValid()` Use to verify that column, row, and slice sizes and TR have valid values.
`boolean`	`isValid(StringBuffer buf)` Use to verify that column, row, and slice sizes and TR have valid values.
`void`	`setColNegativeState(boolean bool)` Sets the negative state of voxel column size.
`void`	`setColSize(double val)` Sets the size of a voxel along the column dimension.
`void`	`setFlip(boolean flip)`
`void`	`setRowNegativeState(boolean bool)` Sets the negative state of voxel row size.
`void`	`setRowSize(double val)` Sets the size of a voxel along the row dimension.
`void`	`setSliceNegativeState(boolean bool)` Sets the negative state of voxel slice size.
`void`	`setSliceThickness(double val)` Sets the size of a voxel along the slice dimension.
`void`	`setSpatialUnit(int unit)` Sets the spatial unit of the voxel.
`void`	`setSpatialUnit(String unit)` Sets the spatial unit of the voxel.
`void`	`setTE1(double num)` Sets the TE1.
`void`	`setTE2(double num)` Sets the TE2.
`void`	`setTemporalUnit(int unit)` Sets the temporal unit of the voxel.
`void`	`setTemporalUnit(String unit)` Sets the temporal unit of the voxel.
`void`	`setTR(double num)` Sets the TR.
`void`	`setValues(VoxelDimensions vd)` Set the values of this VoxelDimensions to that of another.
`void`	`setValues(VoxelDimensions vd, boolean updateXYZ)` Set the values of this VoxelDimensions to that of another.
`void`	`setVariableSpacing(float[] variableSpacing)` Sets an array of variable slice spacings.
`void`	`setVariableTiming(float[] variableTiming)` Sets an array of variable volume durations.
`void`	`setXSize(double num)` Sets the size of a voxel along the X dimension.
`void`	`setYSize(double num)` Sets the size of a voxel along the Y dimension.
`void`	`setZSize(double num)` Sets the size of a voxel along 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
  - UNIT_STRING
```
public static final String[] UNIT_STRING
```
  - UNITS_HZ
```
public static final short UNITS_HZ
```
    See Also:
    Constant Field Values
  - UNITS_METER
```
public static final short UNITS_METER
```
    See Also:
    Constant Field Values
  - UNITS_MICRON
```
public static final short UNITS_MICRON
```
    See Also:
    Constant Field Values
  - UNITS_MM
```
public static final short UNITS_MM
```
    See Also:
    Constant Field Values
  - UNITS_MSEC
```
public static final short UNITS_MSEC
```
    See Also:
    Constant Field Values
  - UNITS_PPM
```
public static final short UNITS_PPM
```
    See Also:
    Constant Field Values
  - UNITS_RADS
```
public static final short UNITS_RADS
```
    See Also:
    Constant Field Values
  - UNITS_SEC
```
public static final short UNITS_SEC
```
    See Also:
    Constant Field Values
  - UNITS_UNKNOWN
```
public static final short UNITS_UNKNOWN
```
    See Also:
    Constant Field Values
  - UNITS_USEC
```
public static final short UNITS_USEC
```
    See Also:
    Constant Field Values
- Constructor Detail
  - VoxelDimensions
```
public VoxelDimensions(double colSize,
               double rowSize,
               double sliceThickness,
               double TR)
```
    The only class constructor.
    
    Parameters:
    colSize - size of a voxel's column dimension
    rowSize - size of a voxel's row dimension
    sliceThickness - size of a voxel's slice dimension
    TR - temporal resolution
- Method Detail
  - clearNegativeVoxelSizes
```
public void clearNegativeVoxelSizes()
```
    Replaces any stored negative voxel sizes with their absolute value.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    cloned object
    
    Throws:
    
    CloneNotSupportedException - clone not supported exception
  - equals
```
@Deprecated
public boolean equals(VoxelDimensions obj)
```
    Deprecated.
    
    Tests equality. Ignores TR, TE1, TE2.
    
    Parameters:
    obj - object to compare
    
    Returns:
    true if the objects are equal, false otherwise
  - equals
```
public boolean equals(Object obj)
```
    Tests equality. Ignores TR, TE1, TE2.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - object to compare
    
    Returns:
    true if the objects are equal, false otherwise
  - getAxialArea
```
public double getAxialArea()
```
    Returns the area of a voxel in the axial plane.
    
    Returns:
    area of a voxel in the axial plane
  - getColSize
```
public double getColSize(boolean abs)
```
    Returns the size of a voxel's column dimension.
    
    Parameters:
    abs - a negative value will be converted to positive, if true
    
    Returns:
    size of a voxel's column dimension
  - getCoronalArea
```
public double getCoronalArea()
```
    Returns the area of a voxel in the coronal plane.
    
    Returns:
    area of a voxel in the coronal plane
  - getRowSize
```
public double getRowSize(boolean abs)
```
    Returns the size of a voxel's row dimension.
    
    Parameters:
    abs - a negative value will be converted to positive, if true
    
    Returns:
    size of a voxel's row dimension
  - getSagittalArea
```
public double getSagittalArea()
```
    Returns the area of a voxel in the sagittal plane.
    
    Returns:
    area of a voxel in the sagittal plane
  - getSliceThickness
```
public double getSliceThickness(boolean abs)
```
    Returns the size of a voxel's slice dimension.
    
    Parameters:
    abs - negative value will be converted to positive, if true
    
    Returns:
    size of a voxel's slice dimension
  - getSpatialUnit
```
public int getSpatialUnit()
```
    Returns the spatial unit code.
    
    Returns:
    spatial unit code
  - getSpatialUnitMultiplier
```
public double getSpatialUnitMultiplier()
```
    Returns a multiplier to convert units to mm.
    
    Returns:
    a multiplier to convert units to mm
  - getTE1
```
public double getTE1()
```
    Returns the TE1.
    
    Returns:
    size of TE1
  - getTE2
```
public double getTE2()
```
    Returns the TE2.
    
    Returns:
    size of TE2
  - getTemporalUnit
```
public int getTemporalUnit()
```
    Returns the temporal unit code.
    
    Returns:
    temporal unit code
  - getTemporalUnitMultiplier
```
public double getTemporalUnitMultiplier()
```
    Returns a multiplier to convert units to seconds.
    
    Returns:
    a multiplier to convert units to seconds
  - getTR
```
public double getTR()
```
    Returns the TR.
    
    Returns:
    size of TR
  - getVariableSpacing
```
public float[] getVariableSpacing()
```
    Returns an array of variable slice spacings. If this array is null, then it is assumed the slice spacings are constant across the volume and equal to sliceThickness.
    
    Returns:
    the array
  - getVariableTiming
```
public float[] getVariableTiming()
```
    Returns an array of variable volume durations. If this array is null for series data, then it is assumed the volume durations are constant across the series and equals to TR.
    
    Returns:
    the array
  - getVolume
```
public double getVolume()
```
    Returns the volume of a voxel.
    
    Returns:
    volume of a voxel.
  - getXSize
```
public double getXSize()
```
    Returns the size of a voxel along the X dimension.
    
    Returns:
    size of voxel along X dimension
  - getYSize
```
public double getYSize()
```
    Returns the size of a voxel along the Y dimension.
    
    Returns:
    size of voxel along Y dimension
  - getZSize
```
public double getZSize()
```
    Returns the size of a voxel along the Z dimension.
    
    Returns:
    size of voxel along Z dimension
  - hashCode
```
public int hashCode()
```
    Compute hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code
  - isValid
```
public boolean isValid()
```
    Use to verify that column, row, and slice sizes and TR have valid values.
    
    Returns:
    true if valid
  - isValid
```
public boolean isValid(StringBuffer buf)
```
    Use to verify that column, row, and slice sizes and TR have valid values.
    
    Parameters:
    buf - stores any error messages
    
    Returns:
    true if valid
  - setColNegativeState
```
public void setColNegativeState(boolean bool)
```
    Sets the negative state of voxel column size.
    
    Parameters:
    bool - if true, column size will be set as negative; positive otherwise
  - setColSize
```
public void setColSize(double val)
```
    Sets the size of a voxel along the column dimension.
    
    Parameters:
    val - size of a voxel along the column dimension
  - setRowNegativeState
```
public void setRowNegativeState(boolean bool)
```
    Sets the negative state of voxel row size.
    
    Parameters:
    bool - if true, row size will be set as negative; positive otherwise
  - setRowSize
```
public void setRowSize(double val)
```
    Sets the size of a voxel along the row dimension.
    
    Parameters:
    val - size of a voxel along the row dimension
  - setSliceNegativeState
```
public void setSliceNegativeState(boolean bool)
```
    Sets the negative state of voxel slice size.
    
    Parameters:
    bool - if true, slice size will be set as negative; positive otherwise
  - setSliceThickness
```
public void setSliceThickness(double val)
```
    Sets the size of a voxel along the slice dimension.
    
    Parameters:
    val - size of a voxel along the slice dimension
  - setSpatialUnit
```
public void setSpatialUnit(int unit)
```
    Sets the spatial unit of the voxel.
    
    Parameters:
    unit - spatial unit code
  - setSpatialUnit
```
public void setSpatialUnit(String unit)
```
    Sets the spatial unit of the voxel.
    
    Parameters:
    unit - spatial unit name
  - setTE1
```
public void setTE1(double num)
```
    Sets the TE1.
    
    Parameters:
    num - size of TE1
  - setTE2
```
public void setTE2(double num)
```
    Sets the TE2.
    
    Parameters:
    num - size of TE2
  - setTemporalUnit
```
public void setTemporalUnit(int unit)
```
    Sets the temporal unit of the voxel.
    
    Parameters:
    unit - temporal unit code
  - setTemporalUnit
```
public void setTemporalUnit(String unit)
```
    Sets the temporal unit of the voxel.
    
    Parameters:
    unit - temporal unit name
  - setTR
```
public void setTR(double num)
```
    Sets the TR.
    
    Parameters:
    num - size of TR
  - setValues
```
public void setValues(VoxelDimensions vd)
```
    Set the values of this VoxelDimensions to that of another.
    
    Parameters:
    vd - replacement VoxelDimensions object
  - setValues
```
public void setValues(VoxelDimensions vd,
             boolean updateXYZ)
```
    Set the values of this VoxelDimensions to that of another.
    
    Parameters:
    vd - replacement VoxelDimensions object
    updateXYZ - xyz values will be replaced, if true
  - setVariableSpacing
```
public void setVariableSpacing(float[] variableSpacing)
```
    Sets an array of variable slice spacings.
    
    Parameters:
    variableSpacing - the array
  - setVariableTiming
```
public void setVariableTiming(float[] variableTiming)
```
    Sets an array of variable volume durations.
    
    Parameters:
    variableTiming - the array
  - setXSize
```
public void setXSize(double num)
```
    Sets the size of a voxel along the X dimension.
    
    Parameters:
    num - size of voxel along the X dimension
  - setYSize
```
public void setYSize(double num)
```
    Sets the size of a voxel along the Y dimension.
    
    Parameters:
    num - size of voxel along the Y dimension
  - setZSize
```
public void setZSize(double num)
```
    Sets the size of a voxel along the Z dimension.
    
    Parameters:
    num - size of voxel along the 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
  - isFlip
```
public boolean isFlip()
```
  - setFlip
```
public void setFlip(boolean flip)
```

Class VoxelDimensions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIT_STRING

UNITS_HZ

UNITS_METER

UNITS_MICRON

UNITS_MM

UNITS_MSEC

UNITS_PPM

UNITS_RADS

UNITS_SEC

UNITS_UNKNOWN

UNITS_USEC

Constructor Detail

VoxelDimensions

Method Detail

clearNegativeVoxelSizes

clone

equals

equals

getAxialArea

getColSize

getCoronalArea

getRowSize

getSagittalArea

getSliceThickness

getSpatialUnit

getSpatialUnitMultiplier

getTE1

getTE2

getTemporalUnit

getTemporalUnitMultiplier

getTR

getVariableSpacing

getVariableTiming

getVolume

getXSize

getYSize

getZSize

hashCode

isValid

isValid

setColNegativeState

setColSize

setRowNegativeState

setRowSize

setSliceNegativeState

setSliceThickness

setSpatialUnit

setSpatialUnit

setTE1

setTE2

setTemporalUnit

setTemporalUnit

setTR

setValues

setValues

setVariableSpacing

setVariableTiming

setXSize

setYSize

setZSize

toString

isFlip

setFlip