Source

pilgui / pythondoc-PIL.ImageFilter.xml

<module filename="C:\PROGRAM FILES\PYTHON27\lib\site-packages\PIL\ImageFilter.py" name="PIL.ImageFilter"><class lineno="18" name="PIL.ImageFilter.Filter"><info><def>Filter</def><name>Filter</name></info></class><class lineno="24" name="PIL.ImageFilter.Kernel"><info><def>Kernel(Filter)</def><name>Kernel</name><summary>Convolution filter kernel.</summary><description>Convolution filter kernel.</description></info><method lineno="44" name="PIL.ImageFilter.Kernel.__init__"><info><name>__init__</name><summary>Create a convolution kernel.</summary><description><p>Create a convolution kernel.  The current version only
supports 3x3 and 5x5 integer and floating point kernels.
</p><p>
In the current version, kernels can only be applied to
"L" and "RGB" images.

</p></description><def>__init__(size, kernel, **options)</def><param name="size">Kernel size, given as (width, height).  In
   the current version, this must be (3,3) or (5,5).</param><param name="kernel">A sequence containing kernel weights.</param><param name="**options">Optional keyword arguments.</param><keyparam name="scale">Scale factor.  If given, the result for each
   pixel is divided by this value.  The default is the sum
   of the kernel weights.</keyparam><keyparam name="offset">Offset.  If given, this value is added to the
   result, after it has been divided by the scale factor.</keyparam></info></method><method lineno="52" name="PIL.ImageFilter.Kernel.filter"><info><def>filter(image)</def><name>filter</name></info></method></class><class lineno="57" name="PIL.ImageFilter.BuiltinFilter"><info><def>BuiltinFilter(Kernel)</def><name>BuiltinFilter</name></info><method lineno="58" name="PIL.ImageFilter.BuiltinFilter.__init__"><info><def>__init__()</def><name>__init__</name></info></method></class><class lineno="64" name="PIL.ImageFilter.RankFilter"><info><def>RankFilter(Filter)</def><name>RankFilter</name><summary>Rank filter.</summary><description>Rank filter.</description></info><method lineno="76" name="PIL.ImageFilter.RankFilter.__init__"><info><def>__init__(size, rank)</def><name>__init__</name><summary>Create a rank filter.</summary><description>Create a rank filter.  The rank filter sorts all pixels in
a window of the given size, and returns the rank'th value.</description><param name="size">The kernel size, in pixels.</param><param name="rank">What pixel value to pick.  Use 0 for a min filter,
   size*size/2 for a median filter, size*size-1 for a max filter,
   etc.</param></info></method><method lineno="80" name="PIL.ImageFilter.RankFilter.filter"><info><def>filter(image)</def><name>filter</name></info></method></class><class lineno="90" name="PIL.ImageFilter.MedianFilter"><info><def>MedianFilter(RankFilter)</def><name>MedianFilter</name><summary>Median filter.</summary><description>Median filter.  Picks the median pixel value in a window with the
