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

Modifier and Type	Field and Description
private ArithmeticDecoder	arithDecoder
private CX	cx
private long	dataHeaderLength
private long	dataHeaderOffset
private long	dataLength
private long	dataOffset
private boolean[]	gbAtOverride
private short[]	gbAtX Generic region segment AT flags, 7.4.6.3
private short[]	gbAtY
private byte	gbTemplate
private boolean	isMMREncoded
private boolean	isTPGDon
private MMRDecompressor	mmrDecompressor
private boolean	override If true, AT pixels are not on their nominal location and have to be overridden
private Bitmap	regionBitmap Decoded data as pixel values (use row stride/width to wrap line)
private RegionSegmentInformation	regionInfo Region segment information field, 7.4.1
private SubInputStream	subInputStream
private boolean	useExtTemplates Generic region segment flags, 7.4.6.2

Access	Constructor and Description
public	GenericRegion()
public	GenericRegion(final SubInputStream subInputStream)

Method Summary

Modifier and Type	Method and Description
private void	computeSegmentDataStructure()
private void	copyLineAbove(final int - Coordinate of the row that should be set. lineNumber) Each pixel gets the value from the corresponding pixel of the row above.
private void	decodeLine(final int lineNumber, final int width, final int rowStride, final int paddedWidth)
private int	decodeSLTP()
private void	decodeTemplate0a(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx)
private void	decodeTemplate0b(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx)
private void	decodeTemplate1(final int lineNumber, int width, final int rowStride, final int paddedWidth, int byteIndex, int idx)
private void	decodeTemplate2(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx)
private void	decodeTemplate3(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx)
protected short[]	getGbAtX()
protected short[]	getGbAtY()
protected byte	getGbTemplate()
private byte	getPixel(final int x, final int y)
public Bitmap	Returns: The decoded `Bitmap` of this region. getRegionBitmap() Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap. The procedure is described in 6.2.5.7, page 17.
public RegionSegmentInformation	getRegionInfo() Implements org.apache.pdfbox.jbig2.Region.getRegionInfo. Simply returns the `RegionSegmentInformation`.
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	isMMREncoded()
protected boolean	isTPGDon()
private int	overrideAtTemplate0a(int context, final int x, final int y, final int result, final int minorX, final int toShift)
private int	overrideAtTemplate0b(int context, final int x, final int y, final int result, final int minorX, final int toShift)
private int	overrideAtTemplate1(int context, final int x, final int y, final int result, final int minorX)
private int	overrideAtTemplate2(int context, final int x, final int y, final int result, final int minorX)
private int	overrideAtTemplate3(int context, final int x, final int y, final int result, final int minorX)
private void	parseHeader()
private void	readGbAtPixels(final int amountOfGbAt)
protected void	resetBitmap() Simply sets the memory-critical bitmap of this region to `null`.
private void	setOverrideFlag(final int index)
protected void	setParameters(final boolean the data is MMR encoded isMMREncoded, final long the offset dataOffset, final long the length of the data dataLength, final int bitmap height gbh, final int bitmap width gbw) Used by `SymbolDictionary`.
protected void	setParameters(final boolean the data is MMR encoded isMMREncoded, final byte sd template sdTemplate, final boolean is TPGDon isTPGDon, final boolean use skip useSkip, final short[] x values gbA pixels sdATX, final short[] y values gbA pixels sdATY, final int bitmap width symWidth, final int bitmap height hcHeight, final CX context for the arithmetic decoder cx, final ArithmeticDecoder the arithmetic decode to be used Used by `SymbolDictionary`. arithmeticDecoder)
protected void	setParameters(final boolean the data is MMR encoded isMMREncoded, final long the offset dataOffset, final long the length of the data dataLength, final int bitmap height gbh, final int bitmap width gbw, final byte gb template gbTemplate, final boolean is TPGDon isTPGDon, final boolean use skip useSkip, final short[] x values of gbA pixels gbAtX, final short[] y values of gbA pixels gbAtY) Used by `PatternDictionary` and `HalftoneRegion`.
private void	updateOverrideFlags()
protected boolean	useExtTemplates()

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

arithDecoder	back to summary
private ArithmeticDecoder arithDecoder

cx	back to summary
private CX cx

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

gbAtOverride	back to summary
private boolean[] gbAtOverride

gbAtX	back to summary
private short[] gbAtX Generic region segment AT flags, 7.4.6.3

gbAtY	back to summary
private short[] gbAtY

gbTemplate	back to summary
private byte gbTemplate

isMMREncoded	back to summary
private boolean isMMREncoded

isTPGDon	back to summary
private boolean isTPGDon

mmrDecompressor	back to summary
private MMRDecompressor mmrDecompressor

override	back to summary
private boolean override If true, AT pixels are not on their nominal location and have to be overridden

regionBitmap	back to summary
private Bitmap regionBitmap Decoded data as pixel values (use row stride/width to wrap line)

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

subInputStream	back to summary
private SubInputStream subInputStream

useExtTemplates	back to summary
private boolean useExtTemplates Generic region segment flags, 7.4.6.2

GenericRegion	back to summary
public GenericRegion()

GenericRegion	back to summary
public GenericRegion(final SubInputStream subInputStream)

Method Detail

computeSegmentDataStructure	back to summary
private void computeSegmentDataStructure() throws IOException

