FileInfo (ImageJ 1.53b API)

java.lang.Object
- ij.io.FileInfo

All Implemented Interfaces:

Cloneable
```
public class FileInfo
extends Object
implements Cloneable
```
This class consists of public fields that describe an image file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABGR` 32-bit interleaved ABGR.
`static int`	`ARGB` 32-bit interleaved ARGB.
`static int`	`BARG` 32-bit interleaved BARG (MCID).
`static int`	`BGR` 24-bit interleaved BGR.
`static int`	`BITMAP` 1-bit black and white.
`byte[]`	`blues`
`static int`	`BMP`
`int`	`calibrationFunction`
`byte[][]`	`channelLuts`
`static int`	`CMYK` 32-bit interleaved CMYK.
`double[]`	`coefficients`
`static int`	`COLOR8` 8-bit unsigned integer with color lookup table.
`int`	`compression`
`static int`	`COMPRESSION_NONE`
`static int`	`COMPRESSION_UNKNOWN`
`String`	`debugInfo`
`String`	`description`
`static int`	`DICOM`
`String`	`directory`
`double[]`	`displayRanges`
`int`	`fileFormat`
`String`	`fileName`
`int`	`fileType`
`static int`	`FITS`
`double`	`frameInterval`
`int`	`gapBetweenImages`
`static int`	`GIF_OR_JPG`
`static int`	`GRAY12_UNSIGNED` 12-bit unsigned integer (0-4095).
`static int`	`GRAY16_SIGNED` 16-bit signed integer (-32768-32767).
`static int`	`GRAY16_UNSIGNED` 16-bit unsigned integer (0-65535).
`static int`	`GRAY24_UNSIGNED` 24-bit unsigned integer.
`static int`	`GRAY32_FLOAT` 32-bit floating-point.
`static int`	`GRAY32_INT` 32-bit signed integer.
`static int`	`GRAY32_UNSIGNED` 32-bit unsigned integer.
`static int`	`GRAY64_FLOAT` 64-bit floating-point.
`static int`	`GRAY8` 8-bit unsigned integer (0-255).
`byte[]`	`greens`
`int`	`height`
`static int`	`IMAGEIO`
`String`	`info`
`InputStream`	`inputStream`
`boolean`	`intelByteOrder`
`static int`	`JPEG`
`long`	`longGap`
`long`	`longOffset`
`int`	`lutSize`
`static int`	`LZW`
`static int`	`LZW_WITH_DIFFERENCING`
`byte[][]`	`metaData`
`int[]`	`metaDataTypes`
`int`	`nImages`
`int`	`offset`
`String`	`openNextDir`
`String`	`openNextName`
`byte[][]`	`overlay`
`static int`	`PACK_BITS`
`static int`	`PGM`
`double`	`pixelDepth`
`double`	`pixelHeight`
`Object`	`pixels`
`double`	`pixelWidth`
`byte[]`	`plot`
`String[]`	`properties`
`static int`	`RAW`
`byte[]`	`reds`
`static int`	`RGB` 24-bit interleaved RGB.
`static int`	`RGB_PLANAR` 24-bit planer RGB.
`static int`	`RGB48` 48-bit interleaved RGB.
`static int`	`RGB48_PLANAR` 48-bit planar RGB.
`byte[]`	`roi`
`int`	`rowsPerStrip`
`int`	`samplesPerPixel`
`String[]`	`sliceLabels`
`int`	`sliceNumber`
`int[]`	`stripLengths`
`int[]`	`stripOffsets`
`static int`	`TIFF`
`String`	`unit`
`static int`	`UNKNOWN`
`String`	`url`
`String`	`valueUnit`
`VirtualStack`	`virtualStack`
`boolean`	`whiteIsZero`
`int`	`width`
`static int`	`ZIP`
`static int`	`ZIP_ARCHIVE`

Constructor Summary

Constructors
Constructor and Description

FileInfo()
Creates a FileInfo object with all of its fields set to their default value.

Constructors
Constructor and Description
`FileInfo()` Creates a FileInfo object with all of its fields set to their default value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`int`	`getBytesPerPixel()` Returns the number of bytes used per pixel.
`String`	`getCode()` Returns JavaScript code that can be used to recreate this FileInfo.
`String`	`getFilePath()` Returns the file path.
`long`	`getGap()` Returns the gap between images as a long.
`long`	`getOffset()` Returns the offset as a long.
`String`	`toString()`

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

- Field Detail
  - GRAY8
```
public static final int GRAY8
```
    8-bit unsigned integer (0-255).
    
    See Also:
    
    Constant Field Values
  - GRAY16_SIGNED
```
public static final int GRAY16_SIGNED
```
    16-bit signed integer (-32768-32767). Imported signed images are converted to unsigned by adding 32768.
    
    See Also:
    
    Constant Field Values
  - GRAY16_UNSIGNED
```
public static final int GRAY16_UNSIGNED
```
    16-bit unsigned integer (0-65535).
    
    See Also:
    
    Constant Field Values
  - GRAY32_INT
```
public static final int GRAY32_INT
```
    32-bit signed integer. Imported 32-bit integer images are converted to floating-point.
    
    See Also:
    
    Constant Field Values
  - GRAY32_FLOAT
```
public static final int GRAY32_FLOAT
```
    32-bit floating-point.
    
    See Also:
    
    Constant Field Values
  - COLOR8
```
public static final int COLOR8
```
    8-bit unsigned integer with color lookup table.
    
    See Also:
    
    Constant Field Values
  - RGB
```
public static final int RGB
```
    24-bit interleaved RGB. Import/export only.
    
    See Also:
    
    Constant Field Values
  - RGB_PLANAR
```
public static final int RGB_PLANAR
```
    24-bit planer RGB. Import only.
    
    See Also:
    
    Constant Field Values
  - BITMAP
```
public static final int BITMAP
```
    1-bit black and white. Import only.
    
    See Also:
    
    Constant Field Values
  - ARGB
```
public static final int ARGB
```
    32-bit interleaved ARGB. Import only.
    
    See Also:
    
    Constant Field Values
  - BGR
```
public static final int BGR
```
    24-bit interleaved BGR. Import only.
    
    See Also:
    
    Constant Field Values
  - GRAY32_UNSIGNED
```
public static final int GRAY32_UNSIGNED
```
    32-bit unsigned integer. Imported 32-bit integer images are converted to floating-point.
    
    See Also:
    
    Constant Field Values
  - RGB48
```
public static final int RGB48
```
    48-bit interleaved RGB.
    
    See Also:
    
    Constant Field Values
  - GRAY12_UNSIGNED
```
public static final int GRAY12_UNSIGNED
```
    12-bit unsigned integer (0-4095). Import only.
    
    See Also:
    
    Constant Field Values
  - GRAY24_UNSIGNED
```
public static final int GRAY24_UNSIGNED
```
    24-bit unsigned integer. Import only.
    
    See Also:
    
    Constant Field Values
  - BARG
```
public static final int BARG
```
    32-bit interleaved BARG (MCID). Import only.
    
    See Also:
    
    Constant Field Values
  - GRAY64_FLOAT
```
public static final int GRAY64_FLOAT
```
    64-bit floating-point. Import only.
    
    See Also:
    
    Constant Field Values
  - RGB48_PLANAR
```
public static final int RGB48_PLANAR
```
    48-bit planar RGB. Import only.
    
    See Also:
    
    Constant Field Values
  - ABGR
```
public static final int ABGR
```
    32-bit interleaved ABGR. Import only.
    
    See Also:
    
    Constant Field Values
  - CMYK
```
public static final int CMYK
```
    32-bit interleaved CMYK. Import only.
    
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final int UNKNOWN
```
    See Also:
    
    Constant Field Values
  - RAW
