ParametriceqCHOP Class

From Derivative
Jump to: navigation, search

This class inherits from the CHOP class. It references a specific Parametric EQ CHOP.


Members[edit]

chanIndex (Read Only) The index of the current channel being evaluated.

sampleIndex (Read Only) The index of the current sample being evaluated.


Methods[edit]

No operator specific methods.

CHOP Class[edit]

Members[edit]

As these attributes are dependent on each other, set the rate and start (or startTime) attributes, before the len, end (or endTime) attributes.

numChansint (Read Only):

The number of channels.

numSamplesint :

Get or set the number of samples (or indices) per channel. You can change the number of samples by setting this value, only in a scriptCHOP.

startfloat :

Get or set the start index of the channels. This can be modified only when the CHOP is a scriptCHOP.

endfloat :

Get or set the end index of the channels. This can be modified only when the CHOP is a scriptCHOP.

ratefloat :

Get or set the sample rate of the CHOP. This can be modified only when the CHOP is a scriptCHOP.

exportbool :

Get or set export flag.

exportChangesint (Read Only):

Number of times the export mapping information has changed.

isCHOPbool (Read Only):

True if the operator is a CHOP.

isTimeSlicebool (Read Only):

True if the CHOP last cooked as a time slice.

Methods[edit]

[nameOrIndex]Channel:

channels may be easily accessed from a CHOP using the [] subscript operator.

  • nameOrIndex - Must be an exact string name, or it may be a numeric channel index. Wildcards are not supported. Refer to the help on channels to see how to use the returned Channel object.
    n = op('pattern1')
    c = n[4]
    c = n['chan2']
    
    and to get the third sample from the channel, assuming the channel has 3 or more samples:
    n = op('pattern1')
    c = n['chan2'][2]
    

chan(nameOrIndex1, nameOrIndex2..., caseSensitive=True)Channel or None:

Returns the first Channel that matches the given name or index or None if none are found.

Multiple patterns may be specified which are all added to the search.

  • nameOrIndex - May be a string name, possibly using Pattern Matching, or it may be a numeric channel index.
  • caseSensitive - (Optional) Specifies whether or not case sensitivity is used.
n = op('pattern1')
c = n.chan(4)
c = n.chan('chan*')
c = n.chan('chan3zall', caseSensitive=False)

chans(nameOrIndex1, nameOrIndex2..., caseSensitive=True)list:

Returns a (possibly empty) list of Channels that match that specified names or indices. Multiple names and indices may be provided.

  • nameOrIndex - (Optional) One or more string names, possibly using Pattern Matching, or numeric channel index. No arguments are passed, a list of all channels is returned.
  • caseSensitive - (Optional) Specifies whether or not case sensitivity is used.
n = op('pattern1')
newlist = n.chans() # get all channels in the CHOP
newlist = n.chans('a*', 3,4,5, 'd*')

numpyArray()numpy.array:

Returns all of the channels in this CHOP a 2D NumPy array with a width equal to the track length and a height equal to the number of tracks.

convertToKeyframes(tolerance=0.1)animationCOMP:

Create an Animation COMP that contains a keyframed approximation of the CHOP's channels.

The resultant animationCOMP is returned.

  • tolerance - (Keyword, Optional) If this is not given, the default value is 0.1. It may be overridden for higher accuracy match between the source channels and the resulting keyframed channels.

save(filepath)filepath:

Saves the channel to the file system. Supported file formats are .clip, .bclip, .chan, .bchan and .aiff.

Returns the file path used.

  • filepath - (Optional) The path and filename to save to.
n = op('pattern1')
name = n.save()   #save in native format with default name
n.save('output.chan')  #ascii readable tab delimited format
n.save('output.aiff')  #supported audio format

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.

A CHOP outputs one or more channels, where a channel is simply a sequence of numbers, representing motion, audio, etc. Channels are passed between CHOPs in TouchDesigner networks. See also Export.