GridFlow 0.6.5 - reference index

Objects for Input/Output

• 
• 
• 
• 
• 
• @export_symbol
• 
• 
• 

Objects for Generating

Objects for Computing

• 
• 
• @complex_sq
• 
• @scan
• 
• 
• 
• @join
• @finished

Objects for Coordinate Transforms

• 
• 
• 
• 
• 
• @downscale_by
• 
• @apply_colormap_channelwise
• @rgb_to_greyscale
• @greyscale_to_rgb

Objects for Reporting

• 
• @print
• rubyprint
• printargs

Objects for Picture Processing

• 
• 
• 
• @solarize
• @checkers
• @layer
• @draw_polygon

Special Objects

• rtmetro
• pingpong
• 
• fps

External Picture Formats

• 
• 
• format jpeg @in/@out
• 
• 
• 
• format sdl @out
• 
• aalib @out

Objects for Scripting

• ruby class FObject extending Data
• ruby class GridObject extending FObject
• ruby class BitPacking
• FPatcher extending FObject

Objects for Internals

• C++ class GridInlet
• C++ class GridOutlet
• C++ class Dim
• C++ class Grid
• C++ class Operator1
• C++ class Operator2
• C++ class GridClass
• C++ class GFBridge

Objects for Input/Output

This object allows you to import non-grid jMax data, such as integers and lists of integers. This object also reframes/resyncs integers and grids so that multiple grids may be joined together, or single grids may be split.

this object is the opposite of @import.

this object is another opposite of @import, which puts all of its values in a jMax list.

this object is another opposite of @import, which puts all of its values in a jMax list.

holds two values, defaulting to (0,0). each time one is changed (by sending an integer in that inlet), a Dim(2) grid of those values is sent through the outlet.

holds three values, defaulting to (0,0,0). each time one is changed (by sending an integer in that inlet), a Dim(3) grid of those values is sent through the outlet.

holds four values, defaulting to (0,0,0,0). each time one is changed (by sending an integer in that inlet), a Dim(4) grid of those values is sent through the outlet.

Objects for Generating

when given scalar bounds, works like a regular [for] object plugged to a [@import] tuned for a Dim(size) where size is the number of values produced by a bang to that [for].

when given vector bounds, will work like any number of [for] objects producing all possible combinations of their values in the proper order. This replaces the old [@identity_transform] object.

Objects for Computing

This object outputs a grid by computing "in parallel" a same operation on each left-hand element with its corresponding right-hand element. This is a massively parallel version of jMax's builtin arithmetic operators. In case you wonder, it's only parallel in the sense that all those computations are independent; there's no guarantee about how many of them will actually be computed at once.

This object computes a grid by computing "in parallel" a same operation on each element of the grid.

this object computes the square of complex numbers. If seeing imaginary as Y and real as X, then this operation squares the distance of a point from origin and doubles the angle between it and the +X half-axis clockwise. (fun, eh?)

used on an indexmap, this makes each thing appear twice, spanning half of the original angle.

• 1 : [@fold +] computes totals
• 2 : [@fold inv+] is an alternated sum (+/-)
• 3 : [@fold * 1] can compute the size of a grid using its dimension list
• 4 : [@fold & 1] can mean "for all"
• 5 : [@fold | 0] can mean "there exists (at least one)"
• 6 : [@fold ^ 0] can mean "there exists an odd number of..."
• 7 : [@fold ^ 1] can mean "there exists an even number of...".

[@scan +] computes subtotals.

When given a grid of Dim(3) and a grid of Dim(5) [@outer] will produce a grid of Dim(3,5) with the selected two-input operation applied on each of the possible pairs combinations between numbers from the left grid and the ones from the right. for example : (10,20,30) [@outer +] (1,2,3) will give : ((11,12,13),(21,22,23),(31,32,33))

think of this one as a special combination of [@outer], [@] and [@fold]. this is one of the most complex operations. It is very useful for performing linear transforms like rotations, scalings, tilts, and color remappings. A linear transform is done by something called matrix multiplication, which happens to be [@inner * + 0].

This object has been renamed from @inner to @inner2 because a different @inner object will be added in the future.

a variant on @inner.

This object used to be called @inner.

NOT IMPLEMENTED

Objects for Coordinate Transforms

example: with a 240 320 RGB image, @redim 120 640 3 will visually separate the even lines (left) from the odd lines (right). contrary to this, @redim 640 120 3 will split every line and put its left half on a even line and the right half on the following odd line. @redim 480 320 3 will repeat the input image twice in the output image. @redim 240 50 3 will only keep the 50 top lines.

A @store object can store exactly one grid, using the right inlet. You fetch it back, or selected subparts thereof, using the left inlet.

OBSOLETE AND REMOVED. USE @for INSTEAD.

@scale_to is normally fed the same inlet 1,2 values as @identity_transform, and chained from @identity_transform and to @store. This will scale an image of any size to the size specified in inlets 1,2. If it doesn't correspond the values of @identity_transform, part of the image will be trimmed and/or duplicated.

typically you plug a @for into this object, and you plug this object into the left side of a @store. it will scatter pixels around, giving an "unpolished glass" effect.

if you put a picture in it, however, it will add noise. The resulting values may be out of range, so you may need to clip them using min/max.

@spread scatters the pixels in an image. Not all original pixels will appear, and some may get duplicated (triplicated, etc) randomly. Some wrap-around effect will occur close to the edges.

Sending an integer to inlet 1 sets the amount of spreading in maximum number of pixels + 1. even values translate the whole image by half a pixel due to rounding.

