Loading...
Searching...
No Matches
BagSource Class Reference
Inheritance diagram for BagSource:
Public Member Functions | |
| __init__ (self, args=None, **kwargs) | |
| close (self) | |
| close_batch (self) | |
| configure (self, args=None, **kwargs) | |
| format_message_meta (self, topic, msg, stamp, index=None) | |
| format_meta (self) | |
| get_batch (self) | |
| get_message_class (self, typename, typehash=None) | |
| get_message_definition (self, msg_or_type) | |
| get_message_meta (self, topic, msg, stamp, index=None) | |
| get_message_type_hash (self, msg_or_type) | |
| get_meta (self) | |
| init_progress (self) | |
| is_processable (self, topic, msg, stamp, index=None) | |
| notify (self, status) | |
| read (self) | |
| validate (self) | |
 Public Member Functions inherited from Source | |
| __enter__ (self) | |
| __exit__ (self, exc_type, exc_value, traceback) | |
| __iter__ (self) | |
| bind (self, sink) | |
| configure_progress (self, **kwargs) | |
| thread_excepthook (self, text, exc) | |
| update_progress (self, count, running=True) | |
| Public Member Functions inherited from ConditionMixin | |
| conditions_get_topics (self) | |
| conditions_register_message (self, topic, msg) | |
| conditions_set_topic_state (self, topic, pure) | |
| has_conditions (self) | |
| is_conditions_topic (self, topic, pure=True) | |
Public Attributes | |
| bar | |
| topics | |
| valid | |
| Public Attributes inherited from Source | |
| args | |
| bar | |
| ProgressBar instance, if any. | |
| preprocess | |
| Apply all filter arguments when reading, not only topic and type. | |
| sink | |
| outputs.Sink instance bound to this source | |
| topics | |
| All topics in source, as {(topic, typenane, typehash): total message count or None}. | |
| valid | |
| Result of validate() | |
| Public Attributes inherited from ConditionMixin | |
| args | |
Static Public Attributes | |
| DEFAULT_ARGS | |
| Constructor argument defaults. | |
| str | MESSAGE_META_TEMPLATE = "{topic} {index}/{total} ({type} {dt} {stamp})" |
| Template for message metainfo line. | |
| str | META_TEMPLATE |
| Template for bag metainfo header. | |
| Static Public Attributes inherited from Source | |
| DEFAULT_ARGS | |
| Constructor argument defaults. | |
| str | MESSAGE_META_TEMPLATE = "{topic} #{index} ({type} {dt} {stamp})" |
| Template for message metainfo line. | |
| Static Public Attributes inherited from ConditionMixin | |
| DEFAULT_ARGS = dict(CONDITION=()) | |
| Constructor argument defaults. | |
| TOPIC_RGX = re.compile(r"<topic\s+([^\s><]+)\s*>") | |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| __init__ | ( | self, | |
args = None, |
|||
| ** | kwargs | ||
| ) |
@param args arguments as namespace or dictionary, case-insensitive;
or a single path as the ROS bagfile to read,
or a stream to read from,
or one or more {@link grepros.api.Bag Bag} instances
<!--sep-->
Bag-specific arguments:
@param args.file names of ROS bagfiles to read if not all in directory,
or a stream to read from;
or one or more {@link grepros.api.Bag Bag} instances
@param args.path paths to scan if not current directory
@param args.recurse recurse into subdirectories when looking for bagfiles
@param args.orderby "topic" or "type" if any to group results by
@param args.decompress decompress archived bags to file directory
@param args.reindex make a copy of unindexed bags and reindex them (ROS1 only)
@param args.timescale emit messages on original timeline from first message
at given rate, 0 disables
@param args.timescale_emission
timeline from first matched message not first in bag,
requires notify() for each message
@param args.write outputs, to skip in input files
@param args.bag one or more {@link grepros.api.Bag Bag} instances
<!--sep-->
General arguments:
@param args.topic ROS topics to read if not all
@param args.type ROS message types to read if not all
@param args.skip_topic ROS topics to skip
@param args.skip_type ROS message types to skip
@param args.start_time earliest timestamp of messages to read
@param args.end_time latest timestamp of messages to read
@param args.start_index message index within topic to start from
@param args.end_index message index within topic to stop at
@param args.unique emit messages that are unique in topic
@param args.select_field message fields to use for uniqueness if not all
@param args.noselect_field message fields to skip for uniqueness
@param args.nth_message read every Nth message in topic, starting from first
@param args.nth_interval minimum time interval between messages in topic,
as seconds or ROS duration
@param args.condition Python expressions that must evaluate as true
for message to be processable, see ConditionMixin
@param args.progress whether to print progress bar
@param args.stop_on_error stop execution on any error like unknown message type
@param args.verbose whether to print error stacktraces
@param kwargs any and all arguments as keyword overrides, case-insensitive
Reimplemented from Source.
Member Function Documentation
◆ close()
| close | ( | self | ) |
◆ close_batch()
| close_batch | ( | self | ) |
◆ configure()
| configure | ( | self, | |
args = None, |
|||
| ** | kwargs | ||
| ) |
◆ format_message_meta()
| format_message_meta | ( | self, | |
| topic, | |||
| msg, | |||
| stamp, | |||
index = None |
|||
| ) |
◆ format_meta()
| format_meta | ( | self | ) |
◆ get_batch()
| get_batch | ( | self | ) |
◆ get_message_class()
| get_message_class | ( | self, | |
| typename, | |||
typehash = None |
|||
| ) |
◆ get_message_definition()
| get_message_definition | ( | self, | |
| msg_or_type | |||
| ) |
◆ get_message_meta()
| get_message_meta | ( | self, | |
| topic, | |||
| msg, | |||
| stamp, | |||
index = None |
|||
| ) |
◆ get_message_type_hash()
| get_message_type_hash | ( | self, | |
| msg_or_type | |||
| ) |
◆ get_meta()
| get_meta | ( | self | ) |
◆ init_progress()
| init_progress | ( | self | ) |
◆ is_processable()
| is_processable | ( | self, | |
| topic, | |||
| msg, | |||
| stamp, | |||
index = None |
|||
| ) |
◆ notify()
| notify | ( | self, | |
| status | |||
| ) |
◆ read()
| read | ( | self | ) |
◆ validate()
| validate | ( | self | ) |
Member Data Documentation
◆ bar
◆ DEFAULT_ARGS
|
static |
Initial value:
= dict(BAG=(), FILE=(), PATH=(), RECURSE=False, TOPIC=(), TYPE=(),
SKIP_TOPIC=(), SKIP_TYPE=(), START_TIME=None, END_TIME=None,
START_INDEX=None, END_INDEX=None, CONDITION=(), AFTER=0, ORDERBY=None,
DECOMPRESS=False, REINDEX=False, WRITE=(), PROGRESS=False,
STOP_ON_ERROR=False, TIMESCALE=0, TIMESCALE_EMISSION=False, VERBOSE=False)
Constructor argument defaults.
◆ MESSAGE_META_TEMPLATE
|
static |
◆ META_TEMPLATE
|
static |
◆ topics
◆ valid
The documentation for this class was generated from the following file:
- grepros/inputs.py
