Difference between revisions of "Leuze ROD4 CHOP"

From TouchDesigner Documentation
Jump to: navigation, search
(TD Editor)
(cleaning)
Line 1: Line 1:
 
{{Summary
 
{{Summary
|OPfilter=False
+
|opFilter=False
 
|long=The Leuze ROD4 CHOP connects to the [http://www.leuze.com/en/deutschland/produkte/schaltende_sensoren/flaechendeckende_sensoren_lichtschnittsensoren/laserscanner/index.php Leuze ROD4] laser scanner via TCP/IP. Blob Tracking mode allows for turning the measured distances into blobs for use as an interaction surface. It should work with any of the ROD4 scanners currently available.
 
|long=The Leuze ROD4 CHOP connects to the [http://www.leuze.com/en/deutschland/produkte/schaltende_sensoren/flaechendeckende_sensoren_lichtschnittsensoren/laserscanner/index.php Leuze ROD4] laser scanner via TCP/IP. Blob Tracking mode allows for turning the measured distances into blobs for use as an interaction surface. It should work with any of the ROD4 scanners currently available.
 
 
 
The 'object detection' mode available on some of the models is not currently supported.
 
The 'object detection' mode available on some of the models is not currently supported.
|OPlicense=Commercial
+
|opLicense=Commercial
|OPclass=leuzerod4CHOP_Class
+
|opClass=leuzerod4CHOP_Class
|OPlabel=Leuze ROD4
+
|opLabel=Leuze ROD4
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
 
|short=The Leuze ROD4 CHOP connects to the [http://www.leuze.com/en/deutschland/produkte/schaltende_sensoren/flaechendeckende_sensoren_lichtschnittsensoren/laserscanner/index.php Leuze ROD4] laser scanner via TCP/IP.
 
|short=The Leuze ROD4 CHOP connects to the [http://www.leuze.com/en/deutschland/produkte/schaltende_sensoren/flaechendeckende_sensoren_lichtschnittsensoren/laserscanner/index.php Leuze ROD4] laser scanner via TCP/IP.
 
}}
 
}}
 
{{ParameterPage
 
{{ParameterPage
|OPfamily=CHOP
+
|opFamily=CHOP
|Pagename=ROD4
+
|pageName=ROD4
 
|items=
 
|items=
{{ParToggle
+
{{Parameter|parName=active
|Parname=active
+
|parOrder=0
|Parorder=0
+
|parLabel=Active
|Parlabel=Active
+
|opFamily=CHOP
|OPfamily=CHOP
+
|opType=rod
|OPtype=rod
+
|parSummary=While on, the CHOP receives information from the scanner. While off, the network connection is disconnected and no updating occurs.
|Parsummary=While on, the CHOP receives information from the scanner. While off, the network connection is disconnected and no updating occurs.
+
|parType=
}}
+
|parReadOnly=
{{ParString
+
|parItems=
|Parname=netaddress
+
}}
|Parorder=1
+
{{Parameter|parName=netaddress
|Parlabel=Network Address
+
|parOrder=1
|OPfamily=CHOP
+
|parLabel=Network Address
|OPtype=rod
+
|opFamily=CHOP
|Parsummary=The IP address of the ROD4 scanner.
+
|opType=rod
}}
+
|parSummary=The IP address of the ROD4 scanner.
{{ParInteger
+
|parType=
|Parname=port
+
|parReadOnly=
|Parorder=2
+
|parItems=
|Parlabel=Network Port
+
}}
|OPfamily=CHOP
+
{{Parameter|parName=port
|OPtype=rod
+
|parOrder=2
|Parsummary=The network port of the scanner.
+
|parLabel=Network Port
}}
+
|opFamily=CHOP
{{ParMenu
+
|opType=rod
|Parname=rod4porotocol
+
|parSummary=The network port of the scanner.
|Paritems=
+
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 +
{{Parameter|parName=rod4porotocol
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemname=binary
 
|Itemname=binary
Line 57: Line 62:
 
}}
 
}}
 
 
|Parorder=3
+
|parOrder=3
|Parlabel=ROD4 Protocol
+
|parLabel=ROD4 Protocol
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
|Parsummary=Selects which protocol to use. This must match the protocol the scanner was set to use in the RODplussoft setup utility for the device. You may still get some sort of data if the wrong protocol is selected, but the data will be random and incorrect.
+
|parSummary=Selects which protocol to use. This must match the protocol the scanner was set to use in the RODplussoft setup utility for the device. You may still get some sort of data if the wrong protocol is selected, but the data will be random and incorrect.
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parname=inputcoordinate
+
}}
|Paritems=
+
{{Parameter|parName=inputcoordinate
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemname=polar
 
|Itemname=polar
Line 81: Line 87:
 
}}
 
}}
 
 
|Parorder=4
+
|parOrder=4
|Parlabel=Input Coordinate
+
|parLabel=Input Coordinate
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
|Parsummary=Available when using ROD4plus ASCII-Remote protocol, specifies whether to use Polar or Cartesian input coordinates. This must match the coordinate the scanner was set to use in the RODplussoft setup utility for the device.
+
|parSummary=Available when using ROD4plus ASCII-Remote protocol, specifies whether to use Polar or Cartesian input coordinates. This must match the coordinate the scanner was set to use in the RODplussoft setup utility for the device.
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parname=outputmode
+
}}
|Paritems=
+
{{Parameter|parName=outputmode
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemname=rawdata
 
|Itemname=rawdata
Line 105: Line 112:
 
}}
 
}}
 
 
|Parorder=5
+
|parOrder=5
|Parlabel=Output Mode
+
|parLabel=Output Mode
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
|Parsummary=Select Raw Data or Blob Tracking mode for output channels. The parameters below are only available in Blob Tracking mode.
+
|parSummary=Select Raw Data or Blob Tracking mode for output channels. The parameters below are only available in Blob Tracking mode.
}}
+
|parType=
{{ParInteger
+
|parReadOnly=
|Parname=maxblobs
+
}}
|Parorder=6
+
{{Parameter|parName=maxblobs
|Parlabel=Max Blobs
+
|parOrder=6
|OPfamily=CHOP
+
|parLabel=Max Blobs
|OPtype=rod
+
|opFamily=CHOP
|Parsummary=The maximum number of blobs that can be tracked.
+
|opType=rod
 +
|parSummary=The maximum number of blobs that can be tracked.
 
 
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parname=maxpointdistance
+
|parItems=
|Parorder=7
+
}}
|Parlabel=Max Point Distance in Blob
+
{{Parameter|parName=maxpointdistance
|OPfamily=CHOP
+
|parOrder=7
|OPtype=rod
+
|parLabel=Max Point Distance in Blob
|Parsummary=Two measured points from the scanner are considered to be part of the same blob if they are this distance or closer to each other. Distance is specified in meters.
+
|opFamily=CHOP
}}
+
|opType=rod
{{ParFloat
+
|parSummary=Two measured points from the scanner are considered to be part of the same blob if they are this distance or closer to each other. Distance is specified in meters.
|Parname=maxblobmovement
+
|parType=
|Parorder=8
+
|parReadOnly=
|Parlabel=Max Blob Movement
+
|parItems=
|OPfamily=CHOP
+
}}
|OPtype=rod
+
{{Parameter|parName=maxblobmovement
|Parsummary=Specified in meters. This controls the maximum distance a blob can move between successive frames and still be considered the same 'blob'.
+
|parOrder=8
}}
+
|parLabel=Max Blob Movement
{{ParMenu
+
|opFamily=CHOP
|Parname=areaofinterest
+
|opType=rod
|Paritems=
+
|parSummary=Specified in meters. This controls the maximum distance a blob can move between successive frames and still be considered the same 'blob'.
 +
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 +
{{Parameter|parName=areaofinterest
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemname=off
 
|Itemname=off
Line 161: Line 175:
 
}}
 
}}
 
 
|Parorder=9
+
|parOrder=9
|Parlabel=Area of Interest
+
|parLabel=Area of Interest
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
|Parsummary=Limits the area in which blobs are tracked.
+
|parSummary=Limits the area in which blobs are tracked.
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parname=maxdistance
+
}}
|Parorder=10
+
{{Parameter|parName=maxdistance
|Parlabel=Max Distance
+
|parOrder=10
|OPfamily=CHOP
+
|parLabel=Max Distance
|OPtype=rod
+
|opFamily=CHOP
|Parsummary=Maximum distance in which blobs are tracked when Area of Interest parameter is set to Distance Based.
+
|opType=rod
}}
+
|parSummary=Maximum distance in which blobs are tracked when Area of Interest parameter is set to Distance Based.
{{ParFloat
+
|parType=
|Parname=lowerleft
+
|parReadOnly=
|Paritems=
+
|parItems=
 +
}}
 +
{{Parameter|parName=lowerleft
 +
|parItems=
 
{{floatitem
 
{{floatitem
 
|Itemname=lowerleft1
 
|Itemname=lowerleft1
Line 193: Line 210:
 
}}
 
}}
 
 
|Parorder=11
+
|parOrder=11
|Parlabel=Lower Left Corner
+
|parLabel=Lower Left Corner
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
|Parsummary=Specifies the lower left corner of the bounding box used when Area of Interest parameter is set to Bounding Box.
+
|parSummary=Specifies the lower left corner of the bounding box used when Area of Interest parameter is set to Bounding Box.
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parname=upperright
+
}}
|Paritems=
+
{{Parameter|parName=upperright
 +
|parItems=
 
{{floatitem
 
{{floatitem
 
|Itemname=upperright1
 
|Itemname=upperright1
Line 217: Line 235:
 
}}
 
}}
 
 
|Parorder=12
+
|parOrder=12
|Parlabel=Upper Right Corner
+
|parLabel=Upper Right Corner
|OPfamily=CHOP
+
|opFamily=CHOP
|OPtype=rod
+
|opType=rod
|Parsummary=Specifies the upper right corner of the bounding box used when Area of Interest parameter is set to Bounding Box.
+
|parSummary=Specifies the upper right corner of the bounding box used when Area of Interest parameter is set to Bounding Box.
}}
+
|parType=
{{ParToggle
+
|parReadOnly=
|Parname=allowmovementoutside
+
}}
|Parorder=13
+
{{Parameter|parName=allowmovementoutside
|Parlabel=Allow Movement Outside Area
+
|parOrder=13
|OPfamily=CHOP
+
|parLabel=Allow Movement Outside Area
|OPtype=rod
+
|opFamily=CHOP
|Parsummary=When this is on, blobs detected within the Area of Interest can move outside of that area and still be tracked. When this is off blobs that move outside the area of interest will stop being tracked.
+
|opType=rod
}}
+
|parSummary=When this is on, blobs detected within the Area of Interest can move outside of that area and still be tracked. When this is off blobs that move outside the area of interest will stop being tracked.
{{ParTopRef
+
|parType=
|Parname=boundingboxmask
+
|parReadOnly=
|Paritems=
+
|parItems=
|Parorder=14
+
}}
|Parlabel=Bounding Box Mask TOP
+
{{Parameter|parName=boundingboxmask
|OPfamily=CHOP
+
|parItems=
|OPtype=rod
+
|parOrder=14
|Parsummary=Specify a TOP to use as a mask for the bounding box when Area of Interest parameter is set to Bounding Box. Any pixel with a non-zero value will be treated as part of the area of interest, any pixel that is (0,0,0) will be treated as not in the area of interest. Regardless of resolution/aspect ratio of the TOP, the TOP will be stretched to fix the bounding box specified. This TOP should '''not''' be cooking every frame as that will make the ROD4 CHOP very slow.
+
|parLabel=Bounding Box Mask TOP
}}
+
|opFamily=CHOP
{{ParFloat
+
|opType=rod
|Parname=rotate
+
|parSummary=Specify a TOP to use as a mask for the bounding box when Area of Interest parameter is set to Bounding Box. Any pixel with a non-zero value will be treated as part of the area of interest, any pixel that is (0,0,0) will be treated as not in the area of interest. Regardless of resolution/aspect ratio of the TOP, the TOP will be stretched to fix the bounding box specified. This TOP should '''not''' be cooking every frame as that will make the ROD4 CHOP very slow.
|Parorder=15
+
|parType=
|Parlabel=Rotate Incoming Coordinates
+
|parReadOnly=
|OPfamily=CHOP
+
}}
|OPtype=rod
+
{{Parameter|parName=rotate
|Parsummary=
+
|parOrder=15
}}
+
|parLabel=Rotate Incoming Coordinates
 +
