gnuradio.blocks: Stream Tag Tools

gnuradio.blocks.burst_tagger(size_t itemsize) → burst_tagger_sptr

Sets a burst on/off tag based on the value of the trigger input.

This block takes two inputs, a signal stream on the input stream 0 and a trigger stream of shorts on input stream 1. If the trigger stream goes above 0, a tag with the key “burst” will be transmitted as a pmt::PMT_T. When the trigger signal falls below 0, the “burst” tag will be transmitted as pmt::PMT_F.

The signal on stream 0 is retransmitted to output stream 0.

Constructor Specific Documentation:

Build a burst tagger gnuradio/blocks.

Parameters:itemsize – itemsize of the signal stream on input 0.

burst_tagger_sptr.active_thread_priority(burst_tagger_sptr self) → int

burst_tagger_sptr.declare_sample_delay(burst_tagger_sptr self, int which, int delay)

declare_sample_delay(burst_tagger_sptr self, unsigned int delay)

burst_tagger_sptr.message_subscribers(burst_tagger_sptr self, swig_int_ptr which_port) → swig_int_ptr

burst_tagger_sptr.min_noutput_items(burst_tagger_sptr self) → int

burst_tagger_sptr.pc_input_buffers_full_avg(burst_tagger_sptr self, int which) → float

pc_input_buffers_full_avg(burst_tagger_sptr self) -> pmt_vector_float

burst_tagger_sptr.pc_noutput_items_avg(burst_tagger_sptr self) → float

burst_tagger_sptr.pc_nproduced_avg(burst_tagger_sptr self) → float

burst_tagger_sptr.pc_output_buffers_full_avg(burst_tagger_sptr self, int which) → float

pc_output_buffers_full_avg(burst_tagger_sptr self) -> pmt_vector_float

burst_tagger_sptr.pc_throughput_avg(burst_tagger_sptr self) → float

burst_tagger_sptr.pc_work_time_avg(burst_tagger_sptr self) → float

burst_tagger_sptr.pc_work_time_total(burst_tagger_sptr self) → float

burst_tagger_sptr.sample_delay(burst_tagger_sptr self, int which) → unsigned int

burst_tagger_sptr.set_false_tag(burst_tagger_sptr self, std::string const & key, bool value)

For the false burst tag, change the key name to and a new value of .

burst_tagger_sptr.set_min_noutput_items(burst_tagger_sptr self, int m)

burst_tagger_sptr.set_thread_priority(burst_tagger_sptr self, int priority) → int

burst_tagger_sptr.set_true_tag(burst_tagger_sptr self, std::string const & key, bool value)

For the true burst tag, change the key name to and a new value of .

burst_tagger_sptr.thread_priority(burst_tagger_sptr self) → int

gnuradio.blocks.tag_debug(size_t sizeof_stream_item, std::string const & name, std::string const & key_filter="") → tag_debug_sptr

Bit bucket that prints out any tag received.

This block collects all tags sent to it on all input ports and displays them to stdout in a formatted way. The parameter is used to identify which debug sink generated the tag, so when connecting a block to this debug sink, an appropriate name is something that identifies the input block.

This block otherwise acts as a NULL sink in that items from the input stream are ignored. It is designed to be able to attach to any block and watch all tags streaming out of that block for debugging purposes.

Specifying a key will allow this block to filter out all other tags and only display tags that match the given key. This can help clean up the output and allow you to focus in on a particular tag of interest.

The tags from the last call to this work function are stored and can be retrieved using the function ‘current_tags’.

Constructor Specific Documentation:

Build a tag debug block

Parameters:

• sizeof_stream_item – size of the items in the incoming stream.
• name – name to identify which debug sink generated the info.
• key_filter – Specify a tag’s key value to use as a filter.

tag_debug_sptr.active_thread_priority(tag_debug_sptr self) → int

tag_debug_sptr.current_tags(tag_debug_sptr self) → tags_vector_t

Returns a vector of tag_t items as of the last call to work.

tag_debug_sptr.declare_sample_delay(tag_debug_sptr self, int which, int delay)

declare_sample_delay(tag_debug_sptr self, unsigned int delay)

tag_debug_sptr.key_filter(tag_debug_sptr self) → std::string

Get the current filter key.

tag_debug_sptr.message_subscribers(tag_debug_sptr self, swig_int_ptr which_port) → swig_int_ptr

