.. _package-rst-classification:
============================
Package rst.classification
============================
*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"]
"6" [label=< | ClassifiedRegion3D |
|
| BoundingBox3DFloat | region |
| ClassificationResult | result |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | BoundingBox3DFloat |
|
| Pose | transformation |
| FLOAT32 | width |
| FLOAT32 | depth |
| FLOAT32 | height |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Pose |
|
| Translation | translation |
| Rotation | rotation |
>,shape=box,style=filled,fillcolor="white"];
"10" [label=< | Rotation |
|
| FLOAT64 | qw |
| FLOAT64 | qx |
| FLOAT64 | qy |
| FLOAT64 | qz |
| ASCII-STRING | frame_id |
>,shape=box,style=filled,fillcolor="white"];
"9" [label=< | Translation |
|
| FLOAT64 | x |
| FLOAT64 | y |
| FLOAT64 | z |
| ASCII-STRING | frame_id |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | ClassificationResultMap |
|
| Entry | aspects |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | Entry |
|
| ASCII-STRING | name |
| ClassificationResult | result |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | ClassificationResults |
|
| ClassificationResult | classes |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | ClassificationResult |
|
| OCTET-VECTOR | decided_class |
| ClassWithProbability | classes |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | ClassWithProbability |
|
| OCTET-VECTOR | name |
| FLOAT32 | confidence |
>,shape=box,style=filled,fillcolor="white"];
"6":result -> "2" [];
"6":region -> "7" [];
"7":transformation -> "8" [];
"8":rotation -> "10" [];
"8":translation -> "9" [];
"4" -> "5" [];
"4":aspects -> "5" [];
"5":result -> "2" [];
"1":classes -> "2" [];
"2" -> "3" [];
"2":classes -> "3" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`ClassificationResults `
* :ref:`ClassificationResultMap `
* :ref:`ClassifiedRegion3D `
* :ref:`ClassificationResult `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-classification-classificationresults:
Message ClassificationResults
-----------------------------
.. container:: message-rst-classification-classificationresults-multi
.. container:: message-rst-classification-classificationresults-documentation
.. py:class:: rst.classification.ClassificationResults
A class representing multiple result of classification process(es).
.. codeauthor:: Norman Koester
.. py:attribute:: classes
:type: array of :py:class:`rst.classification.ClassificationResult`
A vector of results holding multiple classification results.
The results inside should be a merged representation and not
contradict each other w.r.t. the individual classes.
Empty collection of boxes is allowed.
The order of box objects is not significant.
.. container:: message-rst-classification-classificationresults-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/sandbox/rst/classification/ClassificationResults.proto
:lines: 12-25
:language: protobuf
:emphasize-lines: 12-12
.. _message-rst-classification-classificationresultmap:
Message ClassificationResultMap
-------------------------------
.. container:: message-rst-classification-classificationresultmap-multi
.. container:: message-rst-classification-classificationresultmap-documentation
.. py:class:: rst.classification.ClassificationResultMap
A map of :py:class:`ClassificationResult ` instances.
Entries are indexed by string keys.
.. codeauthor:: Viktor Richter
.. py:attribute:: aspects
:type: array of :py:class:`rst.classification.ClassificationResultMap.Entry`
The map contents. Each must exist only once. Order
does not matter. Empty set is allowed.
.. container:: message-rst-classification-classificationresultmap-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/sandbox/rst/classification/ClassificationResultMap.proto
:lines: 13-39
:language: protobuf
:emphasize-lines: 25-25
.. _message-rst-classification-classificationresultmap-entry:
Message Entry
-------------
.. container:: message-rst-classification-classificationresultmap-entry-multi
.. container:: message-rst-classification-classificationresultmap-entry-documentation
.. py:class:: rst.classification.ClassificationResultMap.Entry
One entry of the map as a key-value pair.
.. py:attribute:: name
:type: :py:class:`ASCII-STRING`
The name or key of the entry.
.. py:attribute:: result
:type: :py:class:`rst.classification.ClassificationResult`
The associated :py:class:`ClassificationResult `
of the entry.
.. container:: message-rst-classification-classificationresultmap-entry-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/sandbox/rst/classification/ClassificationResultMap.proto
:lines: 18-31
:language: protobuf
:emphasize-lines: 6-6,12-12
.. _message-rst-classification-classifiedregion3d:
Message ClassifiedRegion3D
--------------------------
.. container:: message-rst-classification-classifiedregion3d-multi
.. container:: message-rst-classification-classifiedregion3d-documentation
.. py:class:: rst.classification.ClassifiedRegion3D
Focus on image coordinate systems (vision-based).
A region in 3D space with a classification result.
.. codeauthor:: Leon Ziegler
.. py:attribute:: region
:type: :py:class:`rst.geometry.BoundingBox3DFloat`
Region in 3D space.
.. py:attribute:: result
:type: :py:class:`rst.classification.ClassificationResult`
The class represented by the 3D region.
.. container:: message-rst-classification-classifiedregion3d-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegion3D.proto
:lines: 15-27
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-classification-classificationresult:
Message ClassificationResult
----------------------------
.. container:: message-rst-classification-classificationresult-multi
.. container:: message-rst-classification-classificationresult-documentation
.. py:class:: rst.classification.ClassificationResult
A class representing the result of a classification process.
An example of such a result could be the output of an SVM-based
classifier.
In the simplest form, only the name of a decided class is
given. However, it is also possible to give the whole vector of
possible classes with their probabilities.
.. codeauthor:: Johannes Wienke
.. py:attribute:: decided_class
:type: :py:class:`OCTET-VECTOR`
A shortcut to get the most likely class easily.
This needs to be an ASCII string.
.. py:attribute:: classes
:type: array of :py:class:`rst.classification.ClassificationResult.ClassWithProbability`
The complete vector of classes with their probabilities if
suitable.
The results in this vector should of cause not contradict
decided_class.
.. container:: message-rst-classification-classificationresult-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassificationResult.proto
:lines: 17-56
:language: protobuf
:emphasize-lines: 8-8,38-38
.. _message-rst-classification-classificationresult-classwithprobability:
Message ClassWithProbability
----------------------------
.. container:: message-rst-classification-classificationresult-classwithprobability-multi
.. container:: message-rst-classification-classificationresult-classwithprobability-documentation
.. py:class:: rst.classification.ClassificationResult.ClassWithProbability
Represents a single class a classification process can return
with the probability that this class applies to the classified
aspect.
.. py:attribute:: name
:type: :py:class:`OCTET-VECTOR`
Name of the class (ASCII string).
.. py:attribute:: confidence
:type: :py:class:`FLOAT32`
Some kind of confidence, values are application dependent.
However, values summing up to 1 are preferred.
.. container:: message-rst-classification-classificationresult-classwithprobability-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassificationResult.proto
:lines: 31-45
:language: protobuf
:emphasize-lines: 6-6,13-13