# jit.wake

## Description

Use the jit.wake object to perform video feedback with a convolution stage.

## Examples

## Discussion

The feedback, feed forward, gain, and convolution kernel values down, left, right, and up) for red, green, and blue planes are all separately controllable. Additional controls for feedback, feed forward, and gain for all colors considered together, as well as convolution kernel value control for all colors (upper, lower, left, and right).

## Matrix Operator

Name | IOProc | Planelink | Typelink | Dimlink | Plane | Dim | Type |
---|---|---|---|---|---|---|---|

out | n/a | 1 | 1 | 1 | 4 | 1 | char |

### More about Matrix Operators

### The Jitter MOP

Since the matrix is Jitter's focus, it is not surprising that the majority of Jitter objects fall in this category of Matrix Operators. Every Matrix operator has some number of matrix inputs and some number of matrix outputs. Matrix inputs are referred to by the names "in", "in2", "in3", etc., from left to right, and matrix outputs are referred to by the names "out", "out2", "out3", etc., from left to right--i.e. the names are appended by the input/output number except for the first (leftmost) input and first (leftmost) output which are simply named "in" and "out". We will refer to the input or output name names as the "I/O-name".

Matrix inputs and outputs typically each have their own matrices internally where information is kept. This is necessary because Jitter is an asynchronous framework (i.e. all the matrices don't arrive at all inputs at the same time). Various aspects of matrix inputs and outputs can be set using the command [I/O-name] combined with one of the following suffixes: "_dim" which will set the dimensions of the specified I/O matrix, "_type" which will set the type of the specified matrix, "_planecount" which will set the plane of the specified matrix, or "_name" which will set the name of the specified matrix. There is one special case which does not have an internal matrix and this is the first input "in". This is the case since this special input actually triggers the calculation of the matrix operator, so it doesn't need to be cached until a calulation takes place, unlike the other inputs. Therefore there is no mechanism to set the dim, planecount, type, or name of "in".

Matrix operators accept what we'll refer to as "matrix args"--i.e.

. if these arguments are present, the attribute will be turned off, otherwise it will be turned on. If adapt mode is turned on, each time a matrix is received in the first input, there will also be the equivalent of setting the , , and attributes to that of the input matrix. If the other inputs and outputs are linked to these attributes, this will affect their linked attributes as well. See the "MOP" table to determine which inputs and outputs will be linked to which attributes when adapt mode is turned on. For the leftmost input this is not applicable, and hence all columns are labelled "n/a".The jit.matrix object is a named matrix which may be used to matrix data storage and retrieval, resampling, and matrix type and planecount conversion operations.

### MOP Arguments

### planecount [int]

Explicitly sets the number of planes for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

### type [symbol]

Explicitly sets the type of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

### dimensions [list]

Explicitly sets the dimensions of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

### MOP Attributes

### adapt [int]

Matrix adaptation flag (default = 0 if matrix arguments are present, otherwise 1) When the flag is set, the jit.matrix object will adapt to the incoming matrix planecount, type, and dimensions.

### [in/out]_dim [32 ints]

The matrix data dimensions (default = 1 1)

### [in/out]_name [symbol]

The input or output name of the matrix (default = UID)

### [in/out]_planecount [int]

The number of planes in matrix input our output data. Except in special cases, this value is equal to the

.### [in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to

.### outputmode [int]

Output mode (default = 1 (calculate and output matrix))

0 = No output

1 = Calculate and output the matrix

2 = Pass input (no calculation)

3 = Pass output (no calculation)

### type [int]

The matrix data type (default =

Supported data types are , , , or .

### MOP Messages

### bang

### clear

### exportattrs

#### Arguments

### getattributes

*attribute-name*

*get-value*

*foo*set-value

*number-of-values*.

### getstate

*attribute-value1*

*attribute-value2*...

*attribute-valueN*.

### importattrs

#### Arguments

### jit_matrix

#### Arguments

### outputmatrix

### summary

*object-name*. The second and third lines describe the number of inlets and outlets for the object in the form

*number-of-(inlets/outlets)*. The fourth line describes the matrixoutput in the form

*descriptor*

*planelink-value*

*typelink-value*

*dimlink-value*

*data-type(s)*. Each attribute for the object is then listed, one attribute per line. Each line listing takes the form

*attribute-name attribute-value1 attribute-value2 ... attribute-valueN*.

## Attributes

### bdownbleed [float]

The lower convolution kernel value for the blue plane (default = 0.)

### bfb [float]

The feedback level for blue plane values (default = 0.)

### bff [float]

The feed forward level for blue plane values (default = 1.)

### bgain [float]

The gain level for blue plane values (default = 1.)

### bleed [float]

The all upper, lower, left, and right convolution kernel values

### bleftbleed [float]

The blue left convolution kernel value (default = 0.)

### brightbleed [float]

The blue right convolution kernel value (default = 0.)

### bupbleed [float]

The blue upper convolution kernel value (default = 0.)

### fb [float]

The feedback level for all plane values (default = 0.)

### ff [float]

The feed forward level for all plane values (default = 1.)

### gain [float]

The gain level for all colors (default = 1.)

### gdownbleed [float]

The lower convolution kernel value for the green plane (default = 0.)

### gfb [float]

The feedback level for green plane values (default = 0.)

### gff [float]

The feed forward level for green plane values (default = 1.)

### ggain [float]

The gain level for green plane values (default = 1.)

### gleftbleed [float]

The left convolution kernel value for the green plane (default = 0.)

### grightbleed [float]

The right convolution kernel value for the green plane (default = 0.)

### gupbleed [float]

The upper convolution kernel value for the green plane (default = 0.)

### normalize [int]

Normalization flag (default = 0)

### rdownbleed [float]

The lower convolution kernel value for the red plane (default = 0.)

### rfb [float]

The feedback level for red plane values (default = 0.)

### rff [float]

The feed forward level for red plane values (default = 1.)

### rgain [float]

The gain level for red plane values (default = 1.)

### rleftbleed [float]

The left convolution kernel value for the red plane (default = 0.)

### rrightbleed [float]

The right convolution kernel value for the red plane (default = 0.)

### rupbleed [float]

The upper convolution kernel value for the red plane (default = 0.)

### Common Box Attributes

### annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

### background [int] (default: 0)

Adds or removes the object from the patcher's background layer.

adds the object to the background layer, removes it. Objects in the background layer are shown behind all objects in the default foreground layer.### color [4 floats]

Sets the color for the object box outline.

### fontface [int]

Sets the type style used by the object. The options are:

plain

bold

italic

bold italic

Possible values:

0 = 'regular'

1 = 'bold'

2 = 'italic'

3 = 'bold italic'

### fontname [symbol]

Sets the object's font.

### fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'

'9'

'10'

'11'

'12'

'13'

'14'

'16'

'18'

'20'

'24'

'30'

'36'

'48'

'64'

'72'

### hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

### hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

### ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

### jspainterfile [symbol]

JS Painter File

### patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

### position [2 floats]

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

### presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

### presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

### rect [4 floats]

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

### size [2 floats]

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

### textcolor [4 floats]

Sets the color for the object's text in RGBA format.

### textjustification [int]

Sets the justification for the object's text.

Possible values:

0 = 'left'

1 = 'center'

2 = 'right'

### varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

## See Also

Name | Description |
---|---|

Working with Video in Jitter | Working with Video in Jitter |

jit.convolve | Convolve two matrices |

jit.glop | Produce feedback with gain staging |

jit.op | Apply binary or unary operators |

Tutorial 45: Introduction to using Jitter within JavaScript | Tutorial 45: Introduction to using Jitter within JavaScript |