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

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceFilterIssueCodes, SpruceFilterIssueCodes

.. oe:constnamespace:: OESpruceFilterIssueCodes

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for Spruce filter issue codes.

   .. seealso::

      * :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` class

   .. oe:constant:: Success

      This issue code indicates that the input structure does not have errors and passes the spruce filter

   .. oe:constant:: InvalidNames

      This issue code indicates that the input structure contains invalid names.

   .. oe:constant:: InvalidResidueStates

      This issue code indicates that the input structure contains residues at invalid state.

   .. oe:constant:: InvalidMetalBond

      This issue code indicates that the input structure contains invalid covalent bonds to metals.

   .. oe:constant:: InvalidCRYST1

      This issue code indicates that the input structure does not have a valid CRYST1 header.

   .. oe:constant:: InvalidElectronDensityOverlap

      This issue code indicates that the provided electron density map does not overlap with the input structure

   .. oe:constant:: InvalidSeqAlign

      This issue code indicates that the sequence does not align with the input structure.
    
   .. oe:constant:: All

      This issue code indicates that the structure contains all the issues listed above.
