Apache PDFBox 3.0.4 · org.apache.pdfbox.jbig2.segments.HalftoneRegion

Field Summary

Modifier and Type	Field and Description
private long	dataHeaderLength
private long	dataHeaderOffset
private long	dataLength
private long	dataOffset
private Bitmap	halftoneRegionBitmap Decoded data
private CombinationOperator	hCombinationOperator
private byte	hDefaultPixel Halftone segment information field, 7.4.5.1.1
private int	hGridHeight Height of the gray-scale image, 7.4.5.1.2.2
private int	hGridWidth Width of the gray-scale image, 7.4.5.1.2.1
private int	hGridX Horizontal offset of the grid, 7.4.5.1.2.3
private int	hGridY Vertical offset of the grid, 7.4.5.1.2.4
private int	hRegionX Horizontal coordinate of the halftone grid vector, 7.4.5.1.3.1
private int	hRegionY Vertical coordinate of the halftone grod vector, 7.4.5.1.3.2
private boolean	hSkipEnabled
private byte	hTemplate
private boolean	isMMREncoded
private ArrayList<Bitmap>	patterns Previously decoded data from other regions or dictionaries, stored to use as patterns in this region.
private RegionSegmentInformation	regionInfo Region segment information field, 7.4.1
private SegmentHeader	segmentHeader
private SubInputStream	subInputStream

Constructor Summary

Access	Constructor and Description
public	HalftoneRegion()
public	HalftoneRegion(final SubInputStream subInputStream)
public	HalftoneRegion(final SubInputStream subInputStream, final SegmentHeader segmentHeader)

Method Summary

