niryo_libraries.rostopic.ROSTopicHz

class documentation

class ROSTopicHz(object):

Constructor: ROSTopicHz(window_size, filter_expr, use_wtime)

ROSTopicHz receives messages for a topic and computes frequency stats

Method	`__init__`	Undocumented
Method	`callback_hz`	ros sub callback :param m: Message instance :param topic: Topic name
Method	`get_hz`	calculate the average publising rate
Method	`get_last_printed_tn`	Undocumented
Method	`get_msg_t0`	Undocumented
Method	`get_msg_tn`	Undocumented
Method	`get_times`	Undocumented
Method	`print_hz`	print the average publishing rate to screen
Method	`set_last_printed_tn`	Undocumented
Method	`set_msg_t0`	Undocumented
Method	`set_msg_tn`	Undocumented
Method	`set_times`	Undocumented
Instance Variable	`filter_expr`	Undocumented
Instance Variable	`last_printed_tn`	Undocumented
Instance Variable	`lock`	Undocumented
Instance Variable	`msg_t0`	Undocumented
Instance Variable	`msg_tn`	Undocumented
Instance Variable	`times`	Undocumented
Instance Variable	`use_wtime`	Undocumented
Instance Variable	`window_size`	Undocumented
Instance Variable	`_last_printed_tn`	Undocumented
Instance Variable	`_msg_t0`	Undocumented
Instance Variable	`_msg_tn`	Undocumented
Instance Variable	`_times`	Undocumented

def __init__(self, window_size, filter_expr=None, use_wtime=False): ¶

Undocumented

def callback_hz(self, m, topic=None): ¶

ros sub callback :param m: Message instance :param topic: Topic name

def get_hz(self, topic=None): ¶

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

def get_last_printed_tn(self, topic=None): ¶

Undocumented

def get_msg_t0(self, topic=None): ¶

Undocumented

def get_msg_tn(self, topic=None): ¶

Undocumented

def get_times(self, topic=None): ¶

Undocumented

def print_hz(self, topics=(None)): ¶

print the average publishing rate to screen

def set_last_printed_tn(self, value, topic=None): ¶

Undocumented

def set_msg_t0(self, value, topic=None): ¶

Undocumented

def set_msg_tn(self, value, topic=None): ¶

Undocumented

def set_times(self, value, topic=None): ¶

Undocumented

filter_expr = ¶

Undocumented

last_printed_tn = ¶

Undocumented

lock = ¶

Undocumented

msg_t0 = ¶

Undocumented

msg_tn = ¶

Undocumented

times = ¶

Undocumented

use_wtime = ¶

Undocumented

window_size = ¶

Undocumented

_last_printed_tn = ¶

Undocumented

_msg_t0 = ¶

Undocumented

_msg_tn = ¶

Undocumented

_times = ¶

Undocumented