pynbody.sph.renderers

pynbody.sph.renderers#

Core classes for rendering images of SPH simulations.

For most users, the pynbody.plot.sph.image() function is the most convenient interface for rendering images of SPH simulations. A slightly lower-level approach is to use make_render_pipeline() to create a renderer object, which then produces an image when the ImageRendererBase.render() method is called.

For complete control, one may use the ImageRenderer class directly.

Functions

make_render_pipeline(sim, /[, quantity, ...])

Generate a renderer object for rendering images of a simulation snapshot.

Classes

ApproximateImageRenderer(base, levels[, factor])

A class to render images using a lower-resolution approximation for large smoothing lengths.

DenoisedImageRenderer(base)

A class to render images with denoising applied.

Grid3dRenderer(snap)

Implementation for rendering a simulation snapshot to a 3d grid

HealpixRenderer(snap)

Implementation for rendering a simulation snapshot to healpix

ImageGeometry()

A class to store the geometry of an image to be rendered.

ImageRenderer(snap)

Implementation for rendering a simulation snapshot to 2d image

ImageRendererBase(snap)

An abstract base class for image renderers

MultipassImageRenderer(template, n_copies[, ...])

A base class for image rendering using multiple passes to the underlying renderer

ProjectionAverageImageRenderer(base, ...)

A class to render projected images.

ReadOnlyGeometry(geometry)

A wrapper around an ImageGeometry object that makes it read-only.

ThreadedImageRenderer(base, num_threads)

A class to render images across multiple threads.

Exceptions

RenderPipelineLogicError