Keep M in N: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
Decimate a stream, keeping the first M items out of every N starting after offset items.
Decimate a stream, keeping the first M items out of every N starting after offset items.
[[File:Keep M in N visual.png]]


Also see [[Keep 1 in N]].
Also see [[Keep 1 in N]].
Line 6: Line 8:
== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Type
: Supported types are: complex, float, int, short, and byte


; M (''R'')
; M (''R'')
Line 18: Line 23:
== Example Flowgraph ==
== Example Flowgraph ==


Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI.  Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
Here is an example flowgraph using the Keep M in N Block. It has a vector source with values <code>[1,2,3,4,5,6,7,8,9,10]</code> repeating.
 
[[File:Keep M in N Example Flowgraph.png]]
 
 
The block parameters are set to:
 
[[File:Keep M in N Settings.png|500px]]
 
 
This results in the following output:
 
[[File:Keep M in N Example output.png|900px]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/keep_m_in_n_impl.cc]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/keep_m_in_n_impl.cc keep_m_in_n_impl.cc]]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/keep_m_in_n_impl.h]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/keep_m_in_n_impl.h keep_m_in_n_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/keep_m_in_n.h]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/keep_m_in_n.h keep_m_in_n.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_keep_m_in_n.block.yml]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_keep_m_in_n.block.yml blocks_keep_m_in_n.block.yml]

Latest revision as of 13:09, 6 August 2023

Decimate a stream, keeping the first M items out of every N starting after offset items.

Keep M in N visual.png

Also see Keep 1 in N.

Parameters

(R): Run-time adjustable

Type
Supported types are: complex, float, int, short, and byte
M (R)
Number of items to take in block of items
N (R)
Block size in items
Initial Offset
Initial item offset into the stream

Example Flowgraph

Here is an example flowgraph using the Keep M in N Block. It has a vector source with values [1,2,3,4,5,6,7,8,9,10] repeating.

Keep M in N Example Flowgraph.png


The block parameters are set to:

Keep M in N Settings.png


This results in the following output:

Keep M in N Example output.png

Source Files

C++ files
keep_m_in_n_impl.cc]
Header files
keep_m_in_n_impl.h
Public header files
keep_m_in_n.h
Block definition
blocks_keep_m_in_n.block.yml