Molecule Layouts

The previous chapters described how to depict a single molecule in an image. This chapter provides examples for drawing multiple molecular diagrams into the same image.

Depicting Molecules in an Arbitrary Position

The OEImageFrame class provides a general framework to display a molecule in a specific region of the image by defining the following parameters:

  • the reference of the parent image
  • the width and height of the generated frame
  • the offset of the frame relative to the top-left corner of its parent (OE2DPoint)

The Listing 1 examples generates an image where the same molecule is depicted in different regions of the image. The molecular diagrams are automatically resized in order to fit into the specific frame, since the corresponding OE2DMolDisplay object is constructed with the width and height of the OEImageFrame object. When the OERenderMolecule function is called, the offset of the OEImageFrame object is added to the coordinates stored in OE2DMolDisplay in order to transfer the molecule into the specific region of the image. The image created by Listing 1 is shown in Figure: Example of using OEImageFrame.

Listing 1: Example of using OEImageFrame

public class ImageFrame
{
    private static void DrawMolecule(OEImageBase image, OEMolBase mol,
                                     double width, double height, OE2DPoint offset)
    {
        OEImageFrame frame = new OEImageFrame(image, width, height, offset);

        OEDepict.OEDrawBorder(frame, OEDepict.OELightGreyPen);

        double scale = OEScale.AutoScale;
        OE2DMolDisplayOptions opts = new OE2DMolDisplayOptions(width, height, scale);
        OE2DMolDisplay disp = new OE2DMolDisplay(mol, opts);
        bool clearBackground = true;
        OEDepict.OERenderMolecule(frame, disp, !clearBackground);
    }

    public static void Main(string [] argv)
    {
        OEImage image = new OEImage(400, 400);

        OEGraphMol mol = new OEGraphMol();
        OEChem.OESmilesToMol(mol, "C1CC(O)CNC1");
        OEDepict.OEPrepareDepiction(mol);

        DrawMolecule(image, mol,  60,  60, new OE2DPoint(50.0,   40.0));
        DrawMolecule(image, mol, 180, 180, new OE2DPoint(180.0, 120.0));
        DrawMolecule(image, mol,  80,  80, new OE2DPoint(300.0,  20.0));
        DrawMolecule(image, mol,  50,  50, new OE2DPoint(150.0, 320.0));
        DrawMolecule(image, mol,  20,  20, new OE2DPoint(360.0, 360.0));

        OEDepict.OEWriteImage("ImageFrame.png", image);
    }
}
../_images/ImageFrame.png

Example of using OEImageFrame

See also

Depicting Molecules in a Grid

The OEImageGrid class allows molecules to be aligned into rows and columns. After generating an OEImageGrid object by specifying its number of rows and columns, the cells of the grid can be accessed (from left to right, top to bottom order) by calling the OEImageGrid.GetCells method. The image created by Listing 2 is shown in Figure: Example of using OEImageGrid.

Listing 2: Example of using OEImageGrid

public class ImageGridSimple
{
    public static void Main(string [] args)
    {
        List<String> smiles = new List<String>();
        smiles.Add("C1CC(C)CCC1");
        smiles.Add("C1CC(O)CCC1");
        smiles.Add("C1CC(Cl)CCC1");

        OEImage image = new OEImage(200, 200);

        uint rows = 2;
        uint cols = 2;
        OEImageGrid grid = new OEImageGrid(image, rows, cols);

        OE2DMolDisplayOptions opts = new OE2DMolDisplayOptions(grid.GetCellWidth(),
                                                               grid.GetCellHeight(),
                                                               OEScale.AutoScale);
        OEImageBaseIter celliter = grid.GetCells();
        foreach (String smi in smiles)
        {
            OEGraphMol mol = new OEGraphMol();
            OEChem.OESmilesToMol(mol, smi);
            OEDepict.OEPrepareDepiction(mol);

            OE2DMolDisplay disp = new OE2DMolDisplay(mol, opts);
            OEDepict.OERenderMolecule(celliter.Target(), disp);
            celliter.Increment();
        }

        OEDepict.OEWriteImage("ImageGridSimple.svg", image);
    }
}
../_images/ImageGridSimple.png