copyLineAbove	back to summary
private void copyLineAbove(final int lineNumber) Each pixel gets the value from the corresponding pixel of the row above. Line 0 cannot get copied values (source will be -1, doesn't exist). Parameters lineNumber:int - Coordinate of the row that should be set.

copyLineAbove

back to summary

private void copyLineAbove(final int lineNumber)

Each pixel gets the value from the corresponding pixel of the row above. Line 0 cannot get copied values (source will be -1, doesn't exist).

Parameters

lineNumber:int: - Coordinate of the row that should be set.

decodeLine	back to summary
private void decodeLine(final int lineNumber, final int width, final int rowStride, final int paddedWidth) throws IOException

decodeSLTP	back to summary
private int decodeSLTP() throws IOException

decodeTemplate0a	back to summary
private void decodeTemplate0a(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx) throws IOException

decodeTemplate0b	back to summary
private void decodeTemplate0b(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx) throws IOException

decodeTemplate1	back to summary
private void decodeTemplate1(final int lineNumber, int width, final int rowStride, final int paddedWidth, int byteIndex, int idx) throws IOException

decodeTemplate2	back to summary
private void decodeTemplate2(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx) throws IOException

decodeTemplate3	back to summary
private void decodeTemplate3(final int lineNumber, final int width, final int rowStride, final int paddedWidth, int byteIndex, int idx) throws IOException

getGbAtX	back to summary
protected short[] getGbAtX()

getGbAtY	back to summary
protected short[] getGbAtY()

getGbTemplate	back to summary
protected byte getGbTemplate()

getPixel	back to summary
private byte getPixel(final int x, final int y) throws IOException

getRegionBitmap back to summary

getRegionBitmap	back to summary
public Bitmap getRegionBitmap() throws IOException Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap. The procedure is described in 6.2.5.7, page 17. Returns:Bitmap The decoded `Bitmap` of this region. Exceptions IOException: Doc from org.apache.pdfbox.jbig2.Region.getRegionBitmap. if an underlying IO operation fails

public Bitmap getRegionBitmap() throws IOException

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

The procedure is described in 6.2.5.7, page 17.

Returns:Bitmap

The decoded Bitmap of this region.

Exceptions

IOException:

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

if an underlying IO operation fails

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.

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.

Exceptions

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

isMMREncoded	back to summary
protected boolean isMMREncoded()

isTPGDon	back to summary
protected boolean isTPGDon()

overrideAtTemplate0a	back to summary
private int overrideAtTemplate0a(int context, final int x, final int y, final int result, final int minorX, final int toShift) throws IOException

overrideAtTemplate0b	back to summary
private int overrideAtTemplate0b(int context, final int x, final int y, final int result, final int minorX, final int toShift) throws IOException

overrideAtTemplate1	back to summary
private int overrideAtTemplate1(int context, final int x, final int y, final int result, final int minorX) throws IOException

overrideAtTemplate2	back to summary
private int overrideAtTemplate2(int context, final int x, final int y, final int result, final int minorX) throws IOException

overrideAtTemplate3	back to summary
private int overrideAtTemplate3(int context, final int x, final int y, final int result, final int minorX) throws IOException

parseHeader	back to summary
private void parseHeader() throws IOException, InvalidHeaderValueException

readGbAtPixels	back to summary
private void readGbAtPixels(final int amountOfGbAt) throws IOException

resetBitmap	back to summary
protected void resetBitmap() Simply sets the memory-critical bitmap of this region to `null`.

setOverrideFlag	back to summary
private void setOverrideFlag(final int index)

setParameters back to summary

protected void setParameters(final boolean isMMREncoded, final long dataOffset, final long dataLength, final int gbh, final int gbw)

Used by SymbolDictionary.

Parameters

isMMREncoded:boolean: the data is MMR encoded
dataOffset:long: the offset
dataLength:long: the length of the data
gbh:int: bitmap height
gbw:int: bitmap width

setParameters back to summary

protected void setParameters(final boolean isMMREncoded, final byte sdTemplate, final boolean isTPGDon, final boolean useSkip, final short[] sdATX, final short[] sdATY, final int symWidth, final int hcHeight, final CX cx, final ArithmeticDecoder arithmeticDecoder)

Parameters

isMMREncoded:boolean: the data is MMR encoded
sdTemplate:byte: sd template
isTPGDon:boolean: is TPGDon
useSkip:boolean: use skip
sdATX:short[]: x values gbA pixels
sdATY:short[]: y values gbA pixels
symWidth:int: bitmap width
hcHeight:int: bitmap height
cx:CX: context for the arithmetic decoder
arithmeticDecoder:ArithmeticDecoder: the arithmetic decode to be used Used by SymbolDictionary.

setParameters back to summary

protected void setParameters(final boolean isMMREncoded, final long dataOffset, final long dataLength, final int gbh, final int gbw, final byte gbTemplate, final boolean isTPGDon, final boolean useSkip, final short[] gbAtX, final short[] gbAtY)

Used by PatternDictionary and HalftoneRegion.

Parameters

isMMREncoded:boolean: the data is MMR encoded
dataOffset:long: the offset
dataLength:long: the length of the data
gbh:int: bitmap height
gbw:int: bitmap width
gbTemplate:byte: gb template
isTPGDon:boolean: is TPGDon
useSkip:boolean: use skip
gbAtX:short[]: x values of gbA pixels
gbAtY:short[]: y values of gbA pixels

updateOverrideFlags	back to summary
private void updateOverrideFlags()

useExtTemplates	back to summary
protected boolean useExtTemplates()

public Class GenericRegion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail