Pattern CHOP

From TouchDesigner Documentation
Jump to: navigation, search


The Pattern CHOP generates a sequence of samples in a channel. Unlike the Wave CHOP its purpose is generating arrays of samples that have no reference to time (seconds or frames).

It is useful for curve generation like lookup tables, simple shapes that can be converted to SOPs, generating channels that are passed to the Geometry COMP to generate instances, and other non-time-based curve-generation, with as little need to make expressions in Python.

All defaults are in samples, not seconds or frames (though like all CHOPs, it carries with it a sample rate). There is no start-end, just Length in samples.

Tip: To display a CHOP viewer in the units of samples, make the Viewer Active and change RMB -> Units to be Samples.

The Pattern CHOP optionally takes one input CHOP to match the length and sample rate, and, choosing via the Combine Channels menu, Appends or Inserts the new channel(s), Replaces the incoming channels, Adds to the incoming channels or Multiplies the incoming channels.

The Pattern CHOP defaults to one cycle of the curve over the length of the CHOP, no matter how many samples long.

Tip: Customizing each channel: The python object for Pattern has a chanIndex member, so if Pattern generates three channels you can put something like [1, 3, 7][me.chanIndex] in any parameter to customize its value for each channel.


Parameters - Pattern Page

Type wavetype - - The shape of one cycle of the pattern.

  • Constant const - (1)
  • Sine sin - (-1 to 1)
  • Cosine cos - (-1 to 1)
  • Triangle tri - (-1 to 1)
  • Ramp ramp - (0-1)
  • Ramp Samples rampsamples - (0 to numSamples-1)
  • Square square - (-1 to -1)
  • Pulse pulse - (0-1)
  • Random random - (0-1)
  • Random per Cycle randomcycle - All samples in a cycle will have the same randomly generated value.
  • Random Non-Repeating Integers randomnonrepint - This wave type is used in conjunction with the Randomize pulse. Between each Randomize pulse, the random values at each sample will be non-repeating. For example in the simplest case with a channel length of 1, each time Randomize is pulsed the random value of sample 1 after the pulse will be different than the random value before the pulse.
  • Step step -

Length length - Set the number of samples for this CHOP.

Number of Cycles numcycles - Set the number of repeating cycles of the Type shapes over the Length, except for Random.

Bias bias - Makes Triangle type into a sawtooth wave, and sets the Square type variable-width.

Seed seed - The seed for the random Types.

Phase phase - Shifts the cycle.

Phase Step phasestep - Increases the phase for each channel. A Phase Step of .25 when there are 2 channels will shift the second channel to be 1/4 cycle later phase than the first phase, where if the 2 channels are used for x and y, will draw a circle when passed to a CHOP to SOP.

Taper taper - - Two parameters to multiply by a line from taper1 at the start to taper2 at the end. The default of (1 1) has no effect.

  • taper1 -
  • taper2 -

Taper Decay Rate taperdecay - An exponent that is applied to the result of the taper.

Amplitude amp - See also the Range.

Offset offset - See also the Range.

From Range fromrange - - A value at each From Range will become its corresponding To Range value.

  • fromrange1 -
  • fromrange2 -

To Range torange - - A value at each From Range will become its corresponding To Range value.

  • torange1 -
  • torange2 -

Integer integer - - A round-off menu to convert all numbers to integers.

  • Off off -
  • Ceiling ceiling -
  • Floor floor -
  • Round round -

Reverse reverse - Reverses the final order of the samples as in the Stretch CHOP.

Randomize randomize - When the Type parameter above is set to Random Non-Repeating Integers, this trigger will randomize all the values.

Parameters - Channel Page

Channel Names channelname - You can creates many channels with simple patterns like chan[1-20], which generates 20 channels from chan1 to chan20, or t[xyz] which generates tx, ty and tz. See the section, Common CHOP Parameters for a description of this and all Options. See Scope and Channel Name Matching Options.

Combine Channels combine - - If an input CHOP is attached, it adopts the length and sample rate of the input CHOP, and

  • Off off - It only adopts the length and sample rate of the input.
  • Append append - It appends the new Pattern CHOP channels after the last incoming channel.
  • Insert insert - It inserts the new channels before the first incoming channel.
  • Replace replace - It replaces the incoming channels using channel-name-matching.
  • Add add - It adds incoming channels to the generated channels, matching by channel-name-matching.
  • Multiply multiply - It multiplies incoming channels with the generated channels, matching by channel-name-matching.

Sample Rate rate - The sample rate of the channels, in samples per second.

Extend Left left - - The left right extend conditions (before/after range).

  • Hold hold - Hold the current value of the channel.
  • Slope slope - Continue the slope before the start of the channel.
  • Cycle cycle - Cycle the channel repeatedly.
  • Mirror mirror - Cycle the channel repeatedly, mirroring every other cycle.
  • Default Value default - Use the constant value specified in the Default Value parameter.

Extend Right right - - The right extend conditions (before/after range).

  • Hold hold - Hold the current value of the channel.
  • Slope slope - Continue the slope after the end of the channel.
  • Cycle cycle - Cycle the channel repeatedly.
  • Mirror mirror - Cycle the channel repeatedly, mirroring every other cycle.
  • Default Value default - Use the constant value specified in the Default Value parameter.

Default Value defval - The value used for the Default Value extend condition.

