.. _package-rst-tracking:
======================
Package rst.tracking
======================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/corlab.css";
node [fontsize=11]
node [fontname="Arial"]
edge [fontsize=11]
edge [fontname="Arial"]
"9" [label=<
| TrackedPositions3DFloat |
|
TrackedPosition3DFloat | position |
>,shape=box,style=filled,fillcolor="white"];
"10" [label=< | TrackedPosition3DFloat |
|
TrackingInfo | info |
Translation | position |
FLOAT32 | confidence |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | TrackedPostures3DFloat |
|
TrackedPosture3DFloat | posture |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | TrackedPosture3DFloat |
|
TrackingInfo | info |
Posture3DFloat | posture |
FLOAT32 | confidence |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | Posture3DFloat |
|
Translation | position |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Translation |
|
FLOAT64 | x |
FLOAT64 | y |
FLOAT64 | z |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | States |
|
State | state |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | State |
|
TrackingInfo | info |
Aspect | aspect |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | Aspect |
|
ASPECT_POSITION_2D | 0 |
ASPECT_POSITION_3D | 1 |
ASPECT_AXIS_ALIGNED_BOUNDING_BOX_2D | 2 |
ASPECT_AXIS_ALIGNED_BOUNDING_BOX_3D | 3 |
ASPECT_BOUNDING_BOX_2D | 4 |
ASPECT_BOUNDING_BOX_3D | 5 |
ASPECT_CONTOUR | 6 |
ASPECT_POSTURE_2D | 7 |
ASPECT_POSTURE_3D | 8 |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | TrackingInfo |
|
UINT32 | id |
>,shape=box,style=filled,fillcolor="white"];
"9":position -> "10" [];
"10":position -> "8" [];
"10":info -> "3" [];
"5":posture -> "6" [];
"6":posture -> "7" [];
"6":info -> "3" [];
"7":position -> "8" [];
"1":state -> "2" [];
"2" -> "4" [dir=both,arrowtail=odiamond];
"2":aspect -> "4" [];
"2":info -> "3" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`States `
* :ref:`State `
* :ref:`TrackedPostures3DFloat `
* :ref:`TrackedPosture3DFloat `
* :ref:`TrackedPositions3DFloat `
* :ref:`TrackedPosition3DFloat `
* :ref:`TrackingInfo `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-tracking-states:
Message States
--------------
.. container:: message-rst-tracking-states-multi
.. container:: message-rst-tracking-states-documentation
.. py:class:: rst.tracking.States
A collection of :py:class:`State ` objects.
Collecting multiple :py:class:`State ` objects in a single data structure
is an easy way to express the fact that they have been recorded at
the same point in time.
.. codeauthor:: Jan Moringen
.. py:attribute:: state
:type: array of :py:class:`rst.tracking.State`
Empty collections of states are allowed.
Order of states is not significant since association of states
to tracked subjects is done via .
.. container:: message-rst-tracking-states-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/States.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/States.proto
:lines: 16-26
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-tracking-state:
Message State
-------------
.. container:: message-rst-tracking-state-multi
.. container:: message-rst-tracking-state-documentation
.. py:class:: rst.tracking.State
Describes the available tracking information (via :py:attr:`aspect `) for
a given tracked subject (identified by :py:attr:`info `).
Possible applications include answering queries regarding the
tracking state of certain subjects or broadcasting updated tracking
state information when changes occur.
.. codeauthor:: Jan Moringen
.. py:attribute:: info
:type: :py:class:`rst.tracking.TrackingInfo`
Identifies the subject for which the tracking state is
reported.
.. py:attribute:: aspect
:type: array of :py:class:`rst.tracking.State.Aspect`
Lists of the available tracking aspects for the subject
identified by :py:attr:`info `.
An empty collection of aspects is allowed and corresponds to
the fact that a subject has been lost.
The order of aspects is not significant.
.. container:: message-rst-tracking-state-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/State.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/State.proto
:lines: 17-116
:language: protobuf
:emphasize-lines: 87-87,98-98
.. _message-rst-tracking-state-aspect:
Message Aspect
--------------
.. container:: message-rst-tracking-state-aspect-multi
.. container:: message-rst-tracking-state-aspect-documentation
.. py:class:: rst.tracking.State.Aspect
Aspects of tracking information which are available in the
reported tracking state.
.. py:attribute:: ASPECT_POSITION_2D
= 0
A rough description of the position of the tracked subject
in two-dimensional space (e.g. in a camera image) is
available.
See :py:class:`Vec2DInt `, :py:class:`Vec2DFloat `.
.. py:attribute:: ASPECT_POSITION_3D
= 1
A rough description of the position of the tracked subject
in three-dimensional space is available.
See :py:class:`Translation `.
.. py:attribute:: ASPECT_AXIS_ALIGNED_BOUNDING_BOX_2D
= 2
An axis-aligned box bounding the area in which the tracked
subject is contained is available.
See :py:class:`BoundingBox `.
.. py:attribute:: ASPECT_AXIS_ALIGNED_BOUNDING_BOX_3D
= 3
An axis-aligned box bounding the volume in which the
tracked subject is contained is available.
See :py:class:`AxisAlignedBoundingBox3DFloat `.
.. py:attribute:: ASPECT_BOUNDING_BOX_2D
= 4
A box in general position and orientation (i.e. not
necessarily axis-aligned) bounding the area in which the
tracked subject is contained is available.
.. py:attribute:: ASPECT_BOUNDING_BOX_3D
= 5
A box in general position and orientation (i.e. not
necessarily axis-aligned) bounding the volume in which the
tracked subject is contained is available.
See :py:class:`BoundingBox3DFloat `.
.. py:attribute:: ASPECT_CONTOUR
= 6
A contour bounding the area in which the tracked subject is
contained is available.
.. py:attribute:: ASPECT_POSTURE_2D
= 7
For an articulated tracked subject (such as a human or a
humanoid robot), individual estimations of the positions of
certain points on/in the body of the subject in
two-dimensional space are available.
.. py:attribute:: ASPECT_POSTURE_3D
= 8
For an articulated tracked subject (such as a human or a
humanoid robot), individual estimations of the positions of
certain points on/in the body of the subject in
three-dimensional space are available.
See :py:class:`Posture3DFloat `.
.. container:: message-rst-tracking-state-aspect-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/State.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/State.proto
:lines: 23-97
:language: protobuf
:emphasize-lines: 10-10,18-18,26-26,34-34,41-41,50-50,56-56,64-64,74-74
.. _message-rst-tracking-trackedpostures3dfloat:
Message TrackedPostures3DFloat
------------------------------
.. container:: message-rst-tracking-trackedpostures3dfloat-multi
.. container:: message-rst-tracking-trackedpostures3dfloat-documentation
.. py:class:: rst.tracking.TrackedPostures3DFloat
A collection of :py:class:`TrackedPosture3DFloat ` objects.
Collecting multiple :py:class:`TrackedPosture3DFloat ` objects in a single
data structure is an easy way to express the fact that they have
been recorded at the same point in time.
.. codeauthor:: Jan Moringen
.. py:attribute:: posture
:type: array of :py:class:`rst.tracking.TrackedPosture3DFloat`
Empty collections of tracked postures are allowed but should
rarely be necessary.
Order of postures is not significant since association of
tracked postures to tracked subjects is done via .
.. container:: message-rst-tracking-trackedpostures3dfloat-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPostures3DFloat.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPostures3DFloat.proto
:lines: 16-28
:language: protobuf
:emphasize-lines: 11-11
.. _message-rst-tracking-trackedposture3dfloat:
Message TrackedPosture3DFloat
-----------------------------
.. container:: message-rst-tracking-trackedposture3dfloat-multi
.. container:: message-rst-tracking-trackedposture3dfloat-documentation
.. py:class:: rst.tracking.TrackedPosture3DFloat
**Constraint**: ``len(.posture) == len(.confidence)``
Posture of an articulated tracked subject.
.. codeauthor:: Jan Moringen
.. py:attribute:: info
:type: :py:class:`rst.tracking.TrackingInfo`
Tracking information such as identity of the subject being
tracked.
.. py:attribute:: posture
:type: :py:class:`rst.kinematics.Posture3DFloat`
Posture of the tracked subject identified by :py:attr:`info `.
.. py:attribute:: confidence
:type: array of :py:class:`FLOAT32`
**Constraint**: ``0 <= value <= 1``
Confidence values for the individual positions stored in :py:attr:`posture `.
.. container:: message-rst-tracking-trackedposture3dfloat-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPosture3DFloat.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPosture3DFloat.proto
:lines: 14-34
:language: protobuf
:emphasize-lines: 7-7,12-12,19-19
.. _message-rst-tracking-trackedpositions3dfloat:
Message TrackedPositions3DFloat
-------------------------------
.. container:: message-rst-tracking-trackedpositions3dfloat-multi
.. container:: message-rst-tracking-trackedpositions3dfloat-documentation
.. py:class:: rst.tracking.TrackedPositions3DFloat
A collection of :py:class:`TrackedPosition3DFloat ` objects.
Collecting multiple :py:class:`TrackedPosition3DFloat ` objects in a
single data structure is an easy way to express the fact that they
have been recorded at the same point in time.
.. codeauthor:: Jan Moringen
.. py:attribute:: position
:type: array of :py:class:`rst.tracking.TrackedPosition3DFloat`
Empty collections of tracked positions are allowed but should
rarely be necessary.
Order of positions is not significant since association of
tracked positions to tracked subjects is done via .
.. container:: message-rst-tracking-trackedpositions3dfloat-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPositions3DFloat.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPositions3DFloat.proto
:lines: 16-28
:language: protobuf
:emphasize-lines: 11-11
.. _message-rst-tracking-trackedposition3dfloat:
Message TrackedPosition3DFloat
------------------------------
.. container:: message-rst-tracking-trackedposition3dfloat-multi
.. container:: message-rst-tracking-trackedposition3dfloat-documentation
.. py:class:: rst.tracking.TrackedPosition3DFloat
Position of a tracked subject in three-dimensional space.
.. codeauthor:: Jan Moringen
.. py:attribute:: info
:type: :py:class:`rst.tracking.TrackingInfo`
Tracking information such as identity of the subject being
tracked.
.. py:attribute:: position
:type: :py:class:`rst.geometry.Translation`
Position of the tracked subject identified by :py:attr:`info ` in
three-dimensional space.
.. py:attribute:: confidence
:type: :py:class:`FLOAT32`
**Constraint**: ``0 <= value <= 1``
Confidence in the correctness of the value stored in :py:attr:`position `.
.. container:: message-rst-tracking-trackedposition3dfloat-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPosition3DFloat.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/tracking/TrackedPosition3DFloat.proto
:lines: 13-34
:language: protobuf
:emphasize-lines: 7-7,13-13,20-20
.. _message-rst-tracking-trackinginfo:
Message TrackingInfo
--------------------
.. container:: message-rst-tracking-trackinginfo-multi
.. container:: message-rst-tracking-trackinginfo-documentation
.. py:class:: rst.tracking.TrackingInfo
Identifier for tracked objects.
.. codeauthor:: Johannes Wienke
.. py:attribute:: id
:type: :py:class:`UINT32`
A unique id for each track.
.. container:: message-rst-tracking-trackinginfo-source
:download:`Download this file /home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/tracking/TrackingInfo.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/tracking/TrackingInfo.proto
:lines: 10-17
:language: protobuf
:emphasize-lines: 6-6