.. oe:namespace:: OESiteHopper



.. _OESiteHopper_OESiteHopperSearchOptions:

.. oe:class:: OESiteHopperSearchOptions

   .. oe:api::


      class OESiteHopperSearchOptions : public OESystem::OEOptions

   Options to control the process in OESiteHopperSearch.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESiteHopperSearchOptions()
            OESiteHopperSearchOptions(OESiteHopperSearchOptions &&)
            OESiteHopperSearchOptions(const OESiteHopperSearchOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperSearchOptions() -> OESiteHopperSearchOptions
            OESiteHopperSearchOptions(arg2: OESiteHopperSearchOptions) -> OESiteHopperSearchOptions

      Default constructors.

   .. oe:method:: GetMaxHits

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

         .. oe:api::

            unsigned int GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      Get maximum number of hits to return from the search. Very large hitlists can use a large amount of RAM.

      [default: 200]

   .. oe:method:: GetNCPU

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

         .. oe:api::

            unsigned int GetNCPU() const

      .. oe:language:: python

         .. oe:api:: python

            GetNCPU() -> int

      Get maximum number of CPUs to use for search. Zero (0) implies use all available.

      [default: 0]


   .. oe:method:: GetNormalizeAndRescore

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

         .. oe:api::

            bool GetNormalizeAndRescore() const

      .. oe:language:: python

         .. oe:api:: python

            GetNormalizeAndRescore() -> bool

      Flag to determine whether patches of hits will be normalized to the
      surface area of the query patch and then rescored for the final hitlist.

      [default: false]

   .. oe:method:: GetScoreCutoff

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

         .. oe:api::

            float GetScoreCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreCutoff() -> float

      Minimum PatchScore for a hit to be considered part of the hitlist. 

      [default: 0.0]

   .. oe:method:: GetSequenceCutoff

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

         .. oe:api::

            float GetSequenceCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceCutoff() -> float

      Maximum protein sequence similarity for a hit to be considered part of the hitlist.
      
      [default: 100.0]

   .. oe:method:: GetUseGPU

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

         .. oe:api::

            bool GetUseGPU() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseGPU() -> bool

      Flag to determine whether to use a GPU for prescreen as part of the search. This reduce the search time,
      but requires Linux and a compatible Nvidia GPU. See :ref:`GPU Prerequisites <sitehopper_search_gpu>`


   .. oe:method:: SetMaxHits

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

         .. oe:api::

            bool SetMaxHits(unsigned int maxHits)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Set maximum number of hits to return from the search. Very large hitlists can use a large amount of RAM.

      [default: 200]

   .. oe:method:: SetNCPU

      .. oe:api:: c++ java csharp
      
         void SetNCPU(unsigned int n)

      .. oe:api:: python
      
         SetNCPU(value: int) -> None

      Set maximum number of CPUs to use for search. Zero (0) implies use all available.

      [default: 0]

   .. oe:method:: SetNormalizeAndRescore

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

         .. oe:api::

            bool SetNormalizeAndRescore(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetNormalizeAndRescore(value: bool) -> bool

      Flag to determine whether patches of hit OEDesignUnits will be normalized to the
      surface area of the query patch and then rescored for the final hitlist.

      [default: false]

   .. oe:method:: SetScoreCutoff

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

         .. oe:api::

            bool SetScoreCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreCutoff(value: float) -> bool

      Minimum PatchScore for a hit to be considered part of the hitlist. 

      [default: 0.0]

   .. oe:method:: SetSequenceCutoff

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

         .. oe:api::

            bool SetSequenceCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetSequenceCutoff(value: float) -> bool

      Maximum protein sequence similarity for a hit to be considered part of the hitlist.
      
      [default: 100.0]

   .. oe:method:: SetUseGPU

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

         .. oe:api::

            bool GetUseGPU() const

      .. oe:language:: python

         .. oe:api:: python

            SetUseGPU(value: bool) -> bool

      Flag to set whether to use a GPU for prescreen as part of the search. This reduces the search time,
      but requires Linux and a compatible Nvidia GPU. See :ref:`GPU Prerequisites <sitehopper_search_gpu>`


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

      .. oe:api::

         OESiteHopperSearchOptions &operator=(OESiteHopperSearchOptions &&)
         OESiteHopperSearchOptions &operator=(const OESiteHopperSearchOptions &)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESiteHopperSearchOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESiteHopperSearchOptions

