Wiki bot at 11:31, 23 October 2023

2023-10-23T11:31:30Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray..."

2023-10-23T10:55:39Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 1.2
|-
| width="20%" style="color:gray;" | Category
| DSP Inputs
|}

==Quadrature Generator component==
A quadrature generator allowing the generation of two waves Q and I which are b default 90 degrees out of phase from each other. Useful in modulating data.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Quadrature.fcfx FC_Comp_Source_DSP_Quadrature.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Quadrature.fcfx FC_Comp_Source_DSP_Quadrature.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

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

==Macro reference==

===Generate===
{| 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;" | '''Generate'''
|-
| colspan="2" | Assigns a single value to the specified buffer from the selected waveform data. Each call will read the next value from the waveform and will wrap correctly at the end of the data period. 
|-
|-
| 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''
|}

===GenerateArray===
{| 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;" | '''GenerateArray'''
|-
| colspan="2" | Fills the output buffer with the selected waveform data. If the buffer is smaller or larger then the waveform data period then the data passed will follow on correctly for subsequent cycles. 
|-
|-
| 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''
|}

===GetOffset===
{| 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;" | '''GetOffset'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ModifyAmplitude===
{| 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;" | '''ModifyAmplitude'''
|-
| colspan="2" | Allows the amplitude to be adjusted by applying a scaler to the waveform data. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Scaler
|-
| colspan="2" | 1.0 = 100% Default / 0.5 = 50% / 2.0 = 200% 
|-
| 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''
|}

===ModifyFrequency===
{| 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;" | '''ModifyFrequency'''
|-
| colspan="2" | Sets the frequency output rate by altering the period offset to a new value. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | OffsetRate
|-
| colspan="2" | 0.2=F/5 0.5=F/2 1.0=F 1.5=F*1.5 2.0=F*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''
|}

===ModifyPhaseOffset===
{| 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;" | '''ModifyPhaseOffset'''
|-
| colspan="2" | Shifts the output phase by the specified absolute angle in degrees. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | PhaseOffset
|-
| colspan="2" | Phase offset in degrees 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Absolute
|-
| colspan="2" | 0=Relative offset to current o/p 1=Absolute offset to initial o/p 
|-
| 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''
|}

===SetOffset===
{| 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" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| 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-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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Waveform
|-
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Amplitude
|-
| colspan="2" | Waveform amplitude or volume 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Offset
|-
| colspan="2" | Waveform DC offset 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Calculate Data
|-
| colspan="2" | Yes = Allows Sine, Cosine, Noise data to be generated on the fly using a calculation, provides much better resolution at the cost of processing performance. No = Allows Sine, Cosine, Noise data to be generated ahead of run time, provides fixed resolution output but is fast and efficient to generate. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Samples
|-
| colspan="2" | Waveform sample count, the number of data points in the stored cyclic wave look up table. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Start Phase Angle
|-
| colspan="2" | Waveform phase, the angle in degrees or sample in the wave to start streaming from 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Data
|-
| colspan="2" | The raw waveform data 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Period Offset
|-
| colspan="2" | The initial amount that the index increments through the LUT data when reading the stored waveform. 0.2 = Frequency / 5 0.5 = Frequency / 2 1.0 = Original Frequency 1.5 = Frequency * 1.5 2.0 = Frequency * 2 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Sample Period
|-
| colspan="2" | Degrees per default sample offset period 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Frequency Calculation - Reference Only
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Sample Rate (hz)
|-
| colspan="2" | Allows the sample rate to be entered to allow some basic calculations 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Period (s)
|-
| colspan="2" | The length of time in seconds that the wave period will cover at the specified sample rate 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Frequency (hz)
|-
| colspan="2" | The repeat frequency of the wave at the specified sample rate 
|}

@@ Line 28: / Line 28: @@
 ''<span style="color:red;">No additional examples</span>''
 ==Macro reference==
@@ Line 65: / Line 67: @@
 | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetOffset'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Gets the current phase of the wave as an index from 0 to Num Samples.&nbsp;
 |-
 |-
@@ Line 141: / Line 143: @@
 | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOffset'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Sets the current phase of the wave as an index from 0 to Num Samples.&nbsp;
 |-
 |-
@@ Line 147: / Line 149: @@
 | width="90%" | Offset
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Current sample of the wave: range 0 to num samples - 1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID

Component: Quadrature Generator (DSP Inputs) - Revision history

Wiki bot at 11:31, 23 October 2023

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray..."