```
public static final int RAW
```
    See Also:
    
    Constant Field Values
  - TIFF
```
public static final int TIFF
```
    See Also:
    
    Constant Field Values
  - GIF_OR_JPG
```
public static final int GIF_OR_JPG
```
    See Also:
    
    Constant Field Values
  - FITS
```
public static final int FITS
```
    See Also:
    
    Constant Field Values
  - BMP
```
public static final int BMP
```
    See Also:
    
    Constant Field Values
  - DICOM
```
public static final int DICOM
```
    See Also:
    
    Constant Field Values
  - ZIP_ARCHIVE
```
public static final int ZIP_ARCHIVE
```
    See Also:
    
    Constant Field Values
  - PGM
```
public static final int PGM
```
    See Also:
    
    Constant Field Values
  - IMAGEIO
```
public static final int IMAGEIO
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_UNKNOWN
```
public static final int COMPRESSION_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_NONE
```
public static final int COMPRESSION_NONE
```
    See Also:
    
    Constant Field Values
  - LZW
```
public static final int LZW
```
    See Also:
    
    Constant Field Values
  - LZW_WITH_DIFFERENCING
```
public static final int LZW_WITH_DIFFERENCING
```
    See Also:
    
    Constant Field Values
  - JPEG
```
public static final int JPEG
```
    See Also:
    
    Constant Field Values
  - PACK_BITS
