mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-11 02:24:38 +08:00
1835 lines
239 KiB
HTML
1835 lines
239 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en" >
|
||
|
||
<head><meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
||
<meta property="og:title" content="Data Parsers" />
|
||
|
||
<meta property="og:type" content="website" />
|
||
|
||
<meta property="og:url" content="http://docs.nerf.studio/reference/api/data/dataparsers.html" />
|
||
|
||
<meta property="og:description" content="Base Data Parser, ARKitScenes, Blender, D-NeRF, dycheck, Instant-NGP, Minimal, NeRF-OSR, Nerfstudio, nuScenes, Phototourism, ScanNet, SDFStudio, sitcoms3D. Base Data Parser: A set of standard datas..." />
|
||
|
||
<meta property="og:image" content="https://assets.nerf.studio/opg.png" />
|
||
|
||
<meta property="og:image:alt" content="Data Parsers" />
|
||
<link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" /><link rel="next" title="DataManagers" href="../../../developer_guides/pipelines/datamanagers.html" /><link rel="prev" title="DataParsers" href="../../../developer_guides/pipelines/dataparsers.html" />
|
||
|
||
<meta name="generator" content="sphinx-5.2.1, furo 2022.09.29" />
|
||
<title>Data Parsers - nerfstudio</title>
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f9fb;
|
||
--color-code-foreground: black;
|
||
--color-brand-primary: #d34600;
|
||
--color-brand-content: #ff6f00;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #282C34;
|
||
--color-code-foreground: #ABB2BF;
|
||
--color-brand-primary: #fdd06c;
|
||
--color-brand-content: ##fea96a;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #282C34;
|
||
--color-code-foreground: #ABB2BF;
|
||
--color-brand-primary: #fdd06c;
|
||
--color-brand-content: ##fea96a;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
|
||
<script src="../../../_static/jquery.js"></script>
|
||
<script src="../../../_static/underscore.js"></script>
|
||
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="../../../_static/doctools.js"></script>
|
||
<script src="../../../_static/sphinx_highlight.js"></script>
|
||
<script src="../../../_static/scripts/furo.js"></script>
|
||
<script src="../../../_static/clipboard.min.js"></script>
|
||
<script src="../../../_static/copybutton.js"></script>
|
||
<script>let toggleHintShow = 'Click to show';</script>
|
||
<script>let toggleHintHide = 'Click to hide';</script>
|
||
<script>let toggleOpenOnPrint = 'true';</script>
|
||
<script src="../../../_static/togglebutton.js"></script>
|
||
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
|
||
<script src="../../../_static/design-tabs.js"></script>
|
||
<script src="../../../_static/require.min.js"></script>
|
||
<script src="../../../_static/custom.js"></script>
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="../../../index.html"><div class="brand">nerfstudio</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a
|
||
class="sidebar-brand"
|
||
href="../../../index.html"
|
||
>
|
||
|
||
<div class="sidebar-logo-container">
|
||
<img
|
||
class="sidebar-logo only-light"
|
||
src="../../../_static/imgs/logo.png"
|
||
alt="Light Logo"
|
||
/>
|
||
<img
|
||
class="sidebar-logo only-dark"
|
||
src="../../../_static/imgs/logo-dark.png"
|
||
alt="Dark Logo"
|
||
/>
|
||
</div>
|
||
</a>
|
||
|
||
<div style="text-align: center">
|
||
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
||
<!-- Place this tag where you want the button to render. -->
|
||
<a
|
||
class="github-button"
|
||
href="https://github.com/nerfstudio-project/nerfstudio/"
|
||
data-color-scheme="no-preference: light; light: light; dark: light;"
|
||
data-size="large"
|
||
data-show-count="true"
|
||
aria-label="Download buttons/github-buttons on GitHub"
|
||
>
|
||
Github
|
||
</a>
|
||
<br />
|
||
<a
|
||
href="https://colab.research.google.com/github/nerfstudio-project/nerfstudio/blob/main/colab/demo.ipynb"
|
||
style="
|
||
background-color: #ebf0f4;
|
||
background-image: linear-gradient(180deg, #f6f8fa, #ebf0f4 90%);
|
||
border-radius: 3px;
|
||
border: 1px solid #1b1f2426;
|
||
display: inline-flex;
|
||
cursor: pointer;
|
||
color: #0d0d0d;
|
||
font-family: Arial;
|
||
font-size: 12px;
|
||
font-weight: bold;
|
||
padding: 5px 41px;
|
||
line-height: 16px;
|
||
text-decoration: none;
|
||
"
|
||
>
|
||
<svg
|
||
viewBox="0 0 24 24"
|
||
width="16"
|
||
height="16"
|
||
class="octicon octicon-mark-github"
|
||
>
|
||
<g>
|
||
<path
|
||
d="M4.54,9.46,2.19,7.1a6.93,6.93,0,0,0,0,9.79l2.36-2.36A3.59,3.59,0,0,1,4.54,9.46Z"
|
||
style=""
|
||
fill="#E8710A"
|
||
></path>
|
||
<path
|
||
d="M2.19,7.1,4.54,9.46a3.59,3.59,0,0,1,5.08,0l1.71-2.93h0l-.1-.08h0A6.93,6.93,0,0,0,2.19,7.1Z"
|
||
style=""
|
||
fill="#F9AB00"
|
||
></path>
|
||
<path
|
||
d="M11.34,17.46h0L9.62,14.54a3.59,3.59,0,0,1-5.08,0L2.19,16.9a6.93,6.93,0,0,0,9,.65l.11-.09"
|
||
style=""
|
||
fill="#F9AB00"
|
||
></path>
|
||
<path
|
||
d="M12,7.1a6.93,6.93,0,0,0,0,9.79l2.36-2.36a3.59,3.59,0,1,1,5.08-5.08L21.81,7.1A6.93,6.93,0,0,0,12,7.1Z"
|
||
style=""
|
||
fill="#F9AB00"
|
||
></path>
|
||
<path
|
||
d="M21.81,7.1,19.46,9.46a3.59,3.59,0,0,1-5.08,5.08L12,16.9A6.93,6.93,0,0,0,21.81,7.1Z"
|
||
style=""
|
||
fill="#E8710A"
|
||
></path>
|
||
</g>
|
||
</svg>
|
||
<span> colab</span></a
|
||
>
|
||
</div><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
|
||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/first_nerf.html">Training your first model</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/existing_dataset.html">Using existing data</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/custom_dataset.html">Using custom data</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/viewer_quickstart.html">Using the viewer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/export_geometry.html">Export geometry</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart/data_conventions.html">Data conventions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Extensions</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../extensions/blender_addon.html">Blender VFX add-on</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../extensions/maya_plugin.html">Autodesk Maya Plug-in</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../extensions/unreal_engine.html">Exporting to Unreal Engine</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../extensions/sdfstudio.html">SDFStudio</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">NeRFology</span></p>
|
||
<ul>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../nerfology/methods/index.html">Methods</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/instant_ngp.html"> Instant-NGP</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/splat.html"> Splatfacto</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/splatw.html"> Splatfacto-W</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/in2n.html"> Instruct-NeRF2NeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/igs2gs.html"> Instruct-GS2GS</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/signerf.html"> SIGNeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/kplanes.html"> K-Planes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/lerf.html"> LERF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/livescene.html"> LiveScene</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/feature_splatting.html"> Feature-Splatting</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/mipnerf.html"> Mip-NeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/nerf.html"> NeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/nerfacto.html"> Nerfacto</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/nerfbusters.html"> Nerfbusters</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/nerfplayer.html"> NeRFPlayer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/tetranerf.html"> Tetra-NeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/tensorf.html"> TensoRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/generfacto.html"> Generfacto</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/pynerf.html"> PyNeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/seathru_nerf.html"> SeaThru-NeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/zipnerf.html"> Zip-NeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/bionerf.html"> BioNeRF</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/nerf2gs2nerf.html"> NeRFtoGSandBack</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/methods/opennerf.html"> OpenNeRF</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../nerfology/model_components/index.html">Model components</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/model_components/visualize_cameras.html"> Cameras models</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/model_components/visualize_samples.html"> Sample representation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/model_components/visualize_samplers.html"> Ray samplers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/model_components/visualize_spatial_distortions.html"> Spatial distortions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../nerfology/model_components/visualize_encoders.html"> Encoders</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Developer Guides</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../developer_guides/new_methods.html">Adding a New Method</a></li>
|
||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../../../developer_guides/pipelines/index.html">Pipelines overview</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||
<li class="toctree-l2 current has-children"><a class="reference internal" href="../../../developer_guides/pipelines/dataparsers.html">DataParsers</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Data Parsers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/pipelines/datamanagers.html">DataManagers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/pipelines/models.html">Models</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/pipelines/fields.html">Fields</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/pipelines/pipelines.html">Pipelines</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../developer_guides/viewer/index.html">Viewer</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/viewer/custom_gui.html">Custom GUI</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/viewer/viewer_control.html">Python Viewer Control</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/viewer/local_viewer.html">(Legacy Viewer) Local Server</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../developer_guides/config.html">Customizable configs</a></li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../developer_guides/debugging_tools/index.html">Debugging tools</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/debugging_tools/local_logger.html">Local writer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/debugging_tools/profiling.html">Code profiling support</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../../developer_guides/debugging_tools/benchmarking.html">Benchmarking workflow</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../cli/index.html">CLI</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_install_cli.html">ns-install-cli</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_process_data.html">ns-process-data</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_download_data.html">ns-download-data</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_train.html">ns-train</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_render.html">ns-render</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_viewer.html">ns-viewer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_export.html">ns-export</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../cli/ns_eval.html">ns-eval</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../index.html">API</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../cameras.html">Cameras</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../config.html">Configs</a></li>
|
||
<li class="toctree-l2 current has-children"><a class="reference internal" href="index.html">Data</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||
<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">Data Parsers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="datamanagers.html">Datamanagers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="datasets.html">Datasets</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.html">Utils</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../fields.html">Fields</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../field_components/index.html">Field Modules</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../field_components/encodings.html">Encodings</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../field_components/embeddings.html">Embeddings</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../field_components/field_heads.html">Field Heads</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../field_components/mlp.html">MLP</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../field_components/spatial_distortions.html">Spatial Distortions</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models.html">Models</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../model_components/index.html">Model components</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../model_components/ray_sampler.html">Ray Sampler</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../model_components/losses.html">Losses</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../model_components/renderers.html">Renderers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../optimizers.html">Engine</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../plugins.html">Plugins</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../utils/index.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../utils/colors.html">Colors</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../utils/math.html">Math</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../utils/colormaps.html">Colormaps</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../utils/tensor_dataclass.html">TensorDataclass</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../viewer.html">Viewer</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container">
|
||
|
||
<div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
<section id="data-parsers">
|
||
<span id="dataparser"></span><h1>Data Parsers<a class="headerlink" href="#data-parsers" title="Permalink to this heading">#</a></h1>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#base-data-parser">Base Data Parser</a></p></li>
|
||
<li><p><a class="reference internal" href="#arkitscenes">ARKitScenes</a></p></li>
|
||
<li><p><a class="reference internal" href="#blender">Blender</a></p></li>
|
||
<li><p><a class="reference internal" href="#d-nerf">D-NeRF</a></p></li>
|
||
<li><p><a class="reference internal" href="#dycheck">dycheck</a></p></li>
|
||
<li><p><a class="reference internal" href="#instant-ngp">Instant-NGP</a></p></li>
|
||
<li><p><a class="reference internal" href="#minimal">Minimal</a></p></li>
|
||
<li><p><a class="reference internal" href="#nerf-osr">NeRF-OSR</a></p></li>
|
||
<li><p><a class="reference internal" href="#nerfstudio">Nerfstudio</a></p></li>
|
||
<li><p><a class="reference internal" href="#nuscenes">nuScenes</a></p></li>
|
||
<li><p><a class="reference internal" href="#phototourism">Phototourism</a></p></li>
|
||
<li><p><a class="reference internal" href="#scannet">ScanNet</a></p></li>
|
||
<li><p><a class="reference internal" href="#sdfstudio">SDFStudio</a></p></li>
|
||
<li><p><a class="reference internal" href="#sitcoms3d">sitcoms3D</a></p></li>
|
||
</ul>
|
||
<section id="base-data-parser">
|
||
<h2>Base Data Parser<a class="headerlink" href="#base-data-parser" title="Permalink to this heading">#</a></h2>
|
||
<p>A set of standard datasets.</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.base_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataParser">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.base_dataparser.</span></span><span class="sig-name descname"><span class="pre">DataParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><span class="pre">DataParserConfig</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>A dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> – datasetparser config containing all information needed to instantiate dataset</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataParser.config">
|
||
<span class="sig-name descname"><span class="pre">config</span></span><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser.config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>datasetparser config containing all information needed to instantiate dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig">nerfstudio.data.dataparsers.base_dataparser.DataParserConfig</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataParser.includes_time">
|
||
<span class="sig-name descname"><span class="pre">includes_time</span></span><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser.includes_time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Does the dataset include time information in the camera poses.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataParser.get_dataparser_outputs">
|
||
<span class="sig-name descname"><span class="pre">get_dataparser_outputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">split</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'train'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs" title="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs"><span class="pre">DataparserOutputs</span></a></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataParser.get_dataparser_outputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser.get_dataparser_outputs" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Returns the dataparser outputs for the given split.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>split</strong> – Which dataset split to generate (train/test).</p></li>
|
||
<li><p><strong>kwargs</strong> – kwargs for generating dataparser outputs.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>DataparserOutputs containing data for the specified dataset and split</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.base_dataparser.</span></span><span class="sig-name descname"><span class="pre">DataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('.')</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Basic dataset config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('.')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.base_dataparser.</span></span><span class="sig-name descname"><span class="pre">DataparserOutputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">image_filenames:</span> <span class="pre">~typing.List[~pathlib.Path],</span> <span class="pre">cameras:</span> <span class="pre">~nerfstudio.cameras.cameras.Cameras,</span> <span class="pre">alpha_color:</span> <span class="pre">~typing.Optional[~jaxtyping.Float[Tensor,</span> <span class="pre">'3']]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">scene_box:</span> <span class="pre">~nerfstudio.data.scene_box.SceneBox</span> <span class="pre">=</span> <span class="pre"><factory>,</span> <span class="pre">mask_filenames:</span> <span class="pre">~typing.Optional[~typing.List[~pathlib.Path]]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">metadata:</span> <span class="pre">~typing.Dict[str,</span> <span class="pre">~typing.Any]</span> <span class="pre">=</span> <span class="pre"><factory>,</span> <span class="pre">dataparser_transform:</span> <span class="pre">~jaxtyping.Float[Tensor,</span> <span class="pre">'3</span> <span class="pre">4']</span> <span class="pre">=</span> <span class="pre">tensor([[1.,</span> <span class="pre">0.,</span> <span class="pre">0.,</span> <span class="pre">0.],</span>         <span class="pre">[0.,</span> <span class="pre">1.,</span> <span class="pre">0.,</span> <span class="pre">0.],</span>         <span class="pre">[0.,</span> <span class="pre">0.,</span> <span class="pre">1.,</span> <span class="pre">0.]]),</span> <span class="pre">dataparser_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataparserOutputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Dataparser outputs for the which will be used by the DataManager
|
||
for creating RayBundle and RayGT objects.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.alpha_color">
|
||
<span class="sig-name descname"><span class="pre">alpha_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'3'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.alpha_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Color of dataset background.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.as_dict">
|
||
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataparserOutputs.as_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.as_dict" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Returns the dataclass as a dictionary.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.cameras">
|
||
<span class="sig-name descname"><span class="pre">cameras</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../cameras.html#nerfstudio.cameras.cameras.Cameras" title="nerfstudio.cameras.cameras.Cameras"><span class="pre">Cameras</span></a></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.cameras" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Camera object storing collection of camera information in dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.dataparser_scale">
|
||
<span class="sig-name descname"><span class="pre">dataparser_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.dataparser_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Scale applied by the dataparser.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.dataparser_transform">
|
||
<span class="sig-name descname"><span class="pre">dataparser_transform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'3</span> <span class="pre">4'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">tensor([[1.,</span> <span class="pre">0.,</span> <span class="pre">0.,</span> <span class="pre">0.],</span>         <span class="pre">[0.,</span> <span class="pre">1.,</span> <span class="pre">0.,</span> <span class="pre">0.],</span>         <span class="pre">[0.,</span> <span class="pre">0.,</span> <span class="pre">1.,</span> <span class="pre">0.]])</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.dataparser_transform" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Transform applied by the dataparser.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.image_filenames">
|
||
<span class="sig-name descname"><span class="pre">image_filenames</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.image_filenames" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filenames for the images.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.mask_filenames">
|
||
<span class="sig-name descname"><span class="pre">mask_filenames</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.mask_filenames" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filenames for any masks that are required</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.metadata">
|
||
<span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.metadata" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Dictionary of any metadata that be required for the given experiment.
|
||
Will be processed by the InputDataset to create any additional tensors that may be required.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.save_dataparser_transform">
|
||
<span class="sig-name descname"><span class="pre">save_dataparser_transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataparserOutputs.save_dataparser_transform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.save_dataparser_transform" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Save dataparser transform to json file. Some dataparsers will apply a transform to the poses,
|
||
this method allows the transform to be saved so that it can be used in other applications.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>path</strong> – path to save transform to</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.scene_box">
|
||
<span class="sig-name descname"><span class="pre">scene_box</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="index.html#nerfstudio.data.scene_box.SceneBox" title="nerfstudio.data.scene_box.SceneBox"><span class="pre">SceneBox</span></a></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.scene_box" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Scene box of dataset. Used to bound the scene or provide the scene scale depending on model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.transform_poses_to_original_space">
|
||
<span class="sig-name descname"><span class="pre">transform_poses_to_original_space</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">poses</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'num_poses</span> <span class="pre">3</span> <span class="pre">4'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_convention</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'opengl'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'opencv'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'opencv'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'num_poses</span> <span class="pre">3</span> <span class="pre">4'</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#DataparserOutputs.transform_poses_to_original_space"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.transform_poses_to_original_space" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Transforms the poses in the transformed space back to the original world coordinate system.
|
||
:param poses: Poses in the transformed space
|
||
:param camera_convention: Camera system convention used for the transformed poses</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Original poses</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.Semantics">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.base_dataparser.</span></span><span class="sig-name descname"><span class="pre">Semantics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">filenames:</span> <span class="pre">~typing.List[~pathlib.Path],</span> <span class="pre">classes:</span> <span class="pre">~typing.List[str],</span> <span class="pre">colors:</span> <span class="pre">~torch.Tensor,</span> <span class="pre">mask_classes:</span> <span class="pre">~typing.List[str]</span> <span class="pre">=</span> <span class="pre"><factory></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#Semantics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Dataclass for semantic labels.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.Semantics.classes">
|
||
<span class="sig-name descname"><span class="pre">classes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.classes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>class labels for data</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.Semantics.colors">
|
||
<span class="sig-name descname"><span class="pre">colors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Tensor</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.colors" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>color mapping for classes</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.Semantics.filenames">
|
||
<span class="sig-name descname"><span class="pre">filenames</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.filenames" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>filenames to load semantic data</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.Semantics.mask_classes">
|
||
<span class="sig-name descname"><span class="pre">mask_classes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.mask_classes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>classes to mask out from training for all modalities</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.base_dataparser.transform_poses_to_original_space">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.base_dataparser.</span></span><span class="sig-name descname"><span class="pre">transform_poses_to_original_space</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">poses</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'num_poses</span> <span class="pre">3</span> <span class="pre">4'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">applied_transform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'3</span> <span class="pre">4'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">applied_scale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_convention</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'opengl'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'opencv'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'opencv'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Float</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'num_poses</span> <span class="pre">3</span> <span class="pre">4'</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/base_dataparser.html#transform_poses_to_original_space"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.base_dataparser.transform_poses_to_original_space" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Transforms the poses in the transformed space back to the original world coordinate system.
|
||
:param poses: Poses in the transformed space
|
||
:param applied_transform: Transform matrix applied in the data processing step
|
||
:param applied_scale: Scale used in the data processing step
|
||
:param camera_convention: Camera system convention used for the transformed poses</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Original poses</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="arkitscenes">
|
||
<h2>ARKitScenes<a class="headerlink" href="#arkitscenes" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for ARKitScenes dataset</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.arkitscenes_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenes">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.arkitscenes_dataparser.</span></span><span class="sig-name descname"><span class="pre">ARKitScenes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig" title="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig"><span class="pre">ARKitScenesDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/arkitscenes_dataparser.html#ARKitScenes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>ARKitScenes DatasetParser</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.arkitscenes_dataparser.</span></span><span class="sig-name descname"><span class="pre">ARKitScenesDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/ARKitScenes/3dod/Validation/41069021')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_method:</span> <span class="pre">~typing.Literal['poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'focus'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_scale_poses:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_split_fraction:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth_unit_scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.001</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/arkitscenes_dataparser.html#ARKitScenesDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>ARKitScenes dataset config.
|
||
ARKitScenes dataset (<a class="reference external" href="http://github.com/apple/ARKitScenes">http://github.com/apple/ARKitScenes</a>) is a large-scale 3D dataset of indoor scenes.
|
||
This dataparser uses 3D detection subset of the ARKitScenes dataset.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.auto_scale_poses">
|
||
<span class="sig-name descname"><span class="pre">auto_scale_poses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.auto_scale_poses" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to automatically scale the poses to fit in +/- 1 bounding box.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.center_method">
|
||
<span class="sig-name descname"><span class="pre">center_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'poses'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'focus'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'poses'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.center_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use to center the poses.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/ARKitScenes/3dod/Validation/41069021')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Path to ARKitScenes folder with densely extracted scenes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.depth_unit_scale_factor">
|
||
<span class="sig-name descname"><span class="pre">depth_unit_scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.001</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.depth_unit_scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Scales the depth values to meters. Default value is 0.001 for a millimeter to meter conversion.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the region of interest by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.train_split_fraction">
|
||
<span class="sig-name descname"><span class="pre">train_split_fraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.9</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.train_split_fraction" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The fraction of images to use for training. The remaining images are for eval.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.arkitscenes_dataparser.traj_string_to_matrix">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.arkitscenes_dataparser.</span></span><span class="sig-name descname"><span class="pre">traj_string_to_matrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">traj_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/arkitscenes_dataparser.html#traj_string_to_matrix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.traj_string_to_matrix" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>convert traj_string into translation and rotation matrices
|
||
:param traj_string: A space-delimited file where each line represents a camera position at a particular timestamp.
|
||
:param The file has seven columns:
|
||
:param * Column 1: timestamp
|
||
:param * Columns 2-4: rotation (axis-angle representation in radians)
|
||
:param * Columns 5-7: translation (usually in meters)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>translation matrix
|
||
Rt: rotation matrix</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>ts</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="blender">
|
||
<h2>Blender<a class="headerlink" href="#blender" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for blender dataset</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.blender_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.blender_dataparser.Blender">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.blender_dataparser.</span></span><span class="sig-name descname"><span class="pre">Blender</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig" title="nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig"><span class="pre">BlenderDataParserConfig</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/blender_dataparser.html#Blender"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.blender_dataparser.Blender" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Blender Dataset
|
||
Some of this code comes from <a class="reference external" href="https://github.com/yenchenlin/nerf-pytorch/blob/master/load_blender.py#L37">https://github.com/yenchenlin/nerf-pytorch/blob/master/load_blender.py#L37</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.blender_dataparser.</span></span><span class="sig-name descname"><span class="pre">BlenderDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/blender/lego')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha_color:</span> <span class="pre">~typing.Optional[str]</span> <span class="pre">=</span> <span class="pre">'white'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ply_path:</span> <span class="pre">~typing.Optional[~pathlib.Path]</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/blender_dataparser.html#BlenderDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Blender dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.alpha_color">
|
||
<span class="sig-name descname"><span class="pre">alpha_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'white'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.alpha_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>alpha color of background, when set to None, InputDataset that consumes DataparserOutputs will not attempt
|
||
to blend with alpha_colors using image’s alpha channel data. Thus rgba image will be directly used in training.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/blender/lego')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.ply_path">
|
||
<span class="sig-name descname"><span class="pre">ply_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.ply_path" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Path to PLY file to load 3D points from, defined relative to the dataset directory. This is helpful for
|
||
Gaussian splatting and generally unused otherwise. If <cite>None</cite>, points are initialized randomly.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="d-nerf">
|
||
<h2>D-NeRF<a class="headerlink" href="#d-nerf" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for blender dataset</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.dnerf_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dnerf_dataparser.DNeRF">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dnerf_dataparser.</span></span><span class="sig-name descname"><span class="pre">DNeRF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig" title="nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig"><span class="pre">DNeRFDataParserConfig</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dnerf_dataparser.html#DNeRF"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRF" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>DNeRF Dataset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dnerf_dataparser.</span></span><span class="sig-name descname"><span class="pre">DNeRFDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/dnerf/lego')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha_color:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'white'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dnerf_dataparser.html#DNeRFDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>D-NeRF dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.alpha_color">
|
||
<span class="sig-name descname"><span class="pre">alpha_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'white'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.alpha_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>alpha color of background</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/dnerf/lego')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="dycheck">
|
||
<h2>dycheck<a class="headerlink" href="#dycheck" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for DyCheck (<a class="reference external" href="https://arxiv.org/abs/2210.13445">https://arxiv.org/abs/2210.13445</a>) dataset of <cite>iphone</cite> subset</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.dycheck_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.Dycheck">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dycheck_dataparser.</span></span><span class="sig-name descname"><span class="pre">Dycheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig" title="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig"><span class="pre">DycheckDataParserConfig</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dycheck_dataparser.html#Dycheck"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.Dycheck" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Dycheck (<a class="reference external" href="https://arxiv.org/abs/2210.13445">https://arxiv.org/abs/2210.13445</a>) Dataset <cite>iphone</cite> subset</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.Dycheck.process_frames">
|
||
<span class="sig-name descname"><span class="pre">process_frames</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame_names</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dycheck_dataparser.html#Dycheck.process_frames"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.Dycheck.process_frames" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Read cameras and filenames from the name list.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>frame_names</strong> – list of file names.</p></li>
|
||
<li><p><strong>time_ids</strong> – time id of each frame.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A list of camera, each entry is a dict of the camera.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dycheck_dataparser.</span></span><span class="sig-name descname"><span class="pre">DycheckDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/iphone/mochi-high-five')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">5.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha_color:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'white'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downscale_factor:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_box_bound:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.5</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dycheck_dataparser.html#DycheckDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Dycheck (<a class="reference external" href="https://arxiv.org/abs/2210.13445">https://arxiv.org/abs/2210.13445</a>) dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.alpha_color">
|
||
<span class="sig-name descname"><span class="pre">alpha_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'white'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.alpha_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>alpha color of background</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/iphone/mochi-high-five')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.downscale_factor">
|
||
<span class="sig-name descname"><span class="pre">downscale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.downscale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to downscale images.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.scene_box_bound">
|
||
<span class="sig-name descname"><span class="pre">scene_box_bound</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.5</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.scene_box_bound" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Boundary of scene box.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.downscale">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dycheck_dataparser.</span></span><span class="sig-name descname"><span class="pre">downscale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">img</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dycheck_dataparser.html#downscale"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.downscale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Function from DyCheck’s repo. Downscale an image.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>img</strong> – Input image</p></li>
|
||
<li><p><strong>scale</strong> – Factor of the scale</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>New image</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.rescale">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dycheck_dataparser.</span></span><span class="sig-name descname"><span class="pre">rescale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">img</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dycheck_dataparser.html#rescale"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.rescale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Function from DyCheck’s repo. Rescale an image.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>img</strong> – Input image</p></li>
|
||
<li><p><strong>scale</strong> – Factor of the scale</p></li>
|
||
<li><p><strong>interpolation</strong> – Interpolation method in opencv</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>New image</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.dycheck_dataparser.upscale">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.dycheck_dataparser.</span></span><span class="sig-name descname"><span class="pre">upscale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">img</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/dycheck_dataparser.html#upscale"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.dycheck_dataparser.upscale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Function from DyCheck’s repo. Upscale an image.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>img</strong> – Input image</p></li>
|
||
<li><p><strong>scale</strong> – Factor of the scale</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>New image</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="instant-ngp">
|
||
<h2>Instant-NGP<a class="headerlink" href="#instant-ngp" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for instant ngp data</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.instant_ngp_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGP">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.instant_ngp_dataparser.</span></span><span class="sig-name descname"><span class="pre">InstantNGP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig" title="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig"><span class="pre">InstantNGPDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/instant_ngp_dataparser.html#InstantNGP"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGP" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Instant NGP Dataset</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGP.get_focal_lengths">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_focal_lengths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meta</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/instant_ngp_dataparser.html#InstantNGP.get_focal_lengths"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGP.get_focal_lengths" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Reads or computes the focal length from transforms dict.
|
||
:param meta: metadata from transforms.json file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Focal lengths in the x and y directions. Error is raised if these cannot be calculated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.instant_ngp_dataparser.</span></span><span class="sig-name descname"><span class="pre">InstantNGPDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/ours/posterv2')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.3333</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_mode:</span> <span class="pre">~typing.Literal['fraction'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'filename'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'interval'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'all']</span> <span class="pre">=</span> <span class="pre">'fraction'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_split_fraction:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_interval:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">8</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/instant_ngp_dataparser.html#InstantNGPDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Instant-NGP dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/ours/posterv2')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory or explicit json file path specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.eval_interval">
|
||
<span class="sig-name descname"><span class="pre">eval_interval</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.eval_interval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The interval between frames to use for eval. Only used when eval_mode is eval-interval.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.eval_mode">
|
||
<span class="sig-name descname"><span class="pre">eval_mode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'fraction'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'filename'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'interval'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'all'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fraction'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.eval_mode" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use for splitting the dataset into train and eval.
|
||
Fraction splits based on a percentage for train and the remaining for eval.
|
||
Filename splits based on filenames containing train/eval.
|
||
Interval uses every nth frame for eval.
|
||
All uses all the images for any split.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.3333</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the scene.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.train_split_fraction">
|
||
<span class="sig-name descname"><span class="pre">train_split_fraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.9</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.train_split_fraction" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The percentage of the dataset to use for training. Only used when eval_mode is train-split-fraction.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="minimal">
|
||
<h2>Minimal<a class="headerlink" href="#minimal" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for pre-prepared datasets for all cameras, with no additional processing needed
|
||
Optional fields - semantics, mask_filenames, cameras.distortion_params, cameras.times</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.minimal_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParser">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.minimal_dataparser.</span></span><span class="sig-name descname"><span class="pre">MinimalDataParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig" title="nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig"><span class="pre">MinimalDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/minimal_dataparser.html#MinimalDataParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParser" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Minimal DatasetParser</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.minimal_dataparser.</span></span><span class="sig-name descname"><span class="pre">MinimalDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('/home/nikhil/nerfstudio-main/tests/data/lego_test/minimal_parser')</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/minimal_dataparser.html#MinimalDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Minimal dataset config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('/home/nikhil/nerfstudio-main/tests/data/lego_test/minimal_parser')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="nerf-osr">
|
||
<h2>NeRF-OSR<a class="headerlink" href="#nerf-osr" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for NeRF-OSR datasets</p>
|
||
<p>Presented in the paper: <a class="reference external" href="https://4dqv.mpi-inf.mpg.de/NeRF-OSR/">https://4dqv.mpi-inf.mpg.de/NeRF-OSR/</a></p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.nerfosr_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSR">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nerfosr_dataparser.</span></span><span class="sig-name descname"><span class="pre">NeRFOSR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig" title="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig"><span class="pre">NeRFOSRDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nerfosr_dataparser.html#NeRFOSR"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSR" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>NeRFOSR Dataparser
|
||
Presented in the paper: <a class="reference external" href="https://4dqv.mpi-inf.mpg.de/NeRF-OSR/">https://4dqv.mpi-inf.mpg.de/NeRF-OSR/</a></p>
|
||
<p>Some of this code comes from <a class="reference external" href="https://github.com/r00tman/NeRF-OSR/blob/main/data_loader_split.py">https://github.com/r00tman/NeRF-OSR/blob/main/data_loader_split.py</a></p>
|
||
<dl class="simple">
|
||
<dt>Source data convention is:</dt><dd><p>camera coordinate system: x–>right, y–>down, z–>scene (opencv/colmap convention)
|
||
poses is camera-to-world
|
||
masks are 0 for dynamic content, 255 for static content</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nerfosr_dataparser.</span></span><span class="sig-name descname"><span class="pre">NeRFOSRDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/NeRF-OSR/Data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'stjacob'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_masks:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation_method:</span> <span class="pre">~typing.Literal['pca'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'up'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'vertical'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'vertical'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_method:</span> <span class="pre">~typing.Literal['poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'focus'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'focus'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_scale_poses:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nerfosr_dataparser.html#NeRFOSRDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Nerfstudio dataset config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.auto_scale_poses">
|
||
<span class="sig-name descname"><span class="pre">auto_scale_poses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.auto_scale_poses" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to automatically scale the poses to fit in +/- 1 bounding box.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.center_method">
|
||
<span class="sig-name descname"><span class="pre">center_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'poses'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'focus'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'focus'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.center_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use for centering.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/NeRF-OSR/Data')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.orientation_method">
|
||
<span class="sig-name descname"><span class="pre">orientation_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'pca'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'up'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'vertical'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'vertical'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.orientation_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use for orientation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scene">
|
||
<span class="sig-name descname"><span class="pre">scene</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stjacob'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scene" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Which scene to load</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the region of interest by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.use_masks">
|
||
<span class="sig-name descname"><span class="pre">use_masks</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.use_masks" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to use masks.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfosr_dataparser.get_camera_params">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nerfosr_dataparser.</span></span><span class="sig-name descname"><span class="pre">get_camera_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scene_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'train'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'validation'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'test'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nerfosr_dataparser.html#get_camera_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.get_camera_params" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Load camera intrinsic and extrinsic parameters for a given scene split.</p>
|
||
<dl class="simple">
|
||
<dt>Args”</dt><dd><p>scene_dir : The directory containing the scene data.
|
||
split : The split for which to load the camera parameters.</p>
|
||
</dd>
|
||
<dt>Returns</dt><dd><p>A tuple containing the intrinsic parameters (as a torch.Tensor of shape [N, 4, 4]),
|
||
the camera-to-world matrices (as a torch.Tensor of shape [N, 4, 4]), and the number of cameras (N).</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="nerfstudio">
|
||
<h2>Nerfstudio<a class="headerlink" href="#nerfstudio" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for nerfstudio datasets.</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.nerfstudio_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.Nerfstudio">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nerfstudio_dataparser.</span></span><span class="sig-name descname"><span class="pre">Nerfstudio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig" title="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig"><span class="pre">NerfstudioDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downscale_factor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nerfstudio_dataparser.html#Nerfstudio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.Nerfstudio" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Nerfstudio DatasetParser</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nerfstudio_dataparser.</span></span><span class="sig-name descname"><span class="pre">NerfstudioDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('.')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downscale_factor:</span> <span class="pre">~typing.Optional[int]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation_method:</span> <span class="pre">~typing.Literal['pca'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'up'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'vertical'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'up'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_method:</span> <span class="pre">~typing.Literal['poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'focus'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_scale_poses:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_mode:</span> <span class="pre">~typing.Literal['fraction'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'filename'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'interval'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'all']</span> <span class="pre">=</span> <span class="pre">'fraction'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_split_fraction:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_interval:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth_unit_scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.001</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask_color:</span> <span class="pre">~typing.Optional[~typing.Tuple[float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">float]]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_3D_points:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nerfstudio_dataparser.html#NerfstudioDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Nerfstudio dataset config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.auto_scale_poses">
|
||
<span class="sig-name descname"><span class="pre">auto_scale_poses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.auto_scale_poses" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to automatically scale the poses to fit in +/- 1 bounding box.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.center_method">
|
||
<span class="sig-name descname"><span class="pre">center_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'poses'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'focus'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'poses'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.center_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use to center the poses.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('.')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory or explicit json file path specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.depth_unit_scale_factor">
|
||
<span class="sig-name descname"><span class="pre">depth_unit_scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.001</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.depth_unit_scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Scales the depth values to meters. Default value is 0.001 for a millimeter to meter conversion.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.downscale_factor">
|
||
<span class="sig-name descname"><span class="pre">downscale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.downscale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to downscale images. If not set, images are chosen such that the max dimension is <1600px.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.eval_interval">
|
||
<span class="sig-name descname"><span class="pre">eval_interval</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.eval_interval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The interval between frames to use for eval. Only used when eval_mode is eval-interval.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.eval_mode">
|
||
<span class="sig-name descname"><span class="pre">eval_mode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'fraction'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'filename'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'interval'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'all'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fraction'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.eval_mode" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use for splitting the dataset into train and eval.
|
||
Fraction splits based on a percentage for train and the remaining for eval.
|
||
Filename splits based on filenames containing train/eval.
|
||
Interval uses every nth frame for eval.
|
||
All uses all the images for any split.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.load_3D_points">
|
||
<span class="sig-name descname"><span class="pre">load_3D_points</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.load_3D_points" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to load the 3D points from the colmap reconstruction.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.mask_color">
|
||
<span class="sig-name descname"><span class="pre">mask_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.mask_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Replace the unknown pixels with this color. Relevant if you have a mask but still sample everywhere.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.orientation_method">
|
||
<span class="sig-name descname"><span class="pre">orientation_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'pca'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'up'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'vertical'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'up'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.orientation_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use for orientation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the region of interest by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.train_split_fraction">
|
||
<span class="sig-name descname"><span class="pre">train_split_fraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.9</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.train_split_fraction" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The percentage of the dataset to use for training. Only used when eval_mode is train-split-fraction.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="nuscenes">
|
||
<h2>nuScenes<a class="headerlink" href="#nuscenes" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for NuScenes dataset</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.nuscenes_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenes">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nuscenes_dataparser.</span></span><span class="sig-name descname"><span class="pre">NuScenes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig" title="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig"><span class="pre">NuScenesDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nuscenes_dataparser.html#NuScenes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>NuScenes DatasetParser</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nuscenes_dataparser.</span></span><span class="sig-name descname"><span class="pre">NuScenesDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory>,</span> <span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('scene-0103'),</span> <span class="pre">data_dir:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('/mnt/local/NuScenes'),</span> <span class="pre">version:</span> <span class="pre">~typing.Literal['v1.0-mini',</span> <span class="pre">'v1.0-trainval']</span> <span class="pre">=</span> <span class="pre">'v1.0-mini',</span> <span class="pre">cameras:</span> <span class="pre">~typing.Tuple[~typing.Literal['FRONT',</span> <span class="pre">'FRONT_LEFT',</span> <span class="pre">'FRONT_RIGHT',</span> <span class="pre">'BACK',</span> <span class="pre">'BACK_LEFT',</span> <span class="pre">'BACK_RIGHT'],</span> <span class="pre">...]</span> <span class="pre">=</span> <span class="pre">('FRONT',),</span> <span class="pre">mask_dir:</span> <span class="pre">~typing.Optional[~pathlib.Path]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">train_split_fraction:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.9,</span> <span class="pre">verbose:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nuscenes_dataparser.html#NuScenesDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>NuScenes dataset config.
|
||
NuScenes (<a class="reference external" href="https://www.nuscenes.org/nuscenes">https://www.nuscenes.org/nuscenes</a>) is an autonomous driving dataset containing 1000 20s clips.
|
||
Each clip was recorded with a suite of sensors including 6 surround cameras.
|
||
It also includes 3D cuboid annotations around objects.
|
||
We optionally use these cuboids to mask dynamic objects by specifying the mask_dir flag.
|
||
To create these masks use nerfstudio/scripts/datasets/process_nuscenes_masks.py.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.cameras">
|
||
<span class="sig-name descname"><span class="pre">cameras</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'FRONT'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'FRONT_LEFT'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'FRONT_RIGHT'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'BACK'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'BACK_LEFT'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'BACK_RIGHT'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('FRONT',)</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.cameras" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Which cameras to use.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('scene-0103')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Name of the scene.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.data_dir">
|
||
<span class="sig-name descname"><span class="pre">data_dir</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('/mnt/local/NuScenes')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.data_dir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Path to NuScenes dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.mask_dir">
|
||
<span class="sig-name descname"><span class="pre">mask_dir</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.mask_dir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Path to masks of dynamic objects.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.train_split_fraction">
|
||
<span class="sig-name descname"><span class="pre">train_split_fraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.9</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.train_split_fraction" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The percent of images to use for training. The remaining images are for eval.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.verbose">
|
||
<span class="sig-name descname"><span class="pre">verbose</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.verbose" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Load dataset with verbose messaging</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.version">
|
||
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'v1.0-mini'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'v1.0-trainval'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'v1.0-mini'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.version" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Dataset version.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.nuscenes_dataparser.rotation_translation_to_pose">
|
||
<span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.nuscenes_dataparser.</span></span><span class="sig-name descname"><span class="pre">rotation_translation_to_pose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">r_quat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t_vec</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/nuscenes_dataparser.html#rotation_translation_to_pose"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.rotation_translation_to_pose" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Convert quaternion rotation and translation vectors to 4x4 matrix</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="phototourism">
|
||
<h2>Phototourism<a class="headerlink" href="#phototourism" title="Permalink to this heading">#</a></h2>
|
||
<p>Phototourism dataset parser. Datasets and documentation here: <a class="reference external" href="http://phototour.cs.washington.edu/datasets/">http://phototour.cs.washington.edu/datasets/</a></p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.phototourism_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.Phototourism">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.phototourism_dataparser.</span></span><span class="sig-name descname"><span class="pre">Phototourism</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig" title="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig"><span class="pre">PhototourismDataParserConfig</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/phototourism_dataparser.html#Phototourism"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.Phototourism" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Phototourism dataset. This is based on <a class="reference external" href="https://github.com/kwea123/nerf_pl/blob/nerfw/datasets/phototourism.py">https://github.com/kwea123/nerf_pl/blob/nerfw/datasets/phototourism.py</a>
|
||
and uses colmap’s utils file to read the poses.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.phototourism_dataparser.</span></span><span class="sig-name descname"><span class="pre">PhototourismDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/phototourism/brandenburg-gate')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha_color:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'white'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_split_fraction:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation_method:</span> <span class="pre">~typing.Literal['pca'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'up'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'vertical'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'up'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_method:</span> <span class="pre">~typing.Literal['poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'focus'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_scale_poses:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/phototourism_dataparser.html#PhototourismDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Phototourism dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.alpha_color">
|
||
<span class="sig-name descname"><span class="pre">alpha_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'white'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.alpha_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>alpha color of background</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.auto_scale_poses">
|
||
<span class="sig-name descname"><span class="pre">auto_scale_poses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.auto_scale_poses" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to automatically scale the poses to fit in +/- 1 bounding box.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.center_method">
|
||
<span class="sig-name descname"><span class="pre">center_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'poses'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'focus'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'poses'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.center_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use to center the poses.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/phototourism/brandenburg-gate')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.orientation_method">
|
||
<span class="sig-name descname"><span class="pre">orientation_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'pca'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'up'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'vertical'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'up'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.orientation_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use for orientation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the region of interest by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.train_split_fraction">
|
||
<span class="sig-name descname"><span class="pre">train_split_fraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.9</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.train_split_fraction" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The fraction of images to use for training. The remaining images are for eval.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="scannet">
|
||
<h2>ScanNet<a class="headerlink" href="#scannet" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for ScanNet dataset</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.scannet_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNet">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.scannet_dataparser.</span></span><span class="sig-name descname"><span class="pre">ScanNet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig" title="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig"><span class="pre">ScanNetDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/scannet_dataparser.html#ScanNet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNet" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>ScanNet DatasetParser</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.scannet_dataparser.</span></span><span class="sig-name descname"><span class="pre">ScanNetDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('nvsmask3d/data/scene_example')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_method:</span> <span class="pre">~typing.Literal['poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'focus'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'none']</span> <span class="pre">=</span> <span class="pre">'poses'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_scale_poses:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_split_fraction:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth_unit_scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.001</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_3D_points:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">point_cloud_color:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ply_file_path:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('nvsmask3d/data/scene_example/scene_example.ply')</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/scannet_dataparser.html#ScanNetDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>ScanNet dataset config.
|
||
ScanNet dataset (<a class="reference external" href="https://www.scan-net.org/">https://www.scan-net.org/</a>) is a large-scale 3D dataset of indoor scenes.
|
||
This dataparser assumes that the dense stream was extracted from .sens files.
|
||
Expected structure of scene directory:</p>
|
||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>root/
|
||
├── color/
|
||
├── depth/
|
||
├── intrinsic/
|
||
├── pose/
|
||
|── ply/
|
||
</pre></div>
|
||
</div>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.auto_scale_poses">
|
||
<span class="sig-name descname"><span class="pre">auto_scale_poses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.auto_scale_poses" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to automatically scale the poses to fit in +/- 1 bounding box.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.center_method">
|
||
<span class="sig-name descname"><span class="pre">center_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'poses'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'focus'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'poses'</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.center_method" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The method to use to center the poses.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('nvsmask3d/data/scene_example')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Path to ScanNet folder with densely extracted scenes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.depth_unit_scale_factor">
|
||
<span class="sig-name descname"><span class="pre">depth_unit_scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.001</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.depth_unit_scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Scales the depth values to meters. Default value is 0.001 for a millimeter to meter conversion.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.load_3D_points">
|
||
<span class="sig-name descname"><span class="pre">load_3D_points</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.load_3D_points" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Whether to load the 3D points from the .ply</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.ply_file_path">
|
||
<span class="sig-name descname"><span class="pre">ply_file_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('nvsmask3d/data/scene_example/scene_example.ply')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.ply_file_path" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>path to the .ply file containing the 3D points</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.point_cloud_color">
|
||
<span class="sig-name descname"><span class="pre">point_cloud_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.point_cloud_color" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>read point cloud colors from .ply files or not</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.scale_factor">
|
||
<span class="sig-name descname"><span class="pre">scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the camera origins by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>How much to scale the region of interest by.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.train_split_fraction">
|
||
<span class="sig-name descname"><span class="pre">train_split_fraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.9</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.train_split_fraction" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>The fraction of images to use for training. The remaining images are for eval.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="sdfstudio">
|
||
<h2>SDFStudio<a class="headerlink" href="#sdfstudio" title="Permalink to this heading">#</a></h2>
|
||
<p>Datapaser for sdfstudio formatted data</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.sdfstudio_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudio">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.sdfstudio_dataparser.</span></span><span class="sig-name descname"><span class="pre">SDFStudio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig" title="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig"><span class="pre">SDFStudioDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/sdfstudio_dataparser.html#SDFStudio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudio" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>SDFStudio Dataset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.sdfstudio_dataparser.</span></span><span class="sig-name descname"><span class="pre">SDFStudioDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/DTU/scan65')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_mono_prior:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth_unit_scale_factor:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.001</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_foreground_mask:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downscale_factor:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">2.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_every_for_val_split:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_orient:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/sdfstudio_dataparser.html#SDFStudioDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>Scene dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/DTU/scan65')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.depth_unit_scale_factor">
|
||
<span class="sig-name descname"><span class="pre">depth_unit_scale_factor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.001</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.depth_unit_scale_factor" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Scales the depth values to meters. Default value is 0.001 for a millimeter to meter conversion.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.include_foreground_mask">
|
||
<span class="sig-name descname"><span class="pre">include_foreground_mask</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.include_foreground_mask" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>whether or not to load foreground mask</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.include_mono_prior">
|
||
<span class="sig-name descname"><span class="pre">include_mono_prior</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.include_mono_prior" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>whether or not to load monocular depth and normal</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Sets the bounding cube to have edge length of this size.
|
||
The longest dimension of the axis-aligned bbox will be scaled to this value.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.skip_every_for_val_split">
|
||
<span class="sig-name descname"><span class="pre">skip_every_for_val_split</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.skip_every_for_val_split" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>sub sampling validation images</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="sitcoms3d">
|
||
<h2>sitcoms3D<a class="headerlink" href="#sitcoms3d" title="Permalink to this heading">#</a></h2>
|
||
<p>Data parser for sitcoms3D dataset.</p>
|
||
<p>The dataset is from the paper [“The One Where They Reconstructed 3D Humans and
|
||
Environments in TV Shows”](<a class="reference external" href="https://ethanweber.me/sitcoms3D/">https://ethanweber.me/sitcoms3D/</a>)</p>
|
||
<span class="target" id="module-nerfstudio.data.dataparsers.sitcoms3d_dataparser"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3D">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.sitcoms3d_dataparser.</span></span><span class="sig-name descname"><span class="pre">Sitcoms3D</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig" title="nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig"><span class="pre">Sitcoms3DDataParserConfig</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">includes_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/sitcoms3d_dataparser.html#Sitcoms3D"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3D" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser" title="nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParser</span></code></a></p>
|
||
<p>Sitcoms3D Dataset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.data.dataparsers.sitcoms3d_dataparser.</span></span><span class="sig-name descname"><span class="pre">Sitcoms3DDataParserConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('data/sitcoms3d/TBBT-big_living_room')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_semantics:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downscale_factor:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene_scale:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">2.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/nerfstudio/data/dataparsers/sitcoms3d_dataparser.html#Sitcoms3DDataParserConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig" title="nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a></p>
|
||
<p>sitcoms3D dataset parser config</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.data">
|
||
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('data/sitcoms3d/TBBT-big_living_room')</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.data" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Directory specifying location of data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.include_semantics">
|
||
<span class="sig-name descname"><span class="pre">include_semantics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.include_semantics" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>whether or not to include loading of semantics data</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.scene_scale">
|
||
<span class="sig-name descname"><span class="pre">scene_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2.0</span></em><a class="headerlink" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.scene_scale" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Sets the bounding cube to have edge length of this size.
|
||
The longest dimension of the Sitcoms3D axis-aligned bbox will be scaled to this value.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="../../../developer_guides/pipelines/datamanagers.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">DataManagers</div>
|
||
</div>
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="../../../developer_guides/pipelines/dataparsers.html">
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">DataParsers</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 2022, nerfstudio Team
|
||
</div>
|
||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
|
||
</div>
|
||
<div class="right-details">
|
||
<div class="icons">
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
On this page
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Data Parsers</a><ul>
|
||
<li><a class="reference internal" href="#base-data-parser">Base Data Parser</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser"><code class="docutils literal notranslate"><span class="pre">DataParser</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser.config"><code class="docutils literal notranslate"><span class="pre">DataParser.config</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser.includes_time"><code class="docutils literal notranslate"><span class="pre">DataParser.includes_time</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParser.get_dataparser_outputs"><code class="docutils literal notranslate"><span class="pre">DataParser.get_dataparser_outputs()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig"><code class="docutils literal notranslate"><span class="pre">DataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">DataParserConfig.data</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.alpha_color"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.alpha_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.as_dict"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.as_dict()</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.cameras"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.cameras</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.dataparser_scale"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.dataparser_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.dataparser_transform"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.dataparser_transform</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.image_filenames"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.image_filenames</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.mask_filenames"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.mask_filenames</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.metadata"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.metadata</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.save_dataparser_transform"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.save_dataparser_transform()</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.scene_box"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.scene_box</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.DataparserOutputs.transform_poses_to_original_space"><code class="docutils literal notranslate"><span class="pre">DataparserOutputs.transform_poses_to_original_space()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics"><code class="docutils literal notranslate"><span class="pre">Semantics</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.classes"><code class="docutils literal notranslate"><span class="pre">Semantics.classes</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.colors"><code class="docutils literal notranslate"><span class="pre">Semantics.colors</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.filenames"><code class="docutils literal notranslate"><span class="pre">Semantics.filenames</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.Semantics.mask_classes"><code class="docutils literal notranslate"><span class="pre">Semantics.mask_classes</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.base_dataparser.transform_poses_to_original_space"><code class="docutils literal notranslate"><span class="pre">transform_poses_to_original_space()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#arkitscenes">ARKitScenes</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenes"><code class="docutils literal notranslate"><span class="pre">ARKitScenes</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.auto_scale_poses"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.auto_scale_poses</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.center_method"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.center_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.depth_unit_scale_factor"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.depth_unit_scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.ARKitScenesDataParserConfig.train_split_fraction"><code class="docutils literal notranslate"><span class="pre">ARKitScenesDataParserConfig.train_split_fraction</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.arkitscenes_dataparser.traj_string_to_matrix"><code class="docutils literal notranslate"><span class="pre">traj_string_to_matrix()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#blender">Blender</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.Blender"><code class="docutils literal notranslate"><span class="pre">Blender</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig"><code class="docutils literal notranslate"><span class="pre">BlenderDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.alpha_color"><code class="docutils literal notranslate"><span class="pre">BlenderDataParserConfig.alpha_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">BlenderDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.ply_path"><code class="docutils literal notranslate"><span class="pre">BlenderDataParserConfig.ply_path</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.blender_dataparser.BlenderDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">BlenderDataParserConfig.scale_factor</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#d-nerf">D-NeRF</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRF"><code class="docutils literal notranslate"><span class="pre">DNeRF</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig"><code class="docutils literal notranslate"><span class="pre">DNeRFDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.alpha_color"><code class="docutils literal notranslate"><span class="pre">DNeRFDataParserConfig.alpha_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">DNeRFDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dnerf_dataparser.DNeRFDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">DNeRFDataParserConfig.scale_factor</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#dycheck">dycheck</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.Dycheck"><code class="docutils literal notranslate"><span class="pre">Dycheck</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.Dycheck.process_frames"><code class="docutils literal notranslate"><span class="pre">Dycheck.process_frames()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig"><code class="docutils literal notranslate"><span class="pre">DycheckDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.alpha_color"><code class="docutils literal notranslate"><span class="pre">DycheckDataParserConfig.alpha_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">DycheckDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.downscale_factor"><code class="docutils literal notranslate"><span class="pre">DycheckDataParserConfig.downscale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">DycheckDataParserConfig.scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.DycheckDataParserConfig.scene_box_bound"><code class="docutils literal notranslate"><span class="pre">DycheckDataParserConfig.scene_box_bound</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.downscale"><code class="docutils literal notranslate"><span class="pre">downscale()</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.rescale"><code class="docutils literal notranslate"><span class="pre">rescale()</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.dycheck_dataparser.upscale"><code class="docutils literal notranslate"><span class="pre">upscale()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#instant-ngp">Instant-NGP</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGP"><code class="docutils literal notranslate"><span class="pre">InstantNGP</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGP.get_focal_lengths"><code class="docutils literal notranslate"><span class="pre">InstantNGP.get_focal_lengths()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig"><code class="docutils literal notranslate"><span class="pre">InstantNGPDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">InstantNGPDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.eval_interval"><code class="docutils literal notranslate"><span class="pre">InstantNGPDataParserConfig.eval_interval</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.eval_mode"><code class="docutils literal notranslate"><span class="pre">InstantNGPDataParserConfig.eval_mode</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">InstantNGPDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.instant_ngp_dataparser.InstantNGPDataParserConfig.train_split_fraction"><code class="docutils literal notranslate"><span class="pre">InstantNGPDataParserConfig.train_split_fraction</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#minimal">Minimal</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParser"><code class="docutils literal notranslate"><span class="pre">MinimalDataParser</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig"><code class="docutils literal notranslate"><span class="pre">MinimalDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.minimal_dataparser.MinimalDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">MinimalDataParserConfig.data</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerf-osr">NeRF-OSR</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSR"><code class="docutils literal notranslate"><span class="pre">NeRFOSR</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.auto_scale_poses"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.auto_scale_poses</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.center_method"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.center_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.orientation_method"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.orientation_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scene"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.scene</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.NeRFOSRDataParserConfig.use_masks"><code class="docutils literal notranslate"><span class="pre">NeRFOSRDataParserConfig.use_masks</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfosr_dataparser.get_camera_params"><code class="docutils literal notranslate"><span class="pre">get_camera_params()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio">Nerfstudio</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.Nerfstudio"><code class="docutils literal notranslate"><span class="pre">Nerfstudio</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.auto_scale_poses"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.auto_scale_poses</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.center_method"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.center_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.depth_unit_scale_factor"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.depth_unit_scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.downscale_factor"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.downscale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.eval_interval"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.eval_interval</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.eval_mode"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.eval_mode</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.load_3D_points"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.load_3D_points</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.mask_color"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.mask_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.orientation_method"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.orientation_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nerfstudio_dataparser.NerfstudioDataParserConfig.train_split_fraction"><code class="docutils literal notranslate"><span class="pre">NerfstudioDataParserConfig.train_split_fraction</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nuscenes">nuScenes</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenes"><code class="docutils literal notranslate"><span class="pre">NuScenes</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.cameras"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.cameras</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.data_dir"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.data_dir</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.mask_dir"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.mask_dir</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.train_split_fraction"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.train_split_fraction</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.verbose"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.verbose</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.NuScenesDataParserConfig.version"><code class="docutils literal notranslate"><span class="pre">NuScenesDataParserConfig.version</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.nuscenes_dataparser.rotation_translation_to_pose"><code class="docutils literal notranslate"><span class="pre">rotation_translation_to_pose()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#phototourism">Phototourism</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.Phototourism"><code class="docutils literal notranslate"><span class="pre">Phototourism</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.alpha_color"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.alpha_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.auto_scale_poses"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.auto_scale_poses</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.center_method"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.center_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.orientation_method"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.orientation_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.phototourism_dataparser.PhototourismDataParserConfig.train_split_fraction"><code class="docutils literal notranslate"><span class="pre">PhototourismDataParserConfig.train_split_fraction</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#scannet">ScanNet</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNet"><code class="docutils literal notranslate"><span class="pre">ScanNet</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.auto_scale_poses"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.auto_scale_poses</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.center_method"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.center_method</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.depth_unit_scale_factor"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.depth_unit_scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.load_3D_points"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.load_3D_points</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.ply_file_path"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.ply_file_path</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.point_cloud_color"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.point_cloud_color</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.scale_factor"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.scannet_dataparser.ScanNetDataParserConfig.train_split_fraction"><code class="docutils literal notranslate"><span class="pre">ScanNetDataParserConfig.train_split_fraction</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#sdfstudio">SDFStudio</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudio"><code class="docutils literal notranslate"><span class="pre">SDFStudio</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.depth_unit_scale_factor"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig.depth_unit_scale_factor</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.include_foreground_mask"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig.include_foreground_mask</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.include_mono_prior"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig.include_mono_prior</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig.scene_scale</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sdfstudio_dataparser.SDFStudioDataParserConfig.skip_every_for_val_split"><code class="docutils literal notranslate"><span class="pre">SDFStudioDataParserConfig.skip_every_for_val_split</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#sitcoms3d">sitcoms3D</a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3D"><code class="docutils literal notranslate"><span class="pre">Sitcoms3D</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig"><code class="docutils literal notranslate"><span class="pre">Sitcoms3DDataParserConfig</span></code></a><ul>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.data"><code class="docutils literal notranslate"><span class="pre">Sitcoms3DDataParserConfig.data</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.include_semantics"><code class="docutils literal notranslate"><span class="pre">Sitcoms3DDataParserConfig.include_semantics</span></code></a></li>
|
||
<li><a class="reference internal" href="#nerfstudio.data.dataparsers.sitcoms3d_dataparser.Sitcoms3DDataParserConfig.scene_scale"><code class="docutils literal notranslate"><span class="pre">Sitcoms3DDataParserConfig.scene_scale</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div></body>
|
||
|
||
</html> |