Class GenericRefinementRegionDecodingProcedure
This class is purely algorithmic. It has no knowledge of how its inputs
are obtained and no dependency on segment headers or input streams.
The entry point is the static decode() method; callers
supply the ArithmeticDecoder and CX context model directly,
so they decide whether to create fresh instances or share existing ones:
GenericRefinementRegion— creates its ownArithmeticDecoderandCX, then callsdecode().- Symbol dictionary refinement (§6.5.8.2) — passes the
parent dictionary's shared
ArithmeticDecoderandCX. - Text region refinement (§6.4) — passes the parent text
region's shared
ArithmeticDecoderandCX.
This class cannot be instantiated by callers. The private constructor and
the internal run(int, int, short, boolean, org.apache.pdfbox.jbig2.Bitmap, int, int, short[], short[]) method exist solely to let the many private helper
methods share state through fields rather than through long parameter lists.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classEncapsulates the template-specific operations: context bit formation (GenericRefinementRegionDecodingProcedure.Template.form(short, short, short, short, short)) and initial CX index selection (GenericRefinementRegionDecodingProcedure.Template.setIndex(org.apache.pdfbox.jbig2.decoder.arithmetic.CX)). -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final GenericRefinementRegionDecodingProcedure.TemplateSingleton template 0 instance (stateless).static final GenericRefinementRegionDecodingProcedure.TemplateSingleton template 1 instance (stateless). -
Method Summary
Modifier and TypeMethodDescriptionstatic Bitmapdecode(ArithmeticDecoder arithDecoder, CX cx, int width, int height, short grTemplate, boolean isTPGROn, Bitmap referenceBitmap, int referenceDX, int referenceDY, short[] grAtX, short[] grAtY) Executes the Generic Refinement Region decoding procedure (§6.3.5.6) and returns the decoded bitmap.
-
Field Details
-
T0
Singleton template 0 instance (stateless). -
T1
Singleton template 1 instance (stateless).
-
-
Method Details
-
decode
public static Bitmap decode(ArithmeticDecoder arithDecoder, CX cx, int width, int height, short grTemplate, boolean isTPGROn, Bitmap referenceBitmap, int referenceDX, int referenceDY, short[] grAtX, short[] grAtY) throws IOException Executes the Generic Refinement Region decoding procedure (§6.3.5.6) and returns the decoded bitmap.A short-lived instance is created internally so that the many private helper methods can share state through fields rather than through long parameter lists. No state survives the return of this method.
- Parameters:
arithDecoder- the arithmetic decoder — shared with the parent when called from a symbol dictionary or text region, or freshly created when called from a standalone segment; must not benullcx- the context model — shared or fresh, as above; must not benullwidth- decoded bitmap width (GRW); must be > 0height- decoded bitmap height (GRH); must be > 0grTemplate- template index: must be 0 or 1 (GRTEMPLATE)isTPGROn- whether typical prediction is enabled (TPGRON)referenceBitmap- the reference / base bitmap (GRREFERENCE); must not benullreferenceDX- horizontal offset of reference bitmap (GRREFERENCEDX)referenceDY- vertical offset of reference bitmap (GRREFERENCEDY)grAtX- AT pixel X offsets; required forgrTemplate == 0, must be a non-null array of length 2 in that case; ignored forgrTemplate == 1grAtY- AT pixel Y offsets; same requirements asgrAtX- Returns:
- the decoded bitmap
- Throws:
IllegalArgumentException- if any parameter constraint above is violatedIOException- if an underlying I/O operation fails
-