.. include:: ../substitutions

.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetCrystalSymmetry

.. oe:function:: OEGetCrystalSymmetry

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

      .. oe:api::

         bool OEGetCrystalSymmetry(OECrystalSymmetryParams& params,
                                   const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCrystalSymmetry(params: OECrystalSymmetryParams,
                              mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Retrieves the crystal symmetry information from the
   molecule.
   The retrieved information is stored in the given
   :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` object.

   .. note::

      Use this overloaded function in the supported wrapped
      languages: Python, Java and C#.

   **Example:**

   .. oe:source:: OEGetCrystalSymmetry.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

   .. oe:source:: OEGetCrystalSymmetry.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

   .. oe:source:: OEGetCrystalSymmetry.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

   .. oe:source:: OEGetCrystalSymmetryDoc.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

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

      .. oe:api::

         bool OEGetCrystalSymmetry(const OEChem::OEMolBase& mol, float& a,
                                   float& b, float& c, float& alpha,
                                   float& beta, float& gamma,
                                   unsigned int& sgnumber)
         bool OEGetCrystalSymmetry(const OEChem::OEMolBase& mol, float& a,
                                   float& b, float& c, float& alpha,
                                   float& beta, float& gamma,
                                   unsigned int& sgnumber, unsigned int& zvalue)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCrystalSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol]) -> (a: float, b: float, c: float, alpha: float, beta: float, gamma: float, sgnumber: int, zvalue: int)

   Retrieves the following the crystal symmetry information from the
   molecule:

   * standard cell lengths
   * cell angles 'alpha', 'beta' and 'gamma' and
   * spacegroup number
   * z-value

   .. seealso::

      * :oe:func:`OEBio::OESetCrystalSymmetry` function
