Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Deprecate camera calibration file spec and remove VRG references #307

Merged
merged 1 commit into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Documentation/file-specifications/camera-calibration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## VTKCam 1.0

```{important} Deprecated
This file specification is no longer supported. The VRG generation functionality was removed in [BrownBiomechanics/SlicerAutoscoperM#140](https://github.com/BrownBiomechanics/SlicerAutoscoperM/pull/140). Please refer to the updated workflows and documentation for alternative solutions.
```

### Overview

The camera calibration file is a yaml and contains all of the information to load a camera into Autoscoper. The file is organized with key value pairs.
Expand Down
1 change: 0 additions & 1 deletion Documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,3 @@ This section defines terms that are commonly used by Autoscoper and SlicerAutosc
* **Sequential 3D CT**: A series of 3D CT scans acquired from the same region of interest (such as a joint or limb) in different positions. Using the Sequences module, these independent volumes can be visualized and processed together as a series.
* **TFM**: An ITK transformation file with the extension `.tfm`.
* **TRA**: A transform file with the extension `.tra` exported by Autoscoper. It contains a Nx16 transformation matrix of rigid body kinematics. Each one of the N lines represents a frame of BVR data optimized by Autoscoper. The TRA transforms can be applied to AUT models to visualized 3D motion of the rigid body and calculate motion.
* **Virtually Generated Radiograph (VRG)**: Synthetic radiograph generated from 3D CT using synthetic camera models.
3 changes: 1 addition & 2 deletions Documentation/tutorials/pre-processing-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ Currently, the module supports the following tasks:
- Segmentation generation or loading
- Partial volume cropping and extraction

In the future, we will add support for the following tasks
- Virtual Radiograph (VRG) generation
In the future, we will add support for the following tasks:
- Config file generation
```

Expand Down
Loading