FileMincDimElem (MIPAV API Documentation)

java.lang.Object
- gov.nih.mipav.model.structures.ModelSerialCloneable
- - gov.nih.mipav.model.file.FileMincDimElem

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class FileMincDimElem
extends ModelSerialCloneable
```
This class represents a MINC dimension element. As far as I can tell, MINC dimension elements are always descriptors of the three dimensions of the image file. Thus they contain a name and a length; the name is "xspace", "yspace", or "zspace", and the length is the size of that dimension. So an axial image that was 256x256 and had 34 slices would have "xspace" with length 256, "yspace" with length 256, and "zspace" with length 34. On the other hand, a coronal image with the same dimensions would have "xspace" with length 256, "yspace" with length 34, and "zspace" with length 256. This is because MINC always refers to the patient when assigning these dimension variables.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

int length
DOCUMENT ME!

java.lang.String name
DOCUMENT ME!

private static long serialVersionUID
Use serialVersionUID for interoperability.

Constructor Summary

Constructors
Constructor Description

FileMincDimElem(java.lang.String name, int length)
Constructor that creates a MINC dimension element with the given name and length.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`clone()`	Returns a new MincDimElem with the same values as this one.
`java.lang.String`	`toString()`	Creates a readable version of this element; used in displayAboutInfo.

Methods inherited from class gov.nih.mipav.model.structures.ModelSerialCloneable
nativeClone

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Use serialVersionUID for interoperability.
    
    See Also:
    
    Constant Field Values
  - length
```
public int length
```
    DOCUMENT ME!
  - name
```
public java.lang.String name
```
    DOCUMENT ME!
- Constructor Detail
  - FileMincDimElem
```
public FileMincDimElem(java.lang.String name,
                       int length)
```
    Constructor that creates a MINC dimension element with the given name and length.
    
    Parameters:
    
    name - Name of this dimension element (usually xspace, yspace, or zspace).
    
    length - Size of the dimension.
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Returns a new MincDimElem with the same values as this one.
    
    Overrides:
    
    clone in class ModelSerialCloneable
    
    Returns:
    
    The new MincDimElem element.
  - toString
```
public java.lang.String toString()
```
    Creates a readable version of this element; used in displayAboutInfo.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string listing the name and length of this dimension element.