tag_debug_sptr.min_noutput_items(tag_debug_sptr self) → int

tag_debug_sptr.num_tags(tag_debug_sptr self) → int

Return the total number of tags in the tag queue.

tag_debug_sptr.pc_input_buffers_full_avg(tag_debug_sptr self, int which) → float

pc_input_buffers_full_avg(tag_debug_sptr self) -> pmt_vector_float

tag_debug_sptr.pc_noutput_items_avg(tag_debug_sptr self) → float

tag_debug_sptr.pc_nproduced_avg(tag_debug_sptr self) → float

tag_debug_sptr.pc_output_buffers_full_avg(tag_debug_sptr self, int which) → float

pc_output_buffers_full_avg(tag_debug_sptr self) -> pmt_vector_float

tag_debug_sptr.pc_throughput_avg(tag_debug_sptr self) → float

tag_debug_sptr.pc_work_time_avg(tag_debug_sptr self) → float

tag_debug_sptr.pc_work_time_total(tag_debug_sptr self) → float

tag_debug_sptr.sample_delay(tag_debug_sptr self, int which) → unsigned int

tag_debug_sptr.set_display(tag_debug_sptr self, bool d)

Set the display of tags to stdout on/off.

tag_debug_sptr.set_key_filter(tag_debug_sptr self, std::string const & key_filter)

Set a new key to filter with.

tag_debug_sptr.set_min_noutput_items(tag_debug_sptr self, int m)

tag_debug_sptr.set_thread_priority(tag_debug_sptr self, int priority) → int

tag_debug_sptr.thread_priority(tag_debug_sptr self) → int

gnuradio.blocks.tagged_file_sink(size_t itemsize, double samp_rate) → tagged_file_sink_sptr

A file sink that uses tags to save files.

The sink uses a tag with the key ‘burst’ to trigger the saving of the burst data to a new file. If the value of this tag is True, it will open a new file and start writing all incoming data to it. If the tag is False, it will close the file (if already opened). The file names are based on the time when the burst tag was seen. If there is an ‘rx_time’ tag (standard with UHD sources), that is used as the time. If no ‘rx_time’ tag is found, the new time is calculated based off the sample rate of the block.

Constructor Specific Documentation:

Build a tagged_file_sink block.

Parameters:

• itemsize – The item size of the input data stream.
• samp_rate – The sample rate used to determine the time difference between bursts

tagged_file_sink_sptr.active_thread_priority(tagged_file_sink_sptr self) → int

tagged_file_sink_sptr.declare_sample_delay(tagged_file_sink_sptr self, int which, int delay)

declare_sample_delay(tagged_file_sink_sptr self, unsigned int delay)

tagged_file_sink_sptr.message_subscribers(tagged_file_sink_sptr self, swig_int_ptr which_port) → swig_int_ptr

tagged_file_sink_sptr.min_noutput_items(tagged_file_sink_sptr self) → int

tagged_file_sink_sptr.pc_input_buffers_full_avg(tagged_file_sink_sptr self, int which) → float

pc_input_buffers_full_avg(tagged_file_sink_sptr self) -> pmt_vector_float

tagged_file_sink_sptr.pc_noutput_items_avg(tagged_file_sink_sptr self) → float

tagged_file_sink_sptr.pc_nproduced_avg(tagged_file_sink_sptr self) → float

tagged_file_sink_sptr.pc_output_buffers_full_avg(tagged_file_sink_sptr self, int which) → float

pc_output_buffers_full_avg(tagged_file_sink_sptr self) -> pmt_vector_float

tagged_file_sink_sptr.pc_throughput_avg(tagged_file_sink_sptr self) → float

tagged_file_sink_sptr.pc_work_time_avg(tagged_file_sink_sptr self) → float

tagged_file_sink_sptr.pc_work_time_total(tagged_file_sink_sptr self) → float

tagged_file_sink_sptr.sample_delay(tagged_file_sink_sptr self, int which) → unsigned int

tagged_file_sink_sptr.set_min_noutput_items(tagged_file_sink_sptr self, int m)

tagged_file_sink_sptr.set_thread_priority(tagged_file_sink_sptr self, int priority) → int

tagged_file_sink_sptr.thread_priority(tagged_file_sink_sptr self) → int