Component: Offset (DSP)

From Flowcode Help
Revision as of 09:11, 12 October 2020 by BenR (talk | contribs) (XML import)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search


Author Matrix Ltd
Version 1.1 (Release)
Category DSP


Image Offset component

Allows the values in a single buffer to be offset uniformly. Functions include: Add, Subtract

Examples

No additional examples


Downloadable macro reference

Calculate

Performs the selected offset on a value from the input buffer and passes to the output buffer.

Parameters

This macro has no parameters


Return value

This call does not return a value


CalculateArray

Performs the selected offset on an entire buffer.

Parameters

This macro has no parameters


Return value

This call does not return a value


SetOffset

Sets the Offset to be used when calling the calculate function.

Parameters

INT Offset


Return value

This call does not return a value


Simulation macro reference

This component does not contain any simulation macros


Property reference

Connect To

This property is of type Panel object and can be referenced with the variable name ConnectTo.

DSP component with output buffer to collect our data from.

Buffer Size

This property is of type Unsigned integer and can be referenced with the variable name BuffSize.

Number of individual elements the buffer can store, default 1.

Buffer Type

This property is of type Fixed list of ints and can be referenced with the variable name BuffType.

Sets the buffer data type.

Offset Type

This property is of type Fixed list of ints and can be referenced with the variable name OffsetType.

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

This property is of type True or false and can be referenced with the variable name 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

This property is of type Signed integer and can be referenced with the variable name InitialOffset.

No additional information