given size.</description></info><method lineno="98" name="PIL.ImageFilter.MedianFilter.__init__"><info><def>__init__(size=3)</def><name>__init__</name><summary>Create a median filter.</summary><description>Create a median filter.</description><param name="size">The kernel size, in pixels.</param></info></method></class><class lineno="106" name="PIL.ImageFilter.MinFilter"><info><def>MinFilter(RankFilter)</def><name>MinFilter</name><summary>Min filter.</summary><description>Min filter.  Picks the lowest pixel value in a window with the given
size.</description></info><method lineno="114" name="PIL.ImageFilter.MinFilter.__init__"><info><def>__init__(size=3)</def><name>__init__</name><summary>Create a min filter.</summary><description>Create a min filter.</description><param name="size">The kernel size, in pixels.</param></info></method></class><class lineno="122" name="PIL.ImageFilter.MaxFilter"><info><def>MaxFilter(RankFilter)</def><name>MaxFilter</name><summary>Max filter.</summary><description>Max filter.  Picks the largest pixel value in a window with the
given size.</description></info><method lineno="130" name="PIL.ImageFilter.MaxFilter.__init__"><info><def>__init__(size=3)</def><name>__init__</name><summary>Create a max filter.</summary><description>Create a max filter.</description><param name="size">The kernel size, in pixels.</param></info></method></class><class lineno="140" name="PIL.ImageFilter.ModeFilter"><info><def>ModeFilter(Filter)</def><name>ModeFilter</name><summary>Mode filter.</summary><description>Mode filter.  Picks the most frequent pixel value in a box with the
given size.  Pixel values that occur only once or twice are ignored;
if no pixel value occurs more than twice, the original pixel value
is preserved.</description></info><method lineno="148" name="PIL.ImageFilter.ModeFilter.__init__"><info><def>__init__(size=3)</def><name>__init__</name><summary>Create a mode filter.</summary><description>Create a mode filter.</description><param name="size">The kernel size, in pixels.</param></info></method><method lineno="150" name="PIL.ImageFilter.ModeFilter.filter"><info><def>filter(image)</def><name>filter</name></info></method></class><class lineno="156" name="PIL.ImageFilter.GaussianBlur"><info><def>GaussianBlur(Filter)</def><name>GaussianBlur</name><summary>Gaussian blur filter.</summary><description>Gaussian blur filter.</description></info><method lineno="159" name="PIL.ImageFilter.GaussianBlur.__init__"><info><def>__init__(radius=2)</def><name>__init__</name></info></method><method lineno="161" name="PIL.ImageFilter.GaussianBlur.filter"><info><def>filter(image)</def><name>filter</name></info></method></class><class lineno="167" name="PIL.ImageFilter.UnsharpMask"><info><def>UnsharpMask(Filter)</def><name>UnsharpMask</name><summary>Unsharp mask filter.</summary><description>Unsharp mask filter.</description></info><method lineno="170" name="PIL.ImageFilter.UnsharpMask.__init__"><info><def>__init__(radius=2, percent=150, threshold=3)</def><name>__init__</name></info></method><method lineno="174" name="PIL.ImageFilter.UnsharpMask.filter"><info><def>filter(image)</def><name>filter</name></info></method></class><class lineno="180" name="PIL.ImageFilter.BLUR"><info><def>BLUR(BuiltinFilter)</def><name>BLUR</name><summary>Simple blur filter.</summary><description>Simple blur filter.</description></info></class><class lineno="193" name="PIL.ImageFilter.CONTOUR"><info><def>CONTOUR(BuiltinFilter)</def><name>CONTOUR</name><summary>Simple contour filter.</summary><description>Simple contour filter.</description></info></class><class lineno="204" name="PIL.ImageFilter.DETAIL"><info><def>DETAIL(BuiltinFilter)</def><name>DETAIL</name><summary>Simple detail filter.</summary><description>Simple detail filter.</description></info></class><class lineno="215" name="PIL.ImageFilter.EDGE_ENHANCE"><info><def>EDGE_ENHANCE(BuiltinFilter)</def><name>EDGE_ENHANCE</name><summary>Simple edge enhancement filter.</summary><description>Simple edge enhancement filter.</description></info></class><class lineno="226" name="PIL.ImageFilter.EDGE_ENHANCE_MORE"><info><def>EDGE_ENHANCE_MORE(BuiltinFilter)</def><name>EDGE_ENHANCE_MORE</name><summary>Simple stronger edge enhancement filter.</summary><description>Simple stronger edge enhancement filter.</description></info></class><class lineno="237" name="PIL.ImageFilter.EMBOSS"><info><def>EMBOSS(BuiltinFilter)</def><name>EMBOSS</name><summary>Simple embossing filter.</summary><description>Simple embossing filter.</description></info></class><class lineno="248" name="PIL.ImageFilter.FIND_EDGES"><info><def>FIND_EDGES(BuiltinFilter)</def><name>FIND_EDGES</name><summary>Simple edge-finding filter.</summary><description>Simple edge-finding filter.</description></info></class><class lineno="259" name="PIL.ImageFilter.SMOOTH"><info><def>SMOOTH(BuiltinFilter)</def><name>SMOOTH</name><summary>Simple smoothing filter.</summary><description>Simple smoothing filter.</description></info></class><class lineno="270" name="PIL.ImageFilter.SMOOTH_MORE"><info><def>SMOOTH_MORE(BuiltinFilter)</def><name>SMOOTH_MORE</name><summary>Simple stronger smoothing filter.</summary><description>Simple stronger smoothing filter.</description></info></class><class lineno="283" name="PIL.ImageFilter.SHARPEN"><info><def>SHARPEN(BuiltinFilter)</def><name>SHARPEN</name><summary>Simple sharpening filter.</summary><description>Simple sharpening filter.</description></info></class></module>