.. oe:namespace:: OESzmap

.. meta::
   :keywords: OECalcSzmapValue

.. oe:function:: OECalcSzmapValue

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

      .. oe:api::

         double OECalcSzmapValue(OESzmap::OESzmapEngine& szmap,
                                 const float* xyz,
                                 unsigned int ensembleType = OESzmap::OEEnsemble::Default)
         double OECalcSzmapValue(OESzmap::OESzmapEngine& szmap,
                                 const double* xyz,
                                 unsigned int ensembleType = OESzmap::OEEnsemble::Default)

   .. oe:language:: python

      .. oe:api:: python

         OECalcSzmapValue(szmap: OESzmapEngine, xyz: OEFloatArray,
                          ensembleType: int = OEEnsemble_Default) -> float
         OECalcSzmapValue(szmap: OESzmapEngine, xyz: OEDoubleArray,
                          ensembleType: int = OEEnsemble_Default) -> float

   Returns one of the :oe:constns:`OESzmap::OEEnsemble` values at the specified 3D point,
   using the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` provided. See
   :oe:const:`OESzmap::OEEnsemble::Default`
   for a description of the default energy value.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   .. :oe:language:: python

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


   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

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

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example
