org.apache.pdfbox.jbig2.segments

Class GenericRefinementRegion

java.lang.Object

org.apache.pdfbox.jbig2.segments.GenericRefinementRegion

All Implemented Interfaces:

Region, SegmentData

public class GenericRefinementRegion
extends Object
implements Region

This class represents a generic refinement region and implements the procedure described in JBIG2 ISO standard, 6.3 and 7.4.7.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericRefinementRegion.Template

Constructor Summary

Constructors

Constructor and Description
GenericRefinementRegion()
GenericRefinementRegion(SubInputStream subInputStream)
GenericRefinementRegion(SubInputStream subInputStream, SegmentHeader segmentHeader)

Method Summary

Modifier and Type	Method and Description
Bitmap	getRegionBitmap() Decode using a template and arithmetic coding, as described in 6.3.5.6
RegionSegmentInformation	getRegionInfo() Simply returns the RegionSegmentInformation.
void	init(SegmentHeader header, SubInputStream sis) Parse the stream and read information of header.
protected void	setParameters(CX cx, ArithmeticDecoder arithmeticDecoder, short grTemplate, int regionWidth, int regionHeight, Bitmap grReference, int grReferenceDX, int grReferenceDY, boolean isTPGRon, short[] grAtX, short[] grAtY)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericRefinementRegion

public GenericRefinementRegion()

GenericRefinementRegion

public GenericRefinementRegion(SubInputStream subInputStream)

GenericRefinementRegion

public GenericRefinementRegion(SubInputStream subInputStream,
                               SegmentHeader segmentHeader)

Method Detail

getRegionBitmap

public Bitmap getRegionBitmap()
                       throws IOException,
                              IntegerMaxValueException,
                              InvalidHeaderValueException

Decode using a template and arithmetic coding, as described in 6.3.5.6

Specified by:

getRegionBitmap in interface Region

Returns:

The decoded region as Bitmap.

Throws:

IOException - if an underlying IO operation fails

InvalidHeaderValueException - if a segment header value is invalid

IntegerMaxValueException - if the maximum value limit of an integer is exceeded

init

public void init(SegmentHeader header,
                 SubInputStream sis)
          throws IOException

Description copied from interface: SegmentData

Parse the stream and read information of header.

Specified by:

init in interface SegmentData

Parameters:

header - - The segments' header (to make referred-to segments available in data part).

sis - - Wrapped ImageInputStream into SubInputStream.

Throws:

IOException - if an underlying IO operation fails

setParameters

protected void setParameters(CX cx,
                             ArithmeticDecoder arithmeticDecoder,
                             short grTemplate,
                             int regionWidth,
                             int regionHeight,
                             Bitmap grReference,
                             int grReferenceDX,
                             int grReferenceDY,
                             boolean isTPGRon,
                             short[] grAtX,
                             short[] grAtY)

getRegionInfo

public RegionSegmentInformation getRegionInfo()

Description copied from interface: Region

Simply returns the RegionSegmentInformation.

Specified by:

getRegionInfo in interface Region

Returns:

The RegionSegmentInformation.