Component: Offset (DSP Operators): Difference between revisions
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..." |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Offset.fcfx FC_Comp_Source_DSP_Offset.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Offset.fcfx FC_Comp_Source_DSP_Offset.fcfx] | |||
==Detailed description== | ==Detailed description== | ||
| Line 36: | Line 48: | ||
==Examples== | ==Examples== | ||
| Line 53: | Line 75: | ||
{| class="wikitable | |||
==Macro reference== | |||
===Calculate=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Calculate''' | ||
|- | |- | ||
| colspan="2" | Performs the selected offset on a value from the input buffer and passes to the output buffer. | | colspan="2" | Performs the selected offset on a value from the input buffer and passes to the output buffer. | ||
| Line 68: | Line 105: | ||
{| class="wikitable | ===CalculateArray=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CalculateArray''' | ||
|- | |- | ||
| colspan="2" | Performs the selected offset on an entire buffer. | | colspan="2" | Performs the selected offset on an entire buffer. | ||
| Line 81: | Line 119: | ||
{| class="wikitable | ===SetOffset=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetOffset''' | ||
|- | |- | ||
| colspan="2" | Sets the Offset to be used when calling the calculate function. | | colspan="2" | Sets the Offset to be used when calling the calculate function. | ||
| Line 97: | Line 136: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 129: | Line 166: | ||
| colspan="2" | Sets the data direction flow of the component | | colspan="2" | Sets the data direction flow of the component | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Offset | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | DSP Operators |
Offset component
Allows the values in a single buffer to be offset uniformly. Functions include: Add, Subtract
Component Source Code
Please click here to download the component source project: FC_Comp_Source_DSP_Offset.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Offset.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
Calculate
|
Calculate |
| Performs the selected offset on a value from the input buffer and passes to the output buffer. | |
 - VOID
|
Return |
CalculateArray
|
|
CalculateArray |
| Performs the selected offset on an entire buffer. | |
| - VOID
|
Return |
SetOffset
|
|
SetOffset |
| Sets the Offset to be used when calling the calculate function. | |
 - INT
|
Offset |
| - VOID
|
Return |
Property reference
|
Properties |
|
Connect To |
| DSP component with output buffer to collect our data from. | |
|
Buffer Size |
| Number of individual elements the buffer can store, default 1. | |
|
|
Buffer Type |
| Sets the buffer data type. | |
|
|
Direction |
| Sets the data direction flow of the component | |
|
Offset |
|
|
Offset Type |
| Defines the type of calculation performed on the input buffer to obtain the output value. A left shift is essentially an optimised multiply with the multiplier being the 2^scaler A right shift is essentially an optimised divide with the divider being the 2^scaler | |
|
Rollover |
| Allow the output buffer to rollover. For example 128 + 128 = 256 which would equate to 0 using an 8-bit buffer with rollover enabled. With rollover disabled the output would be set to 255 which is the max representable value. | |
|
Initial Offset |