ApplyFilter

Function
Like Blur, this modifier applies a filter except you can choose the filter used in X and Y separately. You can then scale the default base range (in pixels) of the predefined filters. For instance, the default number of pixels sampled on either side of the base pixel might be 3 pixels. An xScale of 2 would increase that range to 6 pixels.

You can change the the filter type in the much faster Blur function, so we recommend you use that instead. This function exists only to allow absolute compatibility with images generated by other software packages.

Note that dirac and impulse filters have no effect with ApplyFilter.

 

Parameters
Type
Defaults
Function
x/yFilter
string
"gauss", "gauss" Jump to Filter Types
x/yPixels
float
1,1 The amount of filtering as described in Pixels.
spread
int
0

This tells Shake to consider outside of the frame or not.

0 = Compute with the frame
1 = Compute outside of the frame

Because of the infinite workspace, it is sometimes handy to compute outside of the frame as well, for example, if the Blur is placed after a Scale command. Note that if nothing is outside of the frame (ie, black), you will see a black edge.


Synopsis

image ApplyFilter( image, 
  const char * xFilter, 
  const char * yFilter 
  float xPixels, 
  float yPixels, 
  int spread, 
);


Script

image = ApplyFilter( image,
  "xFilter",
  "yFilter",
  xPixels, 
  yPixels, 
  spread        
);

Command Line

shake -applyfilter xFilter yFilter etc...

Examples

shake lisa.iff -apply gauss box 20 100

See Also
PercentBlur, Blur