Package rostopic :: Class ROSTopicHz

Class ROSTopicHz

source code

object --+
         |
        ROSTopicHz

ROSTopicHz receives messages for a topic and computes frequency stats

Instance Methods
 
__init__(self, window_size, filter_expr=None, use_wtime=False)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
get_last_printed_tn(self, topic=None) source code
 
set_last_printed_tn(self, value, topic=None) source code
 
get_msg_t0(self, topic=None) source code
 
set_msg_t0(self, value, topic=None) source code
 
get_msg_tn(self, topic=None) source code
 
set_msg_tn(self, value, topic=None) source code
 
get_times(self, topic=None) source code
 
set_times(self, value, topic=None) source code
 
callback_hz(self, m, topic=None)
ros sub callback :param m: Message instance :param topic: Topic name
source code
 
get_hz(self, topic=None)
calculate the average publising rate
source code
 
print_hz(self, topics=(None))
print the average publishing rate to screen
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self, window_size, filter_expr=None, use_wtime=False)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

get_hz(self, topic=None)

source code 

calculate the average publising rate

Returns:
tuple of stat results (rate, min_delta, max_delta, standard deviation, window number) None when waiting for the first message or there is no new one