|opFamily=CHOP
 +
|opType=rod
 +
|parSummary=
 +
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 
 
|Pagesummary=
+
|pageSummary=
 
}}
 
}}
 
{{:CHOP Generator Common Page
 
{{:CHOP Generator Common Page
Line 256: Line 281:
 
}}
 
}}
 
{{CHOPNavBox
 
{{CHOPNavBox
|OPfamily=CHOP
+
|opFamily=CHOP
 
}}
 
}}
 
{{#invoke:Category
 
{{#invoke:Category
 
|list|CHOPs}}
 
|list|CHOPs}}

Revision as of 16:42, 24 January 2019

Summary
[edit]

Note: Only available in TouchDesigner Educational, TouchDesigner Commercial and TouchDesigner Pro.

The Leuze ROD4 CHOP connects to the Leuze ROD4 laser scanner via TCP/IP. Blob Tracking mode allows for turning the measured distances into blobs for use as an interaction surface. It should work with any of the ROD4 scanners currently available.

The 'object detection' mode available on some of the models is not currently supported.

PythonIcon.pngleuzerod4CHOP_Class


Parameters - ROD4 Page

Active active - While on, the CHOP receives information from the scanner. While off, the network connection is disconnected and no updating occurs.  

Network Address netaddress - The IP address of the ROD4 scanner.  

