IIXC_Page::TableFilter Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::TableFilter Method}}
 
{{#customTitle:IIXC_Page::TableFilter Method}}
 
{{#parentPage:PXV:IIXC_Page|TableFilter Method|method}}
 
{{#parentPage:PXV:IIXC_Page|TableFilter Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method applies a general table filter to an image page or its specified rectangular area.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;pRect
 
;pRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to the RECT structure which defines the rectangular area where the function should be applied. If this parameter is NULL, the entire page will be processed.
 +
{{note|Please note that partial processing of an area of a page is not supported for all image formats. For example, it is not supported for indexed images, because each pixel in such images contains not a color, but an index into a color table (palette) which is common for the entire page.}}
 
;B_Table
 
;B_Table
:[in, optional]  Pointer to UCHAR.
+
:[in, optional]  Specifies the blue table.
 
;G_Table
 
;G_Table
:[in, optional]  Pointer to UCHAR.
+
:[in, optional]  Specifies the green table.
 
;R_Table
 
;R_Table
:[in, optional]  Pointer to UCHAR.
+
:[in, optional]  Specifies the red table.
  
 
== Return Value ==
 
== Return Value ==
 
Returns S_OK if operation was successful or error code in other cases.
 
Returns S_OK if operation was successful or error code in other cases.
 +
 +
== Comments ==
 +
Each table should have the size of 256.
 +
 +
== Remarks ==
 +
For each pixel in the image its color value is changed according values passed through the tables. i.e. pixel's color value is (5, 120, 17). New color for this pixel will be the color with the component values taken from the tables with indexes (5, 120, 17). So the final color value for the selected pixel will be: (B_Table[5], G_Table[120], R_Table[17]).
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IIXC_Page_FilterMedian|IIXC_Page::FilterMedian]]
 +
:[[PXV:IIXC_Page_FilterMosaic|IIXC_Page::FilterMosaic]]
 +
:[[PXV:IIXC_Page_FilterMedian|IIXC_Page::FilterNoise]]
 +
:[[PXV:IIXC_Page_StdMatrixFilter|IIXC_Page::StdMatrixFilter]]

Revision as of 05:44, 30 April 2015


The method applies a general table filter to an image page or its specified rectangular area.

Syntax

HRESULT TableFilter([in]            RECT*   pRect,
                    [in, optional]  UCHAR*  B_Table,
                    [in, optional]  UCHAR*  G_Table,
                    [in, optional]  UCHAR*  R_Table);

Parameters

pRect
[in] Pointer to the RECT structure which defines the rectangular area where the function should be applied. If this parameter is NULL, the entire page will be processed.
Note:
Please note that partial processing of an area of a page is not supported for all image formats. For example, it is not supported for indexed images, because each pixel in such images contains not a color, but an index into a color table (palette) which is common for the entire page.
B_Table
[in, optional] Specifies the blue table.
G_Table
[in, optional] Specifies the green table.
R_Table
[in, optional] Specifies the red table.

Return Value

Returns S_OK if operation was successful or error code in other cases.

Comments

Each table should have the size of 256.

Remarks

For each pixel in the image its color value is changed according values passed through the tables. i.e. pixel's color value is (5, 120, 17). New color for this pixel will be the color with the component values taken from the tables with indexes (5, 120, 17). So the final color value for the selected pixel will be: (B_Table[5], G_Table[120], R_Table[17]).

See Also

IIXC_Page
IIXC_Page::FilterMedian
IIXC_Page::FilterMosaic
IIXC_Page::FilterNoise
IIXC_Page::StdMatrixFilter