Concepts & Architecture:
Tutorials:
User Guides:
.luxar-index.json
Command-Line Interface:
luxar serve
luxar optimize
luxar restamp-lod
luxar demo
luxar gsplat
luxar gsplat batch-fit
luxar env
luxar env bake
luxar env attach
luxar mesh
luxar mesh lod
Format Specifications:
luxar_delta_v1
citation
input_digests
incomplete
absorption
group
kind: "lod"
kind: "partition"
kind=lod
kind=partition
lod_stats
level_stats
.gsplats.zarr
dim_order
normal_dims
material="physical"
three
Technical Specifications:
extend_to_all
normal
needsDepthSort(mode)
material
add_mesh
viewer_config.audio
src/audio/
REMOTE_CONTROL_SPEC.md
Developer Guides:
make setup-dev
make build-cuda SLURM=1
cuda_build_info.json
src/ui/gui/
<kbd>
<code>
from e
bootstrap.ts
installDebugInterface()
runtimeReady
true
getState()
__luxarDebug.cache
page.evaluate
src
curl -I
counts
codex_pancreas
shape=[0]
array_ref
bsp_tree
indexed
/d/<demo-key>
noOrbitVideo
--floor none
probe-frames.mjs
probe-playback.mjs
--full
isLoading=false
Python API Reference:
Scene
Scene.__init__()
Scene.citation
Scene.add_group()
Scene.get_store_path()
Scene.dimensions
Scene.viewer_config
Scene.overlays
Scene.add_text()
Scene.add_image()
Scene.add_video()
Scene.add_html()
Scene.to_zarr()
Node
Node.__init__()
Node.attrs
Node.add_group()
Node.add_lod_group()
Node.add_partition_group()
Node.walk()
Node.transform
Node.world_transform
Node.nd_transform
Node.world_nd_transform
Node.num_children
Node.is_leaf
Node.is_root
Node.layer
Node.visible
Node.opacity
Node.absorption
Node.gamma
Node.intensity
Node.offset
Node.blending_mode
Node.join
Node.set_opacity()
Node.set_absorption()
Node.set_gamma()
Node.set_intensity()
Node.set_offset()
Node.set_blending_mode()
Node.set_join()
Node.colormap
Node.set_colormap()
Node.__eq__()
Node.__hash__()
Node.__repr__()
Group
Group.add_points()
Group.add_lines()
Group.add_sound()
Group.add_mesh()
Group.add_gsplats()
Group.add_gsplats_from_data()
Group.add_gsplats_from_file()
Group.add_gsplats_from_volume()
Points
Points.__init__()
Points.n_elements
Points.has_colors
Points.has_radii
Points.has_sharpness
Points.has_scalars
Points.has_labels
Points.has_image_labels
Points.has_keys
Points.max_radius
Points.has_spatial_index
Points.ordering
Points.join
Lines
Lines.__init__()
Lines.n_elements
Lines.n_segments
Lines.line_type
Lines.has_colors
Lines.has_sharpness
Lines.has_scalars
Lines.has_labels
Lines.has_image_labels
Lines.has_keys
Lines.max_width
Lines.has_spatial_index
Lines.ordering
GSplats
GSplats.__init__()
GSplats.n_elements
GSplats.has_colors
GSplats.has_labels
GSplats.has_image_labels
GSplats.has_keys
GSplats.ordering
GSplats.amplitude_range
GSplats.center_bounds
GSplats.join
Mesh
Mesh.__init__()
Mesh.n_elements
Mesh.n_faces
Mesh.has_normals
Mesh.normal_dims
Mesh.has_colors
Mesh.has_scalars
Mesh.has_labels
Mesh.has_image_labels
Mesh.has_keys
Mesh.shading
Mesh.double_sided
Mesh.blending_mode
Mesh.join
Mesh.ordering
Sound
Sound.__init__()
Sound.n_elements
Sound.n_positions
Sound.spatial
Sound.trigger
Sound.bus
Sound.attach_to
Sound.format
Sound.audio_file
Sound.duration_ms
Dimensions
Dimensions.dimensions
Dimensions.__post_init__()
Dimensions.ndim
Dimensions.__len__()
Dimensions.names
Dimensions.displayed
Dimensions.non_displayed
Dimensions.spatial_extend_dims
Dimensions.get_dimension()
Dimensions.get_index()
Dimensions.validate_positions()
Dimensions.to_dict()
Dimensions.from_dict()
Dimensions.default_2d()
Dimensions.default_3d()
Dimensions.default_timeseries()
Dimensions.default_multichannel()
Dimensions.from_positions()
Dimensions.__init__()
Dimension
Dimension.name
Dimension.unit
Dimension.range
Dimension.step
Dimension.display
Dimension.discrete
Dimension.cyclic
Dimension.scale
Dimension.spatial
Dimension.categories
Dimension.description
Dimension.__post_init__()
Dimension.get_step()
Dimension.is_categorical
Dimension.to_dict()
Dimension.from_dict()
Dimension.__init__()
identity()
translate()
scale()
rotate_x()
rotate_y()
rotate_z()
rotate()
compose()
inverse()
look_at()
to_list()
from_list()
prepare_transform_for_zarr()
read_transform_from_zarr()
transform_bounding_box()
translation()
scaling()
rotation()
ControlError
ControlError.__init__()
ControlError.no_viewer_attached
Viewer
Viewer.__init__()
Viewer.close()
Viewer.call()
Viewer.notify()
Viewer.recv_event()
Viewer.get_viewer_state()
Viewer.get_dimensions()
Viewer.set_dimension_value()
Viewer.dimension_index()
Viewer.get_camera_pose()
Viewer.fly_to()
Viewer.recenter_camera()
Viewer.subscribe()
Viewer.unsubscribe()
AttachReport
AttachReport.store
AttachReport.status
AttachReport.array_name
AttachReport.digest
AttachReport.scene_content_hash
AttachReport.resolution
AttachReport.removed
AttachReport.__init__()
attach_environment()
pack()
unpack()
TriangleMesh
TriangleMesh.vertices
TriangleMesh.faces
TriangleMesh.normals
TriangleMesh.colors
TriangleMesh.source_format
TriangleMesh.dimension_names
TriangleMesh.n_vertices
TriangleMesh.n_faces
TriangleMesh.__init__()
compile_index_regex()
detect_mesh_format()
import_mesh()
import_mesh_directory()
DecimatedMesh
DecimatedMesh.vertices
DecimatedMesh.faces
DecimatedMesh.normals
DecimatedMesh.colors
DecimatedMesh.scalars
DecimatedMesh.geometric_error
decimate()
decimate_cluster()
decimate_ladder()
resolve_decimation_method()
decimate_qem()
decimate_qem_ladder()
MeshPart
MeshPart.faces
MeshPart.vertex_index
MeshPart.face_index
MeshPart.__init__()
face_centroids()
split_mesh_by_faces()
duplication_factor()
bake_ambient_occlusion()
directional_optical_depth()
sphere_directions()
ElementCapacityWarning
LuxarZarrCompiler
LuxarZarrCompiler.__init__()
LuxarZarrCompiler.__enter__()
LuxarZarrCompiler.__exit__()
LuxarZarrCompiler.create_scene()
LuxarZarrCompiler.write_group()
LuxarZarrCompiler.delete_group_attr()
LuxarZarrCompiler.node_exists()
LuxarZarrCompiler.delete_node()
LuxarZarrCompiler.snapshot_rollback_state()
LuxarZarrCompiler.restore_rollback_state()
LuxarZarrCompiler.transaction()
LuxarZarrCompiler.write_points()
LuxarZarrCompiler.write_lines()
LuxarZarrCompiler.write_mesh()
LuxarZarrCompiler.write_sound()
LuxarZarrCompiler.write_points_multi_lod()
LuxarZarrCompiler.write_lines_multi_lod()
LuxarZarrCompiler.write_mesh_multi_lod()
LuxarZarrCompiler.write_gsplats()
LuxarZarrCompiler.write_gsplat_leaf_subtree()
LuxarZarrCompiler.create_resizable_dataset()
LuxarZarrCompiler.finalize()
LuxarZarrCompiler.store_path
LuxarZarrCompiler.final_store_path
LuxarScene
LuxarScene.__init__()
LuxarScene.load()
LuxarScene.path
LuxarScene.version
LuxarScene.root_attrs
LuxarScene.dimensions
LuxarScene.viewer_config
LuxarScene.nodes
LuxarScene.list_points()
LuxarScene.list_gsplats()
LuxarScene.list_lines()
LuxarScene.list_meshes()
LuxarScene.list_sounds()
LuxarScene.list_groups()
LuxarScene.has_node()
LuxarScene.get_node_type()
LuxarScene.get_node_metadata()
LuxarScene.get_colormap_lut()
LuxarScene.get_group()
LuxarScene.get_points()
LuxarScene.get_point_array()
LuxarScene.get_gsplats()
LuxarScene.get_lines()
LuxarScene.get_mesh()
morton_encode_nd()
morton_encode_128bit()
hilbert_encode_nd()
normalize_coords_to_grid()
compute_auto_resolution()
detect_barrier_dims()
sort_points_compound()
sort_splats_spatial()
compute_chunk_bounds_points()
compute_chunk_bounds_gsplats()
convert_to_indexed()
sort_segments_compound()
order_lines_spatial()
compute_vertex_chunk_bounds()
compute_segment_chunk_bounds()
ZarrWriterProtocol
ZarrWriterProtocol.store
ZarrWriterProtocol.write_group()
ZarrWriterProtocol.write_points()
ZarrWriterProtocol.write_lines()
ZarrWriterProtocol.write_mesh()
ZarrWriterProtocol.write_gsplats()
ZarrWriterProtocol.write_points_multi_lod()
ZarrWriterProtocol.write_lines_multi_lod()
ZarrWriterProtocol.write_sound()
ZarrWriterProtocol.write_mesh_multi_lod()
ZarrWriterProtocol.create_resizable_dataset()
ZarrWriterProtocol.delete_group_attr()
ZarrWriterProtocol.node_exists()
ZarrWriterProtocol.delete_node()
ZarrWriterProtocol.snapshot_rollback_state()
ZarrWriterProtocol.restore_rollback_state()
ZarrWriterProtocol.transaction()
ZarrWriterProtocol.finalize()
ZarrWriterProtocol.store_path
ZarrWriterProtocol.final_store_path
ZarrWriterProtocol.__init__()
load_volume()
discover_ome_zarr_shape()
resolve_ngff_attrs()
ngff_scale_transform()
OMEZarrInfo
OMEZarrInfo.axes
OMEZarrInfo.shape
OMEZarrInfo.n_timepoints
OMEZarrInfo.n_channels
OMEZarrInfo.channel_axes
OMEZarrInfo.channel_shape
OMEZarrInfo.spatial_shape
OMEZarrInfo.spatial_axes
OMEZarrInfo.time_axis
OMEZarrInfo.channel_indices
OMEZarrInfo.spatial_indices
OMEZarrInfo.axis_units
OMEZarrInfo.axis_scales
OMEZarrInfo.voxel_size
OMEZarrInfo.unit
OMEZarrInfo.resolution_levels
OMEZarrInfo.path
OMEZarrInfo.__post_init__()
OMEZarrInfo.__init__()
optimize_store()
plan_optimization()
summarize_chunk_layout()
summarize_plan()
resolve_target_bytes()
CHUNK_PROFILES
OptimizePlan
OptimizePlan.target_bytes
OptimizePlan.profile
OptimizePlan.arrays
OptimizePlan.playback_warnings
OptimizePlan.n_rechunked
OptimizePlan.source_n_chunks
OptimizePlan.target_n_chunks
OptimizePlan.__init__()
ArrayPlan
ArrayPlan.path
ArrayPlan.shape
ArrayPlan.dtype
ArrayPlan.itemsize
ArrayPlan.source_chunks
ArrayPlan.target_chunks
ArrayPlan.source_n_chunks
ArrayPlan.target_n_chunks
ArrayPlan.atom
ArrayPlan.source_file_grid
ArrayPlan.skip_reason
ArrayPlan.rechunked
ArrayPlan.target_chunk_bytes
ArrayPlan.source_file_bytes
ArrayPlan.__init__()
ChunkLayoutSummary
ChunkLayoutSummary.n_arrays
ChunkLayoutSummary.n_chunks
ChunkLayoutSummary.mean_chunk_bytes
ChunkLayoutSummary.n_arrays_under_floor
ChunkLayoutSummary.share_under_floor
ChunkLayoutSummary.__init__()
ArrayEncoder
ArrayEncoder.__init__()
ArrayEncoder.encode()
ArrayEncoder.encodes_as_lut()
ArrayEncoder.reset()
ArrayEncoder.snapshot()
ArrayEncoder.restore()
SemanticType
SemanticType.COORDINATE
SemanticType.COLOR
SemanticType.BOUNDED_SCALAR
SemanticType.POSITIVE_SCALAR
SemanticType.CHOLESKY
SemanticType.CHOLESKY_DIAG
SemanticType.CHOLESKY_OFFDIAG
SemanticType.INDEX
EncodingMode
EncodingMode.AUTO
EncodingMode.PRECISION
EncodingMode.MEMORY
EncodingMode.CUSTOM
gridded_axis_step()
COORDINATE_LEVELS
ValidationError
ValidationError.__init__()
DimensionalCoverageError
DimensionalCoverageError.__init__()
validate_cholesky_for_writing()
validate_colors_for_writing()
validate_labels_for_writing()
validate_node_name()
validate_positions_for_writing()
validate_radii_for_writing()
validate_sharpness_for_writing()
validate_widths_for_writing()
validate_zarr_attributes()
validate_positions()
validate_colors()
validate_radii()
validate_sharpness()
validate_transform()
validate_node_type()
validate_physical_unit()
validate_opacity()
validate_truncation_radius()
validate_gamma()
validate_absorption()
validate_blending_mode()
validate_layer_order()
validate_line_join()
validate_categories()
validate_category_indices()
is_position_array()
is_color_array()
is_transform_matrix()
broadcast_to_all_slices()
validate_dimensional_coverage()
validate_appearance_fraction()
validate_positive_finite()
TEXTURE_FILTERS
TEXTURE_WRAPS
TEXTURE_COLOR_SPACES
validate_texture_filter()
validate_texture_wrap()
validate_texture_color_space()
MESH_MATERIALS
PHYSICAL_MATERIAL_FRACTION_ATTRS
PHYSICAL_TRANSMISSION_ATTRS
PHYSICAL_TRANSMISSION_DEPENDENT_ATTRS
PHYSICAL_MATERIAL_ATTRS
IOR_MIN
HOUSE_SHADER_ONLY_ATTRS
validate_mesh_material()
validate_ior()
validate_non_negative_finite()
validate_hex_color()
MIN_TRUNCATION_RADIUS_FLOAT32
MAX_TRUNCATION_RADIUS_FLOAT32
validate_intensity()
validate_offset()
validate_layer()
validate_bool_flag()
validate_link()
validate_copy_template()
validate_link_target()
validate_visible()
validate_colormap()
validate_finite_reveal_coords()
validate_integral_axis_indices()
validate_color_dtype()
validate_vertices_for_writing()
mesh_decoded_value_count()
validate_mesh_ladder_decode_budget()
validate_mesh_decode_budget()
validate_faces_for_writing()
validate_normals_for_writing()
validate_normal_dims_for_writing()
TEXTURE_ENCODINGS
MAX_MESH_TEXTURE_SIZE
MESH_TEXTURE_DECODE_BUDGET_BYTES
validate_uvs_for_writing()
validate_texture_for_writing()
BundleMemberNotFound
DatasetNotFound
DatasetUnavailable
DependencySpec
DependencySpec.spec
DependencySpec.extra
DependencySpec.note
DependencyStatus
DependencyStatus.module
DependencyStatus.spec
DependencyStatus.installed
DependencyStatus.satisfied
LocalComputeDataset
LocalComputeDataset.__init__()
MissingDependencyError
ResolvedDataset
ResolvedDataset.__init__()
add_demo_caption()
add_reference_cube_to_scene()
cache_computed()
cached_download()
create_lorenz_attractor()
create_random_spheres()
create_time_series_demo()
cubic_bounds()
dataset_spec()
declared_file_names()
demo_source_fingerprint()
detect_device()
download_with_checksum()
download_zip_member()
ensure_dataset()
extras_for()
find_quarantined_files()
format_demo_caption()
format_quarantine_notice()
hsv_to_rgb()
is_installed()
is_lfs_pointer()
control_serve_args()
bake_scene_environment()
launch_viewer()
load_dataset_bundle()
load_dataset_gsplats()
load_local_fit_gsplats()
load_local_fit_gsplats_at()
load_manifest()
load_precomputed_bundle()
load_precomputed_gsplats()
local_fit_path()
parse_demo_flags()
parse_int_arg()
parse_path_arg()
parse_str_arg()
print_data_provenance()
quarantine_file()
require_local_data()
require_module()
rk4_step()
robust_download()
run_luxar_cli()
scene_is_current()
stack_colorings()
stamp_input_digests()
substitutive_lod_or_flat()
survey()
trilinear_vector()
unit_flow()
voxel_sampled_payload_agreement()
warn_if_no_cuda_gpu()
warn_if_quarantined()
window_attrs()
FlowField
FlowField.vectors
FlowField.grid_min
FlowField.grid_max
FlowField.spacing
FlowField.cache_key
FlowField.__init__()
arbol_warnings()
install_arbol_warnings()
ensure_float32()
validate_array_shape()
atomic_copy_file()
atomic_copytree()
deprecated_kwarg_alias()
deprecation_message()
warn_deprecated()
get_datasets_dir()
get_demos_output_dir()
get_examples_output_dir()
get_project_root()
StackedColorings
StackedColorings.positions
StackedColorings.colors
StackedColorings.labels
StackedColorings.categories
StackedColorings.keys
get_verbosity()
set_verbosity()
verbosity()
DimensionIndex
NodePath
CompressorProtocol
CompressorProtocol.encode()
CompressorProtocol.decode()
CompressorProtocol.__init__()
NodeProtocol
NodeProtocol.name
NodeProtocol.children
NodeProtocol.parent
NodeProtocol.attrs
NodeProtocol.add_group()
NodeProtocol.walk()
NodeProtocol.__init__()
BlendingMode
BlendingMode.NORMAL
BlendingMode.ADDITIVE
BlendingMode.MAX
BlendingMode.OPAQUE
BlendingMode.LUMINOUS
BlendingMode.VOLUMETRIC
NodeType
NodeType.SCENE
NodeType.GROUP
NodeType.POINTS
NodeType.LINES
NodeType.GSPLATS
NodeType.MESH
NodeType.SOUND
NodeType.validate()
PhysicalUnit
PhysicalUnit.NANOMETER
PhysicalUnit.MICROMETER
PhysicalUnit.MILLIMETER
PhysicalUnit.CENTIMETER
PhysicalUnit.METER
PhysicalUnit.METRE
PhysicalUnit.KILOMETER
PhysicalUnit.INCH
PhysicalUnit.FOOT
PhysicalUnit.PIXEL
PhysicalUnit.SECOND
PhysicalUnit.ASTRONOMICAL_UNIT
PhysicalUnit.validate()
Defaults
Defaults.OPACITY
Defaults.GAMMA
Defaults.ABSORPTION
Defaults.SHARPNESS
Defaults.CHUNK_SIZE
Defaults.RADIUS
Defaults.COLOR_WHITE
Defaults.COLOR_BLACK
RenderingLimits
RenderingLimits.OPACITY_MIN
RenderingLimits.OPACITY_MAX
RenderingLimits.ABSORPTION_MIN
RenderingLimits.GAMMA_MIN
RenderingLimits.GAMMA_MAX
RenderingLimits.SHARPNESS_MIN
RenderingLimits.SHARPNESS_MAX
RenderingLimits.COLOR_SDR_MIN
RenderingLimits.COLOR_SDR_MAX
RenderingLimits.COLOR_HDR_MAX
DEFAULT_POINT_RADIUS
DEFAULT_TRUNCATION_RADIUS
DEFAULT_SIGMA_MIN_DIAG
ELEMENT_TEXELS_PER_ELEMENT
max_elements_per_node()
MAX_SEGMENTS_PER_LINES_NODE
MAX_POINTS_PER_POINTS_NODE
MAX_SPLATS_PER_GSPLATS_NODE
JS_SAFE_INTEGER_MAX
create_server_app()
DirectoryListingStaticFiles
DirectoryListingStaticFiles.__call__()
DirectoryListingStaticFiles.get_response()
ServedStore
ServedStore.__init__()
ServedStore.data_url
ServedStore.viewer_url
served_store()
deprecated_option()
primary_lan_address()
advertised_host()
origin_hostname()
authority_hostname()
origin_authority()
open_browser()
check_port_available()
find_available_port()
pick_port()
dataset_title()
append_title_param()
wait_for_server()
check_viewer_built()
get_viewer_dist_path()
exit_code_from()
ensure_viewer_built()
build_viewer()
format_tree_node()
format_memory_size()
get_zarr_info()
validate_zarr_store()
NetworkProfile
NetworkProfile.name
NetworkProfile.bandwidth
NetworkProfile.latency
NetworkProfile.jitter
NetworkProfile.packet_loss
NetworkProfile.description
parse_bandwidth()
parse_latency()
parse_jitter()
parse_packet_loss()
parse_network_options()
has_network_simulation()
print_network_params()
load_network_profile()
NetworkSimulationMiddleware
NetworkSimulationMiddleware.__init__()
NetworkSimulationMiddleware.__call__()
export_scene()
SceneFacts
SceneFacts.title
SceneFacts.has_control_panel
SceneFacts.chapter_dimension
SceneFacts.chapter_count
SceneFacts.panel_tiles
SceneFacts.dimensions
SceneFacts.displayed
SceneFacts.citation
SceneFacts.stops
SceneFacts.__init__()
read_scene_facts()
THIRD_PARTY_LICENSES
SERVE_TEMPLATE
QR_MODULE_SOURCE
validate_bundle_name()
LauncherNotBuiltError
get_launcher_path()
bundle_macos_app()
bundle_linux_folder()
zip_macos_app()
register_import_commands()
register_lod_commands()
build_dimensions_from_data()
decode_flat_channel_index()
dump_default_config()
get_fit_defaults()
load_fit_config()
parse_hex_color()
parse_seeds()
parse_shape()
FitPreset
lod_recipe()
register_lod_command()
register_info_command()
HTTP1_RTT_BOUND_CHUNK_BYTES
register_optimize_command()
fit_gaussian_splats()
fit_progressive_gaussian_splats()
GSplatData
GSplatData.additive_sublods
GSplatData.centers
GSplatData.amplitudes
GSplatData.cholesky_factors
GSplatData.colors
GSplatData.label_ids
GSplatData.label_vocabulary
GSplatData.stats
GSplatData.__init__()
GSplatData.__len__()
GSplatData.additive_prefix()
GSplatData.additive_sublod()
GSplatData.affine_intensity()
GSplatData.at_substitutive()
GSplatData.center_at_centroid()
GSplatData.clamp_intensity()
GSplatData.combine_as_new_dimension()
GSplatData.concatenate()
GSplatData.cull()
GSplatData.default_substitutive
GSplatData.eccentricities()
GSplatData.embed_dimension()
GSplatData.filter()
GSplatData.filter_by()
GSplatData.flattened()
GSplatData.from_additive_sublods()
GSplatData.from_default_selection()
GSplatData.from_substitutive_levels()
GSplatData.from_tree()
GSplatData.load()
GSplatData.lod_psnrs()
GSplatData.marginal_sigmas()
GSplatData.masses()
GSplatData.merge_with_channel_colors()
GSplatData.n_additive_sublods
GSplatData.n_splats
GSplatData.n_substitutive
GSplatData.ndim
GSplatData.nearest_neighbor_distances()
GSplatData.neighbor_counts()
GSplatData.normalize_intensity()
GSplatData.partition_from_regions()
GSplatData.principal_radii()
GSplatData.render_to_volume()
GSplatData.reweight_amplitude()
GSplatData.save()
GSplatData.scale()
GSplatData.scale_intensity()
GSplatData.slice_by()
GSplatData.soft_scale_filter()
GSplatData.substitutive_levels
GSplatData.to_spatial_partition()
GSplatData.transform()
GSplatData.translate()
GSplatData.tree
GSplatData.volumes()
GSplatData.with_colors()
GSplatData.with_label_ids()
GSplatData.without_label_ids()
GSplatData.truncation_radius
GSplatData.__repr__()
fit_tiled_gaussian_splats()
fit_tile()
fit_tiled()
announce_unscored_merge()
collect_part_provenance()
resolve_merged_reference()
stamp_merged_quality()
summarize_part_provenance()
TileSpec
TileSpec.index
TileSpec.grid_index
TileSpec.slices
TileSpec.origin
TileSpec.shape
TileSpec.border_low
TileSpec.border_high
TileSpec.overlap_low
TileSpec.overlap_high
TileSpec.__init__()
compute_tile_specs()
resolve_grid_scale()
grid_bsp_tree()
cosine_window()
lift_points_to_gsplats()
lift_lines_to_gsplats()
FitConfig
FitConfig.V
FitConfig.seeds
FitConfig.norm_percentile
FitConfig.init_sigma_vox
FitConfig.sigma_min_diag
FitConfig.sigma_max_diag
FitConfig.truncate
FitConfig.n_iters
FitConfig.lr
FitConfig.max_abs_error
FitConfig.rel_l2_target
FitConfig.gradient_clip
FitConfig.loss_type
FitConfig.asymmetric_penalty
FitConfig.l1_amp
FitConfig.l1_diag
FitConfig.scheduler_type
FitConfig.patience
FitConfig.lr_reduction_factor
FitConfig.early_stop_patience
FitConfig.enable_dynamic_ops
FitConfig.dynamic_config
FitConfig.dynamic_ops_verbose
FitConfig.napari_movie
FitConfig.movie_every
FitConfig.movie_max_frames
FitConfig.device
FitConfig.verbose
FitConfig.floor
FitConfig.norm_range
FitConfig.use_metal
FitConfig.metal_intensity_floor
FitConfig.use_cuda
FitConfig.cuda_intensity_floor
FitConfig.seed_method
FitConfig.seed_kwargs
FitConfig.seed_amps_background_relative
FitConfig.init_L
FitConfig.init_amps
FitConfig.amp_max
FitConfig.max_eccentricity
FitConfig.voxel_footprint_correction
FitConfig.clip_to_bounds
FitConfig.voxel_size
FitConfig.output_space
FitConfig.boundary_penalty
FitConfig.sort_splats_enabled
FitConfig.sort_splats_interval
FitConfig.downscale
FitConfig.iter_callback
FitConfig.iter_callback_every
FitConfig.source_dtype
FitConfig.source_itemsize
FitConfig.source_shape
FitConfig.source_stored_bytes
FitConfig.__init__()
FitParameters
FitParameters.V
FitParameters.seeds
FitParameters.norm_percentile
FitParameters.floor
FitParameters.norm_range
FitParameters.downscale
FitParameters.init_sigma_vox
FitParameters.n_iters
FitParameters.lr
FitParameters.loss_type
FitParameters.asymmetric_penalty
FitParameters.l1_amp
FitParameters.l1_diag
FitParameters.sigma_min_diag
FitParameters.sigma_max_diag
FitParameters.amp_max
FitParameters.max_eccentricity
FitParameters.truncate
FitParameters.seed_method
FitParameters.verbose
FitParameters.max_abs_error
FitParameters.rel_l2_target
FitParameters.gradient_clip
FitParameters.napari_movie
FitParameters.movie_every
FitParameters.movie_max_frames
FitParameters.scheduler_type
FitParameters.patience
FitParameters.lr_reduction_factor
FitParameters.early_stop_patience
FitParameters.dynamic_ops_verbose
FitParameters.voxel_footprint_correction
FitParameters.boundary_penalty
FitParameters.clip_to_bounds
FitParameters.voxel_size
FitParameters.output_space
FitParameters.sort_splats_enabled
FitParameters.sort_splats_interval
FitParameters.iter_callback
FitParameters.iter_callback_every
FitParameters.seed_amps_background_relative
FitParameters.source_dtype
FitParameters.source_shape
FitParameters.source_stored_bytes
FitParameters.seed_kwargs
FitParameters.__init__()
PreprocessedData
PreprocessedData.V_normalized
PreprocessedData.V_tensor
PreprocessedData.seed_centers
PreprocessedData.image_min
PreprocessedData.image_max
PreprocessedData.intensity_range
PreprocessedData.d
PreprocessedData.N
PreprocessedData.max_abs_error
PreprocessedData.rel_l2_target
PreprocessedData.floor
PreprocessedData.floor_strategy
PreprocessedData.l1_amp
PreprocessedData.l1_diag
PreprocessedData.init_L
PreprocessedData.init_amps
PreprocessedData.downscale_factors
PreprocessedData.__init__()
OptimizationResults
OptimizationResults.centers
OptimizationResults.Ls
OptimizationResults.amps
OptimizationResults.converged_early
OptimizationResults.early_stopped
OptimizationResults.actual_iters
OptimizationResults.best_iteration
OptimizationResults.best_loss
OptimizationResults.best_max_abs_error
OptimizationResults.best_rel_l2
OptimizationResults.movie_frames
OptimizationResults.start_time
OptimizationResults.end_time
OptimizationResults.relocation_statistics
OptimizationResults.__init__()
prepare_fit_config()
preprocess_data()
initialize_optimization()
create_loss_function()
run_optimization_loop()
finalize_results()
display_compression_analysis()
show_optimization_movie()
resolve_volume_norm_range()
resolve_volume_norm_range_denoised()
resolve_volume_floor()
resolve_volume_floor_with_strategy()
resolve_volume_floor_denoised_with_strategy()
resolve_volume_floor_denoised()
apply_sigma_min_diag_floor()
resolve_fit_initial_sigma_diag()
SOURCE_GRID_VOLUME_KEYS
lift_source_grid_stats()
lift_normalization_stats()
stamp_voxels_per_splat()
DynamicOpsConfig
RecentlyRelocatedTracker
apply_dynamic_operations()
create_optimizer_and_scheduler()
GaussianSplatModel
GaussianSplatModel.sigma_min_diag
GaussianSplatModel.__init__()
GaussianSplatModel.voxel_size
GaussianSplatModel.sigma_max_diag
GaussianSplatModel.current_params()
GaussianSplatModel.replace_with()
GaussianSplatModel.prune_()
GaussianSplatModel.append_()
GaussianSplatModel.n_splats()
GaussianSplatModel.forward()
render_gaussians()
render_gaussians_numpy()
render_gaussians_pytorch()
stable_inverse_softplus()
stable_inverse_softplus_torch()
solve_lower_triangular()
decompose_image()
MultiScaleDecomposer
MultiScaleDecomposer.raw_images
MultiScaleDecomposer.__init__()
MultiScaleDecomposer.forward()
MultiScaleDecomposer.initialize_from_pyramid()
MultiScaleDecomposer.initialize_finest_scale()
MultiScaleDecomposer.initialize_uniform()
MultiScaleDecomposer.initialize_coarse()
MultiScaleDecomposer.initialize_zero()
decomposition_loss()
upsample_for_visualization()
save_gsplats()
load_gsplats()
load_default_gsplats()
is_mps_available()
resolve_torch_device()
tril_size()
calculate_gradient_dilution_factor()
pack_tril()
unpack_tril()
validate_cholesky_shape()
permute_cholesky_packed()
embed_cholesky_packed()
diag_indices()
offdiag_indices()
split_tril()
merge_tril()
recombine_cholesky()
generate_seeds()
seed_from_decomposition()
seed_from_edges()
seed_from_grid()
seed_from_peaks()
apply_clahe()
CullResult
CullResult.keep_mask
CullResult.n_culled
CullResult.error_budget
CullResult.phase1_candidates
CullResult.phase2_iterations
CullResult.max_joint_error
CullResult.mode
CullResult.__init__()
compute_per_splat_deletion_error()
cull_by_contribution()
compute_ssim()
compute_psnr()
otsu_threshold()
compute_foreground_psnr()
compute_quality_metrics()
CalibrationResult
CalibrationResult.k_values_requested
CalibrationResult.k_values_effective
CalibrationResult.held_out_psnr_db
CalibrationResult.train_psnr_db
CalibrationResult.held_out_mse
CalibrationResult.full_psnr_db
CalibrationResult.full_ssim
CalibrationResult.held_out_peak
CalibrationResult.noise_floor
CalibrationResult.fit_times_seconds
CalibrationResult.splat_paths
CalibrationResult.mask_seed
CalibrationResult.mask_fraction
CalibrationResult.donut_radius
CalibrationResult.fit_config
CalibrationResult.volume_shape
CalibrationResult.volume_dtype
CalibrationResult.timestamp
CalibrationResult.held_out_psnr_fg_db
CalibrationResult.held_out_psnr_fg_weighted_db
CalibrationResult.foreground_mask_fraction
CalibrationResult.__init__()
CalibrationResult.foreground_otsu_threshold
CalibrationResult.fg_bg_ratio
CalibrationResult.held_out_gain_db
CalibrationResult.predict_zero_baseline_mse
CalibrationResult.k_star_metric
CalibrationResult.held_out_peak_selected
CalibrationResult.calibration_region
CalibrationResult.original_volume_shape
CalibrationResult.splat_density
CalibrationResult.rd_model
CalibrationResult.not_converged
CalibrationResult.exponent_fit
CalibrationResult.to_json()
CalibrationResult.from_json()
ExponentFit
ExponentFit.alpha
ExponentFit.intercept
ExponentFit.__init__()
ExponentFit.r_squared
ExponentFit.n_points
ExponentFit.n_distinct
ExponentFit.scales
ExponentFit.n_features
ExponentFit.k_star
FloorEstimate
FloorEstimate.level
FloorEstimate.strategy
FloorEstimate.__init__()
HeldOutPeak
HeldOutPeak.k_star
HeldOutPeak.type
HeldOutPeak.confidence_db
HeldOutPeak.k_knee
HeldOutPeak.knee_idx
HeldOutPeak.drop_after_peak_db
HeldOutPeak.tail_rise_db
HeldOutPeak.plateau_spread_db
HeldOutPeak.total_rise_db
HeldOutPeak.still_climbing
HeldOutPeak.knee_margin_db
HeldOutPeak.__init__()
NoiseFloor
NoiseFloor.sigma_hat
NoiseFloor.sigma_laplacian
NoiseFloor.sigma_haar
NoiseFloor.sigma_background
NoiseFloor.psnr_max_db
NoiseFloor.__init__()
RDModel
RDModel.__init__()
RDModel.floor
RDModel.a
RDModel.beta
RDModel.rmse
RDModel.n_points
RDModel.converged_fraction
RDModel.predict_error()
RDModel.k_for_error()
RegionSelection
RegionSelection.origin
RegionSelection.size
RegionSelection.strategy
RegionSelection.__init__()
RegionSelection.n_features
RegionSelection.score
SplatDensity
SplatDensity.feature_method
SplatDensity.n_features_reference
SplatDensity.k_star_reference
SplatDensity.saturation_exponent
SplatDensity.saturation_cap
SplatDensity.splats_per_feature
SplatDensity.feature_threshold
SplatDensity.predict_k()
SplatDensity.__init__()
build_k_grid()
calibrate()
calibrate_saturation_exponent()
count_features()
cv_mask()
donut_median_fill()
estimate_floor()
estimate_floor_result()
estimate_noise_floor()
feature_threshold()
find_k_star()
fit_rd_model()
fit_saturation_exponent()
foreground_mask_otsu()
foreground_mask_otsu_smoothed()
held_out_gain_db()
held_out_psnr()
held_out_psnr_fg_weighted()
held_out_psnr_foreground()
predict_zero_baseline_mse()
select_calibration_region()
render_calibration_report()
RecipeParams
RecipeParams.n_lods
RecipeParams.additive_method
RecipeParams.reveal_center
RecipeParams.spatial_dims
RecipeParams.breakpoints
RecipeParams.truncation_sigmas
RecipeParams.max_n_dense
RecipeParams.max_elements
RecipeParams.partition_rule
RecipeParams.compression_factor
RecipeParams.levels
RecipeParams.substitutive_method
RecipeParams.lloyd_iterations
RecipeParams.candidate_bins_k
RecipeParams.coverage_inflation
RecipeParams.conserve_mass
RecipeParams.additive_ladders
RecipeParams.refine
RecipeParams.refine_iters
RecipeParams.volume
RecipeParams.image_min
RecipeParams.volume_axes
RecipeParams.coarsen_dims
RecipeParams.quality_stamps
RecipeParams.quality_max_pair_splats
RecipeParams.device
RecipeParams.seed
RecipeParams.effective_max_elements
RecipeParams.__init__()
build_recipe()
compute_additive_order()
interleave_order_across_slices()
make_additive_lod()
make_lod_pyramid()
make_substitutive_lod()
resolve_additive_method()
resolve_truncation_sigmas()
BreakpointSpec
clamp_counts_breakpoints()
validate_counts_breakpoints()
additive_rung_count()
RefineName
resolved_merge_coarsen_dims()
merge_to_count()
RecipeName
RECIPE_NAMES
LEGACY_RECIPE_NAMES
canonical_recipe_name()
MATRIX_RECIPES
COMPOSED_RECIPES
RecipeResult
build_flat()
build_stream()
build_levels()
build_levels_matrix()
build_tiles()
build_adaptive()
build_overview()
PER_PART_RECIPES
uniform_per_part_lod_warning()
build_part_lod()
AnnotateReport
AnnotateReport.path
AnnotateReport.dry_run
AnnotateReport.leaves
AnnotateReport.levels
AnnotateReport.__init__()
LeafStamp
LeafStamp.path
LeafStamp.n_splats
LeafStamp.energy_fraction_cum
LeafStamp.reference_energy
LeafStamp.__init__()
LevelStamp
LevelStamp.path
LevelStamp.n_splats
LevelStamp.quality
LevelStamp.reference_energy
LevelStamp.__init__()
annotate_quality_store()
QualityResult
QualityResult.quality
QualityResult.l2_sq
QualityResult.approx_norm_sq
QualityResult.ref_norm_sq
QualityResult.approx_pair_fraction
QualityResult.ref_pair_fraction
QualityResult.n_cross_pairs
QualityResult.n_approx_pairs
QualityResult.n_ref_pairs
QualityResult.__init__()
mixture_quality()
total_self_energy()
VolumeRefitConfig
VolumeRefitConfig.iters
VolumeRefitConfig.lr
VolumeRefitConfig.early_stop_patience
VolumeRefitConfig.never_worse
VolumeRefitConfig.conserve_mass
VolumeRefitConfig.frame_tolerance
VolumeRefitConfig.image_min
VolumeRefitConfig.__init__()
volume_refine_splats()
GSplatLeaf
GSplatLeaf.additive_sublods
GSplatLeaf.meta
GSplatLeaf.__post_init__()
GSplatLeaf.n_additive_sublods
GSplatLeaf.n_splats
GSplatLeaf.ndim
GSplatLeaf.__init__()
GSplatLodGroup
GSplatLodGroup.__post_init__()
GSplatLodGroup.default_level
GSplatLodGroup.n_children
GSplatLodGroup.n_splats
GSplatLodGroup.__init__()
GSplatPartition
GSplatPartition.__post_init__()
GSplatPartition.n_splats
GSplatPartition.__init__()
GSplatNode
iter_leaves()
total_splats()
node_ndim()
center_bounds()
map_leaves()
without_meta_key()
iter_default_leaves()
amplitude_weighted_centroid()
global_amplitude_max()
nondegenerate_axes()
node_from_substitutive_levels()
gate_authored_selector()
tree_from_substitutive_levels()
substitutive_levels_from_tree()
is_matrix_shaped()
ContentField
ContentField.density
ContentField.cell
ContentField.shape
ContentField.method
ContentField.total
ContentField.box_weight()
ContentField.marginal()
ContentField.__init__()
FitPlan
FitPlan.volume_shape
FitPlan.boxes
FitPlan.overlap
FitPlan.feature_method
FitPlan.min_leaf
FitPlan.max_leaf
FitPlan.density
FitPlan.bsp_tree
FitPlan.__init__()
FitPlan.meta
FitPlan.total_budget
FitPlan.n_boxes
FitPlan.overlap_fraction()
FitPlan.to_json()
FitPlan.from_json()
PlanBox
PlanBox.box
PlanBox.n_features
PlanBox.budget
PlanBox.dims
PlanBox.voxels
PlanBox.__init__()
fit_planned()
fit_planned_parallel()
plan_partition()
plan_volume()
scan_content()
CONTENT_CULL_RETENTION
ClassicalSplats
ClassicalSplats.positions
ClassicalSplats.scales
ClassicalSplats.quaternions
ClassicalSplats.opacities
ClassicalSplats.colors
ClassicalSplats.sh_degree
ClassicalSplats.source_format
ClassicalSplats.y_up
ClassicalSplats.n_splats
ClassicalSplats.__init__()
TrackingGraph
TrackingGraph.node_ids
TrackingGraph.t
TrackingGraph.positions
TrackingGraph.edges
TrackingGraph.scale
TrackingGraph.units
TrackingGraph.n_nodes
TrackingGraph.n_edges
TrackingGraph.n_timepoints
TrackingGraph.positions_um()
TrackingGraph.__init__()
TrackingGraph.index_of()
TrackingGraph.edge_indices()
TrackingGraph.divisions()
TrackingGraph.lineage_ids()
classical_to_gsplat_data()
detect_classical_format()
export_inria_ply()
gsplat_data_to_inria_ply()
gsplats_to_tracksdata_graph()
import_gsplats()
quat_to_rotmat()
read_antimatter_splat()
read_geff()
read_inria_ply()
read_sog()
read_spz()
read_supersplat_ply()
rotmat_to_quat()
splat_mask_and_bbox()
calibrate_all_channels()
calibrate_h_for_channel()
calibrate_nlm_h()
denoise_nlm()
denoise_volume_array()
denormalize_volume()
normalize_volume()
load_profiles()
save_profiles()
append_run()
recompute_summary()
get_gpu_summary()
get_gpu_throughput_table()
list_profiled_gpus()
migrate_v1_profile()
render_to_volume()
render_to_volume_tensor()
resolve_colormap()
scalars_to_colors()
TypeScript API Reference:
luxar
luxar.cli
luxar.cli.export
luxar.cli.gsplat_commands
luxar.cli.gsplat_config
luxar.cli.gsplat_ops
luxar.cli.info_command
luxar.cli.lod
luxar.cli.main
luxar.cli.mesh_commands
luxar.cli.mesh_ops
luxar.cli.native_app
luxar.cli.network_simulation
luxar.cli.optimize_command
luxar.cli.serving
luxar.cli.utils
luxar.colormaps
luxar.control
luxar.core
luxar.core.transforms
luxar.demos
luxar.encoding
luxar.environment
luxar.gsplats
luxar.gsplats.batch
luxar.gsplats.calibration
luxar.gsplats.calibration_report
luxar.gsplats.clahe
luxar.gsplats.culling
luxar.gsplats.fitting
luxar.gsplats.fitting.dynamic_ops
luxar.gsplats.fitting.initialization
luxar.gsplats.fitting.losses
luxar.gsplats.fitting.optimization
luxar.gsplats.fitting.preprocessing
luxar.gsplats.fitting.results
luxar.gsplats.fitting.validation
luxar.gsplats.gpu_profile
luxar.gsplats.interop
luxar.gsplats.io
luxar.gsplats.lift
luxar.gsplats.lod
luxar.gsplats.lod.additive
luxar.gsplats.lod.annotate
luxar.gsplats.lod.quality
luxar.gsplats.lod.recipes
luxar.gsplats.lod.substitutive
luxar.gsplats.lod.volume_refit
luxar.gsplats.merged_quality
luxar.gsplats.metrics
luxar.gsplats.models
luxar.gsplats.models.gsplats
luxar.gsplats.models.utils
luxar.gsplats.multiscale
luxar.gsplats.optim
luxar.gsplats.planner
luxar.gsplats.preprocessing
luxar.gsplats.rendering
luxar.gsplats.seeds
luxar.gsplats.tiling
luxar.gsplats.tree
luxar.gsplats.utils
luxar.gsplats.utils.trils
luxar.io
luxar.io.ome_zarr
luxar.io.optimize
luxar.io.ordering
luxar.io.volume
luxar.mesh
luxar.mesh.decimate
luxar.mesh.interop
luxar.mesh.split
luxar.shading
luxar.shading.occlusion
luxar.typing_utils
luxar.typing_utils.aliases
luxar.typing_utils.constants
luxar.typing_utils.enums
luxar.utils
luxar.utils.array
luxar.utils.colors
luxar.utils.deprecation
luxar.utils.scenes
luxar.utils.verbosity
luxar.validation
luxar.validation.base
luxar.validation.category_validation
luxar.validation.nd
luxar.validation.types