-mask/Mask

Function
This will mask out the previous operation (when in command-line mode) or a node that you specify when in scripting mode. This is the how the GUI interaction of setting a mask is saved in script form. For more information on how the mask works, jump to About Keying.

Parameters Type
Defaults
Function
mask
image
 

The image to be used as a mask on the result of the first input image.

maskChannel
string
"a"
The channel of the mask image to be used as the mask.
percent
float
100
A gain control applied to the maskChannel. 100% means full brightness, 50% means half brightness, 200% means twice as bright, etc.
invertKey
int
0

A switch to invert the maskChannel

0 = Do not invert
1 = Invert

enableKey
int
1

A switch to turn the key on and off.

0 = Off
1 = On


Synopsis

Mask( 
  image, 
  image mask,
  const char * maskChannel,
  float percent,
  int invertKey,
  int enableKey
);


Script

image = Mask( 
  image, 
  mask,
  "maskChannel",
  percent,
  invertKey,
  enableKey
);


Command Line

shake -mask image maskChannel percent ....

Example

shake my_image.@.iff -flop -monitor 
-gamma rgb 1.7 -t 1-20