FileMap (MIPAV API Documentation)

java.lang.Object
- gov.nih.mipav.model.file.FileBase
- - gov.nih.mipav.model.file.FileMap

```
public class FileMap
extends FileBase
```
Special for Benes.

Version:

0.1 Sept 2, 1997

Author:

Matthew J. McAuliffe, Ph.D.

Field Summary

Fields
Modifier and Type Field Description

private java.io.File file
DOCUMENT ME!

private FileInfoBase fileInfo
DOCUMENT ME!
- Fields inherited from class gov.nih.mipav.model.file.FileBase
  BIG_ENDIAN, bitsPerPixel, fileNames, LITTLE_ENDIAN, pBarVisible, raFile, READ, READ_WRITE

Constructor Summary

Constructors
Constructor Description

FileMap(java.lang.String fileName, java.lang.String fileDir, FileInfoBase fInfo, int rwFlag)
Creates a new FileMap object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`parseBuffer(short[] buffer, ModelImage image)`	parseImage 03 00 or 00 03 is the delimiter.
`void`	`readImage(ModelImage image, int offset)`	readImage - This method reads a raw chunk from a file.

Methods inherited from class gov.nih.mipav.model.file.FileBase
addProgressChangeListener, bytesToDouble, bytesToFloat, bytesToInt, bytesToShort, doubleToBytes, finalize, fireProgressStateChanged, fireProgressStateChanged, fireProgressStateChanged, floatToBytes, getBufferDouble, getBufferFloat, getBufferInt, getBufferLong, getBufferShort, getBufferUShort, getDataType, getDouble, getFloat, getInt, getLong, getProgressChangeListeners, getRaFile, getSignedShort, getString, getUInt, getUnsignedByte, getUnsignedShort, intToBytes, isBigEndian, isProgressBarVisible, linkProgress, longToBytes, readDouble, readFloat, readInt, readLong, readShort, readString, readUnsignedShort, removeProgressChangeListener, setBigEndian, setBufferFloat, setBufferInt, setBufferLong, setBufferShort, setBufferString, setDataType, setEndianess, shortToBytes, writeBytes, writeDouble, writeFloat, writeInt, writeLong, writeShort

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

- Field Detail
  - file
```
private java.io.File file
```
    DOCUMENT ME!
  - fileInfo
```
private FileInfoBase fileInfo
```
    DOCUMENT ME!
- Constructor Detail
  - FileMap
```
public FileMap(java.lang.String fileName,
               java.lang.String fileDir,
               FileInfoBase fInfo,
               int rwFlag)
        throws java.io.IOException
```
    Creates a new FileMap object.
    
    Parameters:
    
    fileName - DOCUMENT ME!
    
    fileDir - DOCUMENT ME!
    
    fInfo - DOCUMENT ME!
    
    rwFlag - DOCUMENT ME!
    
    Throws:
    
    java.io.IOException - DOCUMENT ME!
- Method Detail
  - readImage
```
public void readImage(ModelImage image,
                      int offset)
               throws java.io.IOException
```
    readImage - This method reads a raw chunk from a file.
    
    Parameters:
    
    image - the ModelImage to read the image file into
    
    offset - the offset into the image file (from the end of the file)
    
    Throws:
    
    java.io.IOException - if there is an error reading the file
  - parseBuffer
```
private void parseBuffer(short[] buffer,
                         ModelImage image)
```
    parseImage 03 00 or 00 03 is the delimiter.
    
    Parameters:
    
    buffer - DOCUMENT ME!
    
    image - DOCUMENT ME!