Difference between revisions of "Component: Rectifier (DSP)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| DSP
 
| DSP
 
|}
 
|}
  
  
−
 
+
==Rectifier component==
−
==[[File:Component Icon 939a5d54_28c7_488d_af39_46f7c5d2c429.png|Image]] Rectifier component==
 
 
Converts the negative elements of a signal into a mirrored positive signal.
 
Converts the negative elements of a signal into a mirrored positive signal.
  
−
==Examples==
+
==Detailed description==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
''No detailed description exists yet for this component''
  
−
==Downloadable macro reference==
+
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>ControlRectifier</tt></u></span>===
 
−
Enables or disables the rectifier, enabled by default
 
  
−
'''Parameters'''
+
''<span style="color:red;">No additional examples</span>''
  
−
:[[Variable Types|BOOL]] ''State''
 
−
::0=Disable, 1=Enable
 
  
 +
==Downloadable macro reference==
  
−
'''Return value'''
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0=Disable, 1=Enable&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:''This call does not return a value''
 
  
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Rectify</tt></u></span>===
 
−
Collects a single value from the input buffer and outputs a rectified version of the value.
 
  
−
'''Parameters'''
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
:''This macro has no parameters''
 
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
:''This call does not return a value''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ChangePID'''
−
 
+
|-
−
 
+
| colspan="2" | Allows the P, I and D control parameters to be changed on the fly during a program.&nbsp;
−
===<span style="font-weight: normal;"><u><tt>RectifyArray</tt></u></span>===
+
|-
−
Passes an entire buffer through the rectifier and outputs a rectified version of the buffer at the other end
+
|-
−
 
+
| width="10%" align="center" | [[File:]] -
−
'''Parameters'''
+
| width="90%" | P
−
 
+
|-
−
:''This macro has no parameters''
+
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | I
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | D
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Connect To</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''ConnectTo''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
DSP component with output buffer to collect our data from.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Buffer Size</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BuffSize''.
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
−
 
+
| width="90%" | Connect To
−
Number of individual elements the buffer can store, default 1.
+
|-
−
 
+
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
−
<span style="font-weight: normal;"><u>Buffer Type</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''BuffType''.
+
| width="90%" | Buffer Size
−
 
+
|-
−
Sets the buffer data type.
+
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Rectifier Threshold</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Buffer Type
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''RectifyValue''.
+
|-
−
 
+
| colspan="2" | Sets the buffer data type.&nbsp;
−
Value at which to choose to flip the signal.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Default 0 for a signed buffer.
+
| width="90%" | Rectifier Threshold
 +
|-
 +
| colspan="2" | Value at which to choose to flip the signal. Default 0 for a signed buffer.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 +
|-
 +
|}

Revision as of 18:58, 16 November 2021

Author Matrix Ltd
Version 1.2
Category DSP


Rectifier component

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ControlRectifier
Enables or disables the rectifier, enabled by default 
[[File:]] - 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


Fc9-comp-macro.png ChangePID
Allows the P, I and D control parameters to be changed on the fly during a program. 
[[File:]] - P
 
[[File:]] - I
 
[[File:]] - D
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-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-14-icon.png Rectifier Threshold
Value at which to choose to flip the signal. Default 0 for a signed buffer. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Rectifier_(DSP)&oldid=25194"