Difference between revisions of "Component: Offset (DSP Operators)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | 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] | 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 44: | Line 46: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 68: | Line 72: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Calculate''' | ||
| + | |- | ||
| + | | colspan="2" | Performs the selected offset on a value from the input buffer and passes to the output buffer. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CalculateArray''' | ||
| + | |- | ||
| + | | colspan="2" | Performs the selected offset on an entire buffer. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOffset''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the Offset to be used when calling the calculate function. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Offset | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Connect To | ||
| + | |- | ||
| + | | colspan="2" | DSP component with output buffer to collect our data from. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Buffer Size | ||
| + | |- | ||
| + | | colspan="2" | Number of individual elements the buffer can store, default 1. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Buffer Type | ||
| + | |- | ||
| + | | colspan="2" | Sets the buffer data type. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Direction | ||
| + | |- | ||
| + | | colspan="2" | Sets the data direction flow of the component | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Offset | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Offset Type | ||
| + | |- | ||
| + | | colspan="2" | 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 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Rollover | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Initial Offset | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:55, 27 January 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | DSP Operators |
Contents
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 |
| Performs the selected offset on a value from the input buffer and passes to the output buffer. | |
 - VOID
|
Return |
|
|
CalculateArray |
| Performs the selected offset on an entire buffer. | |
| - VOID
|
Return |
|
|
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 |
==Macro reference==
|
|
Calculate |
| Performs the selected offset on a value from the input buffer and passes to the output buffer. | |
| - VOID
|
Return |
|
|
CalculateArray |
| Performs the selected offset on an entire buffer. | |
| - VOID
|
Return |
|
|
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 |
==Macro reference==
|
|
Calculate |
| Performs the selected offset on a value from the input buffer and passes to the output buffer. | |
| - VOID
|
Return |
|
|
CalculateArray |
| Performs the selected offset on an entire buffer. | |
| - VOID
|
Return |
|
|
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 |
==Macro reference==
|
|
Calculate |
| Performs the selected offset on a value from the input buffer and passes to the output buffer. | |
| - VOID
|
Return |
|
|
CalculateArray |
| Performs the selected offset on an entire buffer. | |
| - VOID
|
Return |
|
|
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 |