Example of using OEImageGrid

See also

When an OE2DMolDisplay object is initialized, the dimensions of the depicted molecule is controlled by the width, height and scale parameters of the OE2DMolDisplayOptions object.

When only one molecule is depicted then auto scaling of this molecule is preferred (i.e. scaling the molecule in order to maximally fit it to the given dimensions). However, when more that one molecule, that are quite different in sizes, are depicted next to each other, auto scaling of each molecule can be visually misleading because it emphasizes molecules with greater scaling factors. See example in Figure: Example of using OEImageGrid that is generated by Listing 3.

Listing 3: Example of auto scaling of molecules

public class ImageGridAutoScale
{
    public static void Main(string [] args)
    {
        List<String> smiles = new List<String>();
        smiles.Add("c1ccccc1");
        smiles.Add("c1cccc2c1ccnc2");
        smiles.Add("c1ccc2c(c1)cc3ccccc3n2");

        OEImage image = new OEImage(400, 200);

        uint rows = 1;
        uint cols = 3;
        OEImageGrid grid = new OEImageGrid(image, rows, cols);

        OE2DMolDisplayOptions opts = new OE2DMolDisplayOptions(grid.GetCellWidth(),
                                                               grid.GetCellHeight(),
                                                               OEScale.AutoScale);

        int counter = 0;
        foreach (OEImageBase cell in grid.GetCells())
        {
            OEGraphMol mol = new OEGraphMol();
            OEChem.OESmilesToMol(mol, smiles[counter]);
            OEDepict.OEPrepareDepiction(mol);

            OE2DMolDisplay disp = new OE2DMolDisplay(mol, opts);
            OEDepict.OERenderMolecule(cell, disp);
            counter += 1;
        }

        OEDepict.OEWriteImage("ImageGridAutoScale.svg", image);
    }
}
../_images/ImageGridAutoScale.png

Example of auto scaling of molecules

The following example (Listing 4) shows how to ensure that all molecules are depicted using the same scaling factor. After initializing the molecules, the minimum scaling factor is determined by looping over the molecules being depicted and calling the OEGetMoleculeScale function. This function returns the scaling factor of the molecule considering the depiction options stored in the given OE2DMolDisplayOptions object. After determining the minimum scaling factor, the molecules are rendered to the cells of the grid by using this fixed scaling factor. The image created by Listing 6 is shown in Figure: Example of using OEImageGrid.

Listing 4: Example of identical scaling of molecules

public class ImageGridFixedScale
{
    public static void Main(string [] args)
    {
        List<String> smiles = new List<String>();
        smiles.Add("c1ccccc1");
        smiles.Add("c1cccc2c1ccnc2");
        smiles.Add("c1ccc2c(c1)cc3ccccc3n2");

        List<OEGraphMol> mollist = new List<OEGraphMol>();
        foreach (String smi in smiles)
        {
            OEGraphMol mol = new OEGraphMol();
            OEChem.OESmilesToMol(mol, smi);
            OEDepict.OEPrepareDepiction(mol);
            mollist.Add(mol);
        }

        OEImage image = new OEImage(400, 200);

        uint rows = 1;
        uint cols = 3;
        OEImageGrid grid = new OEImageGrid(image, rows, cols);

        OE2DMolDisplayOptions opts = new OE2DMolDisplayOptions(grid.GetCellWidth(),
                                                               grid.GetCellHeight(),
                                                               OEScale.AutoScale);

        double minscale = Double.MaxValue;
        foreach (OEGraphMol mol in mollist)
        {
            minscale = Math.Min(minscale, OEDepict.OEGetMoleculeScale(mol, opts));
        }
        opts.SetScale(minscale);

        OEImageBaseIter celliter = grid.GetCells();
        foreach (OEGraphMol mol in mollist)
        {
            OE2DMolDisplay disp = new OE2DMolDisplay(mol, opts);
            OEDepict.OERenderMolecule(celliter.Target(), disp);
            celliter.Increment();
        }

        OEDepict.OEWriteImage("ImageGridFixedScale.svg", image);
    }
}
../_images/ImageGridFixedScale.png

