.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEBio


.. _OEBio_OEIridiumData:

.. oe:class:: OEIridiumData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEIridiumData

   This class contains the Iridium category [Warren-2012]_, metrics required for
   categorization, and a methods to determine the Iridium category
   itself.

   .. seealso::

      * :ref:`section_sprucetk_iridium_categorization` section in **OESpruce TK**
      * :oe:func:`OEBio::OECalculateDPI` function
      * :ref:`OEStructureQuality <OEBio_OEStructureQuality>` class
      * :oe:func:`OEGrapheme::OEDrawIridiumData` function in **Grapheme TK** to visualize information stored
        in an :ref:`OEIridiumData <OEBio_OEIridiumData>` object

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawIridiumData.svg" type="image/svg+xml"  width = "250" ></object>
         <p>

         <p align="center">
         <b>Example of visualizing OEIridiumData</b>
         <p>

   .. only:: oepdf

      .. figure:: ../../graphemetk/images/DrawIridiumData.*
         :align:  center

         **Example of visualizing OEIridiumData**

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIridiumData()
            OEIridiumData(const OEIridiumData& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEIridiumData() -> OEIridiumData
            OEIridiumData(rhs: OEIridiumData) -> OEIridiumData

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIridiumData &operator=(const OEIridiumData &rhs)

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEIridiumData <OEBio_OEIridiumData>` object is valid.

   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets the OEIridiumData object to its initial state.

   .. oe:method:: DetermineCategory

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

         .. oe:api::

            void DetermineCategory()

      .. oe:language:: python

         .. oe:api:: python

            DetermineCategory() -> None

      This function uses the internally stored metrics to determine
      the Iridium category.

      .. seealso::

         * :oe:constns:`OEBio::OEIridiumCategory` namespace
         * :ref:`section_sprucetk_iridium_categorization` section in **OESpruce TK**

   .. oe:method:: GetAltConfs

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

         .. oe:api::

            bool GetAltConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetAltConfs() -> bool

      Returns whether or not alternative conformations exist for this structure.

   .. oe:method:: GetAsDensity

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

         .. oe:api::

            double GetAsDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetAsDensity() -> float

      Returns the active site density coverage (0 to 1).

   .. oe:method:: GetCategory

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

         .. oe:api::

            unsigned GetCategory() const

      .. oe:language:: python

         .. oe:api:: python

            GetCategory() -> int

      Returns the Iridium category from the
      :oe:constns:`OEBio::OEIridiumCategory` namespace.

   .. oe:method:: GetDPI

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

         .. oe:api::

            double GetDPI() const

      .. oe:language:: python

         .. oe:api:: python

            GetDPI() -> float

      Returns the diffraction-component precision index (DPI) value.

   .. oe:method:: GetExcipients

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

         .. oe:api::

            bool GetExcipients() const

      .. oe:language:: python

         .. oe:api:: python

            GetExcipients() -> bool

      Returns whether or not excipients have interactions with the ligand.

   .. oe:method:: GetHasMTZ

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

         .. oe:api::

            bool GetHasMTZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetHasMTZ() -> bool

      Returns whether or not an MTZ file exists for this structure.

   .. oe:method:: GetIrrationalRfree

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

         .. oe:api::

            bool GetIrrationalRfree() const

      .. oe:language:: python

         .. oe:api:: python

            GetIrrationalRfree() -> bool

      Returns the irrational Rfree value.

   .. oe:method:: GetLigandDensity

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

         .. oe:api::

            double GetLigandDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandDensity() -> float

      Returns the ligand density coverage (0 to 1).

   .. oe:method:: GetPackingResidues

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

         .. oe:api::

            bool GetPackingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetPackingResidues() -> bool

      Returns whether or not packing residues make interactions with the ligand.

   .. oe:method:: GetPartOccupancyLigand

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

         .. oe:api::

            bool GetPartOccupancyLigand() const

      .. oe:language:: python

         .. oe:api:: python

            GetPartOccupancyLigand() -> bool

      Returns whether or not the ligand has partial occupancy.

   .. oe:method:: GetPartOccupancyProtein

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

         .. oe:api::

            bool GetPartOccupancyProtein() const

      .. oe:language:: python

         .. oe:api:: python

            GetPartOccupancyProtein() -> bool

      Returns whether or not the protein has partial occupancy.

   .. oe:method:: GetPossibleCovalent

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

         .. oe:api::

            bool GetPossibleCovalent() const

      .. oe:language:: python

         .. oe:api:: python

            GetPossibleCovalent() -> bool

      Returns whether or not potential but unperceived covalent 
      interaction can be found in the active site.

   .. oe:method:: GetRFree

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

         .. oe:api::

            double GetRFree() const

      .. oe:language:: python

         .. oe:api:: python

            GetRFree() -> float

      Returns the Rfree value.

   .. oe:method:: GetResolution

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

         .. oe:api::

            double GetResolution() const

      .. oe:language:: python

         .. oe:api:: python

            GetResolution() -> float

      Returns the resolution of the crystal structure.

   .. oe:method:: SetAltConfs

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

         .. oe:api::

            bool SetAltConfs(bool altConfs)

      .. oe:language:: python

         .. oe:api:: python

            SetAltConfs(altConfs: bool) -> bool

      Sets whether or not alternative conformations exist for this structure.

   .. oe:method:: SetAsDensity

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

         .. oe:api::

            bool SetAsDensity(double asDensity)

      .. oe:language:: python

         .. oe:api:: python

            SetAsDensity(asDensity: float) -> bool

      Sets the active site density coverage.

   .. oe:method:: SetCategory

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

         .. oe:api::

            bool SetCategory(unsigned category)

      .. oe:language:: python

         .. oe:api:: python

            SetCategory(category: int) -> bool

      Sets the Iridium category from a value in the
      :oe:constns:`OEBio::OEIridiumCategory` namespace.

   .. oe:method:: SetDPI

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

         .. oe:api::

            bool SetDPI(double dpi)

      .. oe:language:: python

         .. oe:api:: python

            SetDPI(dpi: float) -> bool

      Sets the diffraction-component precision index (DPI) value.

   .. oe:method:: SetExcipients

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

         .. oe:api::

            bool SetExcipients(bool excipients)

      .. oe:language:: python

         .. oe:api:: python

            SetExcipients(excipients: bool) -> bool

      Sets whether or not excipients have interactions with the ligand.

   .. oe:method:: SetHasMTZ

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

         .. oe:api::

            bool SetHasMTZ(bool hasMTZ)

      .. oe:language:: python

         .. oe:api:: python

            SetHasMTZ(hasMTZ: bool) -> bool

      Sets whether or not an MTZ file exists for this structure.

   .. oe:method:: SetIrrationalRfree

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

         .. oe:api::

            bool SetIrrationalRfree(bool irrationalRfree)

      .. oe:language:: python

         .. oe:api:: python

            SetIrrationalRfree(irrationalRfree: bool) -> bool

      Sets the irrational Rfree value.

   .. oe:method:: SetLigandDensity

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

         .. oe:api::

            bool SetLigandDensity(double ligandDensity)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandDensity(ligandDensity: float) -> bool

      Sets the ligand density coverage (0 to 1).

   .. oe:method:: SetPackingResidues

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

         .. oe:api::

            bool SetPackingResidues(bool packingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetPackingResidues(packingResidues: bool) -> bool

      Sets whether or not packing residues make interactions with the ligand.

   .. oe:method:: SetPartOccupancyLigand

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

         .. oe:api::

            bool SetPartOccupancyLigand(bool partOccupancyLigand)

      .. oe:language:: python

         .. oe:api:: python

            SetPartOccupancyLigand(partOccupancyLigand: bool) -> bool

      Sets whether or not the ligand has partial occupancy.

   .. oe:method:: SetPartOccupancyProtein

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

         .. oe:api::

            bool SetPartOccupancyProtein(bool partOccupancyProtein)

      .. oe:language:: python

         .. oe:api:: python

            SetPartOccupancyProtein(partOccupancyProtein: bool) -> bool

      Sets whether or not the protein has partial occupancy.

   .. oe:method:: SetPossibleCovalent

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

         .. oe:api::

            bool SetPossibleCovalent(bool possibleCovalent)

      .. oe:language:: python

         .. oe:api:: python

            SetPossibleCovalent(possibleCovalent: bool) -> bool

      Sets whether or not potential but unperceived covalent 
      interaction can be found in the active site.

   .. oe:method:: SetRFree

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

         .. oe:api::

            bool SetRFree(double rFree)

      .. oe:language:: python

         .. oe:api:: python

            SetRFree(rFree: float) -> bool

      Sets the Rfree value.

   .. oe:method:: SetResolution

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

         .. oe:api::

            bool SetResolution(double resolution)

      .. oe:language:: python

         .. oe:api:: python

            SetResolution(resolution: float) -> bool

      Sets the resolution of the crystal structure.