```
public static final int PACK_BITS
```
    See Also:
    
    Constant Field Values
  - ZIP
```
public static final int ZIP
```
    See Also:
    
    Constant Field Values
  - fileFormat
```
public int fileFormat
```
  - fileType
```
public int fileType
```
  - fileName
```
public String fileName
```
  - directory
```
public String directory
```
  - url
```
public String url
```
  - width
```
public int width
```
  - height
```
public int height
```
  - offset
```
public int offset
```
  - nImages
```
public int nImages
```
  - gapBetweenImages
```
public int gapBetweenImages
```
  - whiteIsZero
```
public boolean whiteIsZero
```
  - intelByteOrder
```
public boolean intelByteOrder
```
  - compression
```
public int compression
```
  - stripOffsets
```
public int[] stripOffsets
```
  - stripLengths
```
public int[] stripLengths
```
  - rowsPerStrip
```
public int rowsPerStrip
```
  - lutSize
```
public int lutSize
```
  - reds
```
public byte[] reds
```
  - greens
```
public byte[] greens
```
  - blues
```
public byte[] blues
```
  - pixels
```
public Object pixels
```
  - debugInfo
```
public String debugInfo
```
  - sliceLabels
```
public String[] sliceLabels
```
  - info
```
public String info
```
  - inputStream
```
public InputStream inputStream
```
  - virtualStack
```
public VirtualStack virtualStack
```
  - sliceNumber
```
public int sliceNumber
```
  - pixelWidth
```
public double pixelWidth
```
  - pixelHeight
```
public double pixelHeight
```
  - pixelDepth
```
public double pixelDepth
```
  - unit
```
public String unit
```
  - calibrationFunction
```
public int calibrationFunction
```
  - coefficients
```
public double[] coefficients
```
  - valueUnit
```
public String valueUnit
```
  - frameInterval
```
public double frameInterval
```
  - description
```
public String description
```
  - longOffset
```
public long longOffset
```
  - longGap
```
public long longGap
```
  - metaDataTypes
```
public int[] metaDataTypes
```
  - metaData
```
public byte[][] metaData
```
  - displayRanges
```
public double[] displayRanges
```
  - channelLuts
```
public byte[][] channelLuts
```
  - plot
```
public byte[] plot
```
  - roi
```
public byte[] roi
```
  - overlay
```
public byte[][] overlay
```
  - samplesPerPixel
```
public int samplesPerPixel
```
  - openNextDir
```
public String openNextDir
```
  - openNextName
```
public String openNextName
```
  - properties
```
public String[] properties
```
- Constructor Detail
  - FileInfo
```
public FileInfo()
```
    Creates a FileInfo object with all of its fields set to their default value.
- Method Detail
  - getFilePath
```
public String getFilePath()
```
    Returns the file path.
  - getOffset
```
public final long getOffset()
```
    Returns the offset as a long.
  - getGap
```
public final long getGap()
```
    Returns the gap between images as a long.
  - getBytesPerPixel
```
public int getBytesPerPixel()
```
    Returns the number of bytes used per pixel.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getCode
```
public String getCode()
```
    Returns JavaScript code that can be used to recreate this FileInfo.
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object

Class FileInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GRAY8

GRAY16_SIGNED

GRAY16_UNSIGNED

GRAY32_INT

GRAY32_FLOAT

COLOR8

RGB

RGB_PLANAR

BITMAP

ARGB

BGR

GRAY32_UNSIGNED

RGB48

GRAY12_UNSIGNED

GRAY24_UNSIGNED

BARG

GRAY64_FLOAT

RGB48_PLANAR

ABGR

CMYK

UNKNOWN

RAW

TIFF

GIF_OR_JPG

FITS

BMP

DICOM

ZIP_ARCHIVE

PGM

IMAGEIO

COMPRESSION_UNKNOWN

COMPRESSION_NONE

LZW

LZW_WITH_DIFFERENCING

JPEG

PACK_BITS

ZIP

fileFormat

fileType

fileName

directory

url

width

height

offset

nImages

gapBetweenImages

whiteIsZero

intelByteOrder

compression

stripOffsets

stripLengths

rowsPerStrip

lutSize

reds

greens

blues

pixels

debugInfo

sliceLabels

info

inputStream

virtualStack

sliceNumber

pixelWidth

pixelHeight

pixelDepth

unit

calibrationFunction

coefficients

valueUnit

frameInterval

description

longOffset