java.lang.Object
- gov.nih.mipav.model.structures.ModelSerialCloneable
- - gov.nih.mipav.model.file.FileInfoBase
  - - gov.nih.mipav.model.file.FileInfoXML
    - - gov.nih.mipav.model.file.FileInfoSurfaceRefXML

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FileInfoSurfaceGiftiXML_WM, FileInfoSurfaceRefXML_J3D, FileInfoSurfaceRefXML_WM
```
public abstract class FileInfoSurfaceRefXML
extends FileInfoXML
```
This structure contains the information that describes how an XML surface (see surface.xsd and FileSurfaceXML.java) is stored on disk.

See Also:

FileIO, FileInfoXML, FileSurfaceXML, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class gov.nih.mipav.model.file.FileInfoBase
  FileInfoBase.AxisOrientation, FileInfoBase.ImageOrientation, FileInfoBase.Modality, FileInfoBase.Unit, FileInfoBase.UnitType

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`filename`	.sur file name.
`private int`	`m_iUnique_ID`	Unique ID, for the surface:.
`private int`	`m_kLevelDetail`	surface level of detail:.
`private float`	`m_kOpacity`	surface opacity:.
`private java.lang.String`	`m_kType`	Type keyword for the surface:.
`private static long`	`serialVersionUID`	Use serialVersionUID for interoperability.

Fields inherited from class gov.nih.mipav.model.file.FileInfoXML
imageDataFileName, imageDescription

Fields inherited from class gov.nih.mipav.model.file.FileInfoBase
ANGSTROMS, ANGSTROMS_STRING, AXIAL, axisOrientation, axisOrientationStr, BIOMAGNETIC_IMAGING, cameraMake, cameraModel, CENTIMETERS, CENTIMETERS_STRING, COLOR_FLOW_DOPPLER, COMPRESSION_BZIP2, COMPRESSION_GZIP, COMPRESSION_NONE, COMPRESSION_ZIP, COMPUTED_RADIOGRAPHY, COMPUTED_TOMOGRAPHY, conversionSpaceTimeUnits, CORONAL, DEGREES, DEGREES_STRING, DIAPHANOGRAPHY, DIGITAL_RADIOGRAPHY, DUPLEX_DOPPLER, ENDOSCOPY, exposureTime, EXTERNAL_CAMERA_PHOTOGRAPHY, FA, fileName, fileSuffix, FNumber, focalLength, focalLength35, GENERAL_MICROSCOPY, HARDCOPY, HOURS, HOURS_STRING, HZ, HZ_STRING, ICG, imageOrientation, INCHES, INCHES_STRING, INTRAORAL_RADIOGRAPHY, ISOSpeedRating, KILOMETERS, KILOMETERS_STRING, LASER_SURFACE_SCAN, MAGNETIC_RESONANCE, MAGNETIC_RESONANCE_ANGIOGRAPHY, MAGNETIC_RESONANCE_SPECTROSCOPY, MAMMOGRAPHY, METERS, METERS_STRING, MICROMETERS, MICROMETERS_STRING, MICROSEC, MICROSEC_STRING, MILES, MILES_STRING, MILLIMETERS, MILLIMETERS_STRING, MILLISEC, MILLISEC_STRING, MILS, MILS_STRING, MINUTES, MINUTES_STRING, modality, NANOMETERS, NANOMETERS_STRING, NANOSEC, NANOSEC_STRING, NUCLEAR_MEDICINE, ORI_A2P_TYPE, ORI_I2S_TYPE, ORI_L2R_TYPE, ORI_P2A_TYPE, ORI_R2L_TYPE, ORI_S2I_TYPE, ORI_UNKNOWN_TYPE, origin, OTHER, PANORAMIC_XRAY, POSITRON_EMISSION_TOMOGRAPHY, PPM, PPM_STRING, RADIO_FLUOROSCOPY, RADIOGRAPHIC_IMAGING, RADIOTHERAPY_DOSE, RADIOTHERAPY_IMAGE, RADIOTHERAPY_PLAN, RADIOTHERAPY_RECORD, RADIOTHERAPY_STRUCTURE_SET, RADS, RADS_STRING, RED_FREE, SAGITTAL, SECONDS, SECONDS_STRING, SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY, SLIDE_MICROSCOPY, sUnits, tagDescription, tagName, THERMOGRAPHY, TRANSFORM_ANOTHER_DATASET, TRANSFORM_MNI_152, TRANSFORM_SCANNER_ANATOMICAL, TRANSFORM_TALAIRACH_TOURNOUX, TRANSFORM_UNKNOWN, tUnits, ULTRASOUND, unitsOfMeasure, UNKNOWN_MEASURE, UNKNOWN_MODALITY, UNKNOWN_ORIENT, UNKNOWN_STRING, XRAY_ANGIOGRAPHY

