Last modified: 2013-3-2

Class JitterMatrix

The jit.matrix object is a named matrix which may be used for data storage and retrieval, resampling, and matrix type and planecount conversion operations.

Class Summary
Constructor Attributes	Constructor Name and Description
	JitterMatrix() The jit.matrix object is a named matrix which may be used for data storage and retrieval, resampling, and matrix type and planecount conversion operations.

Field Summary
Field Attributes	Field Name and Description
Number	adapt Matrix adaptation flag.
Object	dim The dimensions of matrix data.
Object	dimstride The byte stride per dimension.
Object	dstdimend The destination dimension end position.
Object	dstdimstart The destination dimension start position.
Number	interp Matrix interpolation flag.
string	name The name of the matrix.
Number	planecount The number of planes in matrix data.
Object	planemap Maps input places to output planes.
Number	size Total byte size of matrix.
Object	srcdimend The source dimension end position.
Object	srcdimstart The source dimension start position.
string	type The matrix data type.
Number	usedstdim Destdim use flag.
Number	usesrcdim Srcdim use flag.

Fields borrowed from class Maxobj:: background, canhilite, colorindex, fontface, fontname, fontsize, hidden, hint, ignoreclick, js, maxclass, nextobject, patcher, rect, selected, valid, varname

Method Summary
Method Attributes	Method Name and Description
void	bang() Outputs the currently stored matrix.
void	clear() Sets all matrix values to zero.
void	exportimage(filename, file-type, use-dialog) Export the current frame as an image file with the name specified by the first argument.
void	exportmovie(filename, FPS, codec, quality, timescale) Exports a matrix as a QuickTime movie.
void	exprfill(plane, expression) Evaluates expression to fill the matrix.
void	fillplane(plane, value) The word fillplane, followed by an integer that specifies a plane number and a value, will fill the specified plane with the single value.
void	float(values) Sets all cells to the value specified by value(s) and output the data.
void	getcell(position) Sends the value(s) in the cell specified by position out the right outlet of the object as a list in the form cell cell-position0.
void	importmovie(filename, time_offset) Imports a QuickTime movie into the matrix.
void	int(values) Sets all cells to the value specified by value(s) and output the data.
void	jit_gl_texture(texture_name) Copies the texture specified by texture-name to the matrix.
void	list(values) Sets all cells to the value specified by value(s) and output the data.
void	op() The word op, followed by the name of a jit.op object operator and a set of values, is equivalent to including a jit.op object with the specified operator set as an attribute and this jit.matrix object specified as the output matrix.
void	read(filename) Reads Jitter binary data files (.jxf) into a matrix set.
void	setall(values) Sets all cells to the value specified by value(s).
void	setcell(position, plane, plane-number, val, values) Sets the cell specified by position to the value specified by value.
void	setcell1d() The word setcell1d, followed by a number specifying an x coordinate and a list of values, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (1) is fixed.
void	setcell2d() The word setcell2d, followed by a pair of numbers specifying x and y coordinates and a list of values, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (2) is fixed.
void	setcell3d() The word setcell3d, followed by three numbers specifying x, y, and z coordinates and a list of values, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (3) is fixed.
void	setplane1d() The word setplane1d, followed by a number specifying an x coordinate, a number specifying a plane, and a value, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (1) is fixed, or use the "plane" token to specify which plane to set.
void	setplane2d() The word setplane2d, followed by a pair of numbers specifying x and y coordinates, a number specifying a plane, and a value, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (2) is fixed, or use the "plane" token to specify which plane to set.
void	setplane3d() The word setplane3d, followed by three numbers specifying x, y, and z coordinates, a number specifying a plane, and a value, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (1) is fixed, or use the "plane" token to specify which plane to set.
void	val(values) Sets all cells to the value specified by value(s).
void	write(filename) Writes matrix set as a Jitter binary data file (.jxf).

Methods borrowed from class JitterObject:: freepeer, getregisteredname
Methods borrowed from class Maxobj:: annotation, color, help, message, notify, subpatcher, understands

Class Detail

JitterMatrix

()