This object is useful for color correction. For each pixel it takes it apart, looks up each part separately in the colormap, and constructs a new pixel from that

Objects for Reporting

Returns list of dimensions as a grid. Given a grid sized like Dim(240,320,4), @dim will return a grid like Dim(3), whose values are 240, 320, 4.

Objects for Picture Processing

this is the object for blurring, sharpening, finding edges, embossing, and many other uses.

@contrast adjusts the intensity in an image. resulting values outside 0-255 are automatically clipped.

@posterize reduces the number of possible intensities in an image; it rounds the color values.The effect is mostly apparent with a low number of levels.

example: simulate the 216-color "web" palette using 6 levels. simulate a 15-bit display using 32 levels.

makes medium intensities brightest; formerly brightest colours become darkest; formerly darkest stays darkest. This filter is linear: it's like a 200% contrast except that overflows are mirrored instead of clipped or wrapped.

Special Objects

objects of this class do nothing by themselves and are just an access point to features that don't belong to any object in particular.

External Picture Formats

Subformat P6 only. Max-number can only be 255 (24-bit RGB).

Support for RGB-24 (3 channels) and RGBA-32 (4 channels)

Support for RGB non-progressive

Support for MPEG Video Stream only. Does not support MPEG System Stream (that is, files that contain both audio and video).

Can only open one file at once (libmpeg.so limitation). May scream error messages in a rude way.

By opposition to PPM and TARGA, this format driver only allows a single MPEG stream per file (you cannot "cat" several MPEG files together).

Rewind / Frame Select not supported.

This is GridFlow's special file format. This is the only I/O format that can hold absolutely anything that the [@store] object can. However this can only be stored in 32 bits-per-value.

This is the only picture format that currently supports TCP connections. This is still somewhat clunky: the socket only opens in client mode only; and upon bang, jMax freezes until the whole grid is received.

When writing "raw" data, a file may be considered a long string of base 256 digits (called bytes), but different computers have different conventions for dealing with them:
method option endian big () A number will be written starting with the biggest digit. This is the natural way on the Macintosh, Sun, Amiga, and so on.

method option endian little () A number will be written starting with the smallest digit. This is the natural way on the Intel 386/Pentium.

method option endian same () A number will be written in whichever way is more natural on this computer. The natural way is slightly faster to handle. This is the default setting.

Video4Linux-1 devices, RGB-24 only. Variable picture size. should work for bttv based cards and the dc1/dc10plus from Miro.

If you suffer from color inversion, you may feed the list "3 3 # 0 0 1 0 1 0 1 0 0" to the right side of a [@inner2 * + 0]. Use that @inner2 object as a RGB-BGR converter.

color adjustments:
method option brightness (0-65535 level)

method option hue (0-65535 level)

method option colour (0-65535 level)

method option contrast (0-65535 level)

method option whiteness (0-65535 level)

other options:
method option channel (integer )

method option tuner (integer )

method option norm (integer )

method option frequency (integer )

method option transfer mmap () This is the normal (and fast) way of transferring pictures from the camera.

method option transfer read () Some cameras/drivers only support this instead of mmap.

method option size (height, width) sets the input size, especially when using a video digitalizer device

Destroying the object (or sending "close") should close the window. Because of how jMax works, this may be delayed until you do something else.

because of the design of Xlib, or if any of the connections involved crashes, then the whole program (fts) has to be terminated. (don't you love xlib). Something similar happens if you close any of the windows yourself, but IIRC this could be fixed.

only one window may be used per connection (to simplify matters; this doesn't reduce flexibility).

there is an additional argument that may be added to every "open" message; if you don't put it, a new toplevel window is created. if you put "root" then the screen's wallpaper will be used instead (it may fail to work with some popular window managers). You can also put a window number, e.g. 0x28003ff, you may connect to an existing window; you can find out the number of a window by using a tool like xwininfo, part of X11 standard tools.

• 0 : option draw() is never automatically invoked
• 1 : option draw() is invoked after each grid is finished
• 2 : option draw() is invoked incrementally after each row is received. (but buffering may cause lines to come in groups anyway)

• 0 : Shift
• 1 : CapsLock
• 2 : Control
• 3 : Alternate
• 4 : NumLock
• 5 : ???
• 6 : Meta
• 7 : ScrollLock
• 8 : Left Button
• 9 : Middle Button
• 10 : Right Button
• 11 : Wheel Up
• 12 : Wheel Down

Objects for Scripting

This class is much like jMax's templates and subpatchers and PureData's abstractions.

This is a container for objects. Its proper objects are numbered starting with zero. The wire list is given in terms of those numbers: (sourceobject,sourceinlet,destobject,destinlet). There is a pseudo-object numbered #-1 which map to the container's own inlets and outlets.

Objects for Internals

• 1 : map() applies the operator over a memory segment, using a single righthand value. (This is like [@] with a scalar righthand)
• 2 : zip() applies the operator over a memory segment, using a same-sized memory segument as the righthand value. (This is like [@] with a nonscalar righthand)
• 3 : fold() applies the operator in a chained way, computing a single value from a memory segment and a seed value. (this is like @fold with a scalar righthand)
• 4 : fold2() applies the operator in a chained way, over a seed memory segment, chaining in a memory segment of segments. (this is like @fold with a nonscalar righthand)
• 5 : scan() is like @scan with a scalar righthand.
• 6 : scan2() is like @scan with a nonscalar righthand.

GridFlow 0.6.5 Documentation
by Mathieu Bouchard matju@sympatico.ca and
Alexandre Castonguay acastonguay@artengine.ca