.. _package-rst-classification:

============================
 Package rst.classification
============================



In machine learning and statistics, classification is the problem
of identifying to which of a set of categories (sub-populations) a
new observation belongs.

This package contains data types representing classification
problems and classification results (e.g. :py:class:`ClassificationResult <rst.classification.ClassificationResult>`).


.. seealso::

   Wikipedia article containing the definition above
     http://en.wikipedia.org/wiki/Statistical_classification



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"]
           "7" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegions3D" TITLE="Structure rst.classification.ClassifiedRegions3D" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">ClassifiedRegions3D</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion3D" TITLE="Structure rst.classification.ClassifiedRegion3D" TARGET="_parent">ClassifiedRegion3D</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegions3D.regions" TITLE="Field rst.classification.ClassifiedRegions3D.regions" TARGET="_parent" PORT="regions">regions</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "8" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion3D" TITLE="Structure rst.classification.ClassifiedRegion3D" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">ClassifiedRegion3D</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat" TITLE="Structure rst.geometry.BoundingBox3DFloat" TARGET="_parent">BoundingBox3DFloat</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion3D.region" TITLE="Field rst.classification.ClassifiedRegion3D.region" TARGET="_parent" PORT="region">region</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult" TITLE="Structure rst.classification.ClassificationResult" TARGET="_parent">ClassificationResult</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion3D.result" TITLE="Field rst.classification.ClassifiedRegion3D.result" TARGET="_parent" PORT="result">result</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "9" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat" TITLE="Structure rst.geometry.BoundingBox3DFloat" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">BoundingBox3DFloat</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose" TITLE="Structure rst.geometry.Pose" TARGET="_parent">Pose</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.transformation" TITLE="Field rst.geometry.BoundingBox3DFloat.transformation" TARGET="_parent" PORT="transformation">transformation</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.width" TITLE="Field rst.geometry.BoundingBox3DFloat.width" TARGET="_parent" PORT="width">width</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.depth" TITLE="Field rst.geometry.BoundingBox3DFloat.depth" TARGET="_parent" PORT="depth">depth</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.height" TITLE="Field rst.geometry.BoundingBox3DFloat.height" TARGET="_parent" PORT="height">height</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "10" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose" TITLE="Structure rst.geometry.Pose" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Pose</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation" TITLE="Structure rst.geometry.Translation" TARGET="_parent">Translation</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose.translation" TITLE="Field rst.geometry.Pose.translation" TARGET="_parent" PORT="translation">translation</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation" TITLE="Structure rst.geometry.Rotation" TARGET="_parent">Rotation</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose.rotation" TITLE="Field rst.geometry.Pose.rotation" TARGET="_parent" PORT="rotation">rotation</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "12" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation" TITLE="Structure rst.geometry.Rotation" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Rotation</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qw" TITLE="Field rst.geometry.Rotation.qw" TARGET="_parent" PORT="qw">qw</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qx" TITLE="Field rst.geometry.Rotation.qx" TARGET="_parent" PORT="qx">qx</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qy" TITLE="Field rst.geometry.Rotation.qy" TARGET="_parent" PORT="qy">qy</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qz" TITLE="Field rst.geometry.Rotation.qz" TARGET="_parent" PORT="qz">qz</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.frame_id" TITLE="Field rst.geometry.Rotation.frame_id" TARGET="_parent" PORT="frame_id">frame_id</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "11" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation" TITLE="Structure rst.geometry.Translation" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Translation</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.x" TITLE="Field rst.geometry.Translation.x" TARGET="_parent" PORT="x">x</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.y" TITLE="Field rst.geometry.Translation.y" TARGET="_parent" PORT="y">y</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.z" TITLE="Field rst.geometry.Translation.z" TARGET="_parent" PORT="z">z</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.frame_id" TITLE="Field rst.geometry.Translation.frame_id" TARGET="_parent" PORT="frame_id">frame_id</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "1" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegions2D" TITLE="Structure rst.classification.ClassifiedRegions2D" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">ClassifiedRegions2D</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion2D" TITLE="Structure rst.classification.ClassifiedRegion2D" TARGET="_parent">ClassifiedRegion2D</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegions2D.regions" TITLE="Field rst.classification.ClassifiedRegions2D.regions" TARGET="_parent" PORT="regions">regions</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion2D" TITLE="Structure rst.classification.ClassifiedRegion2D" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">ClassifiedRegion2D</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox" TITLE="Structure rst.geometry.BoundingBox" TARGET="_parent">BoundingBox</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion2D.region" TITLE="Field rst.classification.ClassifiedRegion2D.region" TARGET="_parent" PORT="region">region</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult" TITLE="Structure rst.classification.ClassificationResult" TARGET="_parent">ClassificationResult</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassifiedRegion2D.result" TITLE="Field rst.classification.ClassifiedRegion2D.result" TARGET="_parent" PORT="result">result</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "5" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult" TITLE="Structure rst.classification.ClassificationResult" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">ClassificationResult</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.decided_class" TITLE="Field rst.classification.ClassificationResult.decided_class" TARGET="_parent" PORT="decided_class">decided_class</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability" TITLE="Structure rst.classification.ClassificationResult.ClassWithProbability" TARGET="_parent">ClassWithProbability</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.classes" TITLE="Field rst.classification.ClassificationResult.classes" TARGET="_parent" PORT="classes">classes</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "6" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability" TITLE="Structure rst.classification.ClassificationResult.ClassWithProbability" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">ClassWithProbability</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability.name" TITLE="Field rst.classification.ClassificationResult.ClassWithProbability.name" TARGET="_parent" PORT="name">name</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability.confidence" TITLE="Field rst.classification.ClassificationResult.ClassWithProbability.confidence" TARGET="_parent" PORT="confidence">confidence</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "3" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox" TITLE="Structure rst.geometry.BoundingBox" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">BoundingBox</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-math.html#rst.math.Vec2DInt" TITLE="Structure rst.math.Vec2DInt" TARGET="_parent">Vec2DInt</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox.top_left" TITLE="Field rst.geometry.BoundingBox.top_left" TARGET="_parent" PORT="top_left">top_left</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox.width" TITLE="Field rst.geometry.BoundingBox.width" TARGET="_parent" PORT="width">width</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox.height" TITLE="Field rst.geometry.BoundingBox.height" TARGET="_parent" PORT="height">height</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox.image_width" TITLE="Field rst.geometry.BoundingBox.image_width" TARGET="_parent" PORT="image_width">image_width</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox.image_height" TITLE="Field rst.geometry.BoundingBox.image_height" TARGET="_parent" PORT="image_height">image_height</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "4" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-math.html#rst.math.Vec2DInt" TITLE="Structure rst.math.Vec2DInt" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Vec2DInt</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-INT32.html#INT32" TITLE="Fundamental INT32" TARGET="_parent">INT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-math.html#rst.math.Vec2DInt.x" TITLE="Field rst.math.Vec2DInt.x" TARGET="_parent" PORT="x">x</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-INT32.html#INT32" TITLE="Fundamental INT32" TARGET="_parent">INT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-math.html#rst.math.Vec2DInt.y" TITLE="Field rst.math.Vec2DInt.y" TARGET="_parent" PORT="y">y</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "7":regions -> "8" [];
           "8":result -> "5" [];
           "8":region -> "9" [];
           "9":transformation -> "10" [];
           "10":rotation -> "12" [];
           "10":translation -> "11" [];
           "1":regions -> "2" [];
           "2":result -> "5" [];
           "2":region -> "3" [];
           "5" -> "6" [];
           "5":classes -> "6" [];
           "3":top_left -> "4" [];
         

   .. container:: mess4ge-list

      .. container:: messages

         * :ref:`ClassifiedRegions2D <message-rst-classification-classifiedregions2d>`
         * :ref:`ClassifiedRegions3D <message-rst-classification-classifiedregions3d>`
         * :ref:`ClassifiedRegion2D <message-rst-classification-classifiedregion2d>`
         * :ref:`ClassifiedRegion3D <message-rst-classification-classifiedregion3d>`
         * :ref:`ClassificationResult <message-rst-classification-classificationresult>`

      .. container:: clearer

         clearer: should be made invisible via css

