colorspace.boxes

Class PaletteBox

java.lang.Object

colorspace.boxes.JP2Box

colorspace.boxes.PaletteBox

public final class PaletteBox
extends JP2Box

This class models the palette box contained in a JP2 image.

Version:

1.0

Author:

Bruce A. Kern

Nested Class Summary

Nested classes/interfaces inherited from class colorspace.boxes.JP2Box

JP2Box.BoxType

Field Summary

Fields inherited from class colorspace.boxes.JP2Box

boxEnd, boxStart, dataStart, eol, in, length, type

Constructor Summary

Constructors

Constructor and Description
PaletteBox(RandomAccessIO in, int boxStart) Construct a PaletteBox from an input image.

Method Summary

Methods

Modifier and Type	Method and Description
short	getBitDepth(int column) Return the bitdepth of palette entries.
int	getEntry(int column, int entry) Return an entry for a given index and column.
int	getNumColumns() Return the number of palette columns.
int	getNumEntries() Return the number of palette entries.
boolean	isSigned(int column) Are entries signed predicate.
boolean	isUnSigned(int column) Are entries unsigned predicate.
String	toString() Return a suitable String representation of the class instance.

Methods inherited from class colorspace.boxes.JP2Box

getTypeString, getTypeString

Methods inherited from class java.lang.Object

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

Constructor Detail

PaletteBox

public PaletteBox(RandomAccessIO in,
          int boxStart)
           throws IOException,
                  ColorSpaceException

Construct a PaletteBox from an input image.

Parameters:

in - RandomAccessIO jp2 image

boxStart - offset to the start of the box in the image

Throws:

IOException, - ColorSpaceException

IOException

ColorSpaceException

Method Detail

getNumEntries

public int getNumEntries()

Return the number of palette entries.

getNumColumns

public int getNumColumns()

Return the number of palette columns.

isSigned

public boolean isSigned(int column)

Are entries signed predicate.

isUnSigned

public boolean isUnSigned(int column)

Are entries unsigned predicate.

getBitDepth

public short getBitDepth(int column)

Return the bitdepth of palette entries.

getEntry

public int getEntry(int column,
           int entry)

Return an entry for a given index and column.

toString

public String toString()

Return a suitable String representation of the class instance.

Overrides:

toString in class Object