.. include:: ../substitutions

.. oe:namespace:: OESystem

.. meta::
   :keywords: OEReadCIFGridFile

..  _OESystem_OEReadCIFGridFile:

.. oe:function:: OEReadCIFGridFile

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

      .. oe:api::

         bool OEReadCIFGridFile(const std::string& filename,
                                OESystem::OESkewGrid& sgrid,
                                unsigned int maptype)

   .. oe:language:: python

      .. oe:api:: python

         OEReadCIFGridFile(filename: str, sgrid: OESkewGrid, maptype: int) -> bool

   Read a structure factor CIF file into an OpenEye skew grid.
   The grid requires that the proper column name be present to extract the
   appropriate reflection data. 

   The following map types can be read using predefined operations on the sfCIF data:

   ================================================= =========================================
   MapType                                           Description
   ================================================= =========================================
   :oe:const:`OESystem::OEMTZMapType::Fo`            Observed Reflections
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fc`            Map generated from calculated model
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::TwoFoFc`       2Fo - Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::ThreeFoTwoFc`  3Fo - Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FiveFoThreeFc` 5Fo - 3Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::TwoFoFcSigmaA` 2Fo - Fc Sigma-A weighted
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoFcSigmaA`    Fo - Fc Sigma-A weighted
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoSquared`     Fo*Fo
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoFom`         Fo * figure of merit
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fwt`           2mFo - DFc (normally)
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fdelwt`        mFo - DFc (normally)
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::None`          No reflections (used as a status flag)
   ================================================= =========================================

