NVIDIA Clara Viz 最新版本
NVIDIA 文档中心  NVIDIA Clara Viz 最新版本  Clara Viz Core API 参考文档

Clara Viz Core API 参考文档

clara-viz-core：Clara Viz 的核心功能。

class clara.viz.core.Array
__init__(*args, **kwargs)

重载函数。

  1. __init__(self: clara.viz.core._viz.Array, array: numpy.ndarray, dimension_order: str = ‘’, permute_axes: List[int] = [], flip_axes: List[bool] = [], element_size: List[float] = []) -> None

构造数组。

参数

  • array – numpy 数组

  • dimension_order – 定义数据组织和格式的字符串。每个字符定义一个维度，从变化最快的轴开始，到变化最慢的轴结束。例如，2D 彩色图像定义为 ‘CXY’，密度体积的时间序列定义为 ‘DXYZT’。每个字符只能出现一次。数据元素定义字符 ‘C’、‘D’ 或 ‘M’ 和 ‘X’ 轴定义必须存在其中一个。 - ‘X’：宽度 - ‘Y’：高度 - ‘Z’：深度 - ‘T’：时间 - ‘I’：序列 - ‘C’：RGB(A) 颜色 - ‘D’：密度 - ‘M’：掩码

  • permute_axes – 置换给定的数据轴，例如，要交换 3 维密度数组的 x 和 y 轴，请指定 (0, 2, 1, 3)

  • flip_axes – 翻转给定的轴

  • element_size – 每个元素的物理尺寸，顺序由 ‘dimension_order’ 字段定义。对于像 ‘M’ 或 ‘T’ 这样没有物理尺寸的元素，对应的值为 1.0。

  1. __init__(self: clara.viz.core._viz.Array, levels: List[numpy.ndarray], dimension_order: str = ‘’, permute_axes: List[int] = [], flip_axes: List[bool] = [], element_sizes: List[List[float]] = []) -> None

构造一个包含多维数据的数组。

参数

  • levels – numpy 数组的数组，包含多维数据每个级别的数据；对于其他数据（例如体积数据），则为包含单个 numpy 数组的数组

  • dimension_order – 定义数据组织和格式的字符串。每个字符定义一个维度，从变化最快的轴开始，到变化最慢的轴结束。例如，2D 彩色图像定义为 ‘CXY’，密度体积的时间序列定义为 ‘DXYZT’。每个字符只能出现一次。数据元素定义字符 ‘C’、‘D’ 或 ‘M’ 和 ‘X’ 轴定义必须存在其中一个。 - ‘X’：宽度 - ‘Y’：高度 - ‘Z’：深度 - ‘T’：时间 - ‘I’：序列 - ‘C’：RGB(A) 颜色 - ‘D’：密度 - ‘M’：掩码

  • permute_axes – 置换给定的数据轴，例如，要交换 3 维密度数组的 x 和 y 轴，请指定 (0, 2, 1, 3)

  • flip_axes – 翻转给定的轴

  • element_sizes – 每个级别元素的物理尺寸。顺序由 ‘dimension_order’ 字段定义。对于像 ‘M’ 或 ‘T’ 这样没有物理尺寸的元素，对应的值为 1.0。对于多维数据，这是一个元素尺寸的数组；否则，是包含单个元素的数组。

property dimension_order

数据组织

property element_sizes

每个级别元素的物理尺寸

property flip_axes

翻转给定的轴

property levels

每个级别的 numpy 数组

property permute_axes

置换给定的轴

class clara.viz.core.DataDefinition(path: Optional[pathlib.Path] = None, dimension_order='')[source]

定义渲染器使用的数据。

arrays

包含体积数据的 ‘Array’ 元素的列表

settings

渲染设置

fetch_func

一个在需要时调用以获取数据的函数

class Array(array=None, dimension_order='', order='')[source]

定义一个数组。

levels

numpy 数组的数组，包含多维数据每个级别的数据；对于其他数据（例如体积数据），则为包含单个 numpy 数组的数组

element_sizes

每个级别元素的物理尺寸。顺序由 ‘dimension_order’ 字段定义。对于像 ‘M’ 或 ‘T’ 这样没有物理尺寸的元素，对应的值为 1.0。对于多维数据，这是一个元素尺寸的数组；否则，是包含单个元素的数组。默认值：[1.0, 1.0, …]

dimension_order

定义数据组织和格式的字符串。每个字符定义一个维度，从变化最快的轴开始，到变化最慢的轴结束。例如，2D 彩色图像定义为 ‘CXY’，密度体积的时间序列定义为 ‘DXYZT’。每个字符只能出现一次。数据元素定义字符 ‘C’、‘D’ 或 ‘M’ 和 ‘X’ 轴定义必须存在其中一个。 - X：宽度 - Y：高度 - Z：深度 - T：时间 - I：序列 - C：RGB(A) 颜色 - D：密度 - M：掩码

permute_axes

