Difference between revisions of "Component: Rectifier (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/wikicopy/componentsource/FC_Comp_Source_DSP_Rectifier.fcfx FC_Comp_Source_DSP_Rectifier.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Rectifier.fcfx FC_Comp_Source_DSP_Rectifier.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Rectifier.fcfx FC_Comp_Source_DSP_Rectifier.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Rectifier.fcfx FC_Comp_Source_DSP_Rectifier.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;" | '''ControlRectifier'''
 +
|-
 +
| colspan="2" | Enables or disables the rectifier, enabled by default 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0=Disable, 1=Enable 
 +
|-
 +
| 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;" | '''Rectify'''
 +
|-
 +
| colspan="2" | Collects a single value from the input buffer and outputs a rectified version of the value. 
 +
|-
 +
|-
 +
| 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;" | '''RectifyArray'''
 +
|-
 +
| colspan="2" | Passes an entire buffer through the rectifier and outputs a rectified version of the buffer at the other end 
 +
|-
 +
|-
 +
| 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;" | Rectifier
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Rectifier Threshold
 +
|-
 +
| colspan="2" | Value at which to choose to flip the signal. Default 0 for a signed buffer. 
 +
|}==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.2
Category DSP Operators


Rectifier component

Converts the negative elements of a signal into a mirrored positive signal.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DSP_Rectifier.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Rectifier.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Macro reference

Fc9-comp-macro.png ControlRectifier
Enables or disables the rectifier, enabled by default 
Fc9-bool-icon.png - BOOL State
0=Disable, 1=Enable 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Rectify
Collects a single value from the input buffer and outputs a rectified version of the value. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RectifyArray
Passes an entire buffer through the rectifier and outputs a rectified version of the buffer at the other end 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-type-16-icon.png Direction
Sets the data direction flow of the component 
Fc9-conn-icon.png Rectifier
Fc9-type-14-icon.png Rectifier Threshold
Value at which to choose to flip the signal. Default 0 for a signed buffer. 

==Macro reference==

Fc9-comp-macro.png ControlRectifier
Enables or disables the rectifier, enabled by default 
Fc9-bool-icon.png - BOOL State
0=Disable, 1=Enable 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Rectify
Collects a single value from the input buffer and outputs a rectified version of the value. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RectifyArray
Passes an entire buffer through the rectifier and outputs a rectified version of the buffer at the other end 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-type-16-icon.png Direction
Sets the data direction flow of the component 
Fc9-conn-icon.png Rectifier
Fc9-type-14-icon.png Rectifier Threshold
Value at which to choose to flip the signal. Default 0 for a signed buffer. 

==Macro reference==

Fc9-comp-macro.png ControlRectifier
Enables or disables the rectifier, enabled by default 
Fc9-bool-icon.png - BOOL State
0=Disable, 1=Enable 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Rectify
Collects a single value from the input buffer and outputs a rectified version of the value. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RectifyArray
Passes an entire buffer through the rectifier and outputs a rectified version of the buffer at the other end 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-type-16-icon.png Direction
Sets the data direction flow of the component 
Fc9-conn-icon.png Rectifier
Fc9-type-14-icon.png Rectifier Threshold
Value at which to choose to flip the signal. Default 0 for a signed buffer. 

==Macro reference==

Fc9-comp-macro.png ControlRectifier
Enables or disables the rectifier, enabled by default 
Fc9-bool-icon.png - BOOL State
0=Disable, 1=Enable 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Rectify
Collects a single value from the input buffer and outputs a rectified version of the value. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RectifyArray
Passes an entire buffer through the rectifier and outputs a rectified version of the buffer at the other end 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-type-16-icon.png Direction
Sets the data direction flow of the component 
Fc9-conn-icon.png Rectifier
Fc9-type-14-icon.png Rectifier Threshold
Value at which to choose to flip the signal. Default 0 for a signed buffer.