.. _package-rst-vision:
====================
Package rst.vision
====================
*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"]
"10" [label=< | HeadObjects |
|
| HeadObject | head_objects |
>,shape=box,style=filled,fillcolor="white"];
"11" [label=< | HeadObject |
|
| TrackingInfo | tracking_info |
| BoundingBox | region |
| Vec3DFloat | position |
| Vec3DFloat | pose |
| LabeledFace | faces |
| FLOAT32 | speaking_probability |
| OCTET-VECTOR | vfoa_target |
| ClassificationResult | identity |
| ClassificationResult | gender |
| ClassificationResult | age |
>,shape=box,style=filled,fillcolor="white"];
"15" [label=< | ClassificationResult |
|
| OCTET-VECTOR | decided_class |
| ClassWithProbability | classes |
>,shape=box,style=filled,fillcolor="white"];
"16" [label=< | ClassWithProbability |
|
| OCTET-VECTOR | name |
| FLOAT32 | confidence |
>,shape=box,style=filled,fillcolor="white"];
"14" [label=< | LabeledFace |
|
| OCTET-VECTOR | label |
| Face | face |
>,shape=box,style=filled,fillcolor="white"];
"13" [label=< | Vec3DFloat |
|
| FLOAT32 | x |
| FLOAT32 | y |
| FLOAT32 | z |
>,shape=box,style=filled,fillcolor="white"];
"12" [label=< | TrackingInfo |
|
| UINT32 | id |
| OCTET-VECTOR | persistent_id |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | LocatedFace |
|
| Face | face |
| Translation | location |
| Rotation | orientation |
>,shape=box,style=filled,fillcolor="white"];
"9" [label=< | Rotation |
|
| FLOAT64 | qw |
| FLOAT64 | qx |
| FLOAT64 | qy |
| FLOAT64 | qz |
| ASCII-STRING | frame_id |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Translation |
|
| FLOAT64 | x |
| FLOAT64 | y |
| FLOAT64 | z |
| ASCII-STRING | frame_id |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | Face |
|
| BoundingBox | region |
| FLOAT64 | confidence |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | BoundingBox |
|
| Vec2DInt | top_left |
| UINT32 | width |
| UINT32 | height |
| UINT32 | image_width |
| UINT32 | image_height |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | Vec2DInt |
|
| INT32 | x |
| INT32 | y |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | EncodedImageCollection |
|
| EncodedImage | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | EncodedImage |
|
| Encoding | encoding |
| OCTET-VECTOR | data |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Encoding |
|
| PPM | 1 |
| PNG | 2 |
| JPG | 3 |
| JP2 | 4 |
| TIFF | 5 |
>,shape=box,style=filled,fillcolor="white"];
"10":head_objects -> "11"[];
"11" -> "14"[dir=both,arrowtail=odiamond];
"11":age -> "15"[];
"11":gender -> "15"[];
"11":identity -> "15"[];
"11":faces -> "14"[];
"11":pose -> "13"[];
"11":position -> "13"[];
"11":region -> "6"[];
"11":tracking_info -> "12"[];
"15" -> "16"[dir=both,arrowtail=odiamond];
"15":classes -> "16"[];
"14":face -> "5"[];
"4":orientation -> "9"[];
"4":location -> "8"[];
"4":face -> "5"[];
"5":region -> "6"[];
"6":top_left -> "7"[];
"1":element -> "2"[];
"2" -> "3"[dir=both,arrowtail=odiamond];
"2":encoding -> "3"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`EncodedImageCollection `
* :ref:`LocatedFace `
* :ref:`EncodedImage `
* :ref:`HeadObjects `
* :ref:`HeadObject `
* :ref:`Face `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-vision-encodedimagecollection:
Message EncodedImageCollection
------------------------------
.. container:: message-rst-vision-encodedimagecollection-multi
.. container:: message-rst-vision-encodedimagecollection-documentation
.. py:class:: rst.vision.EncodedImageCollection
Collection of :py:class:`EncodedImage ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.vision.EncodedImage`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-vision-encodedimagecollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.16/upstream/RST-0.16.7-Linux/share/rst0.16/proto/sandbox/rst/vision/EncodedImageCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-vision-encodedimage:
Message EncodedImage
--------------------
.. container:: message-rst-vision-encodedimage-multi
.. container:: message-rst-vision-encodedimage-documentation
.. py:class:: rst.vision.EncodedImage
An image encoded in a certain format.
.. codeauthor:: Viktor Richter
@create_collection
.. py:attribute:: encoding
:type: :py:class:`rst.vision.EncodedImage.Encoding`
The encoding used to encode an image into binary data.
.. py:attribute:: data
:type: :py:class:`OCTET-VECTOR`
Holds the binary image data.
Can be decoded using the provided encoding information.
.. container:: message-rst-vision-encodedimage-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.16/upstream/RST-0.16.7-Linux/share/rst0.16/proto/sandbox/rst/vision/EncodedImage.proto
:lines: 13-80
:language: protobuf
:emphasize-lines: 59-59,66-66
.. _message-rst-vision-encodedimage-encoding:
Message Encoding
----------------
.. container:: message-rst-vision-encodedimage-encoding-multi
.. container:: message-rst-vision-encodedimage-encoding-documentation
.. py:class:: rst.vision.EncodedImage.Encoding
Identifies an image/file encoding format.
.. py:attribute:: PPM
= 1
Portable Pixmap Format.
An open uncompressed image file format.
.. seealso::
NIL
https://en.wikipedia.org/wiki/Netpbm_format
.. py:attribute:: PNG
= 2
Portable Network Graphics format (ISO/IEC 15948).
An open lossless compressed image file format.
.. seealso::
NIL
https://en.wikipedia.org/wiki/Portable_Network_Graphics
.. py:attribute:: JPG
= 3
Also known as JPEG (ISO/IEC 10918).
An image file format with adjustable lossy compression
created by the Joint Photographic Experts Group. The
compression is based on the discrete cosine transform.
.. seealso::
NIL
https://en.wikipedia.org/wiki/JPEG
.. py:attribute:: JP2
= 4
Also known as JPEG2000 (ISO/IEC 15444).
An image file format with adjustable lossy compression
created by the Joint Photographic Experts Group. This
format superseeds JPG and can use discrete cosine transform
or wavelet based methods for compression.
.. seealso::
NIL
https://en.wikipedia.org/wiki/JPEG_2000
.. py:attribute:: TIFF
= 5
Tagged Image File Format.
A computer file format for raster graphics developed by
adobe.
.. seealso::
NIL
https://en.wikipedia.org/wiki/Tagged_Image_File_Format
.. container:: message-rst-vision-encodedimage-encoding-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.16/upstream/RST-0.16.7-Linux/share/rst0.16/proto/sandbox/rst/vision/EncodedImage.proto
:lines: 18-66
:language: protobuf
:emphasize-lines: 9-9,17-17,27-27,38-38,47-47
.. _message-rst-vision-headobjects:
Message HeadObjects
-------------------
.. container:: message-rst-vision-headobjects-multi
.. container:: message-rst-vision-headobjects-documentation
.. py:class:: rst.vision.HeadObjects
A list of head objects.
.. codeauthor:: Vasil Khalidov
.. py:attribute:: head_objects
:type: array of :py:class:`rst.vision.HeadObject`
*Not documented*
.. container:: message-rst-vision-headobjects-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.16/upstream/RST-0.16.7-Linux/share/rst0.16/proto/sandbox/rst/vision/HeadObjects.proto
:lines: 14-18
:language: protobuf
:emphasize-lines: 3-3
.. _message-rst-vision-headobject:
Message HeadObject
------------------
.. container:: message-rst-vision-headobject-multi
.. container:: message-rst-vision-headobject-documentation
.. py:class:: rst.vision.HeadObject
Focus on image coordinate systems (vision-based).
A head object represented by its ID, location in the image and head
rotation angles.
id : head object identifier
.. todo::
what does the above mean?
.. codeauthor:: Vasil Khalidov
.. py:attribute:: tracking_info
:type: :py:class:`rst.tracking.TrackingInfo`
*Not documented*
.. py:attribute:: region
:type: :py:class:`rst.geometry.BoundingBox`
Head location in the input image.
.. py:attribute:: position
:type: :py:class:`rst.math.Vec3DFloat`
*Not documented*
.. py:attribute:: pose
:type: :py:class:`rst.math.Vec3DFloat`
:py:attr:`x ` -> pan
Pan head rotation angle. Positive: person looks to her or his
right side.
:py:attr:`y ` -> tilt
Tilt head rotation angle. Positive: person looks up.
:py:attr:`z ` -> roll
Roll head rotation angle. Positive: person's head rolled to
his right shoulder.
.. py:attribute:: faces
:type: array of :py:class:`rst.vision.HeadObject.LabeledFace`
.. todo::
semantic description
Repeated field because in cases of stereo processing there
might be faces from both cameras.
.. py:attribute:: speaking_probability
:type: :py:class:`FLOAT32`
*Not documented*
.. py:attribute:: vfoa_target
:type: :py:class:`OCTET-VECTOR`
String description of the visual focus of attention of this
head.
.. py:attribute:: identity
:type: :py:class:`rst.classification.ClassificationResult`
*Not documented*
.. py:attribute:: gender
:type: :py:class:`rst.classification.ClassificationResult`
*Not documented*
.. py:attribute:: age
:type: :py:class:`rst.classification.ClassificationResult`
*Not documented*
.. container:: message-rst-vision-headobject-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.16/upstream/RST-0.16.7-Linux/share/rst0.16/proto/sandbox/rst/vision/HeadObject.proto
:lines: 24-82
:language: protobuf
:emphasize-lines: 3-3,8-8,10-10,27-27,43-43,45-45,51-51,53-53,55-55,57-57
.. _message-rst-vision-headobject-labeledface:
Message LabeledFace
-------------------
.. container:: message-rst-vision-headobject-labeledface-multi
.. container:: message-rst-vision-headobject-labeledface-documentation
.. py:class:: rst.vision.HeadObject.LabeledFace
*Not documented*
.. py:attribute:: label
:type: :py:class:`OCTET-VECTOR`
*Not documented*
.. py:attribute:: face
:type: :py:class:`rst.vision.Face`
*Not documented*
.. container:: message-rst-vision-headobject-labeledface-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.16/upstream/RST-0.16.7-Linux/share/rst0.16/proto/sandbox/rst/vision/HeadObject.proto
:lines: 52-58
:language: protobuf
:emphasize-lines: 3-3,5-5