OEDrawIridiumDataΒΆ

Attention

PRELIMINARY-IMAGE This is a preliminary API until 2020.Apr and may be improved based on user feedback. It is currently available in C++ and Python.

Note

This API is preliminary due to dependencies on other preliminary APIs.

bool OEDrawIridiumData(OEDepict::OEImageBase &image,
                       const OEBio::OEDesignUnit &du)
bool OEDrawIridiumData(OEDepict::OEImageBase &image,
                       const OEBio::OEIridiumData &iridium)

Renders the Iridium data into an easily interpretable graph.

image
The image on which the Iridium data graph is drawn.
du
The OEDesignUnit object of which Iridium data is being rendered.
iridium
The OEIridiumData object that is being rendered.

Example:

The following code snippet shows how to use the OEDrawIridiumData function. The image created is shown in Figure: Example of using the OEDrawIridiumData function.

du = oechem.OEDesignUnit()
if not oechem.OEReadDesignUnit(filename, du):
    oechem.OEThrow.Fatal("Cannot read design unit!")

image = oedepict.OEImage(250, 250)

oegrapheme.OEDrawIridiumData(image, du)
oedepict.OEDrawBorder(image, oedepict.OELightGreyPen)
oedepict.OEWriteImage("DrawIridiumData.svg", image)

hover cursor over graph

Example of using the OEDrawIridiumData function

Note

When generating .svg image, the output will be interactive. With any other image file format it will be static. See also Generating Interactive SVG Images chapter in OEDepict TK manual.

See also