.. _message-rst-classification-classifiedregions2d:

Message ClassifiedRegions2D
---------------------------

.. container:: message-rst-classification-classifiedregions2d-multi

   .. container:: message-rst-classification-classifiedregions2d-documentation

      .. py:class:: rst.classification.ClassifiedRegions2D

         
         
         A set of image regions with classification results.
         
         
         .. codeauthor:: Leon Ziegler <lziegler@techfak.uni-bielefeld.de>
         

         .. py:attribute:: regions

            :type: array of  :py:class:`rst.classification.ClassifiedRegion2D`

            
            
            The set of regions.
            
            The order of elements is not significant.

   .. container:: message-rst-classification-classifiedregions2d-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegions2D.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegions2D.proto
         :lines: 12-21
         :language: protobuf
         :emphasize-lines: 8-8



.. _message-rst-classification-classifiedregions3d:

Message ClassifiedRegions3D
---------------------------

.. container:: message-rst-classification-classifiedregions3d-multi

   .. container:: message-rst-classification-classifiedregions3d-documentation

      .. py:class:: rst.classification.ClassifiedRegions3D

         
         
         A set of 3D regions with classification results.
         
         
         .. codeauthor:: Leon Ziegler <lziegler@techfak.uni-bielefeld.de>
         

         .. py:attribute:: regions

            :type: array of  :py:class:`rst.classification.ClassifiedRegion3D`

            
            
            The set of regions.
            
            The order of elements is not significant.

   .. container:: message-rst-classification-classifiedregions3d-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegions3D.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegions3D.proto
         :lines: 12-21
         :language: protobuf
         :emphasize-lines: 8-8



.. _message-rst-classification-classifiedregion2d:

Message ClassifiedRegion2D
--------------------------

.. container:: message-rst-classification-classifiedregion2d-multi

   .. container:: message-rst-classification-classifiedregion2d-documentation

      .. py:class:: rst.classification.ClassifiedRegion2D

         
         
         Focus on image coordinate systems (vision-based).
         
         A image region with a classification result.
         
         
         .. codeauthor:: Leon Ziegler <lziegler@techfak.uni-bielefeld.de>
         

         .. py:attribute:: region

            :type: :py:class:`rst.geometry.BoundingBox`

            
            
            Region in the input image.

         .. py:attribute:: result

            :type: :py:class:`rst.classification.ClassificationResult`

            
            
            The class represented by the image region.

   .. container:: message-rst-classification-classifiedregion2d-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegion2D.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegion2D.proto
         :lines: 15-27
         :language: protobuf
         :emphasize-lines: 6-6,11-11



.. _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 <lziegler@techfak.uni-bielefeld.de>
         

         .. 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 <//home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassifiedRegion3D.proto>`

      .. 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 <jwienke@techfak.uni-bielefeld.de>
         

         .. 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 <//home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassificationResult.proto>`

      .. 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 <//home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/classification/ClassificationResult.proto>`

      .. 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