.. oe:namespace:: OESiteHopper



.. _OESiteHopper_OESiteHopperPatchOptions:

.. oe:class:: OESiteHopperPatchOptions

   .. oe:api::


      class OESiteHopperPatchOptions : public OESystem::OEOptions

   Options that affect how SiteHopper Patches are contructed.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESiteHopperPatchOptions()
            OESiteHopperPatchOptions(const OESiteHopperPatchOptions &)
            OESiteHopperPatchOptions(OESiteHopperPatchOptions &&)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperPatchOptions() -> OESiteHopperPatchOptions
            OESiteHopperPatchOptions(arg2: OESiteHopperPatchOptions) -> OESiteHopperPatchOptions

      Default constructors.

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

      .. oe:api::

         OESiteHopperPatchOptions &operator=(const OESiteHopperPatchOptions &)
         OESiteHopperPatchOptions &operator=(OESiteHopperPatchOptions &&)

      Assignment operator.



   .. oe:method:: GetResidueCutoff

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

         .. oe:api::

            float GetResidueCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueCutoff() -> float

      Get distance (in Angstroms) from any ligand atom to any protein residue to consider that residue part of the patch.

      [default: 7.0]


   .. oe:method:: GetSiteSize

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

         .. oe:api::

            float GetSiteSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSiteSize() -> float

      Get distance from any site residue to edge of patch surface to be created.
      A larger distance means a larger patch will be created.

      [default: 4.0]

   .. oe:method:: GetSurfaceCutoff

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

         .. oe:api::

            float GetSurfaceCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceCutoff() -> float

      Get maximum distance a color atom can be from the surface to be included in the patch.
      
      [default: 2.5]

   .. oe:method:: GetScaleFactor

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

         .. oe:api::

            unsigned int GetScaleFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetScaleFactor() -> int

      Get factor by which number of surface points are reduced to create the patch surface. 

      [default: 4]

   .. oe:method:: GetUserStartsScaleFactor

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

         .. oe:api::

            unsigned int GetUserStartsScaleFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetUserStartsScaleFactor() -> int

      Get factor by which the number of surface points are reduced to create user starts
      for the optimization.

      [default: 14]

   .. oe:method:: SetResidueCutoff

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

         .. oe:api::

            bool SetResidueCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueCutoff(value: float) -> bool

      Set distance (in Angstroms) from any ligand atom to any protein residue to consider that residue part of the patch.

      [default: 7.0]

   .. oe:method:: SetSiteSize

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

         .. oe:api::

            float GetSiteSize() const

      .. oe:language:: python

         .. oe:api:: python

            SetSiteSize(value: float) -> bool

      Set distance from any site residue to edge of patch surface to be created.
      A larger distance means a larger patch will be created.

      [default: 4.0]

   .. oe:method:: SetSurfaceCutoff

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

         .. oe:api::

            bool SetSurfaceCutoff(const float value)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceCutoff(value: float) -> bool

      Set maximum distance a color atom can be from the surface to be included
      in the patch. A larger value means more color atoms from the protein will
      be included.
      
      [default: 2.5]

   .. oe:method:: SetScaleFactor

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

         .. oe:api::

            bool SetScaleFactor(unsigned int factor)

      .. oe:language:: python

         .. oe:api:: python

            SetScaleFactor(value: int) -> bool

      Set factor by which number of surface points are reduced to create the patch surface. 
      A larger factor will result in fewer surface/shape point. Too few will result in a poor
      shape description of the patch.

      [default: 4]

   .. oe:method:: SetUserStartsScaleFactor

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

         .. oe:api::

            bool SetUserStartsScaleFactor(unsigned int factor)

      .. oe:language:: python

         .. oe:api:: python

            SetUserStartsScaleFactor(value: int) -> bool

      Set factor by which the number of surface points are reduced to create user starts
      for the optimization.

      [default: 14]

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESiteHopperPatchOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESiteHopperPatchOptions

   .. oe:method:: GetColorForceField

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

         .. oe:api::

            const OEShape::OEColorForceField& GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      Get a reference to the OEColorForceField used for patch creation and scoring.
