libcarna.helpers

class libcarna.helpers.FrameRendererHelper

Bases: pybind11_object

add_stage(self: libcarna.helpers.FrameRendererHelper, stage: libcarna.base.RenderStage) → None

commit(self: libcarna.helpers.FrameRendererHelper) → None

reset(self: libcarna.helpers.FrameRendererHelper) → None

class libcarna.helpers.VolumeGridHelperBase

Bases: pybind11_object

DEFAULT_MAX_SEGMENT_BYTESIZE = 54000000

class Extent

Bases: pybind11_object

Specifies the spatial size of the whole dataset.

property units

class Spacing

Bases: pybind11_object

Specifies the spacing between two adjacent voxel centers.

property units

property native_resolution

class libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16

Bases: VolumeGridHelperBase

Computes the partitioning grid of volume data and the corresponding normal map. Also creates scene nodes that represent the volume data within a scene.

Parameters:

• native_resolution – The resolution the partitioning grid is to be prepared for. This is the resolution that will be expected when the data is loaded.

• max_segment_bytesize – Maximum memory size of a single volume segment in bytes. Determines the partitioning of the volume into a regular grid of segments.

DEFAULT_ROLE_INTENSITIES = 0

create_node(*args, **kwargs)

Overloaded function.

1. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16, geometry_type: int, spacing: libcarna.helpers.VolumeGridHelperBase.Spacing) -> libcarna.base.Node

2. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16, geometry_type: int, extent: libcarna.helpers.VolumeGridHelperBase.Extent) -> libcarna.base.Node

property intensities_role

load_intensities(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16, intensity_data: numpy.ndarray[numpy.float64]) → None

class libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16_NormalMap3DInt8

Bases: VolumeGridHelperBase

Computes the partitioning grid of volume data and the corresponding normal map. Also creates scene nodes that represent the volume data within a scene.

Parameters:

• native_resolution – The resolution the partitioning grid is to be prepared for. This is the resolution that will be expected when the data is loaded.

• max_segment_bytesize – Maximum memory size of a single volume segment in bytes. Determines the partitioning of the volume into a regular grid of segments.

DEFAULT_ROLE_INTENSITIES = 0

DEFAULT_ROLE_NORMALS = 1

create_node(*args, **kwargs)

Overloaded function.

1. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16_NormalMap3DInt8, geometry_type: int, spacing: libcarna.helpers.VolumeGridHelperBase.Spacing) -> libcarna.base.Node

2. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16_NormalMap3DInt8, geometry_type: int, extent: libcarna.helpers.VolumeGridHelperBase.Extent) -> libcarna.base.Node

property intensities_role

load_intensities(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt16_NormalMap3DInt8, intensity_data: numpy.ndarray[numpy.float64]) → None

property normals_role

class libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8

Bases: VolumeGridHelperBase

Computes the partitioning grid of volume data and the corresponding normal map. Also creates scene nodes that represent the volume data within a scene.

Parameters:

• native_resolution – The resolution the partitioning grid is to be prepared for. This is the resolution that will be expected when the data is loaded.

• max_segment_bytesize – Maximum memory size of a single volume segment in bytes. Determines the partitioning of the volume into a regular grid of segments.

DEFAULT_ROLE_INTENSITIES = 0

create_node(*args, **kwargs)

Overloaded function.

1. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8, geometry_type: int, spacing: libcarna.helpers.VolumeGridHelperBase.Spacing) -> libcarna.base.Node

2. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8, geometry_type: int, extent: libcarna.helpers.VolumeGridHelperBase.Extent) -> libcarna.base.Node

property intensities_role

load_intensities(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8, intensity_data: numpy.ndarray[numpy.float64]) → None

class libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8_NormalMap3DInt8

Bases: VolumeGridHelperBase

Computes the partitioning grid of volume data and the corresponding normal map. Also creates scene nodes that represent the volume data within a scene.

Parameters:

• native_resolution – The resolution the partitioning grid is to be prepared for. This is the resolution that will be expected when the data is loaded.

• max_segment_bytesize – Maximum memory size of a single volume segment in bytes. Determines the partitioning of the volume into a regular grid of segments.

DEFAULT_ROLE_INTENSITIES = 0

DEFAULT_ROLE_NORMALS = 1

create_node(*args, **kwargs)

Overloaded function.

1. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8_NormalMap3DInt8, geometry_type: int, spacing: libcarna.helpers.VolumeGridHelperBase.Spacing) -> libcarna.base.Node

2. create_node(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8_NormalMap3DInt8, geometry_type: int, extent: libcarna.helpers.VolumeGridHelperBase.Extent) -> libcarna.base.Node

property intensities_role

load_intensities(self: libcarna.helpers.VolumeGridHelper_IntensityVolumeUInt8_NormalMap3DInt8, intensity_data: numpy.ndarray[numpy.float64]) → None

property normals_role