Crate pluot 

This crate provides functionality for rendering visualizations.

Structs

AdataZarrHeatmapLayerParams

Layer params struct for AdataZarrHeatmapLayer.

AxisBandLayerParams

Layer params struct for AxisBandLayer.

AxisLinearLayerParams

Layer params struct for AxisLinearLayer.

BarPlotLayerParams

Layer params struct for BarPlotLayer.

BitmapLayerParams

Layer params struct for BitmapLayer.

BitmaskChannelSettings

Per-channel settings struct used by BitmaskLayerParams::channel_settings.

BitmaskLayerParams

Layer params struct for BitmaskLayer.

BooleanCriteriaParams

A boolean (or 0/1 integer) column, where items with a nonzero value are included.

CategoricalCriteriaParams

A categorical column in categories+codes format (one category code per item, similar to ColorMode::Categorical), along with the set of category codes that are included.

CategoricalCustomParams

Specifies an RGB value per category and the category per instance.

CategoricalParams

Specifies a named categorical colormap and the category per instance.

ChannelSettings

Specify image channel settings, including the intensity window and an RGB color.

CompressedHeatmapLayerParams

Layer params struct for HeatmapCsrLayer and HeatmapCscLayer. Every field but matrix means the same as in HeatmapLayerParams.

CompressedMatrix

The stored entries of a CSR or CSC matrix, in the scipy.sparse layout: the entries of major index m (a row of a CSR matrix, a column of a CSC matrix) are indices[indptr[m]..indptr[m + 1]] and data[indptr[m]..indptr[m + 1]]. Minor indices with no entry are implicit zeros.

CurveLayerParams

Layer params struct for CurveLayer.

DataBounds

Represents an extent of the data (“world”) coordinate system (e.g., the currently-visible extent, given the camera params and other view params).

ExtentResult

Serializable representation of the data extents reported by one or more plotted layers.

HeatmapAxisDomains

One (min, max) normalization domain per row or per column of the matrix.

HeatmapLayerParams

Layer params struct for HeatmapLayer.

HeatmapQuantitativeColormapParams

Parameters for HeatmapColormap::Quantitative.

HistogramLayerParams

Layer params struct for HistogramLayer.

HttpStoreParams

Represents a remote Zarr store located on a standard HTTP static file server.

IdentifierCriteriaParams

Parameters for AxisCriteria::Identifiers.

InstancedOpacityParams

Per-element opacity, one value (between 0.0 and 1.0) per element.

InstancedRgbInterleavedParams

Interleaved analog of InstancedRgbParams.

InstancedRgbParams

Explicitly specifies an RGB color per instance.

InstancedSizeParams

Per-element size (e.g., width or radius), one value per element.

LayerExtentResult

Serializable representation of the data extent reported by a single plotted layer.

LegendColormapQuantitativeLayerParams

Layer params struct for LegendColormapQuantitativeLayer.

LegendPointSizeQuantitativeLayerParams

Layer params struct for LegendPointSizeQuantitativeLayer.

LineLayerParams

Layer params struct for LineLayer.

LocalStoreParams

Represents a local, filesystem-backed Zarr directory store.

MarginParams

Define plot margins: left, right, top, bottom.

MemoryStoreParams

Represents an in-memory, ephemeral Zarr store.

OmeZarrBitmapLayerParams

Layer params struct for OmeZarrBitmapLayer.

OmeZarrBitmapMultiscaleLayerParams

Layer params struct for OmeZarrBitmapMultiscaleLayer.

OmeZarrBitmaskLayerParams

Layer params struct for OmeZarrBitmaskLayer.

OmeZarrBitmaskMultiscaleLayerParams

Layer params struct for OmeZarrBitmaskMultiscaleLayer.

Point3dLayerParams

Layer params struct for Point3dLayer.

PointLayerParams

Layer params struct for PointLayer.

PolygonLayerParams

Layer params struct for PolygonLayer.

QuantitativeCriteriaParams

A quantitative column (one value per item), along with the included range. Omitting min or max implicitly means -infinity/+infinity in that direction.

QuantitativeParams

Specifies a named quantitative colormap and a scalar value per instance.

RawLayerParams

Layer parameters in their raw serde Value form.

RawLayeredPlotRenderParams

Specify LayerParams for rendering of one or more layers.

RawRenderParams

The params that are passed to the crate::render::render function.

RectLayerParams

Layer params struct for RectLayer.

RenderParams

Strongly-typed render params. Mirrors RawRenderParams but accepts layers as a typed LayerParams enum instead of RawLayerParams.

RequestInit

Specify additional options to pass when making HTTP requests.

StoreMap

A collection of Zarr stores keyed by store name.

TextLayerParams

Layer params struct for TextLayer.

ViewParams

