Stype In CHOP

From Derivative
Jump to navigation Jump to search



License: Only available in TouchDesigner Pro.

The Stype CHOP reads camera tracking information sent from a Stype (RedSpy) device using the Stype HF protocol. The CHOP outputs channels that can be used to control a virtual camera and implement lens distortion via the Stype TOP.

The channels exported by the Stype CHOP are:

connected - 1 or 0, indicating whether the CHOP has received valid Stype messages within the last 500ms
recording - 1 or 0, indicating the recording status on the Stype Kit (see Stype protocol for more information)
focus_distance - 1 or 0, indicating how the focus field is used (see Stype protocol for more information)
hours, minutes, seconds, frames - timecode, may be zero if time information is not present
tx, ty, tz - camera position, can be connected to the Camera COMP Translate parameters
rx, ry, rz - camera rotation, can be connected to the Camera COMP Rotate parameters
fov - camera field of view, can be connected to the Camera COMP FOV Angle parameter
padded_fov - field of view expanded by the padding parameter, can be used in Camera COMP FOV Angle parameter
aspect - aspect ratio of the camera
focus - camera focus from 0 (closest) to 1 (infinite), can be used to simulate depth of field
zoom - camera zoom from 0 (wide) to 1 (tele)
centerx, centery - offset of the camera sensor in mm, used by the Stype TOP for calculating lens correction
k1, k2 - radial lens distortion parameters, used by the Stype TOP for calculating lens correction
pawidth, paheight - size of the sensor in mm, used by the Stype TOP for calculating lens correction

For more information or to diagnose connection problems, an Info CHOP can be connected to see if any packets have been dropped or skipped.

NOTE: This CHOP works with Stype hardware. For more information refer to the Stype article.

See also Stype TOP.


Parameters - Stype Page

Protocol protocol - - The network protocol to use. Refer to the Network Protocols article for more information.

  • Messaging (UDP) msging -
  • Multi-Cast Messaging (UDP) multicastmsging -
  • Reliable Messaging (UDT Library) reliablemsging -

Network Address netaddress - When using Multicast, this is the address that Stype will listen for packets on.

Network Port port - The port which the Stype CHOP will accept packets on. The default for the protocol is 6301, but this should be set to match the current hardware output settings.

Local Address localaddress - When the sending machine is equipped with multiple network adapters, this parameter can be used to choose which adapter to send the data from by specifying its IP address here.

Active active - While on, the CHOP receives information sent to the network port. While Off, no updating occurs. Data sent to the port is lost.

Padding padding - A value from 0 to 1 indicating the percentage to increase the field of view in case the given lens distortion requires samples outside of the normal render area. It is used to calculate the padded field of view and can be used to calculate the resolution of the render node.

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).

Info CHOP Channels

Extra Information for the Stype CHOP can be accessed via an Info CHOP.

Specific Stype CHOP Info Channels

  • valid_packets -
  • unrecognized_packets -
  • corrupt_packets -
  • missing_packets -
  • dropped_packets -
  • last_packet_num -

Common CHOP Info Channels

  • start - Start of the CHOP interval in samples.
  • length - Number of samples in the CHOP.
  • sample_rate - The samplerate of the channels in frames per second.
  • num_channels - Number of channels in the CHOP.
  • time_slice - 1 if CHOP is Time Slice enabled, 0 otherwise.
  • export_sernum - A count of how often the export connections have been updated.

Common Operator Info Channels

  • total_cooks - Number of times the operator has cooked since the process started.
  • cook_time - Duration of the last cook in milliseconds.
  • cook_frame - Frame number when this operator was last cooked relative to the component timeline.
  • cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
  • cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
  • cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
  • cooked_this_frame - 1 if operator was cooked this frame.
  • warnings - Number of warnings in this operator if any.
  • errors - Number of errors in this operator if any.

TouchDesigner Build:

Ableton Link • Analyze • Angle • Attribute • Audio Band EQ • Audio Binaural • 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 • Audio Stream Out • Audio VST • Audio Web Render • Beat • Bind • BlackTrax • Blend • Blob Track • Body Track • Bullet Solver • Clip Blender • Clip • Clock • Composite • Constant • Copy • Count • CPlusPlus • Cross • Cycle • DAT to • Delay • Delete • DMX In • DMX Out • Envelope • EtherDream • Event • Expression • Extend • Face Track • Fan • Feedback • File In • File Out • Filter • FreeD In • FreeD Out • Function • Gesture • Handle • Helios DAC • Hog • Hokuyo • Hold • Import Select • In • Info • Interpolate • Introduction To s Vid • Inverse Curve • Inverse Kin • Join • Joystick • Keyboard In • Keyframe • Kinect Azure • Kinect • Lag • Laser • Laser Device • Leap Motion • Leuze ROD4 • LFO • Limit • Logic • Lookup • LTC In • LTC Out • Math • Merge • MIDI In • MIDI In Map • MIDI Out • MoSys • Mouse In • Mouse Out • NatNet In • Ncam • Noise • Null • OAK Device • OAK Select • Object • Oculus Audio • Oculus Rift • OpenVR • OSC In • OSC Out • Out • Override • Panel • Pangolin • Parameter • Pattern • Perform • Phaser • Pipe In • Pipe Out • PosiStageNet • Pulse • RealSense • Record • Rename • Render Pick • RenderStream In • 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 In • Stype Out • Switch • Sync In • Sync Out • Tablet • Time Slice • Timecode • Timeline • Timer • TOP to • Touch In • Touch Out • Trail • Transform • Transform XYZ • Trigger • Experimental:Trigger • Trim • Warp • Wave • WrnchAI • ZED