filterButterworthCtx

Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

filterButterworthCtx [-apply] [-cutoffFrequency float] [-endTime time] [-exists] [-history boolean] [-image1 string] [-image2 string] [-image3 string] [-keepKeysOnFrame boolean] [-name string] [-samplingRate float] [-selectedKeys boolean] [-startTime time] contextName

filterButterworthCtx is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Related

Flags

Long name (short name)	Argument types	Properties
-apply(-a)
When specified, finalizes the current context state and records the command for the operation. This is equivalent to completing the tool action without exiting the current tool context.
-cutoffFrequency(-cof)	float
Specifies the cutoff frequency setting of the Butterworth filter. Default is 7.0.
-endTime(-e)	time
Specifies the end time portion of the time range for this filter. This time range is used when selectedKeys is false.
-exists(-ex)
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-history(-ch)	boolean
If this is a tool command, turn the construction history on for the tool in question.
-image1(-i1)	string
First of three possible icons representing the tool associated with the context.
-image2(-i2)	string
Second of three possible icons representing the tool associated with the context.
-image3(-i3)	string
Third of three possible icons representing the tool associated with the context.
-keepKeysOnFrame(-kof)	boolean
When true, the Butterworth filter will reposition output keys to whole frames for the specified sampling rate.
-name(-n)	string
If this is a tool command, name the tool appropriately.
-samplingRate(-sr)	float
Specifies the sampling rate setting of the Butterworth filter. Default is 30.0.
-selectedKeys(-sk)	boolean
If true, sets the filter to apply to the selected keys. Otherwise, the filter applies to the specified time range. Default is on.
-startTime(-s)	time
Specifies the start time portion of the time range for this filter. This time range is used when selectedKeys is false.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Create a context
string $ctx = `filterButterworthCtx`;

// Activate the tool context
setToolTo $ctx;

// Adjust the Butterworth cutoff frequency to selected keys.
filterButterworthCtx -e -sk 1 -cof 3.0 $ctx;

// Apply the current settings to the selected curves.
filterButterworthCtx -e -apply $ctx;