Traits

class ipyniivue.ColorMap(**kwargs: Any)[source]

Bases: HasTraits

Represents a ColorMap.

Parameters

Rlist of float

The red channel values.

Glist of float

The green channel values.

Blist of float

The blue channel values.

Alist of float or None, optional

The alpha (transparency) channel values. Default is None.

Ilist of float or None, optional

The intensity indices corresponding to the color values. Default is None.

minfloat or None, optional

The minimum intensity value for the colormap. Default is None.

maxfloat or None, optional

The maximum intensity value for the colormap. Default is None.

labelslist of str or None, optional

Labels associated with each color entry in the colormap. Default is None.

parentobject, optional

The parent object that contains this ColorMap. Used for propagating changes to the parent widget. Default is None.

A

An instance of a Python list.

B

An instance of a Python list.

G

An instance of a Python list.

I

An instance of a Python list.

R

An instance of a Python list.

__init__(*args, parent=None, **kwargs)[source]
labels

An instance of a Python list.

max

A float trait.

min

A float trait.

class ipyniivue.LUT(**kwargs: Any)[source]

Bases: HasTraits

Represents a Lookup Table (LUT / Colormap Label).

Parameters

lutlist of int

A flat list representing the RGBA values of the lookup table.

minfloat or None, optional

The minimum intensity value corresponding to the first entry in the LUT. Default is None.

maxfloat or None, optional

The maximum intensity value corresponding to the last entry in the LUT. Default is None.

labelslist of str or None, optional

Labels associated with each color entry in the LUT. Default is None.

parentobject, optional

The parent object that contains this LUT. Used for propagating changes to the parent widget. Default is None.

__init__(*args, parent=None, **kwargs)[source]
labels

An instance of a Python list.

lut

An instance of a Python list.

max

A float trait.

min

A float trait.

class ipyniivue.Graph(**kwargs: Any)[source]

Bases: HasTraits

Represents a Graph in NiiVue.

Parameters

ltwhlist of float, optional

List of four floats representing left, top, width, height. Default is [0, 0, 640, 480].

opacityfloat, optional

Opacity of the graph, between 0.0 (not visible) and 1.0 (visible). Default is 0.0.

volslist of int, optional

List of volume indices to be plotted. Default is [0].

auto_size_multiplanarbool, optional

Automatically size the graph in multiplanar views. Default is False.

normalize_valuesbool, optional

Normalize the values when plotting. Default is False.

is_range_cal_min_maxbool, optional

Use the cal_min and cal_max of volumes for value range. Default is False.

plot_ltwhlist of float, optional

List of four floats specifying the plot area (left, top, width, height).

back_colorlist of float, optional

RGBA color for the background of the graph.

line_colorlist of float, optional

RGBA color for the lines in the graph.

text_colorlist of float, optional

RGBA color for the text in the graph.

line_thicknessfloat, optional

Thickness of the lines in the graph.

grid_line_thicknessfloat, optional

Thickness of the grid lines.

line_alphafloat, optional

Alpha (transparency) value for the lines.

lineslist of list of float, optional

Data lines to be plotted.

selected_columnint, optional

Index of the selected column.

line_rgblist of list of float, optional

List of RGB colors for the lines, each inner list must have exactly 3 floats.

parentobject, optional

The parent object that contains this Graph. Used for propagating changes to the parent widget. Default is None.

__init__(*args, parent=None, **kwargs)[source]
auto_size_multiplanar

A boolean (True, False) trait.

back_color

An instance of a Python list.

grid_line_thickness

A float trait.

is_range_cal_min_max

A boolean (True, False) trait.

line_alpha

A float trait.

line_color

An instance of a Python list.

line_rgb

An instance of a Python list.

line_thickness

A float trait.

lines

An instance of a Python list.

ltwh

An instance of a Python list.

normalize_values

A boolean (True, False) trait.

opacity

A float trait.

plot_ltwh

An instance of a Python list.

selected_column

An int trait.

text_color

An instance of a Python list.

vols

An instance of a Python list.