置换给定的数据轴，例如，要交换 3 维密度数组的 x 和 y 轴，请指定 [0, 2, 1, 3]

flip_axes

翻转给定的轴，例如，要翻转 3 维密度数组的 x 轴，请指定 [False, True, False, False]

__init__(array=None, dimension_order='', order='')[source]

构造数组

参数

  • array – 包含数据的 numpy 数组（可选）

  • dimension_order – 定义数据组织和格式的字符串（可选）

  • order – 自 0.2 版本起已弃用，请改用 ‘dimension_order’ 参数

property array

自 0.2 版本起已弃用：请改用 ‘levels’ 数组

获取 numpy 数组

返回值

numpy 数组

property element_size

自 0.2 版本起已弃用：请改用 ‘element_sizes’ 数组

获取每个元素的物理尺寸

返回值

每个元素的物理尺寸

property order

自 0.2 版本起已弃用：请改用 ‘dimension_order’ 属性

获取维度顺序

返回值

定义数据组织和格式的字符串

__init__(path: Optional[pathlib.Path] = None, dimension_order='')[source]

构造 DataDefinition 对象

参数

  • path – 要加载的数据文件（可选）

  • dimension_order – 定义数据组织和格式的字符串；如果未提供，则对于三维体积数据设置为 ‘DXYZ’，对于二维图像数据设置为 ‘CXY’（可选）

append(path: pathlib.Path, dimension_order='')[source]

将文件附加到 DataDefinition。

参数

  • path – 文件路径

  • dimension_order – 定义数据组织和格式的字符串；如果未提供，则对于三维体积数据设置为 ‘DXYZ’，对于二维图像数据设置为 ‘CXY’

load_settings(path: pathlib.Path)[source]

从 JSON 文件读取设置

参数

path – 要读取的 JSON 文件路径

class clara.viz.core.ImageCapsule
__init__(*args, **kwargs)
class clara.viz.core.ImageType
class ImageType

成员

RAW_RGB_U8_DEPTH_U8 : RAW 未压缩 RGB 无符号整数 8 位，带深度无符号整数 8 位

JPEG : JPEG

JPEG =
RAW_RGB_U8_DEPTH_U8 =
__init__(self: clara.viz.core._viz.ImageType.ImageType, value: int) → None
property name
property value
JPEG =
RAW_RGB_U8_DEPTH_U8 =
__init__(*args, **kwargs)
class clara.viz.core.InterfaceSelector
ALL =
BACKGROUND_LIGHT =
CAMERA =
CAMERA_APERTURE =
DATA =
DATA_CONFIG =
DATA_CROP =
DATA_VIEW =
class InterfaceSelector

成员

ALL

CAMERA

CAMERA_APERTURE

DATA

DATA_CONFIG

DATA_CROP

DATA_VIEW

LIGHT

BACKGROUND_LIGHT

POST_PROCESS_DENOISE

POST_PROCESS_TONEMAP

RENDER_SETTINGS

TRANSFER_FUNCTION

VIEW

ALL =
BACKGROUND_LIGHT =
CAMERA =
CAMERA_APERTURE =
DATA =
DATA_CONFIG =
DATA_CROP =
DATA_VIEW =
LIGHT =
POST_PROCESS_DENOISE =
POST_PROCESS_TONEMAP =
RENDER_SETTINGS =
TRANSFER_FUNCTION =
VIEW =
__init__(self: clara.viz.core._viz.InterfaceSelector.InterfaceSelector, value: int) → None
property name
property value
LIGHT =
POST_PROCESS_DENOISE =
POST_PROCESS_TONEMAP =
RENDER_SETTINGS =
TRANSFER_FUNCTION =
VIEW =
__init__(*args, **kwargs)
class clara.viz.core.Renderer
__init__(*args, **kwargs)

重载函数。

  1. __init__(self: clara.viz.core._viz.Renderer) -> None

Clara Viz 渲染器的构造函数

  1. __init__(self: clara.viz.core._viz.Renderer, density: numpy.ndarray, mask: Optional[numpy.ndarray] = None, view_mode: clara.viz.core._viz.ViewMode.ViewMode = <ViewMode.CINEMATIC: 0>, settings: json = None) -> None

Clara Viz 渲染器的构造函数，用于渲染密度体积以及可选的分割掩码体积

参数

  • density – 包含密度值的 numpy 数组

  • mask – 包含掩码值的 numpy 数组

  • view_mode – 初始视图模式

  • settings – JSON 格式的初始设置

  1. __init__(self: clara.viz.core._viz.Renderer, data_definition: object, view_mode: clara.viz.core._viz.ViewMode.ViewMode = <ViewMode.CINEMATIC: 0>) -> None

Clara Viz 渲染器的构造函数，使用 DataDefinition 对象

参数

  • data_definition – DataDefinition 对象

  • view_mode – 初始视图模式

create_video_stream(self: clara.viz.core._viz.Renderer, callback: Callable[[object, bool], None]) → <a class="reference internal" href="#clara.viz.core.VideoStream" title="clara.viz.core._viz.VideoStream" target="_self">clara.viz.core._viz.VideoStream</a>