Modifier and Type	Method and Description
private Bitmap[]	combineGrayScalePlanes(Bitmap[] grayScalePlanes, int j)
private int[][]	computeGrayScaleValues(final Bitmap[] grayScalePlanes, final int bitsPerValue)
private void	computeSegmentDataStructure()
private int	computeX(final int m, final int n)
private int	computeY(final int m, final int n)
public 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()
private ArrayList<Bitmap>	getPatterns()
public Bitmap	Returns: The decoded `Bitmap` of this region. getRegionBitmap() Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap. The procedure is described in JBIG2 ISO standard, 6.6.5.
public RegionSegmentInformation	getRegionInfo() Implements org.apache.pdfbox.jbig2.Region.getRegionInfo. Simply returns the `RegionSegmentInformation`.
private int[][]	grayScaleDecoding(final int bitsPerValue) Gray-scale image decoding procedure is special for halftone region decoding and is described in Annex C.5 on page 98.
public void	init(final SegmentHeader - The segments' header (to make referred-to segments available in data part). header, final SubInputStream - Wrapped `ImageInputStream` into `SubInputStream`. sis) Implements org.apache.pdfbox.jbig2.SegmentData.init. Parse the stream and read information of header.
protected boolean	isHSkipEnabled()
protected boolean	isMMREncoded()
private void	parseHeader()
private void	renderPattern(final int[][] grayScaleValues) This method draws the pattern into the region bitmap (`htReg`), as described in 6.6.5.2, page 42
private int	shiftAndFill(int value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dataHeaderLength	back to summary
private long dataHeaderLength

dataHeaderOffset	back to summary
private long dataHeaderOffset

dataLength	back to summary
private long dataLength

dataOffset	back to summary
private long dataOffset

halftoneRegionBitmap	back to summary
private Bitmap halftoneRegionBitmap Decoded data

hCombinationOperator	back to summary
private CombinationOperator hCombinationOperator

hDefaultPixel	back to summary
private byte hDefaultPixel Halftone segment information field, 7.4.5.1.1

hGridHeight	back to summary
private int hGridHeight Height of the gray-scale image, 7.4.5.1.2.2

hGridWidth	back to summary
private int hGridWidth Width of the gray-scale image, 7.4.5.1.2.1

hGridX	back to summary
private int hGridX Horizontal offset of the grid, 7.4.5.1.2.3

hGridY	back to summary
private int hGridY Vertical offset of the grid, 7.4.5.1.2.4

hRegionX	back to summary
private int hRegionX Horizontal coordinate of the halftone grid vector, 7.4.5.1.3.1

hRegionY	back to summary
private int hRegionY Vertical coordinate of the halftone grod vector, 7.4.5.1.3.2

hSkipEnabled	back to summary
private boolean hSkipEnabled

hTemplate	back to summary
private byte hTemplate

isMMREncoded	back to summary
private boolean isMMREncoded

patterns	back to summary
private ArrayList<Bitmap> patterns Previously decoded data from other regions or dictionaries, stored to use as patterns in this region.

regionInfo	back to summary
private RegionSegmentInformation regionInfo Region segment information field, 7.4.1

segmentHeader	back to summary
private SegmentHeader segmentHeader

subInputStream	back to summary
private SubInputStream subInputStream

Constructor Detail

HalftoneRegion	back to summary
public HalftoneRegion()

HalftoneRegion	back to summary
public HalftoneRegion(final SubInputStream subInputStream)

HalftoneRegion	back to summary
public HalftoneRegion(final SubInputStream subInputStream, final SegmentHeader segmentHeader)

Method Detail

combineGrayScalePlanes	back to summary
private Bitmap[] combineGrayScalePlanes(Bitmap[] grayScalePlanes, int j)

computeGrayScaleValues	back to summary
private int[][] computeGrayScaleValues(final Bitmap[] grayScalePlanes, final int bitsPerValue)

computeSegmentDataStructure	back to summary
private void computeSegmentDataStructure() throws IOException

computeX	back to summary
private int computeX(final int m, final int n)

computeY	back to summary
private int computeY(final int m, final int n)

getCombinationOperator	back to summary
public CombinationOperator getCombinationOperator()

getHDefaultPixel	back to summary
protected byte getHDefaultPixel()

getHGridHeight	back to summary
protected int getHGridHeight()

getHGridWidth	back to summary
protected int getHGridWidth()

getHGridX	back to summary
protected int getHGridX()

getHGridY	back to summary
protected int getHGridY()

getHRegionX	back to summary
protected int getHRegionX()

getHRegionY	back to summary
protected int getHRegionY()

getHTemplate	back to summary
protected byte getHTemplate()

getPatterns	back to summary
private ArrayList<Bitmap> getPatterns() throws InvalidHeaderValueException, IOException

getRegionBitmap back to summary

getRegionBitmap	back to summary
public Bitmap getRegionBitmap() throws IOException, InvalidHeaderValueException Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap. The procedure is described in JBIG2 ISO standard, 6.6.5. Returns:Bitmap The decoded `Bitmap` of this region. Exceptions IOException: if an underlying IO operation fails InvalidHeaderValueException: if a segment header value is invalid

public Bitmap getRegionBitmap() throws IOException, InvalidHeaderValueException

Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap.

The procedure is described in JBIG2 ISO standard, 6.6.5.

Returns:Bitmap

The decoded Bitmap of this region.

Exceptions

IOException:: if an underlying IO operation fails
InvalidHeaderValueException:: if a segment header value is invalid

getRegionInfo back to summary

getRegionInfo	back to summary
public RegionSegmentInformation getRegionInfo() Implements org.apache.pdfbox.jbig2.Region.getRegionInfo. Doc from org.apache.pdfbox.jbig2.Region.getRegionInfo. Simply returns the `RegionSegmentInformation`. Returns:RegionSegmentInformation The `RegionSegmentInformation`.

public RegionSegmentInformation getRegionInfo()

Implements org.apache.pdfbox.jbig2.Region.getRegionInfo.

Doc from org.apache.pdfbox.jbig2.Region.getRegionInfo.

Simply returns the RegionSegmentInformation.

Returns:RegionSegmentInformation: The RegionSegmentInformation.

grayScaleDecoding	back to summary
private int[][] grayScaleDecoding(final int bitsPerValue) throws IOException Gray-scale image decoding procedure is special for halftone region decoding and is described in Annex C.5 on page 98.

init back to summary

init	back to summary
public void init(final SegmentHeader header, final SubInputStream sis) throws InvalidHeaderValueException, IOException Implements org.apache.pdfbox.jbig2.SegmentData.init. Doc from org.apache.pdfbox.jbig2.SegmentData.init. Parse the stream and read information of header. Parameters header:SegmentHeader - The segments' header (to make referred-to segments available in data part). sis:SubInputStream - Wrapped `ImageInputStream` into `SubInputStream`. Exceptions InvalidHeaderValueException: if the segment header value is invalid IOException: if an underlying IO operation fails

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

Implements org.apache.pdfbox.jbig2.SegmentData.init.

Doc from org.apache.pdfbox.jbig2.SegmentData.init.

Parse the stream and read information of header.

Parameters

header:SegmentHeader: - The segments' header (to make referred-to segments available in data part).
sis:SubInputStream: - Wrapped ImageInputStream into SubInputStream.