track-4dgs 0.1.0__tar.gz

track_4dgs-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

track_4dgs-0.1.0/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.4
+Name: track_4dgs
+Version: 0.1.0
+Summary: Packaged Python point tracking utilities for 4D Gaussian Splatting
+Home-page: https://github.com/yindaheng98/track-4dgs
+Author: yindaheng98
+Author-email: yindaheng98@gmail.com
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gaussian-splatting>=2.3.8
+Requires-Dist: Pillow
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# Point Tracking for 4DGS
+
+This repo is the **point tracking Python extension for 4D Gaussian Splatting**. It wraps sequence point trackers such as [CoTracker3](https://github.com/facebookresearch/co-tracker) and [VGGT](https://github.com/facebookresearch/vggt) behind one small registry, then applies them either to plain image sequences or to multi-timestep Gaussian Splatting camera datasets.
+
+The package provides two common workflows:
+
+* track sampled 2D points through one ordered image sequence
+* project 3D Gaussians into a reference timestep, track those projected points across all timesteps, and attach the resulting tracks back to Gaussian Splatting camera datasets
+
+## Features
+
+* [x] Organised as a standard Python package with `pip install` support
+* [x] Shared point tracker registry with `cotracker3` and `vggt` implementations
+* [x] Single-view image sequence tracking and rendering
+* [x] Multi-timestep Gaussian Splatting camera dataset tracking
+* [x] Camera dataset reordering against a selected reference timestep
+* [ ] Port the motion estimation workflow from [TrackerSplat](https://github.com/yindaheng98/TrackerSplat) for point-tracker-driven motion synthesis
+* [ ] Regularize 3DGS training with point tracker trajectories
+
+## Install
+
+### Prerequisites
+
+* [PyTorch](https://pytorch.org/) (CUDA build recommended)
+* [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) matching your PyTorch installation
+* [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting)
+* [`CoTracker`](https://github.com/facebookresearch/co-tracker)
+* [`VGGT`](https://github.com/facebookresearch/vggt) for the optional `vggt` tracker
+
+Install the core Gaussian Splatting dependency used by the 4DGS dataset utilities:
+
+```shell
+pip install wheel setuptools
+pip install --upgrade gaussian-splatting
+```
+
+If you have trouble with `gaussian-splatting`, try installing it from source:
+
+```shell
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master --no-build-isolation
+```
+
+Install tracker dependencies used by this package:
+
+```shell
+pip install --upgrade git+https://github.com/facebookresearch/co-tracker.git@main
+pip install --upgrade Pillow hydra-core omegaconf
+pip install --upgrade git+https://github.com/facebookresearch/vggt.git@main
+pip install --upgrade git+https://github.com/jytime/LightGlue.git#egg=lightglue
+```
+
+## PyPI Install
+
+```shell
+pip install --upgrade track-4dgs
+```
+
+or build latest from source:
+
+```shell
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/track-4dgs.git@master --no-build-isolation
+```
+
+### Development Install
+
+```shell
+git clone --recursive https://github.com/yindaheng98/track-4dgs.git
+cd track-4dgs
+pip install --target . --upgrade . --no-deps
+```
+
+### Download Checkpoints
+
+CoTracker3 offline checkpoint:
+
+```shell
+mkdir -p checkpoints
+wget -P checkpoints https://huggingface.co/facebook/cotracker3/resolve/main/scaled_offline.pth
+```
+
+VGGT commercial checkpoint:
+
+```shell
+mkdir -p checkpoints
+wget -P checkpoints https://huggingface.co/facebook/VGGT-1B-Commercial/resolve/main/vggt_1B_commercial.pt --header="Authorization: Bearer $HF_TOKEN"
+```
+
+If the VGGT checkpoint is not present, `VGGTPointTracker` falls back to `VGGT.from_pretrained("facebook/VGGT-1B")`.
+
+## Command-Line Usage
+
+### List Registered Point Trackers
+
+Verify that `track_4dgs` can import and register trackers:
+
+```shell
+python -c "import track_4dgs; print(track_4dgs.get_available_point_trackers())"
+```
+
+The built-in trackers are:
+
+* `cotracker3`: CoTracker3 offline point tracker
+* `vggt`: VGGT TrackHead point tracker
+
+### Track One Image Sequence
+
+```shell
+python -m track_4dgs.track1v \
+    -s data/frame_000.png data/frame_001.png data/frame_002.png \
+    -d output/track1v-cotracker3 \
+    --tracker cotracker3 \
+    --num-points 256
+```
+
+The command samples random query points on the first image, tracks them through all source images, and saves a rendered track overlay sequence under the destination directory.
+
+Tracker-specific options can be passed with repeated `-m/--option_tracker` values:
+
+```shell
+python -m track_4dgs.track1v \
+    -s data/frame_000.png data/frame_001.png data/frame_002.png \
+    -d output/track1v-vggt \
+    --tracker vggt \
+    -m checkpoint="'checkpoints/vggt_1B_commercial.pt'" \
+    -m iters=4
+```
+
+### Track 4DGS Camera Datasets
+
+```shell
+python -m track_4dgs.track2d \
+    -s data/sequence/frame_000 data/sequence/frame_001 data/sequence/frame_002 \
+    -d output/sequence \
+    -i 30000 \
+    --tracker cotracker3 \
+    --init-dataset-index 0 \
+    --num-points 256
+```
+
+`track2d` loads a trained Gaussian point cloud from:
+
+```text
+<destination>/point_cloud/iteration_<iteration>/point_cloud.ply
+```
+
+It projects Gaussian centers into every camera of the reference timestep, tracks those projected points across the same camera views in all timesteps, and saves visualisations under:
+
+```text
+<destination>/ours_<iteration>/track2d-<tracker>/
+```
+
+If cameras were saved outside the source scene folders, pass one camera path per source:
+
+```shell
+python -m track_4dgs.track2d \
+    -s data/sequence/frame_000 data/sequence/frame_001 \
+    -d output/sequence \
+    -i 30000 \
+    --load_cameras output/frame_000/cameras.json output/frame_001/cameras.json \
+    --mode camera
+```
+
+## API Usage
+
+### Build a Tracker
+
+```python
+from track_4dgs.registry import build_point_tracker, get_available_point_trackers
+
+print(get_available_point_trackers())
+
+tracker = build_point_tracker(
+    "cotracker3",
+    checkpoint="checkpoints/scaled_offline.pth",
+).to("cuda")
+```
+
+### Track Image Tensors
+
+```python
+import torch
+
+from track_4dgs.track1v import load_image, sample_query
+
+frames = [
+    load_image("data/frame_000.png", "cuda"),
+    load_image("data/frame_001.png", "cuda"),
+]
+query = sample_query(frames[0], num_points=256)
+
+with torch.no_grad():
+    track = tracker.track_view(query, frames, [None] * len(frames))
+
+print(track.points.shape)      # [num_frames, num_points, 2]
+print(track.visibility.shape)  # [num_frames, num_points]
+```
+
+### Track Gaussian Splatting Camera Datasets
+
+```python
+from gaussian_splatting.prepare import prepare_gaussians
+
+from track_4dgs.prepare import prepare_datasets, prepare_tracker
+from track_4dgs.track2d import query_views_from_gaussians
+
+sources = [
+    "data/sequence/frame_000",
+    "data/sequence/frame_001",
+]
+datasets = prepare_datasets(
+    sources=sources,
+    device="cuda",
+    reorder_reference_idx=0,
+)
+gaussians = prepare_gaussians(
+    sh_degree=3,
+    source=sources[0],
+    device="cuda",
+    load_ply="output/sequence/point_cloud/iteration_30000/point_cloud.ply",
+)
+dataset_tracker = prepare_tracker(
+    tracker_name="cotracker3",
+    device="cuda",
+    tracker_configs={"checkpoint": "checkpoints/scaled_offline.pth"},
+)
+
+queries = query_views_from_gaussians(
+    datasets=datasets,
+    gaussians=gaussians,
+    init_dataset_index=0,
+    num_points=256,
+)
+tracked_datasets = dataset_tracker(queries, datasets)
+
+camera_track = tracked_datasets[0][0].custom_data["track"]
+print(camera_track.points.shape)
+```
+
+## Design: Point Tracker Registry
+
+`AbstractPointTracker.__call__` validates inputs, then calls `track`. It takes view-major queries and frame-major camera datasets, and returns one `Track` per view. `CameraDatasetTracker` attaches those tracks back onto the camera datasets:
+
+```text
+view_queries + frame_datasets -> validate + track -> view_tracks -> tracked camera datasets
+```
+
+Single-view trackers (`AbstractViewPointTracker`, e.g. CoTracker3 / VGGT) implement `track_batch(query, frames, masks)` for one camera sequence. Their `track` loops `track_view` over views. Multi-view trackers (`AbstractMultiViewPointTracker`, e.g. MV-TAP) consume all views at once, using camera `K` / `R` / `T` when the model needs them.
+
+```text
+Frame 0 cameras --\
+Frame 1 cameras ----> single-view loop, or one joint multi-view call ----> view_tracks
+Frame 2 cameras --/
+```
+
+This keeps model-specific code isolated in tracker implementations while the 4DGS workflow can use any registered tracker by name.
+
+## Extending: Adding a New Point Tracker
+
+Single-view trackers return `Track(points=[D, N, 2], visibility=[D, N])` from `track_batch`:
+
+```python
+from collections.abc import Sequence
+
+import torch
+
+from track_4dgs.tracker import AbstractViewPointTracker, Query, Track
+
+
+class MyPointTracker(AbstractViewPointTracker):
+    def to(self, device):
+        self.device = torch.device(device)
+        return self
+
+    def track_batch(
+        self,
+        query: Query,
+        frames: Sequence[torch.Tensor],
+        frame_masks: Sequence[torch.Tensor | None],
+    ) -> Track:
+        ...
+```
+
+Register it at import time:
+
+```python
+from track_4dgs.registry import register_point_tracker
+
+register_point_tracker("mytracker", MyPointTracker)
+```
+
+After registration, it is available everywhere:
+
+```shell
+python -m track_4dgs.track1v --tracker mytracker -s frame0.png frame1.png -d output/mytracker
+```
+
+## Acknowledgement
+
+This repo is developed based on [CoTracker](https://github.com/facebookresearch/co-tracker), [VGGT](https://github.com/facebookresearch/vggt), [LightGlue](https://github.com/jytime/LightGlue), and [gaussian-splatting (packaged)](https://github.com/yindaheng98/gaussian-splatting). Many thanks to the authors for open-sourcing their codebases.