Shared rendering parameters at the view level (i.e., not layer-specific).

ZarrBarPlotLayerParams

Layer params struct for ZarrBarPlotLayer.

ZarrBooleanCriteriaParams

A boolean (or 0/1 integer) column, referenced by zarr array path. Items whose value is true are included.

ZarrCategoricalCriteriaParams

A categorical column in categories+codes format, referenced by zarr array path, along with the set of category codes that are included.

ZarrHistogramLayerParams

Layer params struct for ZarrHistogramLayer.

ZarrPoint3dLayerParams

Layer params struct for ZarrPoint3dLayer.

ZarrPointLayerParams

Layer params struct for ZarrPointLayer.

ZarrQuantitativeCriteriaParams

A quantitative column, referenced by zarr array path, along with the included range. Omitting min or max implicitly means -infinity/+infinity in that direction.

ZarrStoreInfo

A serializable, cross-platform representation of a Zarr store and any associated extensions.

Enums

AspectRatioAlignmentMode

Determine what extra data is shown in Contain mode, and what data is hidden in Cover mode.

AspectRatioMode

Specifies how the camera and coordinate system should behave when the plotted region (within the margins) has a non-square aspect ratio.

AxisCriteria

Which entries along one axis of the matrix (obs rows or var columns) are included by a filter, or emphasized by a selection.

AxisPosition

Determines where to render an axis layer: top, right, bottom, or left.

BarOrientation

Determines whether bar plot should be vertical or horizontal.

CategoricalColormap

Named categorical colormap functions.

CodeFormat

The code format for render-to-script outputs.

ColorMode

Specify uniform or instanced colors for rendered elements.

CompressedAxis

The axis that a CompressedMatrix’s indptr is indexed by.

DimensionOrder

Specify the dimension order of an image array.

EmphasisCriteria

Filtering or selection criteria for a layer’s data items.

FontStyle

Specify the font style: normal, italique, or oblique.

FontWeight

Specify the font weight: normal or bold.

GraphicsFormat

The graphics format for outputs.

HeatmapColormap

How to map each matrix value to a color.

HeatmapNormalization

How the quantitative colormap’s domain is derived from the loaded values.

LayerParams

Strongly-typed layer params.

LegendOrientation

Determines whether legend should be vertical (left to right colormap) or horizontal (bottom to top colormap).

MatrixAxis

An axis of a row-major matrix.

MatrixCacheMode

How the loaded matrix values are cached.

NumericData

Typed numeric array supporting multiple dtypes.

OpacityMode

Specify uniform or instanced opacity values for rendered elements.

PathCommand

A single drawing command, the post-parsed form of an SVG path segment. All coordinates are absolute.

PointShapeMode

Determine whether to render points as squares or circles.

QuantitativeColormap

Named quantitative colormap functions.

RawPlotParams

Specify how to render a plot.

SizeMode

Specify uniform or instanced size (e.g., width or radius) values for rendered elements.

TextAlignMode

Specify the horizontal alignment of a text element.

TextBaselineMode

Specify the vertical alignment of a text element.

UnitsMode

Determines whether size/position values are interpreted in pixel, data, or normalized space.

ViewMode

Whether displaying 2D versus 3D graphics.

ZarrEmphasisCriteria

Filtering or selection criteria for a zarr-backed layer’s data items.

ZarrStoreExtension

A serializable, cross-platform representation of a Zarr store extension.

ZarrStoreParams

A serializable, cross-platform representation of a Zarr store.

Functions

extent

Determine the data extent reported by each layer.

extent_with_stores

Similar to extent, but also lets the caller pass Zarr store instances via a StoreMap.

get_bounds

Calculate the visible data range based on camera view and other view parameters.

get_camera_matrix_from_bounds

Given x_min/x_max and y_min/y_max values, compute the corresponding camera matrix that would show data in this range.

project

Projects data-space coordinates to pixel coordinates on screen.

render

Given plotting parameters as input, render a graphical (vector or bitmap) output.

render_to_script

Given plotting parameters as input, “render” them to code which can be used to reproduce the plot.

render_to_script_aux

A variant of render_to_script which allows to keep schema_version as None. This is only intended to prevent extra churn in for the snapshot tests in crates/pluot/tests/test_render_script.rs

render_with_stores

Similar to render, but also lets the caller pass Zarr store instances via a StoreMap.

unproject

Unproject pixel coordinates on screen into data-space coordinates.

Type Aliases

HeatmapCscLayerParams

HeatmapCsrLayerParams

UniformOpacityParams

Static opacity (between 0.0 for fully transparent and 1.0 for fully opaque) shared by every element.

UniformRgbParams

Static (r, g, b) color shared by every instance.

UniformSizeParams

Static size (e.g., width or radius) shared by every element.