The jit.matrix object is a named matrix which may be used for data storage and retrieval, resampling, and matrix type and planecount conversion operations.

Field Detail

{Number}

adapt

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.

{Object}

dim

The dimensions of matrix data. (default = 1 1)

{Object}

dimstride

The byte stride per dimension.

{Object}

dstdimend

The destination dimension end position. (default = all dim values minus 1)

{Object}

dstdimstart

The destination dimension start position. (default = all 0)

{Number}

interp

Matrix interpolation flag. (default = 0) When the flag is set, the input matrix will be interpolated when copied to the internal matrix.

{string}

name

The name of the matrix. (default = UID)

{Number}

planecount

The number of planes in matrix data. (default = 4)

{Object}

planemap

Maps input places to output planes. (default = 0 1 2 3 ...)

{Number}

size

Total byte size of matrix.

{Object}

srcdimend

The source dimension end position. (default = all dim values minus 1)

{Object}

srcdimstart

The source dimension start position. (default = all 0)

{string}

type

The matrix data type. (default = char)

char: Char data (0-255)
long: Long data
float32: 32-bit floating-point data
float64: 64-bit floating-point data

{Number}

usedstdim

Destdim use flag. (default = 0) When the flag is set, the destination dimension's attributes are used when copying an input matrix to an internal matrix.

{Number}

usesrcdim

Srcdim use flag. (default = 0) When the flag is set, the source dimension's attributes are used when copying an input matrix to an internal matrix.

Method Detail

{void}

bang

()

Outputs the currently stored matrix.

{void}

clear

()

Sets all matrix values to zero.

{void}

exportimage

(filename, file-type, use-dialog)

Export the current frame as an image file with the name specified by the first argument. The optional second argument sets the file type (default = png). Available file types are png, bmp, jpeg, macpaint, photoshop, pict, qtimage, sgi, tga and tiff. An optional use-dialog argument of 1 will open a file dialog to allow you to enter the image file settings.

Parameters:
{String} filename
{String} file-type
{Integer} use-dialog

{void}

exportmovie

(filename, FPS, codec, quality, timescale)

Exports a matrix as a QuickTime movie. The exportmovie message takes an optional argument to specify a file name. If no filename is specified, a file dialog will open to let you choose a file.

The default FPS is 30. frames per second

The default codec is raw. Supported codecs are raw, cinepak, graphics, animation, video, componentvideo, jpeg, mjpega, mjpegb, sgi, planarrgb, macpaint, gif, photocd, qdgx, avrjpeg, opendmljpeg, bmp, winraw, vector, qd, h261, h263, dvntsc, dvpal, dvprontsc, dvpropal, flc, targa, png, tiff, componentvideosigned, componentvideounsigned, cmyk, microsoft, sorenson, indeo4, argb64, rgb48, alphagrey32, grey16, mpegyuv420, yuv420, and sorensonyuv9.

The default quality is max. Supported quality settings are lossless, max, min, low, normal, and high.

Note that minimum quality is, in many cases, the codec's default quality. Use "low" quality for consistent results.

The default timescale is 600 units per second.

Parameters:
{String} filename
{Float} FPS
{String} codec
{String} quality
{Integer} timescale

{void}

exprfill

(plane, expression)

Evaluates expression to fill the matrix. If a plane argument is provided, the expression is applied to a single plane. Otherwise, it is applied to allphanes in the matrix. See jit.expr for more information on expressions. Unlike the jit.expr object, there is no support for providing multiple expressions to fill multiple planes at once with different expressions. Call this method multiple times once for each plane you wish to fill.

Parameters:
{Integer} plane
{String} expression

{void}

fillplane

(plane, value)

The word fillplane, followed by an integer that specifies a plane number and a value, will fill the specified plane with the single value.

Parameters:
{Integer} plane
{Integer} value

{void}

float

(values)

Sets all cells to the value specified by value(s) and output the data. Value is specified as a list whose length is equal to the number of dimensions (dimcount).

Parameters:
{Float Array} values

{void}

getcell

(position)

Sends the value(s) in the cell specified by position out the right outlet of the object as a list in the form cell cell-position0... cell-positionN val plane0-value... planeN-value.

