raftcorr 2.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- raftcorr-2.0.0/.gitignore +26 -0
- raftcorr-2.0.0/CHANGELOG.md +61 -0
- raftcorr-2.0.0/LICENSE.md +117 -0
- raftcorr-2.0.0/PKG-INFO +299 -0
- raftcorr-2.0.0/README.md +138 -0
- raftcorr-2.0.0/pyproject.toml +101 -0
- raftcorr-2.0.0/src/raftcorr/__init__.py +94 -0
- raftcorr-2.0.0/src/raftcorr/__main__.py +4 -0
- raftcorr-2.0.0/src/raftcorr/_version.py +1 -0
- raftcorr-2.0.0/src/raftcorr/analysis/__init__.py +52 -0
- raftcorr-2.0.0/src/raftcorr/analysis/engine.py +669 -0
- raftcorr-2.0.0/src/raftcorr/analysis/extract.py +104 -0
- raftcorr-2.0.0/src/raftcorr/analysis/geometry_edit.py +188 -0
- raftcorr-2.0.0/src/raftcorr/analysis/geometry_sampling.py +125 -0
- raftcorr-2.0.0/src/raftcorr/analysis/load_data.py +305 -0
- raftcorr-2.0.0/src/raftcorr/analysis/probes.py +440 -0
- raftcorr-2.0.0/src/raftcorr/analysis/series.py +86 -0
- raftcorr-2.0.0/src/raftcorr/callbacks.py +140 -0
- raftcorr-2.0.0/src/raftcorr/cli/__init__.py +1 -0
- raftcorr-2.0.0/src/raftcorr/cli/main.py +231 -0
- raftcorr-2.0.0/src/raftcorr/config.py +139 -0
- raftcorr-2.0.0/src/raftcorr/conventions.py +42 -0
- raftcorr-2.0.0/src/raftcorr/engine/__init__.py +5 -0
- raftcorr-2.0.0/src/raftcorr/engine/backend.py +124 -0
- raftcorr-2.0.0/src/raftcorr/engine/mapping.py +272 -0
- raftcorr-2.0.0/src/raftcorr/engine/memory.py +136 -0
- raftcorr-2.0.0/src/raftcorr/engine/pipeline.py +318 -0
- raftcorr-2.0.0/src/raftcorr/engine/tiling.py +175 -0
- raftcorr-2.0.0/src/raftcorr/export/__init__.py +27 -0
- raftcorr-2.0.0/src/raftcorr/export/figure_layout.py +164 -0
- raftcorr-2.0.0/src/raftcorr/export/figures.py +384 -0
- raftcorr-2.0.0/src/raftcorr/export/frame_csv.py +187 -0
- raftcorr-2.0.0/src/raftcorr/export/params.py +71 -0
- raftcorr-2.0.0/src/raftcorr/export/probes_csv.py +356 -0
- raftcorr-2.0.0/src/raftcorr/export/report.py +270 -0
- raftcorr-2.0.0/src/raftcorr/export/scientific.py +722 -0
- raftcorr-2.0.0/src/raftcorr/export/tables.py +105 -0
- raftcorr-2.0.0/src/raftcorr/gui/__init__.py +1 -0
- raftcorr-2.0.0/src/raftcorr/gui/app.py +980 -0
- raftcorr-2.0.0/src/raftcorr/gui/app_state.py +437 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/combo_down_hover_light.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/spin_down.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/spin_down_hover.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/spin_down_light.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/spin_up.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/spin_up_hover.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/arrows/spin_up_light.svg +3 -0
- raftcorr-2.0.0/src/raftcorr/gui/assets/icon/RAFTcorr-256.png +0 -0
- raftcorr-2.0.0/src/raftcorr/gui/assets/icon/RAFTcorr.icns +0 -0
- raftcorr-2.0.0/src/raftcorr/gui/assets/icon/RAFTcorr.ico +0 -0
- raftcorr-2.0.0/src/raftcorr/gui/assets/icon/RAFTcorr.svg +7 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/__init__.py +1 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/image_controller.py +178 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/pipeline_controller.py +271 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/pipeline_messages.py +295 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/roi_controller.py +73 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/strain_controller.py +221 -0
- raftcorr-2.0.0/src/raftcorr/gui/controllers/viz_controller.py +164 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/__init__.py +1 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/batch_import_dialog.py +802 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/export_dialog.py +1007 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/export_jobs.py +379 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/export_preview.py +414 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/export_widgets.py +498 -0
- raftcorr-2.0.0/src/raftcorr/gui/dialogs/load_data_dialog.py +365 -0
- raftcorr-2.0.0/src/raftcorr/gui/file_association.py +149 -0
- raftcorr-2.0.0/src/raftcorr/gui/gc_guard.py +46 -0
- raftcorr-2.0.0/src/raftcorr/gui/icons.py +251 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/__init__.py +1 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/__init__.py +13 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/canvas_panel.py +215 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/chart_panel.py +660 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/probe_table.py +210 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/quantities.py +128 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/tab.py +767 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/analysis/text.py +221 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/canvas_area.py +1433 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/left_sidebar.py +350 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/probe_canvas.py +674 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/right_sidebar.py +549 -0
- raftcorr-2.0.0/src/raftcorr/gui/panels/strain_canvas.py +442 -0
- raftcorr-2.0.0/src/raftcorr/gui/project_bridge.py +116 -0
- raftcorr-2.0.0/src/raftcorr/gui/strain_window.py +1055 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/__init__.py +1 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/colormaps.py +155 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/fields.py +84 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/geometry.py +38 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/io_compat.py +46 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/locale_format.py +107 -0
- raftcorr-2.0.0/src/raftcorr/gui/support/matplotlib_fonts.py +75 -0
- raftcorr-2.0.0/src/raftcorr/gui/theme.py +820 -0
- raftcorr-2.0.0/src/raftcorr/gui/theme_manager.py +196 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/__init__.py +5 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/canvas_config_overlay.py +103 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/chart_drawing.py +341 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/collapsible_section.py +131 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/color_range.py +118 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/colorbar_overlay.py +240 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/console_log.py +63 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/double_spin.py +52 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/field_selector.py +59 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/frame_navigator.py +194 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/image_list.py +477 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/info_icon.py +63 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/mpl_chart.py +237 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/param_panel.py +198 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/physical_units_widget.py +173 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/range_mode.py +71 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/roi_hint.py +97 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/roi_toolbar.py +358 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/sticky_headers_overlay.py +172 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/strain_field_selector.py +335 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/strain_navigator.py +228 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/strain_param_panel.py +335 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/strain_viz_panel.py +279 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/velocity_settings.py +161 -0
- raftcorr-2.0.0/src/raftcorr/gui/widgets/workflow_type_panel.py +282 -0
- raftcorr-2.0.0/src/raftcorr/gui/window_chrome.py +53 -0
- raftcorr-2.0.0/src/raftcorr/gui/window_geometry.py +81 -0
- raftcorr-2.0.0/src/raftcorr/i18n/__init__.py +285 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/.gitkeep +2 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_de.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_es.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_fr.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_ja.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_ko.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_zh_CN.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/compiled/raftcorr_zh_TW.qm +0 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/.gitkeep +2 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_de.ts +4201 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_es.ts +4201 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_fr.ts +4201 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_ja.ts +4184 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_ko.ts +4184 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_zh_CN.ts +4184 -0
- raftcorr-2.0.0/src/raftcorr/i18n/source/raftcorr_zh_TW.ts +4184 -0
- raftcorr-2.0.0/src/raftcorr/io/__init__.py +29 -0
- raftcorr-2.0.0/src/raftcorr/io/images.py +236 -0
- raftcorr-2.0.0/src/raftcorr/io/project.py +386 -0
- raftcorr-2.0.0/src/raftcorr/models/__init__.py +41 -0
- raftcorr-2.0.0/src/raftcorr/models/advisor.py +71 -0
- raftcorr-2.0.0/src/raftcorr/models/loader.py +149 -0
- raftcorr-2.0.0/src/raftcorr/models/zoo.py +310 -0
- raftcorr-2.0.0/src/raftcorr/nn/LICENSE-RAFT +33 -0
- raftcorr-2.0.0/src/raftcorr/nn/__init__.py +26 -0
- raftcorr-2.0.0/src/raftcorr/nn/corr.py +91 -0
- raftcorr-2.0.0/src/raftcorr/nn/corr_otf.py +257 -0
- raftcorr-2.0.0/src/raftcorr/nn/extractor.py +192 -0
- raftcorr-2.0.0/src/raftcorr/nn/raft.py +190 -0
- raftcorr-2.0.0/src/raftcorr/nn/update.py +143 -0
- raftcorr-2.0.0/src/raftcorr/nn/utils.py +42 -0
- raftcorr-2.0.0/src/raftcorr/post/__init__.py +24 -0
- raftcorr-2.0.0/src/raftcorr/post/probes.py +183 -0
- raftcorr-2.0.0/src/raftcorr/post/quality.py +62 -0
- raftcorr-2.0.0/src/raftcorr/post/smoothing.py +43 -0
- raftcorr-2.0.0/src/raftcorr/post/strain.py +316 -0
- raftcorr-2.0.0/src/raftcorr/results.py +164 -0
- raftcorr-2.0.0/src/raftcorr/roi/__init__.py +39 -0
- raftcorr-2.0.0/src/raftcorr/roi/masks.py +169 -0
- raftcorr-2.0.0/src/raftcorr/roi/shapes.py +150 -0
- raftcorr-2.0.0/src/raftcorr/schedule.py +110 -0
- raftcorr-2.0.0/src/raftcorr/selftest.py +102 -0
- raftcorr-2.0.0/src/raftcorr/synthetic.py +110 -0
- raftcorr-2.0.0/src/raftcorr/viz/__init__.py +31 -0
- raftcorr-2.0.0/src/raftcorr/viz/colormaps.py +42 -0
- raftcorr-2.0.0/src/raftcorr/viz/fields.py +217 -0
- raftcorr-2.0.0/src/raftcorr/viz/render.py +121 -0
- raftcorr-2.0.0/tests/__init__.py +0 -0
- raftcorr-2.0.0/tests/conftest.py +94 -0
- raftcorr-2.0.0/tests/test_analysis_engine.py +685 -0
- raftcorr-2.0.0/tests/test_analysis_export.py +231 -0
- raftcorr-2.0.0/tests/test_analysis_load_data.py +192 -0
- raftcorr-2.0.0/tests/test_analysis_probes.py +390 -0
- raftcorr-2.0.0/tests/test_api.py +50 -0
- raftcorr-2.0.0/tests/test_cli_options.py +53 -0
- raftcorr-2.0.0/tests/test_config.py +163 -0
- raftcorr-2.0.0/tests/test_export_figures.py +285 -0
- raftcorr-2.0.0/tests/test_export_scientific.py +439 -0
- raftcorr-2.0.0/tests/test_export_tables_report.py +140 -0
- raftcorr-2.0.0/tests/test_gui_analysis.py +526 -0
- raftcorr-2.0.0/tests/test_gui_export.py +612 -0
- raftcorr-2.0.0/tests/test_gui_shell.py +646 -0
- raftcorr-2.0.0/tests/test_gui_strain.py +721 -0
- raftcorr-2.0.0/tests/test_i18n_extractable.py +52 -0
- raftcorr-2.0.0/tests/test_i18n_fill_translations.py +152 -0
- raftcorr-2.0.0/tests/test_i18n_plural_calls.py +132 -0
- raftcorr-2.0.0/tests/test_i18n_translation_sanity.py +137 -0
- raftcorr-2.0.0/tests/test_images.py +267 -0
- raftcorr-2.0.0/tests/test_mapping.py +363 -0
- raftcorr-2.0.0/tests/test_model_download.py +123 -0
- raftcorr-2.0.0/tests/test_packaging.py +93 -0
- raftcorr-2.0.0/tests/test_pipeline_gpu.py +139 -0
- raftcorr-2.0.0/tests/test_project_io.py +282 -0
- raftcorr-2.0.0/tests/test_quality.py +70 -0
- raftcorr-2.0.0/tests/test_roi.py +463 -0
- raftcorr-2.0.0/tests/test_schedule.py +157 -0
- raftcorr-2.0.0/tests/test_strain.py +512 -0
- raftcorr-2.0.0/tests/test_synthetic.py +81 -0
- raftcorr-2.0.0/tests/test_tiling.py +287 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*.egg-info/
|
|
5
|
+
.pytest_cache/
|
|
6
|
+
.coverage
|
|
7
|
+
htmlcov/
|
|
8
|
+
build/
|
|
9
|
+
dist/
|
|
10
|
+
.venv/
|
|
11
|
+
|
|
12
|
+
# Model weights (distributed separately) and image data
|
|
13
|
+
/models/
|
|
14
|
+
*.pth
|
|
15
|
+
/examples/
|
|
16
|
+
/test_data/
|
|
17
|
+
|
|
18
|
+
# Local outputs
|
|
19
|
+
/outputs/
|
|
20
|
+
*.raftcorr
|
|
21
|
+
install.log
|
|
22
|
+
|
|
23
|
+
# Editors
|
|
24
|
+
.vscode/
|
|
25
|
+
.idea/
|
|
26
|
+
/dist-installers/
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 2.0.0 (2026-11-18)
|
|
4
|
+
|
|
5
|
+
A rewrite. One Python process replaces the Flask server and the React front end.
|
|
6
|
+
|
|
7
|
+
### Models
|
|
8
|
+
- The four RAFTcorr-s1, -s2, -s4 and -s8 models, ported from the research implementation
|
|
9
|
+
(pixelwise identical results).
|
|
10
|
+
- On-demand correlation for s <= 4 (memory linear in the image size), stored volume for s8.
|
|
11
|
+
- Checkpoints must carry their architecture (`model_cfg`); they are read with
|
|
12
|
+
`weights_only=True` and verified key by key. The 1.x models, their sign flip and the shape
|
|
13
|
+
heuristics are gone.
|
|
14
|
+
- Model suggestion from a quick s8 survey of the sequence.
|
|
15
|
+
- The model files are assets of the GitHub release `weights-v1`: a model is downloaded and
|
|
16
|
+
verified the first time it is used, or with `raftcorr models --download` (run by `install.bat`).
|
|
17
|
+
|
|
18
|
+
### Engine
|
|
19
|
+
- 20 iterations and raw displacements by default (as in the paper).
|
|
20
|
+
- Work areas grow by the model's reach so that displaced points stay inside the window; large
|
|
21
|
+
regions are tiled with halos and feathered seams; a calibrated per-model memory model sizes the
|
|
22
|
+
tiles; out-of-memory errors shrink them and retry.
|
|
23
|
+
- Accumulative, incremental, every-N and custom reference schedules; incremental results are
|
|
24
|
+
composed into frame-0 coordinates; ROIs of later reference frames are carried forward by an
|
|
25
|
+
inverse map that is robust to large rotations.
|
|
26
|
+
- Frame `k` of a result is image `k` (1.x shifted indices by one).
|
|
27
|
+
- Images: luminance for colour, effective-bit-depth scaling shared by the whole sequence, no
|
|
28
|
+
8-bit re-quantisation.
|
|
29
|
+
|
|
30
|
+
### Application
|
|
31
|
+
- Native desktop application (PySide6) whose interface is ported from pyALDIC (same layout, light and
|
|
32
|
+
dark themes, seven interface languages): images with drag and drop, workflow (tracking mode and
|
|
33
|
+
model, with a model suggestion), regions of interest with per-frame masks, run with progress,
|
|
34
|
+
pause and cancel, displacement on the reference or deformed frame, strain window, analysis with
|
|
35
|
+
probes, export dialog, projects (`.raftcorr`).
|
|
36
|
+
- Intensity residual (tracking-quality map) for every frame, and a warning when the residual jumps.
|
|
37
|
+
- One definition of velocity everywhere.
|
|
38
|
+
- Strain: Green-Lagrange, infinitesimal or Euler-Almansi; uniform or Gaussian gauges; plane or
|
|
39
|
+
quadratic fits; crack-aware; principal strains and angle, von Mises equivalent strain, rotation,
|
|
40
|
+
area change. As in pyALDIC, points whose gauge an edge (region of interest, hole, crack) cuts
|
|
41
|
+
within 0.7 of its half-width are left empty ("Trim low-confidence edges", 0 to 1); pictures can
|
|
42
|
+
fill that band from the reliable points, data files keep it empty.
|
|
43
|
+
- Exports: HDF5, MAT v7.3 and NPZ written frame by frame (NPZ also one file per frame); figures;
|
|
44
|
+
GIF / MP4; CSV; project files. Pictures follow the windows (hidden background white, black or
|
|
45
|
+
transparent; hide untracked regions; fill trimmed edges), with pyALDIC's colorbar style (position,
|
|
46
|
+
font, thickness, background, margin), a resolution cap and the JPEG quality.
|
|
47
|
+
- Command line (`raftcorr run | suggest | models | selftest | info`) and Python API
|
|
48
|
+
(`raftcorr.track`, `raftcorr.compute_strain`).
|
|
49
|
+
|
|
50
|
+
### Distribution
|
|
51
|
+
- `pip install raftcorr` brings the whole application (the GUI, HDF5 and video libraries are no
|
|
52
|
+
longer extras; `raftcorr[all]` still works). The `raftcorr` command starts the application, and
|
|
53
|
+
its subcommands are the command line.
|
|
54
|
+
- Windows installer (`RAFTcorr-Windows-Setup.exe`, per user, no administrator rights): installs
|
|
55
|
+
the PyTorch build that matches the NVIDIA driver (CUDA 12.8, 12.6, 11.8 or the CPU build), RAFTcorr
|
|
56
|
+
and the model files; Start menu entries for RAFTcorr and "Repair RAFTcorr"; optional `raftcorr`
|
|
57
|
+
on PATH; `.raftcorr` files open in RAFTcorr.
|
|
58
|
+
- macOS disk image (`RAFTcorr-macOS.dmg`, Apple silicon, macOS 14 or later), self-contained.
|
|
59
|
+
- `raftcorr selftest --gui` also opens the main window offscreen, to check an installation.
|
|
60
|
+
- `install.bat` reads the CUDA version of newer NVIDIA drivers ("CUDA UMD Version"), which it took
|
|
61
|
+
for no GPU before.
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# THE UNIVERSITY OF TEXAS AT AUSTIN RESEARCH LICENSE
|
|
2
|
+
|
|
3
|
+
**VERSION 1.0, APRIL 2026**
|
|
4
|
+
|
|
5
|
+
The University of Texas at Austin has developed certain software and documentation that it desires to make available to anyone for all purposes except Commercial Distribution, defined below. The accompanying Software and Documentation is made available to you under the terms of this The University of Texas at Austin Research License ("License"). By installing or using the Software, you are consenting to be bound by this License. If you do not agree to the terms and conditions of this License, do not install or use any part of the Software. The terms and conditions in this License not only apply to the Software, but also to any derivative works of the Software.
|
|
6
|
+
|
|
7
|
+
## 1. DEFINITIONS
|
|
8
|
+
|
|
9
|
+
**1.1** "Commercial Distribution" shall mean distribution of Software or Derivative Products by Licensee for direct or indirect financial, commercial or strategic gain or advantage, including without limitation:
|
|
10
|
+
|
|
11
|
+
(a) bundling or integrating the Software with any hardware product or another software product, including Derivative Products, for transfer, sale or license to a third party (even if distributing the Software on separate media and not charging for the Software or Derivative Product);
|
|
12
|
+
|
|
13
|
+
(b) providing users with a link to the Software, Derivative Products, or a copy of the Software for use with hardware or another software product purchased by that customer; or
|
|
14
|
+
|
|
15
|
+
(c) providing software services based on or using Software or Derivative Products.
|
|
16
|
+
|
|
17
|
+
**1.2** "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."
|
|
18
|
+
|
|
19
|
+
**1.3** "Derivative Products" means any derivative works of the Software made by Licensee, and any computer software programs, and Documentation, developed by Licensee which are a modification of, enhancement to, derived from or based upon the Licensed Software or Documentation provided by Licensor for the Licensed Software, and any object code compiled from such computer software programs. Derivative Products include software written to perform substantially the same function, in substantially the same way, to achieve substantially the same result as Software.
|
|
20
|
+
|
|
21
|
+
**1.4** "Licensor" shall mean The University of Texas at Austin, on behalf of the Board of Regents of the University of Texas System, an agency of the State of Texas, whose address is 3925 W. Braker Lane, Suite 1.9A (R3500), Austin, Texas 78759.
|
|
22
|
+
|
|
23
|
+
**1.5** "Licensee" or "you" shall mean the person or entity that has agreed to the terms hereof and is exercising rights granted hereunder.
|
|
24
|
+
|
|
25
|
+
**1.6** "Software" shall mean all files which are made available under this License in source code form, including any error corrections, bug fixes, patches, updates or other modifications that Licensor may in its sole discretion make available to Licensee from time to time, and any object code compiled from such source code.
|
|
26
|
+
|
|
27
|
+
## 2. GRANT OF RIGHTS
|
|
28
|
+
|
|
29
|
+
Subject to the terms and conditions hereunder, Licensor hereby grants to Licensee a worldwide, non-transferable, non-exclusive license for all purposes except Commercial Distribution. Example allowed uses include:
|
|
30
|
+
|
|
31
|
+
(a) academic purposes, research, experimental use, personal use, consulting services, and internal research and development; and
|
|
32
|
+
|
|
33
|
+
(b) use and modification of the Software to create Derivative Products, subject to Section 3.2.
|
|
34
|
+
|
|
35
|
+
For Commercial Distribution, please contact **licensing@discoveries.utexas.edu**.
|
|
36
|
+
|
|
37
|
+
## 3. RESTRICTIONS
|
|
38
|
+
|
|
39
|
+
**3.1** Licensee may not:
|
|
40
|
+
|
|
41
|
+
(a) Commercially Distribute Software or Derivative Products;
|
|
42
|
+
|
|
43
|
+
(b) use the Software or Derivative Products for any use except as described in Section 2; or
|
|
44
|
+
|
|
45
|
+
(c) remove any product identification, copyright, proprietary notices or labels from the Software and Documentation.
|
|
46
|
+
|
|
47
|
+
This License confers no rights upon Licensee except those expressly granted herein.
|
|
48
|
+
|
|
49
|
+
**3.2 Derivative Products.** Licensee hereby agrees that it will provide a copy of all Derivative Products to Licensor and that its use of the Derivative Products will be subject to all the same terms, conditions, restrictions and limitations on use imposed under this License.
|
|
50
|
+
|
|
51
|
+
## 4. WARRANTIES
|
|
52
|
+
|
|
53
|
+
**4.1 Disclaimer of Warranties.** TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE AND DOCUMENTATION ARE BEING PROVIDED ON AN "AS IS" BASIS WITHOUT ANY WARRANTIES OF ANY KIND RESPECTING THE SOFTWARE OR DOCUMENTATION, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF DESIGN, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
|
|
54
|
+
|
|
55
|
+
**4.2 Limitation of Liability.** UNDER NO CIRCUMSTANCES UNLESS REQUIRED BY APPLICABLE LAW SHALL LICENSOR BE LIABLE FOR INCIDENTAL, SPECIAL, INDIRECT, DIRECT OR CONSEQUENTIAL DAMAGES OR LOSS OF PROFITS, INTERRUPTION OF BUSINESS, OR RELATED EXPENSES WHICH MAY ARISE AS A RESULT OF THIS LICENSE OR OUT OF THE USE OR ATTEMPT OF USE OF SOFTWARE OR DOCUMENTATION INCLUDING BUT NOT LIMITED TO THOSE RESULTING FROM DEFECTS IN SOFTWARE AND/OR DOCUMENTATION, OR LOSS OR INACCURACY OF DATA OF ANY KIND. THE FOREGOING EXCLUSIONS AND LIMITATIONS WILL APPLY TO ALL CLAIMS AND ACTIONS OF ANY KIND, WHETHER BASED ON CONTRACT, TORT (INCLUDING, WITHOUT LIMITATION, NEGLIGENCE), OR ANY OTHER GROUNDS.
|
|
56
|
+
|
|
57
|
+
## 5. INDEMNIFICATION
|
|
58
|
+
|
|
59
|
+
Licensee shall indemnify, defend and hold harmless Licensor, the University of Texas System, their Regents, and their officers, agents and employees from and against any claims, demands, or causes of action whatsoever caused by, or arising out of, or resulting from, the exercise or practice of the license granted hereunder by Licensee, its officers, employees, agents or representatives.
|
|
60
|
+
|
|
61
|
+
## 6. TERMINATION
|
|
62
|
+
|
|
63
|
+
If Licensee breaches this License, Licensee's right to use the Software and Documentation will terminate immediately without notice, but all provisions of this License except Section 2 will survive termination and continue in effect. Upon termination, Licensee must destroy all copies of the Software and Documentation.
|
|
64
|
+
|
|
65
|
+
## 7. GOVERNING LAW; JURISDICTION AND VENUE
|
|
66
|
+
|
|
67
|
+
The validity, interpretation, construction and performance of this License shall be governed by the laws of the State of Texas. The Texas state courts of Travis County, Texas (or, if there is exclusive federal jurisdiction, the United States District Court for the Western District of Texas) shall have exclusive jurisdiction and venue over any dispute arising out of this License, and Licensee consents to the jurisdiction of such courts. Application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded.
|
|
68
|
+
|
|
69
|
+
## 8. EXPORT CONTROLS
|
|
70
|
+
|
|
71
|
+
This license is subject to all applicable export restrictions. Licensee must comply with all export and import laws and restrictions and regulations of any United States or foreign agency or authority relating to the Software and its use.
|
|
72
|
+
|
|
73
|
+
## 9. U.S. GOVERNMENT END-USERS
|
|
74
|
+
|
|
75
|
+
The Software is a "commercial item," as that term is defined in 48 C.F.R. 2.101, consisting of "commercial computer software" and "commercial computer software documentation," as such terms are used in 48 C.F.R. 12.212 (Sept. 1995) and 48 C.F.R. 227.7202 (June 1995). Consistent with 48 C.F.R. 12.212, 48 C.F.R. 27.405(b)(2) (June 1998) and 48 C.F.R. 227.7202, all U.S. Government End Users acquire the Software with only those rights as set forth herein.
|
|
76
|
+
|
|
77
|
+
## 10. MISCELLANEOUS
|
|
78
|
+
|
|
79
|
+
If any provision hereof shall be held illegal, invalid or unenforceable, in whole or in part, such provision shall be modified to the minimum extent necessary to make it legal, valid and enforceable, and the legality, validity and enforceability of all other provisions of this License shall not be affected thereby. Licensee may not assign this License in whole or in part, without Licensor's prior written consent. Any attempt to assign this License without such consent will be null and void. This License is the complete and exclusive statement between Licensee and Licensor relating to the subject matter hereof and supersedes all prior oral and written and all contemporaneous oral negotiations, commitments and understandings of the parties, if any. Any waiver by either party of any default or breach hereunder shall not constitute a waiver of any provision of this License or of any subsequent default or breach of the same or a different kind.
|
|
80
|
+
|
|
81
|
+
**END OF LICENSE**
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## APPENDIX: How to apply the License to your Software
|
|
86
|
+
|
|
87
|
+
To apply the License to your work, attach the following boilerplate notice (after the DIVIDER), with the "YYYY" replaced with the current year. 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.
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
------------------------- DIVIDER -------------------------
|
|
91
|
+
|
|
92
|
+
Copyright 2026 The University of Texas at Austin.
|
|
93
|
+
|
|
94
|
+
Licensed under The University of Texas at Austin Research License,
|
|
95
|
+
Version 1.0 ("License"). You MAY NOT use this file except in
|
|
96
|
+
compliance with the License.
|
|
97
|
+
|
|
98
|
+
Unless required by applicable law or agreed to in writing, software
|
|
99
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
100
|
+
AND THE UNIVERSITY OF TEXAS AT AUSTIN EXPRESSLY DISCLAIMS ANY AND
|
|
101
|
+
ALL WARRANTIES CONCERNING THIS SOFTWARE AND DOCUMENTATION, INCLUDING
|
|
102
|
+
ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE,
|
|
103
|
+
NON-INFRINGEMENT AND WARRANTIES OF PERFORMANCE, AND ANY WARRANTY
|
|
104
|
+
THAT MIGHT OTHERWISE ARISE FROM COURSE OF DEALING OR USAGE OF TRADE.
|
|
105
|
+
NO WARRANTY IS EITHER EXPRESS OR IMPLIED WITH RESPECT TO THE USE OF
|
|
106
|
+
THE SOFTWARE OR DOCUMENTATION.
|
|
107
|
+
|
|
108
|
+
Under no circumstances shall The University of Texas at Austin be
|
|
109
|
+
liable for incidental, special, indirect, direct or consequential
|
|
110
|
+
damages or loss of profits, interruption of business, or related
|
|
111
|
+
expenses which may arise from use of Software or Documentation,
|
|
112
|
+
including but not limited to those resulting from defects in Software
|
|
113
|
+
and/or Documentation, or loss or inaccuracy of data of any kind.
|
|
114
|
+
|
|
115
|
+
See the License for the specific language governing permissions and
|
|
116
|
+
limitations under this License.
|
|
117
|
+
```
|
raftcorr-2.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: raftcorr
|
|
3
|
+
Version: 2.0.0
|
|
4
|
+
Summary: RAFTcorr: learned digital image correlation (desktop application, command line and Python library)
|
|
5
|
+
Project-URL: Homepage, https://github.com/zachtong/RAFTcorr
|
|
6
|
+
Project-URL: Repository, https://github.com/zachtong/RAFTcorr
|
|
7
|
+
Project-URL: Issues, https://github.com/zachtong/RAFTcorr/issues
|
|
8
|
+
Project-URL: Releases, https://github.com/zachtong/RAFTcorr/releases
|
|
9
|
+
Author: Zixiang (Zach) Tong
|
|
10
|
+
License: # THE UNIVERSITY OF TEXAS AT AUSTIN RESEARCH LICENSE
|
|
11
|
+
|
|
12
|
+
**VERSION 1.0, APRIL 2026**
|
|
13
|
+
|
|
14
|
+
The University of Texas at Austin has developed certain software and documentation that it desires to make available to anyone for all purposes except Commercial Distribution, defined below. The accompanying Software and Documentation is made available to you under the terms of this The University of Texas at Austin Research License ("License"). By installing or using the Software, you are consenting to be bound by this License. If you do not agree to the terms and conditions of this License, do not install or use any part of the Software. The terms and conditions in this License not only apply to the Software, but also to any derivative works of the Software.
|
|
15
|
+
|
|
16
|
+
## 1. DEFINITIONS
|
|
17
|
+
|
|
18
|
+
**1.1** "Commercial Distribution" shall mean distribution of Software or Derivative Products by Licensee for direct or indirect financial, commercial or strategic gain or advantage, including without limitation:
|
|
19
|
+
|
|
20
|
+
(a) bundling or integrating the Software with any hardware product or another software product, including Derivative Products, for transfer, sale or license to a third party (even if distributing the Software on separate media and not charging for the Software or Derivative Product);
|
|
21
|
+
|
|
22
|
+
(b) providing users with a link to the Software, Derivative Products, or a copy of the Software for use with hardware or another software product purchased by that customer; or
|
|
23
|
+
|
|
24
|
+
(c) providing software services based on or using Software or Derivative Products.
|
|
25
|
+
|
|
26
|
+
**1.2** "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."
|
|
27
|
+
|
|
28
|
+
**1.3** "Derivative Products" means any derivative works of the Software made by Licensee, and any computer software programs, and Documentation, developed by Licensee which are a modification of, enhancement to, derived from or based upon the Licensed Software or Documentation provided by Licensor for the Licensed Software, and any object code compiled from such computer software programs. Derivative Products include software written to perform substantially the same function, in substantially the same way, to achieve substantially the same result as Software.
|
|
29
|
+
|
|
30
|
+
**1.4** "Licensor" shall mean The University of Texas at Austin, on behalf of the Board of Regents of the University of Texas System, an agency of the State of Texas, whose address is 3925 W. Braker Lane, Suite 1.9A (R3500), Austin, Texas 78759.
|
|
31
|
+
|
|
32
|
+
**1.5** "Licensee" or "you" shall mean the person or entity that has agreed to the terms hereof and is exercising rights granted hereunder.
|
|
33
|
+
|
|
34
|
+
**1.6** "Software" shall mean all files which are made available under this License in source code form, including any error corrections, bug fixes, patches, updates or other modifications that Licensor may in its sole discretion make available to Licensee from time to time, and any object code compiled from such source code.
|
|
35
|
+
|
|
36
|
+
## 2. GRANT OF RIGHTS
|
|
37
|
+
|
|
38
|
+
Subject to the terms and conditions hereunder, Licensor hereby grants to Licensee a worldwide, non-transferable, non-exclusive license for all purposes except Commercial Distribution. Example allowed uses include:
|
|
39
|
+
|
|
40
|
+
(a) academic purposes, research, experimental use, personal use, consulting services, and internal research and development; and
|
|
41
|
+
|
|
42
|
+
(b) use and modification of the Software to create Derivative Products, subject to Section 3.2.
|
|
43
|
+
|
|
44
|
+
For Commercial Distribution, please contact **licensing@discoveries.utexas.edu**.
|
|
45
|
+
|
|
46
|
+
## 3. RESTRICTIONS
|
|
47
|
+
|
|
48
|
+
**3.1** Licensee may not:
|
|
49
|
+
|
|
50
|
+
(a) Commercially Distribute Software or Derivative Products;
|
|
51
|
+
|
|
52
|
+
(b) use the Software or Derivative Products for any use except as described in Section 2; or
|
|
53
|
+
|
|
54
|
+
(c) remove any product identification, copyright, proprietary notices or labels from the Software and Documentation.
|
|
55
|
+
|
|
56
|
+
This License confers no rights upon Licensee except those expressly granted herein.
|
|
57
|
+
|
|
58
|
+
**3.2 Derivative Products.** Licensee hereby agrees that it will provide a copy of all Derivative Products to Licensor and that its use of the Derivative Products will be subject to all the same terms, conditions, restrictions and limitations on use imposed under this License.
|
|
59
|
+
|
|
60
|
+
## 4. WARRANTIES
|
|
61
|
+
|
|
62
|
+
**4.1 Disclaimer of Warranties.** TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE AND DOCUMENTATION ARE BEING PROVIDED ON AN "AS IS" BASIS WITHOUT ANY WARRANTIES OF ANY KIND RESPECTING THE SOFTWARE OR DOCUMENTATION, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF DESIGN, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
|
|
63
|
+
|
|
64
|
+
**4.2 Limitation of Liability.** UNDER NO CIRCUMSTANCES UNLESS REQUIRED BY APPLICABLE LAW SHALL LICENSOR BE LIABLE FOR INCIDENTAL, SPECIAL, INDIRECT, DIRECT OR CONSEQUENTIAL DAMAGES OR LOSS OF PROFITS, INTERRUPTION OF BUSINESS, OR RELATED EXPENSES WHICH MAY ARISE AS A RESULT OF THIS LICENSE OR OUT OF THE USE OR ATTEMPT OF USE OF SOFTWARE OR DOCUMENTATION INCLUDING BUT NOT LIMITED TO THOSE RESULTING FROM DEFECTS IN SOFTWARE AND/OR DOCUMENTATION, OR LOSS OR INACCURACY OF DATA OF ANY KIND. THE FOREGOING EXCLUSIONS AND LIMITATIONS WILL APPLY TO ALL CLAIMS AND ACTIONS OF ANY KIND, WHETHER BASED ON CONTRACT, TORT (INCLUDING, WITHOUT LIMITATION, NEGLIGENCE), OR ANY OTHER GROUNDS.
|
|
65
|
+
|
|
66
|
+
## 5. INDEMNIFICATION
|
|
67
|
+
|
|
68
|
+
Licensee shall indemnify, defend and hold harmless Licensor, the University of Texas System, their Regents, and their officers, agents and employees from and against any claims, demands, or causes of action whatsoever caused by, or arising out of, or resulting from, the exercise or practice of the license granted hereunder by Licensee, its officers, employees, agents or representatives.
|
|
69
|
+
|
|
70
|
+
## 6. TERMINATION
|
|
71
|
+
|
|
72
|
+
If Licensee breaches this License, Licensee's right to use the Software and Documentation will terminate immediately without notice, but all provisions of this License except Section 2 will survive termination and continue in effect. Upon termination, Licensee must destroy all copies of the Software and Documentation.
|
|
73
|
+
|
|
74
|
+
## 7. GOVERNING LAW; JURISDICTION AND VENUE
|
|
75
|
+
|
|
76
|
+
The validity, interpretation, construction and performance of this License shall be governed by the laws of the State of Texas. The Texas state courts of Travis County, Texas (or, if there is exclusive federal jurisdiction, the United States District Court for the Western District of Texas) shall have exclusive jurisdiction and venue over any dispute arising out of this License, and Licensee consents to the jurisdiction of such courts. Application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded.
|
|
77
|
+
|
|
78
|
+
## 8. EXPORT CONTROLS
|
|
79
|
+
|
|
80
|
+
This license is subject to all applicable export restrictions. Licensee must comply with all export and import laws and restrictions and regulations of any United States or foreign agency or authority relating to the Software and its use.
|
|
81
|
+
|
|
82
|
+
## 9. U.S. GOVERNMENT END-USERS
|
|
83
|
+
|
|
84
|
+
The Software is a "commercial item," as that term is defined in 48 C.F.R. 2.101, consisting of "commercial computer software" and "commercial computer software documentation," as such terms are used in 48 C.F.R. 12.212 (Sept. 1995) and 48 C.F.R. 227.7202 (June 1995). Consistent with 48 C.F.R. 12.212, 48 C.F.R. 27.405(b)(2) (June 1998) and 48 C.F.R. 227.7202, all U.S. Government End Users acquire the Software with only those rights as set forth herein.
|
|
85
|
+
|
|
86
|
+
## 10. MISCELLANEOUS
|
|
87
|
+
|
|
88
|
+
If any provision hereof shall be held illegal, invalid or unenforceable, in whole or in part, such provision shall be modified to the minimum extent necessary to make it legal, valid and enforceable, and the legality, validity and enforceability of all other provisions of this License shall not be affected thereby. Licensee may not assign this License in whole or in part, without Licensor's prior written consent. Any attempt to assign this License without such consent will be null and void. This License is the complete and exclusive statement between Licensee and Licensor relating to the subject matter hereof and supersedes all prior oral and written and all contemporaneous oral negotiations, commitments and understandings of the parties, if any. Any waiver by either party of any default or breach hereunder shall not constitute a waiver of any provision of this License or of any subsequent default or breach of the same or a different kind.
|
|
89
|
+
|
|
90
|
+
**END OF LICENSE**
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## APPENDIX: How to apply the License to your Software
|
|
95
|
+
|
|
96
|
+
To apply the License to your work, attach the following boilerplate notice (after the DIVIDER), with the "YYYY" replaced with the current year. 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.
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
------------------------- DIVIDER -------------------------
|
|
100
|
+
|
|
101
|
+
Copyright 2026 The University of Texas at Austin.
|
|
102
|
+
|
|
103
|
+
Licensed under The University of Texas at Austin Research License,
|
|
104
|
+
Version 1.0 ("License"). You MAY NOT use this file except in
|
|
105
|
+
compliance with the License.
|
|
106
|
+
|
|
107
|
+
Unless required by applicable law or agreed to in writing, software
|
|
108
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
109
|
+
AND THE UNIVERSITY OF TEXAS AT AUSTIN EXPRESSLY DISCLAIMS ANY AND
|
|
110
|
+
ALL WARRANTIES CONCERNING THIS SOFTWARE AND DOCUMENTATION, INCLUDING
|
|
111
|
+
ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE,
|
|
112
|
+
NON-INFRINGEMENT AND WARRANTIES OF PERFORMANCE, AND ANY WARRANTY
|
|
113
|
+
THAT MIGHT OTHERWISE ARISE FROM COURSE OF DEALING OR USAGE OF TRADE.
|
|
114
|
+
NO WARRANTY IS EITHER EXPRESS OR IMPLIED WITH RESPECT TO THE USE OF
|
|
115
|
+
THE SOFTWARE OR DOCUMENTATION.
|
|
116
|
+
|
|
117
|
+
Under no circumstances shall The University of Texas at Austin be
|
|
118
|
+
liable for incidental, special, indirect, direct or consequential
|
|
119
|
+
damages or loss of profits, interruption of business, or related
|
|
120
|
+
expenses which may arise from use of Software or Documentation,
|
|
121
|
+
including but not limited to those resulting from defects in Software
|
|
122
|
+
and/or Documentation, or loss or inaccuracy of data of any kind.
|
|
123
|
+
|
|
124
|
+
See the License for the specific language governing permissions and
|
|
125
|
+
limitations under this License.
|
|
126
|
+
```
|
|
127
|
+
License-File: LICENSE.md
|
|
128
|
+
Keywords: DIC,RAFT,deep-learning,digital-image-correlation,experimental-mechanics,optical-flow,strain-measurement
|
|
129
|
+
Classifier: Development Status :: 4 - Beta
|
|
130
|
+
Classifier: Environment :: X11 Applications :: Qt
|
|
131
|
+
Classifier: Intended Audience :: Science/Research
|
|
132
|
+
Classifier: License :: Other/Proprietary License
|
|
133
|
+
Classifier: Operating System :: MacOS
|
|
134
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
135
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
136
|
+
Classifier: Programming Language :: Python :: 3
|
|
137
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
138
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
139
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
140
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
141
|
+
Classifier: Topic :: Scientific/Engineering
|
|
142
|
+
Classifier: Topic :: Scientific/Engineering :: Image Processing
|
|
143
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
144
|
+
Requires-Python: >=3.10
|
|
145
|
+
Requires-Dist: h5py>=3.8
|
|
146
|
+
Requires-Dist: imageio-ffmpeg>=0.4
|
|
147
|
+
Requires-Dist: imageio>=2.28
|
|
148
|
+
Requires-Dist: matplotlib>=3.7
|
|
149
|
+
Requires-Dist: numpy>=1.24
|
|
150
|
+
Requires-Dist: pillow>=9.0
|
|
151
|
+
Requires-Dist: pyside6>=6.6
|
|
152
|
+
Requires-Dist: scipy>=1.10
|
|
153
|
+
Requires-Dist: tifffile>=2023.1
|
|
154
|
+
Requires-Dist: torch>=2.1
|
|
155
|
+
Provides-Extra: all
|
|
156
|
+
Provides-Extra: dev
|
|
157
|
+
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
|
|
158
|
+
Requires-Dist: pytest-qt>=4.2; extra == 'dev'
|
|
159
|
+
Requires-Dist: pytest>=7.0; extra == 'dev'
|
|
160
|
+
Description-Content-Type: text/markdown
|
|
161
|
+
|
|
162
|
+
# RAFTcorr
|
|
163
|
+
|
|
164
|
+
**Learned digital image correlation: a desktop application, a command line and a Python library.**
|
|
165
|
+
|
|
166
|
+
RAFTcorr measures full-field displacement and strain from image sequences with the RAFTcorr
|
|
167
|
+
networks: learned correlation models trained on speckle images with exact Lagrangian labels.
|
|
168
|
+
Four released models share one architecture and differ in the encoder downsampling factor `s`:
|
|
169
|
+
|
|
170
|
+
| Model | `s` | Nominal reach (`32 s` px) | Use it for |
|
|
171
|
+
|---|---|---|---|
|
|
172
|
+
| RAFTcorr-s1 | 1 | 32 | small displacements, finest detail (strain concentrations) |
|
|
173
|
+
| RAFTcorr-s2 | 2 | 64 | fine detail, several times faster than s1 |
|
|
174
|
+
| RAFTcorr-s4 | 4 | 128 | a balance of detail and reach (the default) |
|
|
175
|
+
| RAFTcorr-s8 | 8 | 256 | large motion and rotation, or no prior knowledge |
|
|
176
|
+
|
|
177
|
+
A smaller `s` resolves shorter wavelengths; a larger `s` reaches further. The **Suggest a model**
|
|
178
|
+
button measures the motion of your sequence with s8 and picks the finest model that reaches it.
|
|
179
|
+
|
|
180
|
+
## Install
|
|
181
|
+
|
|
182
|
+
**Windows 10/11 (64-bit):** download
|
|
183
|
+
[`RAFTcorr-Windows-Setup.exe`](https://github.com/zachtong/RAFTcorr/releases/latest/download/RAFTcorr-Windows-Setup.exe)
|
|
184
|
+
and run it; no administrator rights are needed. The installer is small and needs an internet
|
|
185
|
+
connection once: it installs the PyTorch build that matches your NVIDIA driver (CUDA 12.8, 12.6
|
|
186
|
+
or 11.8; the CPU build without an NVIDIA GPU), RAFTcorr and the model files. Start RAFTcorr from
|
|
187
|
+
the Start menu; with the option **Add the "raftcorr" command to PATH**, `raftcorr` works in any new
|
|
188
|
+
terminal. If the setup was interrupted (no connection), run **Repair RAFTcorr** from the Start
|
|
189
|
+
menu; its log is `install.log` in the installation folder.
|
|
190
|
+
|
|
191
|
+
**macOS (Apple silicon, macOS 14 or later):** download
|
|
192
|
+
[`RAFTcorr-macOS.dmg`](https://github.com/zachtong/RAFTcorr/releases/latest/download/RAFTcorr-macOS.dmg),
|
|
193
|
+
open it and drag RAFTcorr to Applications. The application is not notarised: the first time
|
|
194
|
+
macOS refuses to open it; choose **System Settings > Privacy & Security > Open Anyway**. It runs
|
|
195
|
+
PyTorch on the CPU. The command line is inside the
|
|
196
|
+
application:
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
alias raftcorr=/Applications/RAFTcorr.app/Contents/MacOS/RAFTcorr # e.g. in ~/.zshrc
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
**With pip (any platform, Python 3.10 or later):** on a computer with an NVIDIA GPU, install
|
|
203
|
+
PyTorch from the [PyTorch index](https://pytorch.org/get-started/locally/) first, because the
|
|
204
|
+
PyTorch on PyPI is the CPU build on Windows:
|
|
205
|
+
|
|
206
|
+
```bash
|
|
207
|
+
pip install torch --index-url https://download.pytorch.org/whl/cu126 # match your driver; skip on macOS
|
|
208
|
+
pip install raftcorr
|
|
209
|
+
raftcorr # start the application
|
|
210
|
+
raftcorr models --download # fetch the model files (otherwise on first use)
|
|
211
|
+
raftcorr selftest # every installed model on a synthetic pair
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
**From the source:** `install.bat` on Windows (a conda environment `raftcorr-app` with the PyTorch
|
|
215
|
+
build for your driver; start with `run.bat`), or on any platform:
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
conda env create -f environment.yml
|
|
219
|
+
conda activate raftcorr-app
|
|
220
|
+
pip install torch --index-url https://download.pytorch.org/whl/cu126 # match your GPU, or /cpu
|
|
221
|
+
pip install -e ".[dev]"
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
The model files `RAFTcorr-s1.pth` ... `RAFTcorr-s8.pth` are assets of the release
|
|
225
|
+
[`weights-v1`](https://github.com/zachtong/RAFTcorr/releases/tag/weights-v1). A model is
|
|
226
|
+
downloaded the first time it is used (or all at once with `raftcorr models --download`) and
|
|
227
|
+
checked against its SHA-256; without an internet connection, put the files in the per-user folder
|
|
228
|
+
below yourself (`raftcorr models` lists where the weights are looked for).
|
|
229
|
+
|
|
230
|
+
The weights are found in, in order: a path you give, `$RAFTCORR_WEIGHTS`, `models/` of a source
|
|
231
|
+
checkout, and the per-user folder (`%LOCALAPPDATA%\RAFTcorr\models` on Windows,
|
|
232
|
+
`~/.raftcorr/models` elsewhere). Every file is checked against its SHA-256.
|
|
233
|
+
|
|
234
|
+
## The application
|
|
235
|
+
|
|
236
|
+
1. **Images**: open a folder; the first image in natural order is the reference (frame 1 in the
|
|
237
|
+
application, index 0 in the arrays of exported data files). 8- to 16-bit grey or colour images
|
|
238
|
+
(PNG, TIFF, BMP, JPEG).
|
|
239
|
+
2. **Region of interest**: rectangle, circle, polygon and brush, each adding or cutting; undo and
|
|
240
|
+
redo; import mask images. A mask on a later frame excludes the regions it leaves out (a crack,
|
|
241
|
+
a hole) and is the region of interest whenever that frame is a reference.
|
|
242
|
+
3. **Model**: s1, s2, s4 or s8, or let RAFTcorr suggest one.
|
|
243
|
+
4. **Tracking**: accumulative (every frame against the reference image; the default, and the most
|
|
244
|
+
accurate whenever the motion stays within the model's reach), incremental, every N frames, or
|
|
245
|
+
custom reference frames. 20 iterations and no smoothing by default.
|
|
246
|
+
5. **Run**: large regions are tiled automatically to fit the GPU memory.
|
|
247
|
+
|
|
248
|
+
Results are shown on the reference image (Lagrangian) or on the current image (deformed
|
|
249
|
+
configuration), with any colour map, fixed or automatic ranges, physical units and playback.
|
|
250
|
+
The **residual** view shows how well each frame was tracked (the grey-level mismatch after
|
|
251
|
+
warping), and RAFTcorr warns when it jumps. **Strain** (strain window) comes from a virtual strain
|
|
252
|
+
gauge (default: Green-Lagrange, unweighted plane fit, 41 px gauge), never fitted across a crack.
|
|
253
|
+
Next to an edge of the region of interest, a hole or a crack the gauge is cut on one side and its
|
|
254
|
+
fit is biased, so points within 0.7 of the gauge half-width of an edge are left empty (**Trim
|
|
255
|
+
low-confidence edges**, from 0 = keep all to 1 = only uncut gauges; `--edge-trim` on the command
|
|
256
|
+
line). Pictures can fill that band from the nearest reliable points; data files keep it empty.
|
|
257
|
+
**Analysis**: points, extensometers, crack-opening gauges, rectangles, circles and polygons, plotted
|
|
258
|
+
over time, along a line, as a kymograph, or against the load of a testing machine (stress-strain).
|
|
259
|
+
**Export**: HDF5, MATLAB v7.3 or NumPy files with every field and the full provenance; per-frame
|
|
260
|
+
CSV tables; PNG / TIFF / PDF / SVG figures; GIF / MP4 animations; an HTML report; probe tables; and
|
|
261
|
+
project files (`.raftcorr`) that reopen the whole session.
|
|
262
|
+
|
|
263
|
+
The interface is available in English, Simplified and Traditional Chinese, Japanese, Korean,
|
|
264
|
+
German, French and Spanish (**Settings → Language**).
|
|
265
|
+
|
|
266
|
+
## Command line
|
|
267
|
+
|
|
268
|
+
```bash
|
|
269
|
+
raftcorr run images/ --roi roi.png --model s4 --strain --out results.h5 --project test.raftcorr
|
|
270
|
+
raftcorr run images/ --model s8 --mode incremental --out results.mat
|
|
271
|
+
raftcorr suggest images/ --roi roi.png
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
## Python
|
|
275
|
+
|
|
276
|
+
```python
|
|
277
|
+
import raftcorr
|
|
278
|
+
|
|
279
|
+
series = raftcorr.track("images/", roi="roi.png", model="s4") # DisplacementSeries
|
|
280
|
+
strain = raftcorr.compute_strain(series) # default strain settings
|
|
281
|
+
u, v = series.u[5], series.v[5] # image 5 (0-based), px, NaN outside the ROI
|
|
282
|
+
exx = strain.components["exx"][5]
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## Conventions
|
|
286
|
+
|
|
287
|
+
`(u, v)` is the displacement from the reference to the deformed image: `+u` right, `+v` down, in
|
|
288
|
+
pixels. Every field is stored in the coordinates of the reference image (Lagrangian); in data
|
|
289
|
+
files and in Python, index `k` of a result is image `k` of the sequence, counted from 0. Shear
|
|
290
|
+
strain is the tensor component (half the engineering shear).
|
|
291
|
+
|
|
292
|
+
## License
|
|
293
|
+
|
|
294
|
+
The University of Texas at Austin Research License (see `LICENSE.md`). The network code is derived
|
|
295
|
+
from RAFT (Teed and Deng, ECCV 2020), BSD 3-Clause License: see `src/raftcorr/nn/LICENSE-RAFT`.
|
|
296
|
+
|
|
297
|
+
## Citing
|
|
298
|
+
|
|
299
|
+
TODO: the RAFTcorr paper (in preparation).
|
raftcorr-2.0.0/README.md
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# RAFTcorr
|
|
2
|
+
|
|
3
|
+
**Learned digital image correlation: a desktop application, a command line and a Python library.**
|
|
4
|
+
|
|
5
|
+
RAFTcorr measures full-field displacement and strain from image sequences with the RAFTcorr
|
|
6
|
+
networks: learned correlation models trained on speckle images with exact Lagrangian labels.
|
|
7
|
+
Four released models share one architecture and differ in the encoder downsampling factor `s`:
|
|
8
|
+
|
|
9
|
+
| Model | `s` | Nominal reach (`32 s` px) | Use it for |
|
|
10
|
+
|---|---|---|---|
|
|
11
|
+
| RAFTcorr-s1 | 1 | 32 | small displacements, finest detail (strain concentrations) |
|
|
12
|
+
| RAFTcorr-s2 | 2 | 64 | fine detail, several times faster than s1 |
|
|
13
|
+
| RAFTcorr-s4 | 4 | 128 | a balance of detail and reach (the default) |
|
|
14
|
+
| RAFTcorr-s8 | 8 | 256 | large motion and rotation, or no prior knowledge |
|
|
15
|
+
|
|
16
|
+
A smaller `s` resolves shorter wavelengths; a larger `s` reaches further. The **Suggest a model**
|
|
17
|
+
button measures the motion of your sequence with s8 and picks the finest model that reaches it.
|
|
18
|
+
|
|
19
|
+
## Install
|
|
20
|
+
|
|
21
|
+
**Windows 10/11 (64-bit):** download
|
|
22
|
+
[`RAFTcorr-Windows-Setup.exe`](https://github.com/zachtong/RAFTcorr/releases/latest/download/RAFTcorr-Windows-Setup.exe)
|
|
23
|
+
and run it; no administrator rights are needed. The installer is small and needs an internet
|
|
24
|
+
connection once: it installs the PyTorch build that matches your NVIDIA driver (CUDA 12.8, 12.6
|
|
25
|
+
or 11.8; the CPU build without an NVIDIA GPU), RAFTcorr and the model files. Start RAFTcorr from
|
|
26
|
+
the Start menu; with the option **Add the "raftcorr" command to PATH**, `raftcorr` works in any new
|
|
27
|
+
terminal. If the setup was interrupted (no connection), run **Repair RAFTcorr** from the Start
|
|
28
|
+
menu; its log is `install.log` in the installation folder.
|
|
29
|
+
|
|
30
|
+
**macOS (Apple silicon, macOS 14 or later):** download
|
|
31
|
+
[`RAFTcorr-macOS.dmg`](https://github.com/zachtong/RAFTcorr/releases/latest/download/RAFTcorr-macOS.dmg),
|
|
32
|
+
open it and drag RAFTcorr to Applications. The application is not notarised: the first time
|
|
33
|
+
macOS refuses to open it; choose **System Settings > Privacy & Security > Open Anyway**. It runs
|
|
34
|
+
PyTorch on the CPU. The command line is inside the
|
|
35
|
+
application:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
alias raftcorr=/Applications/RAFTcorr.app/Contents/MacOS/RAFTcorr # e.g. in ~/.zshrc
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**With pip (any platform, Python 3.10 or later):** on a computer with an NVIDIA GPU, install
|
|
42
|
+
PyTorch from the [PyTorch index](https://pytorch.org/get-started/locally/) first, because the
|
|
43
|
+
PyTorch on PyPI is the CPU build on Windows:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pip install torch --index-url https://download.pytorch.org/whl/cu126 # match your driver; skip on macOS
|
|
47
|
+
pip install raftcorr
|
|
48
|
+
raftcorr # start the application
|
|
49
|
+
raftcorr models --download # fetch the model files (otherwise on first use)
|
|
50
|
+
raftcorr selftest # every installed model on a synthetic pair
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**From the source:** `install.bat` on Windows (a conda environment `raftcorr-app` with the PyTorch
|
|
54
|
+
build for your driver; start with `run.bat`), or on any platform:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
conda env create -f environment.yml
|
|
58
|
+
conda activate raftcorr-app
|
|
59
|
+
pip install torch --index-url https://download.pytorch.org/whl/cu126 # match your GPU, or /cpu
|
|
60
|
+
pip install -e ".[dev]"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
The model files `RAFTcorr-s1.pth` ... `RAFTcorr-s8.pth` are assets of the release
|
|
64
|
+
[`weights-v1`](https://github.com/zachtong/RAFTcorr/releases/tag/weights-v1). A model is
|
|
65
|
+
downloaded the first time it is used (or all at once with `raftcorr models --download`) and
|
|
66
|
+
checked against its SHA-256; without an internet connection, put the files in the per-user folder
|
|
67
|
+
below yourself (`raftcorr models` lists where the weights are looked for).
|
|
68
|
+
|
|
69
|
+
The weights are found in, in order: a path you give, `$RAFTCORR_WEIGHTS`, `models/` of a source
|
|
70
|
+
checkout, and the per-user folder (`%LOCALAPPDATA%\RAFTcorr\models` on Windows,
|
|
71
|
+
`~/.raftcorr/models` elsewhere). Every file is checked against its SHA-256.
|
|
72
|
+
|
|
73
|
+
## The application
|
|
74
|
+
|
|
75
|
+
1. **Images**: open a folder; the first image in natural order is the reference (frame 1 in the
|
|
76
|
+
application, index 0 in the arrays of exported data files). 8- to 16-bit grey or colour images
|
|
77
|
+
(PNG, TIFF, BMP, JPEG).
|
|
78
|
+
2. **Region of interest**: rectangle, circle, polygon and brush, each adding or cutting; undo and
|
|
79
|
+
redo; import mask images. A mask on a later frame excludes the regions it leaves out (a crack,
|
|
80
|
+
a hole) and is the region of interest whenever that frame is a reference.
|
|
81
|
+
3. **Model**: s1, s2, s4 or s8, or let RAFTcorr suggest one.
|
|
82
|
+
4. **Tracking**: accumulative (every frame against the reference image; the default, and the most
|
|
83
|
+
accurate whenever the motion stays within the model's reach), incremental, every N frames, or
|
|
84
|
+
custom reference frames. 20 iterations and no smoothing by default.
|
|
85
|
+
5. **Run**: large regions are tiled automatically to fit the GPU memory.
|
|
86
|
+
|
|
87
|
+
Results are shown on the reference image (Lagrangian) or on the current image (deformed
|
|
88
|
+
configuration), with any colour map, fixed or automatic ranges, physical units and playback.
|
|
89
|
+
The **residual** view shows how well each frame was tracked (the grey-level mismatch after
|
|
90
|
+
warping), and RAFTcorr warns when it jumps. **Strain** (strain window) comes from a virtual strain
|
|
91
|
+
gauge (default: Green-Lagrange, unweighted plane fit, 41 px gauge), never fitted across a crack.
|
|
92
|
+
Next to an edge of the region of interest, a hole or a crack the gauge is cut on one side and its
|
|
93
|
+
fit is biased, so points within 0.7 of the gauge half-width of an edge are left empty (**Trim
|
|
94
|
+
low-confidence edges**, from 0 = keep all to 1 = only uncut gauges; `--edge-trim` on the command
|
|
95
|
+
line). Pictures can fill that band from the nearest reliable points; data files keep it empty.
|
|
96
|
+
**Analysis**: points, extensometers, crack-opening gauges, rectangles, circles and polygons, plotted
|
|
97
|
+
over time, along a line, as a kymograph, or against the load of a testing machine (stress-strain).
|
|
98
|
+
**Export**: HDF5, MATLAB v7.3 or NumPy files with every field and the full provenance; per-frame
|
|
99
|
+
CSV tables; PNG / TIFF / PDF / SVG figures; GIF / MP4 animations; an HTML report; probe tables; and
|
|
100
|
+
project files (`.raftcorr`) that reopen the whole session.
|
|
101
|
+
|
|
102
|
+
The interface is available in English, Simplified and Traditional Chinese, Japanese, Korean,
|
|
103
|
+
German, French and Spanish (**Settings → Language**).
|
|
104
|
+
|
|
105
|
+
## Command line
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
raftcorr run images/ --roi roi.png --model s4 --strain --out results.h5 --project test.raftcorr
|
|
109
|
+
raftcorr run images/ --model s8 --mode incremental --out results.mat
|
|
110
|
+
raftcorr suggest images/ --roi roi.png
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Python
|
|
114
|
+
|
|
115
|
+
```python
|
|
116
|
+
import raftcorr
|
|
117
|
+
|
|
118
|
+
series = raftcorr.track("images/", roi="roi.png", model="s4") # DisplacementSeries
|
|
119
|
+
strain = raftcorr.compute_strain(series) # default strain settings
|
|
120
|
+
u, v = series.u[5], series.v[5] # image 5 (0-based), px, NaN outside the ROI
|
|
121
|
+
exx = strain.components["exx"][5]
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Conventions
|
|
125
|
+
|
|
126
|
+
`(u, v)` is the displacement from the reference to the deformed image: `+u` right, `+v` down, in
|
|
127
|
+
pixels. Every field is stored in the coordinates of the reference image (Lagrangian); in data
|
|
128
|
+
files and in Python, index `k` of a result is image `k` of the sequence, counted from 0. Shear
|
|
129
|
+
strain is the tensor component (half the engineering shear).
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
The University of Texas at Austin Research License (see `LICENSE.md`). The network code is derived
|
|
134
|
+
from RAFT (Teed and Deng, ECCV 2020), BSD 3-Clause License: see `src/raftcorr/nn/LICENSE-RAFT`.
|
|
135
|
+
|
|
136
|
+
## Citing
|
|
137
|
+
|
|
138
|
+
TODO: the RAFTcorr paper (in preparation).
|