Constructor Summary

Constructors
Constructor	Description
`FileInfoSurfaceRefXML(java.lang.String name, java.lang.String directory, int format)`	Main constructor for FileInfoSurfaceXML.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`displayAboutInfo(JDialogBase dlog, TransMatrix kMat)`	Displays the file information.
`void`	`finalize()`	Prepares the class for cleanup.
`int`	`getID()`	Returns the unique id for the surface:
`int`	`getLevelDetail()`	Returns the surface level of detail.
`float`	`getOpacity()`	Returns the surface opacity value.
`java.lang.String`	`getSurfaceFileName()`	Return .sur file reference name.
`java.lang.String`	`getType()`	Returns the surface type keyword:
`void`	`setID(int iID)`	Set the unique id for the surface:
`void`	`setLevelDetail(int levelDetail)`	set the surface level of detail keyword:
`void`	`setOpacity(float opacity)`	set the surface opacity keyword:
`void`	`setSurfaceFileName(java.lang.String name)`	Set the surface file name.
`void`	`setType(java.lang.String kType)`	set the surface type keyword:
`void`	`updateFileInfos(FileInfoXML fInfo)`	Used to propogate all FileInfoSurfaceRefXML private variables to other FileInfosSurfaceRefXML.

Methods inherited from class gov.nih.mipav.model.file.FileInfoXML
appendImageDescription, getImageDataFileName, getImageDescription, setImageDataFileName, setImageDescription

Methods inherited from class gov.nih.mipav.model.file.FileInfoBase
copyCoreInfo, copyCoreInfo, displayAboutInfo, displayPrimaryInfo, getAboutInfo, getAllSameDimUnits, getAreaUnitsOfMeasureStr, getAxisDirection, getAxisOrientation, getAxisOrientation, getAxisOrientationFromStr, getAxisOrientationStr, getCameraMake, getCameraModel, getCompressionType, getDataType, getDataTypeFromStr, getEndianess, getEndianessFromStr, getExposureTime, getExtents, getFileDirectory, getFileFormat, getFileName, getFileSuffix, getFNumber, getFocalLength, getFocalLength35, getImageOrientation, getImageOrientationFromStr, getImageOrientationStr, getIs2_5D, getISOSpeedRating, getLPSOrigin, getLUT, getMax, getMaxB, getMaxG, getMaxR, getMin, getMinB, getMinG, getMinR, getModality, getModalityFromStr, getModalityStr, getModalityStr, getMultiFile, getNumOfBytesPerPixel, getOffset, getOrigin, getOrigin, getOriginalEndianess, getOriginAtSlice, getPhotometric, getPixelPadValue, getPrimaryInfo, getRescaleIntercept, getRescaleSlope, getResolution, getResolutions, getSize, getSliceThickness, getUnitsOfMeasure, getUnitsOfMeasure, getUnitsOfMeasureAbbrevStr, getUnitsOfMeasureAbbrevStr, getUnitsOfMeasureFromStr, getUnitsOfMeasureStr, getUnitsOfMeasureStr, getVolumeUnitsOfMeasureStr, isDicomOrdered, oppositeOrient, sameAxis, setAxisOrientation, setAxisOrientation, setCameraMake, setCameraModel, setCompressionType, setDataType, setEndianess, setExposureTime, setExtents, setExtents, setFileDirectory, setFileFormat, setFileName, setFileSuffix, setFNumber, setFocalLength, setFocalLength35, setImageOrientation, setISOSpeedRating, setLUT, setMax, setMaxB, setMaxG, setMaxR, setMin, setMinB, setMinG, setMinR, setModality, setMultiFile, setOffset, setOrigin, setOrigin, setOriginalEndianess, setPhotometric, setPixelPadValue, setRescaleIntercept, setRescaleSlope, setResolutions, setResolutions, setSliceThickness, setTagDescription, setTagName, setUnitsOfMeasure, setUnitsOfMeasure, setUnitsOfMeasure, setUnitsOfMeasure, toString

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

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Use serialVersionUID for interoperability.
    
    See Also:
    
    Constant Field Values
  - m_iUnique_ID
