mc.snowphasor~ Reference

Control a Population of Phasors

mc.snowphasor~

Description

The mc.snowphasor~ object generates phasor ramps in multiple audio channels according to global controls such as average rate. The object can also trigger ramps from a multi-channel audio signal.

Arguments

None.

Attributes

busymapname [symbol]

If the Use Busy Map (usebusymap) attribute is set, the busymapname specifies a named busy map other than the default global busy map.

chans [int]

Sets the number of output channels. If the value of chans is 0, the number of outputs auto-adapts to the number of channels in a multi-channel signal connected to the object's inlet. If the value of chans is non-zero, the number of channels in the multi-channel output are fixed and do not auto-adapt to the input.

interval [float]

When the mode attribute is set to utilization (0), interval sets the time between updates of the population density of output phasors per unit time. When the mode attribute is set to rate (1), interval sets the rate at which the average rate per unit time of phasors is updated. When the mode attribute is set to audio (2), interval is ignored. When the mode attribute is set to interval (3), interval sets the time between phasor triggers.

intervalcycle [int]

Sets the number of intervals after which the mean interval time (as specified by the interval attribute) is restored. For example, when the intervalcycle attribute is set to 2, any deviation in the interval calculated will be corrected on the subsequent interval. By contrast when the intervalcycle attribute is set to 10, nine intervals will be generated before the tenth interval restores the mean interval time.

intervaldev [float]

Sets the proportion of the current value of the interval attribute that is allowed to vary randomly (above or below). An intervaldev value of 0 will produce no random variation in the ramp time.

mode [int]

Determines how new phasor ramps are triggered Possible values:

0 = 'utilization' ( Utilization Mode )
Maintains a proportion of the total available time and space (channels) with active phasor ramps, as set by the prob attribute.

1 = 'rate' ( Rate Mode )
Maintains a rate of new phasor triggerings (births) per unit time, as set by the rate attribute.

2 = 'interval' ( Interval Mode )
Maintains a constant interval between phasor triggerings, as set by the rate attribute.

3 = 'audio' ( Audio Mode )
Triggers new phasors when audio-channels sample values exceed the signal input threshold (set by the threshold attribute).

perchantriggers [int]

When the perchantriggers is set, zero to non-zero transitions on input audio channels only trigger corresponding output channels. When perchantriggers is 0, triggers are applied to any available output channel.

prob [float]

When the mode attribute is set to utilization (0), the prob attribute sets the percentage of time across all audio output channels occupied by phasor ramps. If the decaytime attribute is set to a higher value, the average number of new ramps (births) per unit time will be lower. The prob has no effect in the other trigger modes.

probdev [float]

Sets the proportion of the current value of the prob attribute that is allowed to vary randomly (above or below). An probdev value of 0 will produce no random variation in the utilization probability.

rampdev [float]

Sets the proportion of the current value of the ramptime attribute that is allowed to vary randomly (above or below). A rampdev value of 0 will produce no random variation in the ramp time.

ramptime [float]

Sets the duration in milliseconds of a phasor ramp produced by mc.snowphasor~.

rate [float]

When the mode attribute is set to rate (1), the rate attribute sets the rate per second of phasor ramps triggerings (births). When the mode attribute is set to other values, the rate attribute has no effect.

ratedev [float]

Sets the proportion of the current value of the rate attribute that is allowed to vary randomly (above or below). An rate value of 0 will produce no random variation in the ramp birth rate.

threshold [float]

Sets the minimum sample value for a ramp trigger in Audio Mode.

usebusymap [int]

When the usebusymap attribute is set, mc.snowphasor~ incorporates the busy map into its voice allocation algorithm and sets channels in the busy map to be busy when triggering ramps.

Common Box Attributes

Messages

signal

In left inlet: When the Trigger Mode (mode) attribute of mc.snowphasor~ is set to audio (2), a new phasor ramp is started. If the perchantriggers attribute is set, the ramp occurs only on a non-busy output channel corresponding to any channel where a sample exceeds the current signal input threshold. If there are more input audio channels than output channels (set by the chans attribute), the additional input channels are ignored. If perchantriggers is 0, the next available (non-busy) output channel is used.
In right inlet: A signal connected to the right inlet sets the ramp duration, overriding the value of the decaytime attribute. If a multi-channel signal is connected, the channel of the input corresponding to the channel of the output ramp is used for the duration.

See Also

Name Description
change~
line~
phasor~
snowfall~
updown~