Conversation
Fix missing directory bug for test
Merge dev into main
Improve visualization and correct small issues in CVXPY matching, apply transforms image by image
…by only reading this page
…: elasitx_utils updated for consistency
Collaborator
Author
|
WIP; needs to be updated when all open PRs are merged |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a complete documentation site for matchmaker, built with Sphinx and wired up
for Read the Docs, plus the supporting docstrings and naming/consistency cleanups
that the API reference surfaced.
Documentation
New Sphinx site under
docs/(Read the Docs config,conf.py, requirements):pytest -sactually does (runs the rigid examplepipeline, downloads reference data, manual fallback)
config and a "try it on the example data" command
scripts (option tables), and the Python API
log_dirtree, per-stage QC plots, and how tojudge whether a registration succeeded
autodoc(mock imports so it buildswithout the heavy/GPU deps)
Code changes supporting the docs
pipeline-stage entry points.
run_*:cpd_from_images→run_cpd(and the low-levelrun_cpd→cpd_from_pcds)match_points→run_matchingelastix_deformable_pointset_alignment→run_pointset_registration(and the low-level
run_pointset_registration→elastix_pointset_registration)run_registration→elastix_registrationConfig / behaviour changes to note when reviewing
output_nameremoved. The output.n5name is now the optionalfixed_image.name/moving_image.name(defaultsfixed_image/moving_image).registration.smk, the example configs, andtests/test_pipeline.pyare updatedaccordingly.
fixed_imageis now genuinely optional –apply_transform.smkguards it, so the overlay is simply skipped when it's absent.
apply_transform.pyusedfrom utils import …(only worked in scriptmode); changed to
from matchmaker.utils import ….Previewing the docs
python -m venv /tmp/docs-venv && /tmp/docs-venv/bin/pip install -r docs/requirements.txt /tmp/docs-venv/bin/sphinx-build -b html docs/source docs/build/html open docs/build/html/index.htmlBuilds cleanly with no warnings.
Follow-ups (not in this PR)