IIXC_Page::FilterNoise Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method applies Noise filter to the image page or its specified area.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 14:
 
== 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}}
 
;nLevel
 
;nLevel
:[in]  Value of ULONG.
+
:[in]  Specifies noise level.
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[in]  Specifies the type of the filter. Could be one of the following [[PXV:IXC_NoiseType|IXC_NoiseType]].
  
 
== Return Value ==
 
== Return Value ==
Line 24: Line 25:
  
 
== 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_StdMatrixFilter|IIXC_Page::StdMatrixFilter]]
 +
:[[PXV:IXC_NoiseType|IXC_NoiseType]]

Revision as of 04:49, 30 April 2015


The method applies Noise filter to the image page or its specified area.

Syntax

HRESULT FilterNoise([in]  RECT*  pRect,
                    [in]  ULONG  nLevel,
                    [in]  ULONG  nFlags);

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
nLevel
[in] Specifies noise level.
nFlags
[in] Specifies the type of the filter. Could be one of the following IXC_NoiseType.

Return Value

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

See Also

IIXC_Page.
IIXC_Page::FilterMedian
IIXC_Page::FilterMosaic
IIXC_Page::StdMatrixFilter
IXC_NoiseType