IIXC_Page::TableFilter Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::TableFilter Method}}
 
{{#customTitle:IIXC_Page::TableFilter Method}}
{{#parentPage:PXV:IIXC_Page|TableFilter Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|TableFilter|method}}
  
 
+
The '''TableFilter''' method applies a general table filter to an image page or its specified rectangular area.
The method applies a general table filter to an image page or its specified rectangular area.
+
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT TableFilter([in]            RECT*  pRect,
+
<pre class="brush:cpp;gutter:false">HRESULT TableFilter([in]            RECT*  stRect,
                     [in, optional]  UCHAR*  B_Table,
+
                     [in, optional]  UCHAR*  nB_Table,
                     [in, optional]  UCHAR*  G_Table,
+
                     [in, optional]  UCHAR*  nG_Table,
                     [in, optional]  UCHAR*  R_Table);</pre>
+
                     [in, optional]  UCHAR*  nR_Table);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pRect
+
;stRect
:[in]  Pointer to the RECT structure which defines the rectangular area where the function should be applied. If this parameter is <tt>NULL</tt>, the entire page will be processed.
+
:[in]  Pointer to the ''RECT'' structure which defines the rectangular area where the function should be applied. If this parameter is <tt>NULL</tt>, 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 pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page.}}
 
{{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 pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page.}}
;B_Table
+
;nB_Table
 
:[in, optional]  Specifies the blue table.
 
:[in, optional]  Specifies the blue table.
;G_Table
+
;nG_Table
 
:[in, optional]  Specifies the green table.
 
:[in, optional]  Specifies the green table.
;R_Table
+
;nR_Table
 
:[in, optional]  Specifies the red table.
 
:[in, optional]  Specifies the red table.
  
Line 29: Line 29:
 
Each table should have the size of 256.  
 
Each table should have the size of 256.  
  
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]).  
+
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 ==
:[[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]]
+

Latest revision as of 02:17, 15 June 2015

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

Syntax

HRESULT TableFilter([in]            RECT*   stRect,
                    [in, optional]  UCHAR*  nB_Table,
                    [in, optional]  UCHAR*  nG_Table,
                    [in, optional]  UCHAR*  nR_Table);

Parameters

stRect
[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 pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page.
nB_Table
[in, optional] Specifies the blue table.
nG_Table
[in, optional] Specifies the green table.
nR_Table
[in, optional] Specifies the red table.

Return Value

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

Remarks

Each table should have the size of 256.

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