Click or drag to resize

PdfCCITTFaxDecodeFilter Class

The CCITTFaxDecode filter decodes image data that has been encoded using either Group 3 or Group 4 CCITT facsimile(fax) encoding.
Inheritance Hierarchy
SystemObject
  GemBox.Pdf.FiltersPdfFilter
    GemBox.Pdf.FiltersPdfCCITTFaxDecodeFilter

Namespace:  GemBox.Pdf.Filters
Assembly:  GemBox.Pdf (in GemBox.Pdf.dll) Version: 13.0.35.1000
Syntax
public sealed class PdfCCITTFaxDecodeFilter : PdfFilter

The PdfCCITTFaxDecodeFilter type exposes the following members.

Properties
  NameDescription
Public propertyBlackIs1

A flag indicating whether 1 bits shall be interpreted as black pixels and 0 bits as white pixels, the reverse of the normal PDF convention for image data.

Default value: .

Public propertyColumns

The width of the image in pixels. If the value is not a multiple of 8, the filter shall adjust the width of the unencoded image to the next multiple of 8 so that each line starts on a byte boundary.

Default value: 1728.

Public propertyDamagedRowsBeforeError

The number of damaged rows of data that shall be tolerated before an error occurs. This entry shall apply only if EndOfLine is and K is non-negative. Tolerating a damaged row shall mean locating its end in the encoded data by searching for an EndOfLine pattern and then substituting decoded data from the previous row if the previous row was not damaged, or a white scan line if the previous row was also damaged.

Default value: 0.

Public propertyEncodedByteAlign

A flag indicating whether the filter shall expect extra 0 bits before each encoded line so that the line begins on a byte boundary. If , the filter shall skip over encoded bits to begin decoding each line at a byte boundary. If , the filter shall not expect extra bits in the encoded representation.

Default value: .

Public propertyEndOfBlock

A flag indicating whether the filter shall expect the encoded data to be terminated by an end-of-block pattern, overriding the Rows parameter. If , the filter shall stop when it has decoded the number of lines indicated by Rows or when its data has been exhausted, whichever occurs first. The end-of-block pattern shall be the CCITT end-of-facsimile-block (EOFB) or return-to-control (RTC) appropriate for the K parameter.

Default value: .

Public propertyEndOfLine

A flag indicating whether end-of-line bit patterns shall be present in the encoding. The PdfCCITTFaxDecodeFilter shall always accept end-of-line bit patterns. If EndOfLine is end-of-line bit patterns shall be present.

Default value: .

Public propertyFilterType
Gets the CCITTFaxDecode value.
(Overrides PdfFilterFilterType.)
Public propertyK

A code identifying the encoding scheme used:

<0
Pure two-dimensional encoding (Group 4)
=0
Pure one-dimensional encoding (Group 3, 1-D)
>0
Mixed one- and two-dimensional encoding (Group 3, 2-D), in which a line encoded one-dimensionally may be followed by at most K − 1 lines encoded two-dimensionally

The filter shall distinguish among negative, zero, and positive values of K to determine how to interpret the encoded data; however, it shall not distinguish between different positive K values.

Default value: 0.

Public propertyRows

The height of the image in scan lines. If the value is 0, the image’s height is not predetermined, and the encoded data shall be terminated by an end-of-block bit pattern or by the end of the filter’s data.

Default value: 0.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to this PdfFilter instance.
(Inherited from PdfFilter.)
Public methodGetHashCode
Returns a hash code for this PdfFilter instance.
(Inherited from PdfFilter.)
Public methodToString
Returns a String that represents this PdfFilter instance.
(Inherited from PdfFilter.)
Top
See Also