Parameters - Common Page

Time Slice timeslice - Turning this on forces the channels to be "Time Sliced". A Time Slice is the time between the last cook frame and the current cook frame.

Scope scope - To determine which channels get affected, some CHOPs use a Scope string on the Common page.

Sample Rate Match srselect - - Handle cases where multiple input CHOPs' sample rates are different. When Resampling occurs, the curves are interpolated according to the Interpolation Method Option, or "Linear" if the Interpolate Options are not available.

  • Resample At First Input's Rate first - Use rate of first input to resample others.
  • Resample At Maximum Rate max - Resample to the highest sample rate.
  • Resample At Minimum Rate min - Resample to the lowest sample rate.
  • Error If Rates Differ err - Doesn't accept conflicting sample rates.

Export Method exportmethod - - This will determine how to connect the CHOP channel to the parameter. Refer to the Export article for more information.

  • DAT Table by Index datindex - Uses the docked DAT table and references the channel via the index of the channel in the CHOP.
  • DAT Table by Name datname - Uses the docked DAT table and references the channel via the name of the channel in the CHOP.
  • Channel Name is Path:Parameter autoname - The channel is the full destination of where to export to, such has geo1/transform1:tx.

Export Root autoexportroot - This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.

Export Table exporttable - The DAT used to hold the export information when using the DAT Table Export Methods (See above).

Operator Inputs

  • Input 0 -

TouchDesigner Build:

Ableton Link • Analyze • Angle • Attribute • Audio Band EQ • Audio Device In • Audio Device Out • Audio Dynamics • Audio File In • Audio File Out • Audio Filter • Audio Movie • Audio NDI • Audio Oscillator • Audio Para EQ • Audio Play • Audio Render • Audio Spectrum • Audio Stream In • Experimental:Audio Stream In • Audio Stream Out • Beat • Bind • BlackTrax • Blend • Blob Track • Bullet Solver • Clip Blender • Clip • Clock • Composite • Constant • Copy • Count • CPlusPlus • Cross • Cycle • DAT to • Delay • Delete • DMX In • Experimental:DMX In • DMX Out • Envelope • EtherDream • Event • Expression • Extend • Fan • Feedback • File In • File Out • Filter • Experimental:Filter • Experimental:FreeD • Function • Gesture • Handle • Helios DAC • Hog • Hokuyo • Hold • Import Select • In • Info • Interpolate • Introduction To CHOPs id • Inverse Curve • Inverse Kin • Join • Joystick • Keyboard In • Keyframe • Kinect Azure • Experimental:Kinect Azure • Kinect • Lag • Laser • Leap Motion • Leuze ROD4 • LFO • Limit • Logic • Lookup • LTC In • LTC Out • Math • Experimental:Math • Merge • MIDI In • MIDI In Map • MIDI Out • Mouse In • Mouse Out • NatNet In • Noise • Null • Object • Oculus Audio • Oculus Rift • OpenVR • Experimental:OpenVR • OSC In • OSC Out • Out • Override • Panel • Pangolin • Parameter • Pattern • Perform • Experimental:Phaser • Pipe In • Pipe Out • PosiStageNet • Pulse • RealSense • Experimental:RealSense • Record • Rename • Render Pick • Reorder • Replace • Resample • S Curve • Scan • Script • Select • Sequencer • Serial • Shared Mem In • Shared Mem Out • Shift • Shuffle • Slope • SOP to • Sort • Speed • Splice • Spring • Stretch • Stype • Switch • Sync In • Sync Out • Tablet • Time Slice • Timeline • Timer • TOP to • Experimental:TOP to • Touch In • Touch Out • Trail • Transform • Transform XYZ • Trigger • Trim • Warp • Wave • Experimental:WrnchAI • ZED

An Operator Family which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

To pulse a parameter is to send it a signal from a CHOP or python or a mouse click that causes a new action to occur immediately. A pulse via python is via the .pulse() function on a pulse-type parameter, such as Reset in a Speed CHOP. A pulse from a CHOP is typically a 0 to 1 to 0 signal in a channel.

An Operator Family that reads, creates and modifies 3D polygons, curves, NURBS surfaces, spheres, meatballs and other 3D surface data.

samples-per-second of a CHOP. Each CHOP in your network has a sample rate, whether it is used or not. The overall timeline has a "frame rate", which is the number of animation frames per second, generally your monitor display frequency.

A Time Slice is the time from the last cook frame to the current cook frame. In CHOPs it is the set of short channels that only contain the CHOP channels' samples between the last and the current cook frame.

A parameter in most CHOPs that restricts which channels of that CHOP will be affected. Normally all channels of a CHOP are affected by the operator.

Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the CHOP Viewer is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See Parameter.

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

The location of an operator within the TouchDesigner environment, for example, /geo1/torus1, a node called torus1 in a component called geo1. The path / is called Root. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

Parameters in TouchDesigner are an operator's settings (numbers, menus, flags, strings, paths) which the user can alter. Parameters for any operator can be opened by right-clicking on the operator and selecting "Parameters..." A currently selected operator's parameters can be viewed in a Network Editor by pressing the keyboard shortcut 'p'.

TouchDesigner is a hierarchy of components. "root" is the top-most network in the hierarchy. The Path is simply /. A typical path is /project1/moviein1.