NDPositions#

NDPositions#

Constructor#

NDPositions(ref_index, nd_subplot, data, ...)

NDGraphic subclass for n-dimensional positional data.

Properties#

NDPositions.cmap

get or set the cmap of the graphics

NDPositions.cmap_range

get or set the cmap_range of the graphics

NDPositions.cmap_transform

get or set the cmap_transform of the graphics

NDPositions.colors

get or set the colors of the graphics

NDPositions.data

get or set managed data.

NDPositions.datapoints_window_func

Get or set the window function applied along the p dim, as (func, apply_dims, window_size).

NDPositions.dims

dim names

NDPositions.display_dims

(n_graphics, p, <value dim>).

NDPositions.display_range

The current range of the display window, [min, max], in reference units of the p dim.

NDPositions.display_window

Get or set the display window, in the reference units of the p dim.

NDPositions.graphic

Underlying Graphic object used to display the current data slice, None if the data is None

NDPositions.graphic_type

Get or set the graphical representation used to display the data slice.

NDPositions.indices

the current index of each slider dim in reference-space units, from the ReferenceIndex

NDPositions.indices_displayed

the indices that the graphic currently represents

NDPositions.markers

get or set the markers of the graphics

NDPositions.max_display_datapoints

Get or set the maximum number of datapoints rendered per graphic.

NDPositions.name

name given to the NDGraphic

NDPositions.ndim

number of dims

NDPositions.pause

Get or set whether this graphic ignores changes in the ReferenceIndex.

NDPositions.shape

interpreted shape of the data

NDPositions.sizes

get or set the sizes of the graphics

NDPositions.slicer

NDSlicer that manages the data and produces data slices to display

NDPositions.slider_dims

the slider dims

NDPositions.slider_maps

Get or set the per-slider-dim mapping from reference-space values to local array indices, {dim_name: transform}.

NDPositions.spatial_func

Get or set the function applied to the spatial slice after the window funcs, right before rendering.

NDPositions.thickness

get or set the thickness of the graphics

NDPositions.window_funcs

Get or set the per-slider-dim window functions applied around the current slider position, {dim_name: (func, window_size)}, ex: {"time": (np.mean, 2.5)}.

NDPositions.window_order

get or set dimension order in which window functions are applied

Methods#

NDPositions.init(ref_index, data, dims, ...)

Set up the slicer and per-graphic state, i.e. everything except creating the graphic.