Parameters:
{Integer Array} position

{void}

importmovie

(filename, time_offset)

Imports a QuickTime movie into the matrix. If no filename is specified, a file dialog will open to let you choose a file. The time-offset argument may be used to set a time offset for the QuickTime movie being imported (the default is 0).

Parameters:
{String} filename
{Integer} time_offset

{void}

int

(values)

Sets all cells to the value specified by value(s) and output the data. Position is specified of a list whose length is equal to the number of dimensions (dimcount).

Parameters:
{Integer Array} values

{void}

jit_gl_texture

(texture_name)

Copies the texture specified by texture-name to the matrix.

Parameters:
{String} texture_name

{void}

list

(values)

Sets all cells to the value specified by value(s) and output the data. Position is specified of a list whose length is equal to the number of dimensions (dimcount).

Parameters:
{Array} values

{void}

op

()

The word op, followed by the name of a jit.op object operator and a set of values, is equivalent to including a jit.op object with the specified operator set as an attribute and this jit.matrix object specified as the output matrix. The additional value arguments may either be a matrix name or a constant. If only one value argument is provided, this matrix is considered both the output and the left operand. For example, "op + foo bar" is equivalent to the operation thismatrix = foo + bar, and "op * 0.5" is equivalent to the operation thismatrix = thismatrix * 0.5.

{void}

read

(filename)

Reads Jitter binary data files (.jxf) into a matrix set. If no filename is specified, a file dialog will open to let you choose a file.

Parameters:
{String} filename

{void}

setall

(values)

Sets all cells to the value specified by value(s). Position is specified of a list whose length is equal to the number of dimensions (dimcount).

Parameters:
{Array} values

{void}

setcell

(position, plane, plane-number, val, values)

Sets the cell specified by position to the value specified by value. Position is specified of a list whose length is equal to the number of dimensions (dimcount). The optional arguments plane plane-number can be used to specify a plane. If a plane is specified, value should be a single number, otherwise it should be a list of numbers of size planecount - 1.

Parameters:
{Array} position
{Integer} plane
{Integer} plane-number
{mixed} val
{Array} values

{void}

setcell1d

()

The word setcell1d, followed by a number specifying an x coordinate and a list of values, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (1) is fixed.

{void}

setcell2d

()

The word setcell2d, followed by a pair of numbers specifying x and y coordinates and a list of values, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (2) is fixed.

{void}

setcell3d

()

The word setcell3d, followed by three numbers specifying x, y, and z coordinates and a list of values, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (3) is fixed.

{void}

setplane1d

()

The word setplane1d, followed by a number specifying an x coordinate, a number specifying a plane, and a value, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (1) is fixed, or use the "plane" token to specify which plane to set.

{void}

setplane2d

()

The word setplane2d, followed by a pair of numbers specifying x and y coordinates, a number specifying a plane, and a value, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (2) is fixed, or use the "plane" token to specify which plane to set.

{void}

setplane3d

()

The word setplane3d, followed by three numbers specifying x, y, and z coordinates, a number specifying a plane, and a value, is similar to the setcell message but without the need to use a "val" token to separate the coordinates from the value since the dimension count (1) is fixed, or use the "plane" token to specify which plane to set.

{void}

val

(values)

Sets all cells to the value specified by value(s). Position is specified of a list whose length is equal to the number of dimensions (dimcount) and outputs the data.

Parameters:
{Array} values

{void}

write

(filename)

Writes matrix set as a Jitter binary data file (.jxf). If no filename is specified, a file dialog will open to let you choose a file.

Parameters:
{String} filename

Classes

Max/MSP Jitter Javascript Reference

Class JitterMatrix

JitterMatrix

adapt

dim

dimstride

dstdimend

dstdimstart

interp

name

planecount

planemap

size

srcdimend

srcdimstart

type

usedstdim

usesrcdim

bang

clear

exportimage

exportmovie

exprfill

fillplane

float

getcell

importmovie

int

jit_gl_texture

list

op

read

setall

setcell

setcell1d

setcell2d

setcell3d

setplane1d

setplane2d

setplane3d

val

write