loci.formats.in
Class BMPReader

java.lang.Object
  loci.formats.FormatHandler
      loci.formats.FormatReader
          loci.formats.in.BMPReader

All Implemented Interfaces:

loci.formats.IFormatHandler, loci.formats.IFormatReader, loci.formats.StatusReporter

public class BMPReader
extends loci.formats.FormatReader

BMPReader is the file format reader for Microsoft Bitmap (BMP) files. See http://astronomy.swin.edu.au/~pbourke/dataformats/bmp/ for a nice description of the BMP file format.

Source code:

Trac, SVN

Author:

Melissa Linkert linkert at wisc.edu

Field Summary

protected int	bpp Number of bits per pixel.
protected int	compression Compression type: 0 = no compression, 1 = 8 bit run length encoding, 2 = 4 bit run length encoding, 3 = RGB bitmap with mask.
protected int	offset Offset to the image data.
protected byte[][]	palette The palette for indexed color images.

Fields inherited from class loci.formats.FormatReader

collectMetadata, core, filterMetadata, group, in, metadata, metadataStore, normalizeData, saveOriginalMetadata, series, THUMBNAIL_DIMENSION

Fields inherited from class loci.formats.FormatHandler

currentId, debug, debugLevel, format, statusListeners, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

BMPReader()
Constructs a new BMP reader.

Method Summary

byte[][]	get8BitLookupTable()
protected void	initFile(String id)
boolean	isThisType(byte[] block)
byte[]	openBytes(int no, byte[] buf)

Methods inherited from class loci.formats.FormatReader

addMeta, checkBytes, close, close, fileGroupOption, get16BitLookupTable, getChannelDimLengths, getChannelDimLengths, getChannelDimTypes, getChannelDimTypes, getCoreMetadata, getCoreMetadata, getCurrentFile, getDimensionOrder, getDimensionOrder, getEffectiveSizeC, getEffectiveSizeC, getImageCount, getImageCount, getIndex, getIndex, getMeta, getMetadata, getMetadata, getMetadataStore, getMetadataStore, getMetadataStoreRoot, getMetadataStoreRoot, getMetadataValue, getMetadataValue, getPixelType, getPixelType, getRGBChannelCount, getRGBChannelCount, getSeries, getSeries, getSeriesCount, getSeriesCount, getSizeC, getSizeC, getSizeT, getSizeT, getSizeX, getSizeX, getSizeY, getSizeY, getSizeZ, getSizeZ, getThumbSizeX, getThumbSizeX, getThumbSizeY, getThumbSizeY, getUsedFiles, getUsedFiles, getZCTCoords, getZCTCoords, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isInterleaved, isInterleaved, isLittleEndian, isLittleEndian, isMetadataCollected, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOrderCertain, isOriginalMetadataPopulated, isRGB, isRGB, isUsedFile, openBytes, openBytes, openBytes, openImage, openImage, openThumbBytes, openThumbBytes, openThumbImage, openThumbImage, setGroupFiles, setId, setMetadataCollected, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setSeries, setSeries

Methods inherited from class loci.formats.FormatHandler

addStatusListener, debug, getFormat, getStatusListeners, getSuffixes, isThisType, isThisType, removeStatusListener, setDebug, setDebugLevel, setId, status, status, status, trace, trace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getSuffixes, isThisType, isThisType, setId

Methods inherited from interface loci.formats.StatusReporter

addStatusListener, getStatusListeners, removeStatusListener

Field Detail

offset

protected int offset

Offset to the image data.

bpp

protected int bpp

Number of bits per pixel.

palette

protected byte[][] palette

The palette for indexed color images.

compression

protected int compression

Compression type: 0 = no compression, 1 = 8 bit run length encoding, 2 = 4 bit run length encoding, 3 = RGB bitmap with mask.

Constructor Detail

BMPReader

public BMPReader()

Constructs a new BMP reader.

Method Detail

isThisType

public boolean isThisType(byte[] block)

get8BitLookupTable

public byte[][] get8BitLookupTable()
                            throws loci.formats.FormatException,
                                   IOException

Specified by:

get8BitLookupTable in interface loci.formats.IFormatReader

Overrides:

get8BitLookupTable in class loci.formats.FormatReader

Throws:

loci.formats.FormatException

IOException

openBytes

public byte[] openBytes(int no,
                        byte[] buf)
                 throws loci.formats.FormatException,
                        IOException

Throws:

loci.formats.FormatException

IOException

initFile

protected void initFile(String id)
                 throws loci.formats.FormatException,
                        IOException

Overrides:

initFile in class loci.formats.FormatReader

Throws:

loci.formats.FormatException

IOException