创建视频流。

参数

callback – 视频数据回调函数。该函数接收视频流数据和一个布尔标志。如果为真，则表示这是新流的第一个数据段。例如，当分辨率更改时，可以触发此操作。写入文件时，可以使用它来关闭当前文件并开始写入新文件。当流式传输到浏览器时，需要创建一个新的 MediaSource SourceBuffer 对象。

返回值

视频流对象

deduce_settings(self: clara.viz.core._viz.Renderer, view_mode: clara.viz.core._viz.ViewMode.ViewMode = ) → None

从配置的数据中推断设置（数据需要通过 SetArray() 配置）。使整个数据集可见。在正确的距离设置灯光。使用数据的直方图设置传递函数。

参数

view_mode – 视图模式

get_arrays(self: clara.viz.core._viz.Renderer) → List[<a class="reference internal" href="#clara.viz.core.Array" title="clara.viz.core._viz.Array" target="_self">clara.viz.core._viz.Array</a>]

获取数据数组

返回值

clara.viz.Array 对象的列表

get_settings(self: clara.viz.core._viz.Renderer) → json

获取设置

返回值

包含设置的 json

merge_settings(self: clara.viz.core._viz.Renderer, new_settings: json) → None

合并设置

参数

new_settings – 要合并的包含设置的 json

render_image(self: clara.viz.core._viz.Renderer, width: int, height: int, image_type: clara.viz.core._viz.ImageType.ImageType = ) → <a class="reference internal" href="#clara.viz.core.ImageCapsule" title="clara.viz.core._viz.ImageCapsule" target="_self">clara.viz.core._viz.ImageCapsule</a>

渲染图像。

参数

  • width – 要渲染的图像宽度

  • height – 要渲染的图像高度

  • image_type – 要渲染的图像类型

返回值

图像数据

reset(self: clara.viz.core._viz.Renderer, selector: List[clara.viz.core._viz.InterfaceSelector.InterfaceSelector] = [ ] ) → None

将选定的接口重置为默认值。

参数

selectors – 要重置为默认值的接口列表

set_arrays(self: clara.viz.core._viz.Renderer, arrays: List[clara.viz.core._viz.Array], fetch_func: Callable[[int, str, int, List[int], List[int], Callable[[int, int, List[int], List[int], numpy.ndarray], bool]], bool] = None) → None

设置数据数组

参数

  • arrays – clara.viz.Array 对象的列表

  • fetch_func – 在需要时调用以获取数据的函数

set_settings(self: clara.viz.core._viz.Renderer, new_settings: json) → None

设置设置

参数

new_settings – 包含新设置的 json

class clara.viz.core.VideoStream
__init__(*args, **kwargs)
configure(self: clara.viz.core._viz.VideoStream, width: int, height: int, frame_rate: float, bit_rate: int) → None

配置视频流。

参数

  • width – 视频宽度，值需要能被 2 整除

  • height – 视频高度，值需要能被 2 整除

  • frame_rate – 视频的目标帧率。如果设置为 0.0，则在渲染完成后交付帧。收敛渲染器将仅交付最后一帧。

  • bit_rate – 视频的目标比特率

pause(self: clara.viz.core._viz.VideoStream) → None

暂停视频。

play(self: clara.viz.core._viz.VideoStream) → None

播放视频。

stop(self: clara.viz.core._viz.VideoStream) → None

停止视频。如果视频流已打开，则会关闭。

class clara.viz.core.ViewMode
CINEMATIC =
SLICE =
SLICE_SEGMENTATION =
TWOD =
class ViewMode

成员

CINEMATIC

3D 电影渲染视图

该视图使用透视投影。数据使用逼真的光照和阴影显示。传递函数用于将输入数据映射到材质属性。

SLICE

3D 切片视图

该视图使用正交投影。相机 ‘look_at’ 和 ‘eye’ 点之间的向量定义了视图方向。相机的 ‘eye’ 点定义了在体积数据中显示的切片。数据的大小由数据数组级别配置 ‘size’ 和 ‘element_size’ 参数定义，数据也受数据裁剪设置的限制。‘fov’ 相机参数定义了视锥体的宽度。

SLICE_SEGMENTATION

3D 切片和分割视图

与上面的 ‘SLICE’ 模式相同，但是当指定分割掩码时，段会使用传递函数的发射和漫反射颜色进行着色，并与数据的密度混合。

TWOD

2D n 维数据视图

该视图显示通用的 n 维数据。要显示的数据部分由 ‘data_view_name’ 定义。

CINEMATIC =
SLICE =
SLICE_SEGMENTATION =
TWOD =
__init__(self: clara.viz.core._viz.ViewMode.ViewMode, value: int) → None
property name
property value
__init__(*args, **kwargs)
© 版权所有 2021-2022，NVIDIA Corporation 及其附属公司。 上次更新于 2022 年 3 月 31 日。
content here