Jump to content

Component: Offset (DSP Operators): Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/DSP_Offset.fcfx FC_Comp_Source_temp/DSP_Offset.fcfx]
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_temp/DSP_Offset.fcfx FC_Comp_Source_temp/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 73: Line 73:


''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''





Revision as of 13:09, 7 February 2023

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