Network Port port - The network port of the scanner.  

ROD4 Protocol rod4porotocol - - Selects which protocol to use. This must match the protocol the scanner was set to use in the RODplussoft setup utility for the device. You may still get some sort of data if the wrong protocol is selected, but the data will be random and incorrect.

Input Coordinate inputcoordinate - - Available when using ROD4plus ASCII-Remote protocol, specifies whether to use Polar or Cartesian input coordinates. This must match the coordinate the scanner was set to use in the RODplussoft setup utility for the device.

Output Mode outputmode - - Select Raw Data or Blob Tracking mode for output channels. The parameters below are only available in Blob Tracking mode.

Max Blobs maxblobs - The maximum number of blobs that can be tracked.  

Max Point Distance in Blob maxpointdistance - Two measured points from the scanner are considered to be part of the same blob if they are this distance or closer to each other. Distance is specified in meters.  

Max Blob Movement maxblobmovement - Specified in meters. This controls the maximum distance a blob can move between successive frames and still be considered the same 'blob'.  

Area of Interest areaofinterest - - Limits the area in which blobs are tracked.

Max Distance maxdistance - Maximum distance in which blobs are tracked when Area of Interest parameter is set to Distance Based.  

Lower Left Corner lowerleft - - Specifies the lower left corner of the bounding box used when Area of Interest parameter is set to Bounding Box.

Upper Right Corner upperright - - Specifies the upper right corner of the bounding box used when Area of Interest parameter is set to Bounding Box.

Allow Movement Outside Area allowmovementoutside - When this is on, blobs detected within the Area of Interest can move outside of that area and still be tracked. When this is off blobs that move outside the area of interest will stop being tracked.  

Bounding Box Mask TOP boundingboxmask - Specify a TOP to use as a mask for the bounding box when Area of Interest parameter is set to Bounding Box. Any pixel with a non-zero value will be treated as part of the area of interest, any pixel that is (0,0,0) will be treated as not in the area of interest. Regardless of resolution/aspect ratio of the TOP, the TOP will be stretched to fix the bounding box specified. This TOP should not be cooking every frame as that will make the ROD4 CHOP very slow.  

Rotate Incoming Coordinates rotate -  


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

TouchDesigner Build:

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

Each SOP has a list of Points. Each point has an XYZ 3D position value plus other optional attributes. Each polygon Primitive is defined by a vertex list, which is list of point numbers.

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.

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.

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.

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.