API#
TODO: Explanation of each component
- Cameras
- Cameras
- Camera Optimizers
- Camera Paths
- Camera Utils
auto_orient_and_center_poses()focus_of_attention()get_distortion_params()get_interpolated_k()get_interpolated_poses()get_interpolated_poses_many()get_ordered_poses_and_k()normalize()normalize_with_norm()quaternion_from_matrix()quaternion_matrix()quaternion_slerp()radial_and_tangential_undistort()rotation_matrix_between()unit_vector()viewmatrix()
- Lie Groups
- Rays
- Configs
InstantiateConfigLocalWriterConfigLoggingConfigMachineConfigPrintableConfigViewerConfigViewerConfig.camera_frustum_scaleViewerConfig.default_composite_depthViewerConfig.image_formatViewerConfig.jpeg_qualityViewerConfig.make_share_urlViewerConfig.max_num_display_imagesViewerConfig.num_rays_per_chunkViewerConfig.quit_on_train_completionViewerConfig.relative_log_filenameViewerConfig.websocket_hostViewerConfig.websocket_portViewerConfig.websocket_port_default
- Data
- Data Parsers
- Base Data Parser
DataParserDataParserConfigDataparserOutputsDataparserOutputs.alpha_colorDataparserOutputs.as_dict()DataparserOutputs.camerasDataparserOutputs.dataparser_scaleDataparserOutputs.dataparser_transformDataparserOutputs.image_filenamesDataparserOutputs.mask_filenamesDataparserOutputs.metadataDataparserOutputs.save_dataparser_transform()DataparserOutputs.scene_boxDataparserOutputs.transform_poses_to_original_space()
Semanticstransform_poses_to_original_space()
- ARKitScenes
ARKitScenesARKitScenesDataParserConfigARKitScenesDataParserConfig.auto_scale_posesARKitScenesDataParserConfig.center_methodARKitScenesDataParserConfig.dataARKitScenesDataParserConfig.depth_unit_scale_factorARKitScenesDataParserConfig.scale_factorARKitScenesDataParserConfig.scene_scaleARKitScenesDataParserConfig.train_split_fraction
traj_string_to_matrix()
- Blender
- D-NeRF
- dycheck
- Instant-NGP
- Minimal
- NeRF-OSR
- Nerfstudio
NerfstudioNerfstudioDataParserConfigNerfstudioDataParserConfig.auto_scale_posesNerfstudioDataParserConfig.center_methodNerfstudioDataParserConfig.dataNerfstudioDataParserConfig.depth_unit_scale_factorNerfstudioDataParserConfig.downscale_factorNerfstudioDataParserConfig.eval_intervalNerfstudioDataParserConfig.eval_modeNerfstudioDataParserConfig.load_3D_pointsNerfstudioDataParserConfig.mask_colorNerfstudioDataParserConfig.orientation_methodNerfstudioDataParserConfig.scale_factorNerfstudioDataParserConfig.scene_scaleNerfstudioDataParserConfig.train_split_fraction
- nuScenes
- Phototourism
PhototourismPhototourismDataParserConfigPhototourismDataParserConfig.alpha_colorPhototourismDataParserConfig.auto_scale_posesPhototourismDataParserConfig.center_methodPhototourismDataParserConfig.dataPhototourismDataParserConfig.orientation_methodPhototourismDataParserConfig.scale_factorPhototourismDataParserConfig.scene_scalePhototourismDataParserConfig.train_split_fraction
- ScanNet
ScanNetScanNetDataParserConfigScanNetDataParserConfig.auto_scale_posesScanNetDataParserConfig.center_methodScanNetDataParserConfig.dataScanNetDataParserConfig.depth_unit_scale_factorScanNetDataParserConfig.load_3D_pointsScanNetDataParserConfig.ply_file_pathScanNetDataParserConfig.point_cloud_colorScanNetDataParserConfig.scale_factorScanNetDataParserConfig.scene_scaleScanNetDataParserConfig.train_split_fraction
- SDFStudio
- sitcoms3D
- Base Data Parser
- Datamanagers
- Base
DataManagerDataManager.train_countDataManager.eval_countDataManager.train_datasetDataManager.eval_datasetDataManager.includes_timeDataManager.forward()DataManager.get_datapath()DataManager.get_eval_iterable()DataManager.get_eval_rays_per_batch()DataManager.get_param_groups()DataManager.get_train_iterable()DataManager.get_train_rays_per_batch()DataManager.get_training_callbacks()DataManager.iter_eval()DataManager.iter_train()DataManager.next_eval()DataManager.next_eval_image()DataManager.next_train()DataManager.setup_eval()DataManager.setup_train()
DataManagerConfigVanillaDataManagerVanillaDataManager.create_eval_dataset()VanillaDataManager.create_train_dataset()VanillaDataManager.dataset_typeVanillaDataManager.get_datapath()VanillaDataManager.get_eval_rays_per_batch()VanillaDataManager.get_param_groups()VanillaDataManager.get_train_rays_per_batch()VanillaDataManager.next_eval()VanillaDataManager.next_eval_image()VanillaDataManager.next_train()VanillaDataManager.setup_eval()VanillaDataManager.setup_train()
VanillaDataManagerConfigVanillaDataManagerConfig.__post_init__()VanillaDataManagerConfig.camera_optimizerVanillaDataManagerConfig.camera_res_scale_factorVanillaDataManagerConfig.collate_fn()VanillaDataManagerConfig.dataparserVanillaDataManagerConfig.eval_image_indicesVanillaDataManagerConfig.eval_num_images_to_sample_fromVanillaDataManagerConfig.eval_num_rays_per_batchVanillaDataManagerConfig.eval_num_times_to_repeat_imagesVanillaDataManagerConfig.patch_sizeVanillaDataManagerConfig.pixel_samplerVanillaDataManagerConfig.train_num_images_to_sample_fromVanillaDataManagerConfig.train_num_rays_per_batchVanillaDataManagerConfig.train_num_times_to_repeat_images
variable_res_collate()
- Base
- Datasets
- Utils
- Base
BaseImageCameraCameraModelImagePoint3Dread_cameras_binary()read_cameras_text()read_images_binary()read_images_text()read_next_bytes()read_points3D_binary()read_points3D_text()write_cameras_binary()write_cameras_text()write_images_binary()write_images_text()write_next_bytes()write_points3D_binary()write_points3D_text()
- Data
- Dataloader
- Nerfstudio Collate
- Base
- Pixel Samplers
- Scene Box
- Data Parsers
- Fields
- Base
- Density
- Nerfacto
- Nerf-W
- SDF
LearnedVarianceSDFFieldSDFFieldConfigSDFFieldConfig.appearance_embedding_dimSDFFieldConfig.base_resSDFFieldConfig.beta_initSDFFieldConfig.biasSDFFieldConfig.divide_factorSDFFieldConfig.features_per_levelSDFFieldConfig.geo_feat_dimSDFFieldConfig.geometric_initSDFFieldConfig.hidden_dimSDFFieldConfig.hidden_dim_colorSDFFieldConfig.inside_outsideSDFFieldConfig.log2_hashmap_sizeSDFFieldConfig.max_resSDFFieldConfig.num_layersSDFFieldConfig.num_layers_colorSDFFieldConfig.num_levelsSDFFieldConfig.smoothstepSDFFieldConfig.use_appearance_embeddingSDFFieldConfig.use_grid_featureSDFFieldConfig.use_hashSDFFieldConfig.weight_norm
- Semantic NeRF
- TensoRF
- Vanilla NeRF
- Field Modules
- Models
- Base
ModelModel.deviceModel.forward()Model.get_image_metrics_and_images()Model.get_loss_dict()Model.get_metrics_dict()Model.get_outputs()Model.get_outputs_for_camera()Model.get_outputs_for_camera_ray_bundle()Model.get_param_groups()Model.get_rgba_image()Model.get_training_callbacks()Model.load_model()Model.populate_modules()Model.update_to_step()
ModelConfig
- Instant NGP
InstantNGPModelConfigInstantNGPModelConfig.alpha_threInstantNGPModelConfig.background_colorInstantNGPModelConfig.collider_paramsInstantNGPModelConfig.cone_angleInstantNGPModelConfig.disable_scene_contractionInstantNGPModelConfig.enable_colliderInstantNGPModelConfig.far_planeInstantNGPModelConfig.grid_levelsInstantNGPModelConfig.grid_resolutionInstantNGPModelConfig.log2_hashmap_sizeInstantNGPModelConfig.max_resInstantNGPModelConfig.near_planeInstantNGPModelConfig.render_step_sizeInstantNGPModelConfig.use_appearance_embeddingInstantNGPModelConfig.use_gradient_scaling
NGPModel
- Semantic NeRF-W
- NeRF
- Base
- Model components
- Ray Sampler
- Losses
DepthLossTypeGradientLossMiDaSMSELossScaleAndShiftInvariantLossdepth_loss()depth_ranking_loss()distortion_loss()ds_nerf_depth_loss()interlevel_loss()lossfun_distortion()lossfun_outer()monosdf_normal_loss()nerfstudio_distortion_loss()orientation_loss()outer()pred_normal_loss()ray_samples_to_sdist()scale_gradients_by_distance_squared()tv_loss()urban_radiance_field_depth_loss()
- Renderers
- Engine
- Optimizers
AdamOptimizerConfigOptimizerConfigOptimizersOptimizers.load_optimizers()Optimizers.load_schedulers()Optimizers.optimizer_scaler_step_all()Optimizers.optimizer_scaler_step_some()Optimizers.optimizer_step()Optimizers.optimizer_step_all()Optimizers.scheduler_step()Optimizers.scheduler_step_all()Optimizers.zero_grad_all()Optimizers.zero_grad_some()
RAdamOptimizerConfig
- Schedulers
- Trainer
TrainerTrainerConfigTrainerConfig.gradient_accumulation_stepsTrainerConfig.load_checkpointTrainerConfig.load_configTrainerConfig.load_dirTrainerConfig.load_stepTrainerConfig.log_gradientsTrainerConfig.max_num_iterationsTrainerConfig.mixed_precisionTrainerConfig.save_only_latest_checkpointTrainerConfig.start_pausedTrainerConfig.steps_per_eval_all_imagesTrainerConfig.steps_per_eval_batchTrainerConfig.steps_per_eval_imageTrainerConfig.steps_per_saveTrainerConfig.use_grad_scaler
- Callbacks
- Optimizers
- Plugins
- Utils
- Colors
- Math
Gaussianscolumnwise_squared_l2_distance()components_from_spherical_harmonics()compute_3d_gaussian()conical_frustum_to_gaussian()cylinder_to_gaussian()expected_sin()generate_polyhedron_basis()intersect_aabb()intersect_obb()masked_reduction()normalized_depth_scale_and_shift()safe_normalize()
- Colormaps
- TensorDataclass
- Viewer