.. _package-rst-hri:
=================
Package rst.hri
=================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"1" [label=<
| GroupHypothesisCollection |
|
GroupHypothesis | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | GroupHypothesis |
|
TrackingInfo | tracking_info |
UINT32 | group_size_estimate |
SizeCategory | group_size_category |
FLOAT32 | interest_level |
FLOAT32 | group_stability |
AgeCategory | age_category |
GenderCategory | gender_category |
MatrixDouble | stability_cues |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | MatrixDouble |
|
Size | size |
Data | data |
>,shape=box,style=filled,fillcolor="white"];
"9" [label=< | Data |
|
FLOAT64 | value |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Size |
|
UINT32 | m |
UINT32 | n |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | GenderCategory |
|
MIXED_GENDERS | 1 |
COMPLETELY_FEMALE | 2 |
COMPLETELY_MALE | 4 |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | AgeCategory |
|
CHILDREN | 1 |
ADULTS | 2 |
SENIORS | 4 |
MIXED | 8 |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | SizeCategory |
|
SMALL_GROUP | 1 |
GROUP | 2 |
CROWD | 4 |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | TrackingInfo |
|
UINT32 | id |
OCTET-VECTOR | persistent_id |
>,shape=box,style=filled,fillcolor="white"];
"1":element -> "2"[];
"2" -> "4"[dir=both,arrowtail=odiamond];
"2" -> "6"[dir=both,arrowtail=odiamond];
"2" -> "5"[dir=both,arrowtail=odiamond];
"2":stability_cues -> "7"[];
"2":gender_category -> "6"[];
"2":age_category -> "5"[];
"2":group_size_category -> "4"[];
"2":tracking_info -> "3"[];
"7" -> "9"[dir=both,arrowtail=odiamond];
"7" -> "8"[dir=both,arrowtail=odiamond];
"7":data -> "9"[];
"7":size -> "8"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`GroupHypothesisCollection `
* :ref:`GroupHypothesis `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-hri-grouphypothesiscollection:
Message GroupHypothesisCollection
---------------------------------
.. container:: message-rst-hri-grouphypothesiscollection-multi
.. container:: message-rst-hri-grouphypothesiscollection-documentation
.. py:class:: rst.hri.GroupHypothesisCollection
Collection of :py:class:`GroupHypothesis ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.hri.GroupHypothesis`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-hri-grouphypothesiscollection-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesisCollection.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesisCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-hri-grouphypothesis:
Message GroupHypothesis
-----------------------
.. container:: message-rst-hri-grouphypothesis-multi
.. container:: message-rst-hri-grouphypothesis-documentation
.. py:class:: rst.hri.GroupHypothesis
A hypothesis about a group visible to and/or interacting with the
robot. Will include estimates about group size and some attributes
like engagement.
.. codeauthor:: David Klotz
@create_collection
.. py:attribute:: tracking_info
:type: :py:class:`rst.tracking.TrackingInfo`
A unique identification of a group hypothesis maintained by the
group manager.
.. py:attribute:: group_size_estimate
:type: :py:class:`UINT32`
Information about the size (number of people) of the group.
.. py:attribute:: group_size_category
:type: :py:class:`rst.hri.GroupHypothesis.SizeCategory`
*Not documented*
.. py:attribute:: interest_level
:type: :py:class:`FLOAT32`
**Constraint**: ``0.0 <= value <= 1.0``
Group engagement information:
A level of interest the group is showing towards the robot.
.. py:attribute:: group_stability
:type: :py:class:`FLOAT32`
**Constraint**: ``0.0 <= value <= 1.0``
How stable is the group, i.e. is there a low level of
fluctuation of group members.
.. py:attribute:: age_category
:type: :py:class:`rst.hri.GroupHypothesis.AgeCategory`
Information about the group composition, structure etc.
.. py:attribute:: gender_category
:type: :py:class:`rst.hri.GroupHypothesis.GenderCategory`
*Not documented*
.. py:attribute:: stability_cues
:type: :py:class:`rst.math.MatrixDouble`
Internal cue data for evaluation
.. container:: message-rst-hri-grouphypothesis-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto
:lines: 18-86
:language: protobuf
:emphasize-lines: 35-35,40-40,41-41,49-49,56-56,61-61,62-62,67-67
.. _message-rst-hri-grouphypothesis-agecategory:
Message AgeCategory
-------------------
.. container:: message-rst-hri-grouphypothesis-agecategory-multi
.. container:: message-rst-hri-grouphypothesis-agecategory-documentation
.. py:class:: rst.hri.GroupHypothesis.AgeCategory
A category for the age of the group members.
.. py:attribute:: CHILDREN
= 1
*Not documented*
.. py:attribute:: ADULTS
= 2
*Not documented*
.. py:attribute:: SENIORS
= 4
*Not documented*
.. py:attribute:: MIXED
= 8
*Not documented*
.. container:: message-rst-hri-grouphypothesis-agecategory-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto
:lines: 23-28
:language: protobuf
:emphasize-lines: 2-2,3-3,4-4,5-5
.. _message-rst-hri-grouphypothesis-gendercategory:
Message GenderCategory
----------------------
.. container:: message-rst-hri-grouphypothesis-gendercategory-multi
.. container:: message-rst-hri-grouphypothesis-gendercategory-documentation
.. py:class:: rst.hri.GroupHypothesis.GenderCategory
A category for the gender of the group members.
.. py:attribute:: MIXED_GENDERS
= 1
*Not documented*
.. py:attribute:: COMPLETELY_FEMALE
= 2
*Not documented*
.. py:attribute:: COMPLETELY_MALE
= 4
*Not documented*
.. container:: message-rst-hri-grouphypothesis-gendercategory-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto
:lines: 33-37
:language: protobuf
:emphasize-lines: 2-2,3-3,4-4
.. _message-rst-hri-grouphypothesis-sizecategory:
Message SizeCategory
--------------------
.. container:: message-rst-hri-grouphypothesis-sizecategory-multi
.. container:: message-rst-hri-grouphypothesis-sizecategory-documentation
.. py:class:: rst.hri.GroupHypothesis.SizeCategory
A category for the group size.
.. py:attribute:: SMALL_GROUP
= 1
*Not documented*
.. py:attribute:: GROUP
= 2
*Not documented*
.. py:attribute:: CROWD
= 4
*Not documented*
.. container:: message-rst-hri-grouphypothesis-sizecategory-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/deprecated/rst/hri/GroupHypothesis.proto
:lines: 42-46
:language: protobuf
:emphasize-lines: 2-2,3-3,4-4