.. oe:namespace:: OESzmap

.. meta::
   :keywords: OECalcSzmapResults

.. oe:function:: OECalcSzmapResults

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalcSzmapResults(OESzmap::OESzmapResults& results,
                                 OESzmap::OESzmapEngine& szmap,
                                 const float* xyz)
         bool OECalcSzmapResults(OESzmap::OESzmapResults& results,
                                 OESzmap::OESzmapEngine& szmap,
                                 const double* xyz)

   .. oe:language:: python

      .. oe:api:: python

         OECalcSzmapResults(results: OESzmapResults, szmap: OESzmapEngine,
                            xyz: OEFloatArray) -> bool
         OECalcSzmapResults(results: OESzmapResults, szmap: OESzmapEngine,
                            xyz: OEDoubleArray) -> bool

   Update a :ref:`OESzmapResults <OESzmap_OESzmapResults>` object by performing *SZMAP* calculations
   at the specified 3D point, using the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` provided. The
   :ref:`OESzmapResults <OESzmap_OESzmapResults>` provides access to all of the
   :oe:constns:`OESzmap::OEEnsemble`
   and :oe:constns:`OESzmap::OEComponent` values as well as orientation probabilities
   and geometry.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`


   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   Returns *false* if calculations were not performed because
   the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` was not initialized.

   The 3D point is a float or double array of size three with coordinates in {x,y,z} order.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`


   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT


