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

.. oe:namespace:: OESpruce



.. _OESpruce_OELoopBuilderOptions:

.. oe:class:: OELoopBuilderOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OELoopBuilderOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building loops in the :oe:func:`OESpruce::OEBuildLoops` and
   :oe:func:`OESpruce::OEBuildSingleLoop` functions.

   .. oe:method:: Constructors

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

         .. oe:api::

            OELoopBuilderOptions()
            OELoopBuilderOptions(const OELoopBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OELoopBuilderOptions() -> OELoopBuilderOptions
            OELoopBuilderOptions(arg2: OELoopBuilderOptions) -> OELoopBuilderOptions

      Default and copy constructor that constructs a `OELoopBuilderOptions` object.

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

      .. oe:api::

         OELoopBuilderOptions &operator=(const OELoopBuilderOptions &)

      Assignment operator.

   .. _OESpruce_OELoopBuilderOptions_GetLoopDBFilename:


   .. oe:method:: GetLoopDBFilename

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

         .. oe:api::

            std::string GetLoopDBFilename() const

      .. oe:language:: python

         .. oe:api:: python

            GetLoopDBFilename() -> str

      Returns the filename of the loop database used when searching for compatible loops.

   .. _OESpruce_OELoopBuilderOptions_GetUsePackingResidues:


   .. oe:method:: GetUsePackingResidues

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

         .. oe:api::

            bool GetUsePackingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetUsePackingResidues() -> bool

      Returns the boolean whether or not to use crystal packing residues during loop modeling (if available).

   .. _OESpruce_OELoopBuilderOptions_GetCropLength:


   .. oe:method:: GetCropLength

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

         .. oe:api::

            unsigned GetCropLength() const

      .. oe:language:: python

         .. oe:api:: python

            GetCropLength() -> int

      Returns the number of residues on either side of a gap to remove, since these are known to sometimes be poorly resolved and
      therefore have configurations that make it difficult to build loops.

   .. _OESpruce_OELoopBuilderOptions_GetTransformThreshold:


   .. oe:method:: GetTransformThreshold

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

         .. oe:api::

            unsigned GetTransformThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransformThreshold() -> int

      Returns the number of loops from the database to transform, meaning mutate from their database sequence to target sequence,
      if they are not 100% sequence matching. Structures with 100% sequence match are not affected by this threshold.

   .. _OESpruce_OELoopBuilderOptions_GetStrictProlineMatch:


   .. oe:method:: GetStrictProlineMatch

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

         .. oe:api::

            bool GetStrictProlineMatch() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictProlineMatch() -> bool

      Returns the boolean of whether or not fuzzy sequence matches have to have proline residues in the correct position. This
      can be relevant since they have a different backbone conformation than other amino acid residues.

   .. _OESpruce_OELoopBuilderOptions_GetConnectBufferDistance:


   .. oe:method:: GetConnectBufferDistance

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

         .. oe:api::

            double GetConnectBufferDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetConnectBufferDistance() -> float

      Returns the buffer distance allowed between the anchor atoms (connection points) when searching for fuzzy sequence matches.

   .. _OESpruce_OELoopBuilderOptions_GetBackboneClashRejectThreshold:


   .. oe:method:: GetBackboneClashRejectThreshold

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

         .. oe:api::

            double GetBackboneClashRejectThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetBackboneClashRejectThreshold() -> float

      Returns the threshold of clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

   .. _OESpruce_OELoopBuilderOptions_GetDeleteExistingResidues:


   .. oe:method:: GetDeleteExistingResidues

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

         .. oe:api::

            bool GetDeleteExistingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteExistingResidues() -> bool

      Returns whether or not to delete residues already present at site where new loops needs to be built.

   .. _OESpruce_OELoopBuilderOptions_GetLoopClashRejectThreshold:


   .. oe:method:: GetLoopClashRejectThreshold

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

         .. oe:api::

            double GetLoopClashRejectThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetLoopClashRejectThreshold() -> float

      Returns the threshold of clashing loops atoms. This threshold excludes already considered clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

   .. _OESpruce_OELoopBuilderOptions_GetOptimizationShell:


   .. oe:method:: GetOptimizationShell

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

         .. oe:api::

            double GetOptimizationShell() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationShell() -> float

      Returns the radius of atoms being considered when minimizing the loops in place. Since multiple loops are being optimized,
      it is the union of atoms inside the radius around each starting loop configuration that is considered. This allows comparison of
      the energies between each loop conformation as the systems are of identical size.

   .. _OESpruce_OELoopBuilderOptions_GetOptimizationTolerance:


   .. oe:method:: GetOptimizationTolerance

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

         .. oe:api::

            double GetOptimizationTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationTolerance() -> float

      Returns the tolerance used by the optimizer.

   .. _OESpruce_OELoopBuilderOptions_GetOptimizationStage1IterMultiplier:


   .. oe:method:: GetOptimizationStage1IterMultiplier

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

         .. oe:api::

            unsigned GetOptimizationStage1IterMultiplier() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationStage1IterMultiplier() -> int

      Returns the multiplier of optimization steps per residue in the loop used during the initial steepest descent optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationStage2IterMultiplier:


  .. oe:method:: GetOptimizationStage2IterMultiplier

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

         .. oe:api::

            unsigned GetOptimizationStage2IterMultiplier() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationStage2IterMultiplier() -> int

      Returns the multiplier of optimization steps per residue in the loop used during the secondary BFGS optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationUseSolventModel:


  .. oe:method:: GetOptimizationUseSolventModel

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

         .. oe:api::

            bool GetOptimizationUseSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationUseSolventModel() -> bool

      Returns whether or not to use a simplistic solvent model during the loop optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationInclSurfaceAreaTerm:


  .. oe:method:: GetOptimizationInclSurfaceAreaTerm

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

         .. oe:api::

            bool GetOptimizationInclSurfaceAreaTerm() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationInclSurfaceAreaTerm() -> bool

      Returns whether or not to include the surface area term when scoring the loops after optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationMaxLoops:


  .. oe:method:: GetOptimizationMaxLoops

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

         .. oe:api::

            unsigned GetOptimizationMaxLoops() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationMaxLoops() -> int

      Returns the number of loops to optimize, the higher the number the longer the calculation will take, but also includes more structural diversity.

  .. _OESpruce_OELoopBuilderOptions_GetAllowBuildDisulfideBridges:


  .. oe:method:: GetAllowBuildDisulfideBridges

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

         .. oe:api::

            bool GetAllowBuildDisulfideBridges() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowBuildDisulfideBridges() -> bool

      Returns whether or not to allow building disulfide bridges between the loop and the protein if possible, requires cystine residues in proximity.

  .. _OESpruce_OELoopBuilderOptions_GetRejectClashingLoopsPostMinimization:


  .. oe:method:: GetRejectClashingLoopsPostMinimization

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

         .. oe:api::

            bool GetRejectClashingLoopsPostMinimization() const

      .. oe:language:: python

         .. oe:api:: python

            GetRejectClashingLoopsPostMinimization() -> bool

      Returns whether or not to reject clashing loops post-minimization.

  .. _OESpruce_OELoopBuilderOptions_GetSeqAlignMethod:


  .. oe:method:: GetSeqAlignMethod

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

         .. oe:api::

            unsigned GetSeqAlignMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqAlignMethod() -> int

      Returns the sequence alignment method, from the :oe:const:`OEBio::OESeqAlignmentMethod` namespace, used to compare the provided sequence and the structure for gaps.

  .. _OESpruce_OELoopBuilderOptions_GetSeqAlignGapPenalty:


  .. oe:method:: GetSeqAlignGapPenalty

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

         .. oe:api::

            int GetSeqAlignGapPenalty() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqAlignGapPenalty() -> int

      Returns the sequence alignment gap penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_GetSeqAlignExtendPenalty:


  .. oe:method:: GetSeqAlignExtendPenalty

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

         .. oe:api::

            int GetSeqAlignExtendPenalty() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqAlignExtendPenalty() -> int

      Returns the sequence alignment extend penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_GetBuildTails:


  .. oe:method:: GetBuildTails

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

         .. oe:api::

            bool GetBuildTails() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildTails() -> bool

      Returns whether or not to allow building missing tails at the N and C termini.

  .. _OESpruce_OELoopBuilderOptions_SetLoopDBFilename:


  .. oe:method:: SetLoopDBFilename

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

         .. oe:api::

            bool SetLoopDBFilename(std::string filename)

      .. oe:language:: python

         .. oe:api:: python

            SetLoopDBFilename(value: str) -> bool

      Sets the filename of the loop database to use when searching for compatible loops.

  .. _OESpruce_OELoopBuilderOptions_SetUsePackingResidues:


  .. oe:method:: SetUsePackingResidues

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

         .. oe:api::

            bool SetUsePackingResidues(bool usePackingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetUsePackingResidues(value: bool) -> bool

      Sets whether or not to use crystal packing residues during loop modeling (if available).

  .. _OESpruce_OELoopBuilderOptions_SetCropLength:


  .. oe:method:: SetCropLength

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

         .. oe:api::

            bool SetCropLength(unsigned cropLength)

      .. oe:language:: python

         .. oe:api:: python

            SetCropLength(value: int) -> bool

      Returns the number of residues on either side of a gap to remove, since these are known to sometimes be poorly resolved and
      therefore have configurations that make it difficult to build loops.

  .. _OESpruce_OELoopBuilderOptions_SetTransformThreshold:


  .. oe:method:: SetTransformThreshold

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

         .. oe:api::

            bool SetTransformThreshold(unsigned transformThreshold)

      .. oe:language:: python

         .. oe:api:: python

            SetTransformThreshold(value: int) -> bool

      Sets the number of loops from the database to transform, meaning mutate from their database sequence to target sequence,
      if they are not 100% sequence matching. Structures with 100% sequence match are not affected by this threshold.

  .. _OESpruce_OELoopBuilderOptions_SetStrictProlineMatch:


  .. oe:method:: SetStrictProlineMatch

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

         .. oe:api::

            bool SetStrictProlineMatch(bool strictProline)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictProlineMatch(value: bool) -> bool

      Sets whether or not fuzzy sequence matches have to have proline residues in the correct position. This
      can be relevant since they have a different backbone conformation than other amino acid residues.

  .. _OESpruce_OELoopBuilderOptions_SetConnectBufferDistance:


  .. oe:method:: SetConnectBufferDistance

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

         .. oe:api::

            bool SetConnectBufferDistance(double buffer)

      .. oe:language:: python

         .. oe:api:: python

            SetConnectBufferDistance(value: float) -> bool

      Sets the buffer distance allowed between the anchor atoms (connection points) when searching for fuzzy sequence matches.

  .. _OESpruce_OELoopBuilderOptions_SetBackboneClashRejectThreshold:


  .. oe:method:: SetBackboneClashRejectThreshold

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

         .. oe:api::

            bool SetBackboneClashRejectThreshold(double bbClashThreshold)

      .. oe:language:: python

         .. oe:api:: python

            SetBackboneClashRejectThreshold(value: float) -> bool

      Sets the threshold of clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

  .. _OESpruce_OELoopBuilderOptions_SetDeleteExistingResidues:


   .. oe:method:: SetDeleteExistingResidues

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

         .. oe:api::

            bool SetDeleteExistingResidues(bool deleteExistingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteExistingResidues(value: bool) -> bool

      Sets whether or not to delete residues already present at site where new loops needs to be built.
      See also :ref:`SetRejectClashingLoopsPostMinimization <OESpruce_OELoopBuilderOptions_SetRejectClashingLoopsPostMinimization>`.

  .. _OESpruce_OELoopBuilderOptions_SetLoopClashRejectThreshold:


  .. oe:method:: SetLoopClashRejectThreshold

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

         .. oe:api::

            bool SetLoopClashRejectThreshold(double loopClashThreshold)

      .. oe:language:: python

         .. oe:api:: python

            SetLoopClashRejectThreshold(value: float) -> bool

      Sets the threshold of clashing loops atoms. This threshold excludes already considered clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationShell:


  .. oe:method:: SetOptimizationShell

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

         .. oe:api::

            bool SetOptimizationShell(double optimizationShellRadius)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationShell(value: float) -> bool

      Set the radius of atoms being considered when minimizing the loops in place. Since multiple loops are being optimized,
      it is the union of atoms inside the radius around each starting loop configuration that is considered. This allows comparison of
      the energies between each loop conformation as the systems are of identical size.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationTolerance:


  .. oe:method:: SetOptimizationTolerance

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

         .. oe:api::

            bool SetOptimizationTolerance(double optimizationTolerance)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationTolerance(value: float) -> bool

      Sets the tolerance used by the optimizer.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationStage1IterMultiplier:


  .. oe:method:: SetOptimizationStage1IterMultiplier

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

         .. oe:api::

            bool SetOptimizationStage1IterMultiplier(unsigned stage1multiplier)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationStage1IterMultiplier(value: int) -> bool

      Sets the multiplier of optimization steps per residue in the loop used during the initial steepest descent optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationStage2IterMultiplier:


  .. oe:method:: SetOptimizationStage2IterMultiplier

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

         .. oe:api::

            bool SetOptimizationStage2IterMultiplier(unsigned stage2multiplier)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationStage2IterMultiplier(value: int) -> bool

      Sets the multiplier of optimization steps per residue in the loop used during the secondary BFGS optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationUseSolventModel:


  .. oe:method:: SetOptimizationUseSolventModel

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

         .. oe:api::

            bool SetOptimizationUseSolventModel(bool useSolventModel)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationUseSolventModel(value: bool) -> bool

      Sets whether or not to use a simplistic solvent model during the loop optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationInclSurfaceAreaTerm:


  .. oe:method:: SetOptimizationInclSurfaceAreaTerm

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

         .. oe:api::

            bool SetOptimizationInclSurfaceAreaTerm(bool useSATerm)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationInclSurfaceAreaTerm(value: bool) -> bool

      Sets whether or not to include the surface area term when scoring the loops after optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationMaxLoops:


  .. oe:method:: SetOptimizationMaxLoops

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

         .. oe:api::

            bool SetOptimizationMaxLoops(unsigned maxOptLoops)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationMaxLoops(value: int) -> bool

      Sets the number of loops to optimize, the higher the number the longer the calculation will take, but also includes more structural diversity.

  .. _OESpruce_OELoopBuilderOptions_SetAllowBuildDisulfideBridges:


  .. oe:method:: SetAllowBuildDisulfideBridges

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

         .. oe:api::

            bool SetAllowBuildDisulfideBridges(bool allowBuildDisulfideBridges)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowBuildDisulfideBridges(value: bool) -> bool

      Sets whether or not to allow building disulfide bridges between the loop and the protein if possible, requires cystine residues in proximity.

  .. _OESpruce_OELoopBuilderOptions_SetRejectClashingLoopsPostMinimization:


  .. oe:method:: SetRejectClashingLoopsPostMinimization

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

         .. oe:api::

            bool GetRejectClashingLoopsPostMinimization() const

      .. oe:language:: python

         .. oe:api:: python

            SetRejectClashingLoopsPostMinimization(value: bool) -> bool

      Set whether or not to reject clashing loops post-minimization. See also
      :ref:`SetDeleteExistingResidues <OESpruce_OELoopBuilderOptions_SetDeleteExistingResidues>`.

  .. _OESpruce_OELoopBuilderOptions_SetSeqAlignMethod:


  .. oe:method:: SetSeqAlignMethod

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

         .. oe:api::

            bool SetSeqAlignMethod(unsigned seqAlignMethod)

      .. oe:language:: python

         .. oe:api:: python

            SetSeqAlignMethod(value: int) -> bool

      Sets the sequence alignment method, from the :oe:const:`OEBio::OESeqAlignmentMethod` namespace, used to compare the provided sequence and the structure for gaps.

  .. _OESpruce_OELoopBuilderOptions_SetSeqAlignGapPenalty:


  .. oe:method:: SetSeqAlignGapPenalty

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

         .. oe:api::

            bool SetSeqAlignGapPenalty(int gapPenalty)

      .. oe:language:: python

         .. oe:api:: python

            SetSeqAlignGapPenalty(value: int) -> bool

      Set the sequence alignment gap penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_SetSeqAlignExtendPenalty:


  .. oe:method:: SetSeqAlignExtendPenalty

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

         .. oe:api::

            bool SetSeqAlignExtendPenalty(int extendPenalty)

      .. oe:language:: python

         .. oe:api:: python

            SetSeqAlignExtendPenalty(value: int) -> bool

      Set the sequence alignment extend penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_SetBuildTails:


  .. oe:method:: SetBuildTails

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

         .. oe:api::

            bool SetBuildTails(bool BuildTails)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildTails(value: bool) -> bool

      Sets whether or not to allow building missing tails at the C and N termini.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :oe:func:`OESpruce::OEBuildLoops` function
      * :oe:func:`OESpruce::OEBuildSingleLoop` function
      * :oe:const:`OEBio::OESeqAlignmentMethod` namespace
      * :oe:func:`OEBio::OEGetSimpleAlignment` function
      * :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` class
