PictureEffects Xojo Plugin |

# RankOrderModule.RankOrderFilter Method

RankOrderFilter is a edge enhancement filter where the result is produced from surrounding pixels.

RankOrderFilter(
p as Picture,
method as Integer,
mask as Picture,
progress as IProgressHandler) as Picture

#### Parameters

p
  The source picture to work with (can be 24 or 32 bits).
method
  The method to use. (This can be one of the constants defined in this module, RankOrderModule.Min, RankOrderModule.Max, RankOrderModule.Median)
mask
  To limit the filtering to certain pixels then set a picture defining the mask to this parameter. Pass nil to this parameter if the filtering should not be limited to certain pixels.
  The mask picture must be a 32 bit picture and must be same size as the src picture. If the mask picture is not 32 bits and same size as the src picture then the function will fail and leave the result picture unchanged.
progress
  Use this parameter to use a progress class to get progress feedback from this function. This class must be a class that Implements the IProgressHandler Interface which is defined in this plugin.
  Pass nil to this parameter if you don't need progress feedback.
  Progress feedback will slow the filter down.

#### Returns

Picture
  If the filter was successful: A reference to the modified picture.
  If the src picture was not 1 bit, 24 or 32 bits then a nil will be returned.

#### Remarks

#### Supported Platforms:

- MacOS X Carbon
- MacOS X Cocoa 32 bit
- MacOS X Cocoa 64 bit
- Windows 32 bit
- Windows 64 bit
- Linux 32 bit
- Linux 64 bit
- Linux ARM

  #### See Also

  RankOrderModule Module