Example of identical scaling of molecules

Depicting Molecules in a Table

The following example demonstrates how to depict molecules and display data alongside them by using the OEImageTable. The individual cells of an OEImageTable object can be accessed by calling the any of the following methods:

These methods return an image (OEImageBase) on which molecule can be drawn or text can be displayed using the OEImageTable.DrawText method. The image created by Listing 5 is shown in Figure: Example of depicting molecules and data using image table.

Listing 5: Example of depicting molecules and data using image table

        List<String> smiles = new List<String>();
        smiles.Add("c1ccccc1 benzene");
        smiles.Add("c1cccnc1 pyridine");
        smiles.Add("c1cncnc1 pyrimidine");

        uint imagewidth = 350;
        uint imageheight = 250;
        OEImage image = new OEImage(imagewidth, imageheight);

        uint mainrows = 3;
        uint maincols = 2;
        OEImageTableOptions maintableopts = new OEImageTableOptions(mainrows, maincols, OEImageTableStyle.NoStyle);
        maintableopts.SetHeader(false);
        OEUIntVector colwidths = new OEUIntVector();
        colwidths.Add(10);
        colwidths.Add(10);
        maintableopts.SetColumnWidths(colwidths);
        OEImageTable maintable = new OEImageTable(image, maintableopts);

        uint datarows = 4;
        uint datacols = 2;
        OEImageTableOptions datatableopts = new OEImageTableOptions(datarows, datacols, OEImageTableStyle.LightGreen);
        datatableopts.SetStubColumn(true);
        datatableopts.SetMargins(5.0);
        datatableopts.SetColumnWidths(colwidths);

        for (uint r = 0; r < mainrows; ++r)
        {
            // depict molecule in first column
            OEImageBase cell = maintable.GetBodyCell(r + 1, 1);
            OE2DMolDisplayOptions opts = new OE2DMolDisplayOptions(cell.GetWidth(), cell.GetHeight(), OEScale.AutoScale);
            opts.SetTitleLocation(OETitleLocation.Hidden);

            OEGraphMol mol = new OEGraphMol();
            OEChem.OESmilesToMol(mol, smiles[(int)r]);
            OEDepict.OEPrepareDepiction(mol);

            OE2DMolDisplay disp = new OE2DMolDisplay(mol, opts);
            OEDepict.OERenderMolecule(cell, disp);

            // depicting data in table
            cell = maintable.GetBodyCell(r + 1, 2);
            OEImageTable datatable = new OEImageTable(cell, datatableopts);

            datatable.DrawText(datatable.GetHeaderCell(1, false), "Property");
            datatable.DrawText(datatable.GetHeaderCell(1), "Value");

            datatable.DrawText(datatable.GetStubColumnCell(1), "Name");
            datatable.DrawText(datatable.GetBodyCell(1, 1), mol.GetTitle());

            datatable.DrawText(datatable.GetStubColumnCell(2), "SMILES");
            datatable.DrawText(datatable.GetBodyCell(2, 1), OEChem.OEMolToSmiles(mol));

            datatable.DrawText(datatable.GetStubColumnCell(3), "MV");
            string mwdata = String.Format("{0:MW = 0.000}", OEChem.OECalculateMolecularWeight(mol));
            datatable.DrawText(datatable.GetBodyCell(3, 1), mwdata);
        }
        OEDepict.OEWriteImage("ImageTable.png", image);
../_images/ImageTable.png

Example of depicting molecules and data using image table