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
InstantiateConfig
LocalWriterConfig
LoggingConfig
MachineConfig
PrintableConfig
ViewerConfig
ViewerConfig.camera_frustum_scale
ViewerConfig.default_composite_depth
ViewerConfig.image_format
ViewerConfig.jpeg_quality
ViewerConfig.make_share_url
ViewerConfig.max_num_display_images
ViewerConfig.num_rays_per_chunk
ViewerConfig.quit_on_train_completion
ViewerConfig.relative_log_filename
ViewerConfig.websocket_host
ViewerConfig.websocket_port
ViewerConfig.websocket_port_default
- Data
- Data Parsers
- Base Data Parser
DataParser
DataParserConfig
DataparserOutputs
DataparserOutputs.alpha_color
DataparserOutputs.as_dict()
DataparserOutputs.cameras
DataparserOutputs.dataparser_scale
DataparserOutputs.dataparser_transform
DataparserOutputs.image_filenames
DataparserOutputs.mask_filenames
DataparserOutputs.metadata
DataparserOutputs.save_dataparser_transform()
DataparserOutputs.scene_box
DataparserOutputs.transform_poses_to_original_space()
Semantics
transform_poses_to_original_space()
- ARKitScenes
ARKitScenes
ARKitScenesDataParserConfig
ARKitScenesDataParserConfig.auto_scale_poses
ARKitScenesDataParserConfig.center_method
ARKitScenesDataParserConfig.data
ARKitScenesDataParserConfig.depth_unit_scale_factor
ARKitScenesDataParserConfig.scale_factor
ARKitScenesDataParserConfig.scene_scale
ARKitScenesDataParserConfig.train_split_fraction
traj_string_to_matrix()
- Blender
- D-NeRF
- dycheck
- Instant-NGP
- Minimal
- NeRF-OSR
- Nerfstudio
Nerfstudio
NerfstudioDataParserConfig
NerfstudioDataParserConfig.auto_scale_poses
NerfstudioDataParserConfig.center_method
NerfstudioDataParserConfig.data
NerfstudioDataParserConfig.depth_unit_scale_factor
NerfstudioDataParserConfig.downscale_factor
NerfstudioDataParserConfig.eval_interval
NerfstudioDataParserConfig.eval_mode
NerfstudioDataParserConfig.load_3D_points
NerfstudioDataParserConfig.mask_color
NerfstudioDataParserConfig.orientation_method
NerfstudioDataParserConfig.scale_factor
NerfstudioDataParserConfig.scene_scale
NerfstudioDataParserConfig.train_split_fraction
- nuScenes
- Phototourism
Phototourism
PhototourismDataParserConfig
PhototourismDataParserConfig.alpha_color
PhototourismDataParserConfig.auto_scale_poses
PhototourismDataParserConfig.center_method
PhototourismDataParserConfig.data
PhototourismDataParserConfig.orientation_method
PhototourismDataParserConfig.scale_factor
PhototourismDataParserConfig.scene_scale
PhototourismDataParserConfig.train_split_fraction
- ScanNet
ScanNet
ScanNetDataParserConfig
ScanNetDataParserConfig.auto_scale_poses
ScanNetDataParserConfig.center_method
ScanNetDataParserConfig.data
ScanNetDataParserConfig.depth_unit_scale_factor
ScanNetDataParserConfig.load_3D_points
ScanNetDataParserConfig.ply_file_path
ScanNetDataParserConfig.point_cloud_color
ScanNetDataParserConfig.scale_factor
ScanNetDataParserConfig.scene_scale
ScanNetDataParserConfig.train_split_fraction
- SDFStudio
- sitcoms3D
- Base Data Parser
- Datamanagers
- Base
DataManager
DataManager.train_count
DataManager.eval_count
DataManager.train_dataset
DataManager.eval_dataset
DataManager.includes_time
DataManager.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()
DataManagerConfig
VanillaDataManager
VanillaDataManager.create_eval_dataset()
VanillaDataManager.create_train_dataset()
VanillaDataManager.dataset_type
VanillaDataManager.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()
VanillaDataManagerConfig
VanillaDataManagerConfig.__post_init__()
VanillaDataManagerConfig.camera_optimizer
VanillaDataManagerConfig.camera_res_scale_factor
VanillaDataManagerConfig.collate_fn()
VanillaDataManagerConfig.dataparser
VanillaDataManagerConfig.eval_image_indices
VanillaDataManagerConfig.eval_num_images_to_sample_from
VanillaDataManagerConfig.eval_num_rays_per_batch
VanillaDataManagerConfig.eval_num_times_to_repeat_images
VanillaDataManagerConfig.patch_size
VanillaDataManagerConfig.pixel_sampler
VanillaDataManagerConfig.train_num_images_to_sample_from
VanillaDataManagerConfig.train_num_rays_per_batch
VanillaDataManagerConfig.train_num_times_to_repeat_images
variable_res_collate()
- Base
- Datasets
- Utils
- Base
BaseImage
Camera
CameraModel
Image
Point3D
read_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
LearnedVariance
SDFField
SDFFieldConfig
SDFFieldConfig.appearance_embedding_dim
SDFFieldConfig.base_res
SDFFieldConfig.beta_init
SDFFieldConfig.bias
SDFFieldConfig.divide_factor
SDFFieldConfig.features_per_level
SDFFieldConfig.geo_feat_dim
SDFFieldConfig.geometric_init
SDFFieldConfig.hidden_dim
SDFFieldConfig.hidden_dim_color
SDFFieldConfig.inside_outside
SDFFieldConfig.log2_hashmap_size
SDFFieldConfig.max_res
SDFFieldConfig.num_layers
SDFFieldConfig.num_layers_color
SDFFieldConfig.num_levels
SDFFieldConfig.smoothstep
SDFFieldConfig.use_appearance_embedding
SDFFieldConfig.use_grid_feature
SDFFieldConfig.use_hash
SDFFieldConfig.weight_norm
- Semantic NeRF
- TensoRF
- Vanilla NeRF
- Field Modules
- Models
- Base
Model
Model.device
Model.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
InstantNGPModelConfig
InstantNGPModelConfig.alpha_thre
InstantNGPModelConfig.background_color
InstantNGPModelConfig.collider_params
InstantNGPModelConfig.cone_angle
InstantNGPModelConfig.disable_scene_contraction
InstantNGPModelConfig.enable_collider
InstantNGPModelConfig.far_plane
InstantNGPModelConfig.grid_levels
InstantNGPModelConfig.grid_resolution
InstantNGPModelConfig.log2_hashmap_size
InstantNGPModelConfig.max_res
InstantNGPModelConfig.near_plane
InstantNGPModelConfig.render_step_size
InstantNGPModelConfig.use_appearance_embedding
InstantNGPModelConfig.use_gradient_scaling
NGPModel
- Semantic NeRF-W
- NeRF
- Base
- Model components
- Ray Sampler
- Losses
DepthLossType
GradientLoss
MiDaSMSELoss
ScaleAndShiftInvariantLoss
depth_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
AdamOptimizerConfig
OptimizerConfig
Optimizers
Optimizers.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
Trainer
TrainerConfig
TrainerConfig.gradient_accumulation_steps
TrainerConfig.load_checkpoint
TrainerConfig.load_config
TrainerConfig.load_dir
TrainerConfig.load_step
TrainerConfig.log_gradients
TrainerConfig.max_num_iterations
TrainerConfig.mixed_precision
TrainerConfig.save_only_latest_checkpoint
TrainerConfig.start_paused
TrainerConfig.steps_per_eval_all_images
TrainerConfig.steps_per_eval_batch
TrainerConfig.steps_per_eval_image
TrainerConfig.steps_per_save
TrainerConfig.use_grad_scaler
- Callbacks
- Optimizers
- Plugins
- Utils
- Colors
- Math
Gaussians
columnwise_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