```
private int m_iUnique_ID
```
    Unique ID, for the surface:.
  - filename
```
private java.lang.String filename
```
    .sur file name.
  - m_kType
```
private java.lang.String m_kType
```
    Type keyword for the surface:.
  - m_kOpacity
```
private float m_kOpacity
```
    surface opacity:.
  - m_kLevelDetail
```
private int m_kLevelDetail
```
    surface level of detail:.
- Constructor Detail
  - FileInfoSurfaceRefXML
```
public FileInfoSurfaceRefXML(java.lang.String name,
                             java.lang.String directory,
                             int format)
```
    Main constructor for FileInfoSurfaceXML.
    
    Parameters:
    
    name - String file name
    
    directory - String file directory
    
    format - int file format (data type)
- Method Detail
  - displayAboutInfo
```
public void displayAboutInfo(JDialogBase dlog,
                             TransMatrix kMat)
```
    Displays the file information.
    
    Specified by:
    
    displayAboutInfo in class FileInfoXML
    
    Parameters:
    
    dlog - JDialogBase dialog box that is written to
    
    kMat - DOCUMENT ME!
  - finalize
```
public void finalize()
```
    Prepares the class for cleanup.
    
    Overrides:
    
    finalize in class FileInfoXML
  - getID
```
public int getID()
```
    Returns the unique id for the surface:
    
    Returns:
    
    DOCUMENT ME!
  - getOpacity
```
public float getOpacity()
```
    Returns the surface opacity value.
    
    Returns:
    
    surface opacity.
  - getLevelDetail
```
public int getLevelDetail()
```
    Returns the surface level of detail.
    
    Returns:
    
    surface level of detail.
  - getType
```
public java.lang.String getType()
```
    Returns the surface type keyword:
    
    Returns:
    
    DOCUMENT ME!
  - getSurfaceFileName
```
public java.lang.String getSurfaceFileName()
```
    Return .sur file reference name.
    
    Returns:
    
    surface file name
  - setID
```
public void setID(int iID)
```
    Set the unique id for the surface:
    
    Parameters:
    
    iID - DOCUMENT ME!
  - setOpacity
```
public void setOpacity(float opacity)
```
    set the surface opacity keyword:
    
    Parameters:
    
    opacity - surface opacity
  - setLevelDetail
```
public void setLevelDetail(int levelDetail)
```
    set the surface level of detail keyword:
    
    Parameters:
    
    level - of detail
  - setType
```
public void setType(java.lang.String kType)
```
    set the surface type keyword:
    
    Parameters:
    
    kType - DOCUMENT ME!
  - setSurfaceFileName
```
public void setSurfaceFileName(java.lang.String name)
```
    Set the surface file name.
    
    Parameters:
    
    name - surface filename.
  - updateFileInfos
```
public void updateFileInfos(FileInfoXML fInfo)
```
    Used to propogate all FileInfoSurfaceRefXML private variables to other FileInfosSurfaceRefXML.
    
    Specified by:
    
    updateFileInfos in class FileInfoXML
    
    Parameters:
    
    fInfo - FileInfoSurfaceRefXML file info to be copied into

Class FileInfoSurfaceRefXML

Nested Class Summary

Nested classes/interfaces inherited from class gov.nih.mipav.model.file.FileInfoBase

Field Summary

Fields inherited from class gov.nih.mipav.model.file.FileInfoXML

Fields inherited from class gov.nih.mipav.model.file.FileInfoBase

Constructor Summary

Method Summary

Methods inherited from class gov.nih.mipav.model.file.FileInfoXML

Methods inherited from class gov.nih.mipav.model.file.FileInfoBase

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

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

m_iUnique_ID

filename

m_kType

m_kOpacity

m_kLevelDetail

Constructor Detail

FileInfoSurfaceRefXML

Method Detail

displayAboutInfo

finalize

getID

getOpacity

getLevelDetail

getType

getSurfaceFileName

setID

setOpacity

setLevelDetail

setType

setSurfaceFileName

updateFileInfos