org.apache.pdfbox.jbig2.segments

Class HalftoneRegion

java.lang.Object

org.apache.pdfbox.jbig2.segments.HalftoneRegion

All Implemented Interfaces:

Region, SegmentData

public class HalftoneRegion
extends Object
implements Region

This class represents the data of segment type "Halftone region". Parsing is described in 7.4.5, page 67. Decoding procedure in 6.6.5 and 7.4.5.2.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CombinationOperator	getCombinationOperator()
protected byte	getHDefaultPixel()
protected int	getHGridHeight()
protected int	getHGridWidth()
protected int	getHGridX()
protected int	getHGridY()
protected int	getHRegionX()
protected int	getHRegionY()
protected byte	getHTemplate()
Bitmap	getRegionBitmap() The procedure is described in JBIG2 ISO standard, 6.6.5.
RegionSegmentInformation	getRegionInfo() Simply returns the RegionSegmentInformation.
void	init(SegmentHeader header, SubInputStream sis) Parse the stream and read information of header.
protected boolean	isHSkipEnabled()
protected boolean	isMMREncoded()

Methods inherited from class java.lang.Object

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

Constructor Detail

HalftoneRegion

public HalftoneRegion()

HalftoneRegion

public HalftoneRegion(SubInputStream subInputStream)

HalftoneRegion

public HalftoneRegion(SubInputStream subInputStream,
                      SegmentHeader segmentHeader)

Method Detail

getRegionBitmap

public Bitmap getRegionBitmap()
                       throws IOException,
                              InvalidHeaderValueException

The procedure is described in JBIG2 ISO standard, 6.6.5.

Specified by:

getRegionBitmap in interface Region

Returns:

The decoded Bitmap of this region.

Throws:

IOException - if an underlying IO operation fails

InvalidHeaderValueException - if a segment header value is invalid

init

public void init(SegmentHeader header,
                 SubInputStream sis)
          throws InvalidHeaderValueException,
                 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:

InvalidHeaderValueException - if the segment header value is invalid

IOException - if an underlying IO operation fails

getCombinationOperator

public CombinationOperator getCombinationOperator()

getRegionInfo

public RegionSegmentInformation getRegionInfo()

Description copied from interface: Region

Simply returns the RegionSegmentInformation.

Specified by:

getRegionInfo in interface Region

Returns:

The RegionSegmentInformation.

getHTemplate

protected byte getHTemplate()

isHSkipEnabled

protected boolean isHSkipEnabled()

isMMREncoded

protected boolean isMMREncoded()

getHGridWidth

protected int getHGridWidth()

getHGridHeight

protected int getHGridHeight()

getHGridX

protected int getHGridX()

getHGridY

protected int getHGridY()

getHRegionX

protected int getHRegionX()

getHRegionY

protected int getHRegionY()

getHDefaultPixel

protected byte getHDefaultPixel()