Grapheme TK 1.2.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEDrawROCSScores` function has been added
  to visualize scores.

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

* :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>` has been added
  to allow more customization of the
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function.

* :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetDepictOrientation` and
  :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetDepictOrientation` methods
  have been added to allow the shape query to orient
  :oe:const:`horizontal<OEDepict::OEDepictOrientation::Horizontal>`,
  :oe:const:`vertical<OEDepict::OEDepictOrientation::Vertical>`, or
  :oe:const:`square<OEDepict::OEDepictOrientation::Square>`.

* :oe:meth:`OEGrapheme::OEShapeQueryDisplay::GetTitle` and
  :oe:meth:`OEGrapheme::OEShapeOverlapDisplay::GetTitle` methods were
  added to access the title of the objects.

* :oe:meth:`OEGrapheme::OEShapeQueryDisplay::IsValid` and
  :oe:meth:`OEGrapheme::OEShapeOverlapDisplay::IsValid` methods were added
  to determine whether the objects have been initialized correctly.

* :oe:func:`OEGrapheme::OERenderShapeOverlap` function has been overloaded to
  enable rendering of shape overlap into two images: one image containing the
  fit molecule with transparent background and the other image showing the
  property map of the shape overlap.
  By superimposing the two images (molecule image on top), the result would
  be similar to visualizing the shape overlay in one image.

* :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class was rewritten to use the
  new implementation of the `OEBio::OEFragmentNetwork` class.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEPrepareDepictionFrom3D <OEGrapheme_OEPrepareDepictionFrom3D>` function has been improved
  to use a better scoring function in cases of atom clashes.

Minor bug fixes
--------------------------------------------------------------------------------

* The default parameter for the maximum number of bond rotations of the
  :ref:`OEDepictionFrom3DOptions <OEGrapheme_OEDepictionFrom3DOptions>` class is now :math:`2^{16} = 65536`.
  This means that by default only the first 16 single bonds of molecule
  will be rotated to find the "closest" 2D layout from the original 3D
  conformation when invoking the
  :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function.

* :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` now limits the maximum number of
  bond rotations to :math:`2^{14} = 16384` when calling the
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function to generate
  2D coordinates aligned to the query molecule.
  This limit provides a reasonable trade-off between speed and the quality
  of the alignments.

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` and
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` have been optimized
  to be 10% faster on average. The algorithms were also revised to
  reduce the accumulation of floating point errors.

* Constructing :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` and
  :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` objects is now significantly
  faster due to code optimization and constraining the 2D layout generations.

* :oe:func:`OEGrapheme::OERenderActiveSite` function was fixed to depict the
  :oe:const:`OEChem::OEResidueIndex::I` residue with the DNA/RNA style.

* :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` and
  :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` now can handle queries without
  any color atoms.

* :oe:func:`OEGrapheme::OERenderShapeQuery` and
  :oe:func:`OEGrapheme::OERenderColorOverlap` now scale the line
  width of the pens used to render the circles representing color atom matches.

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` can now handle
  molecules containing atoms with an unknown atomic number
  (PDB examples: 1S9R, 3KXA, 1I1W).

* :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale` has been improved to capitalize
  on the molecule layout enhancements done in **OEDepict TK** in this release.

* :oe:func:`OEGrapheme::OERenderColorOverlap` was fixed to render the molecule
  surface of the query molecule as :oe:func:`OEGrapheme::OERenderShapeOverlap`
  does.

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`section_examples_summary_shapeoverlap2pdf` example has been
  updated to visualize shape and color atom scores.

* The :ref:`section_examples_summary_complex2img` and
  :ref:`section_examples_summary_bfactor2img` 
  examples have been
  updated to perceive residues in cases when it is not done by the
  molecule reader (for example, in the case of :file:`mol2`).

* All images in this documentation have been automatically regenerated to
  reflect the changes made since the previous release.

