Skip to main content

Figure Generator

Project description

Figure Generator

This is an awesome figure generator. It generates figures in pdf-, html- and pptx-format. The following image shows the output of one of our test files ("tests/pool.py"):

This tool might help not only to create final figures, but also to analyze images faster: We offer a bunch of error metrics that allows not only to compare images visually but also mathematically.

Why did we create a figure generator?

In rendering research, it is quite common to create figures of "comparison"-type. Meaning, that we start with a set of generated images, that needs to be compared. Often, one rendered scene is not enough, therefore, we need several comparison figures - preferably in a similar or same style as the other created figures.

We support grids (images that are grid-like arranged) and simple line-plotting. To get a further understanding what grids are, you might want to have a look at our tutorial (Tutorial.ipynb).

Dependencies

Mandatory:

  • Python 3.11+ with opencv-python, simpleimageio, and texsnip

Optional:

  • For the .pdf backend: pdflatex (in path) with at least: tikz, calc, standalone, fontenc, libertine, inputenc.
  • For the .pptx backend: python-pptx
  • To include pdf files as image data: PyPDF2, and pdf2image (which requires poppler).

Quickstart

You can install the figure generator and all mandatory dependencies with a simple:

python -m pip install figuregen

The fastest way to get a first figure is by using an existing template:

import simpleimageio as sio
import figuregen
from figuregen.util.templates import CropComparison
from figuregen.util.image import Cropbox

figure = CropComparison(
    reference_image=sio.read("images/pool/pool.exr"),
    method_images=[
        sio.read("images/pool/pool-60s-path.exr"),
        sio.read("images/pool/pool-60s-upsmcmc.exr"),
        sio.read("images/pool/pool-60s-radiance.exr"),
        sio.read("images/pool/pool-60s-full.exr"),
    ],
    crops=[
        Cropbox(top=100, left=200, height=96, width=128, scale=5),
        Cropbox(top=100, left=450, height=96, width=128, scale=5),
    ],
    scene_name="Pool",
    method_names=["Reference", "Path Tracer", "UPS+MCMC", "Radiance-based", "Ours"]
)

# here you can modify the figure layout and data
# ...

# Generate the figure with the pdflatex backend and default settings
figuregen.figure([figure.figure_row], width_cm=17.7, filename="pool_with_template.pdf")

The template simply creates a list of Grid objects that can be modified and extended arbitrarily before passing it to the figure() function.

Examples and inspiration for creating your own figure layouts can be found in our examples or the Jupyter tutorial.

Examples

Clicking on an image below leads to the test that created the corresponding figure.

Vertical stacks

Split Comparison

Crop Comparison

Plots

Grid with titles, labels, markers, and frames

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

figuregen-1.2.0.tar.gz (65.3 kB view details)

Uploaded Source

Built Distribution

figuregen-1.2.0-py3-none-any.whl (68.4 kB view details)

Uploaded Python 3

File details

Details for the file figuregen-1.2.0.tar.gz.

File metadata

  • Download URL: figuregen-1.2.0.tar.gz
  • Upload date:
  • Size: 65.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for figuregen-1.2.0.tar.gz
Algorithm Hash digest
SHA256 65055f6dbc59e4ed903e7c66fd5a054f3be2895c7327e87386b33903b60457a3
MD5 fb8a734029b11e3829f5b8dc3b5592c7
BLAKE2b-256 2128f5902d321b43a3f5ac5a25ebd28488514a35e3b26066422668d021c7718f

See more details on using hashes here.

File details

Details for the file figuregen-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: figuregen-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 68.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for figuregen-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 40304f507799104fca961b0b4172c47023f84c3067c55aaa3ad6bba0525b9c37
MD5 3c0215273253ce813597ff3a3ff0190c
BLAKE2b-256 288688028c8b2b1fde2349fb36fbe9efa89a3fe8a02786890d177fc1d9ecb4cb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page