fbinshift~
MSP Reference
Open Help

fbinshift~

Frequency domain frequency shifter for pfft~

Description

The fbinshift~ object implements a frequency-domain frequency shifter that can be used inside a patch loaded by a pfft~ object.

Examples

Using fbinshift~ inside a pfft~ subpatch

Discussion

The fbinshift~ object works by shifting the frequency bins of an FFT'd signal (hence its name - a shortened form of "frequency-bin shifter"). All the frequencies of the complex input signal are shifted by the Hertz value speified. Positive Hertz values shift upward, whereas negative values shift downward. The fbinshift~ object must be used inside a pfft~; outside a pfft~ it does nothing.

Arguments

frequency-shift [float]

Optional
Unitshz

A numerical argument will be used as the frequency shift in Hertz. The default is zero.

frequency-shift [int]

Unitshz

Integer inputs are converted to floating-point values and used as the frequency shift in Hertz. The default is zero.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

signal

In left inlet: The signal present at the left inlet is the real part of a frequency-domain signal coming from a fftin~ object inside a pfft~.

In middle inlet: The signal input to the middle inlet is the imaginary part of a frequency-domain signal coming from a fftin~ object inside a pfft~. Both real and imaginary inputs must be connected for the fbinshift~ to work.

Output

signal

The output is the frequency shifted complex signal. The left outlet is the real component, and the right outlet is the imaginary component. These may be connected to the real and imaginary inputs of a fftout~ object inside a pfft~.

See Also

Name Description
freqshift~ Time-domain frequency shifter
gizmo~ Frequency-domain pitch shifter for pfft~
hilbert~ Phase quadrature filter