DIRECT

DIRECT: Deep Image REConstruction Toolkit

PyPI JOSS Tests Ruff Codacy Codecov

Installation • Quick Start • Documentation • Model Zoo

DIRECT is a Python, end-to-end pipeline for solving Inverse Problems emerging in Imaging Processing. It is built with PyTorch and stores state-of-the-art Deep Learning imaging inverse problem solvers such as denoising, dealiasing and reconstruction. By defining a base forward linear or non-linear operator, DIRECT can be used for training models for recovering images such as MRIs from partially observed or noisy input data. DIRECT stores inverse problem solvers such as the vSHARP, Learned Primal Dual algorithm, Recurrent Inference Machine and Recurrent Variational Network, which were part of the winning solutions in Facebook & NYUs FastMRI challenge in 2019, the Calgary-Campinas MRI reconstruction challenge at MIDL 2020 and the CMRxRecon challenge 2023. For a full list of the baselines currently implemented in DIRECT see here.

DIRECT reconstruction examples

Zero-filled reconstruction, Compressed-Sensing (CS) reconstruction using the BART toolbox, Reconstruction using a RIM model trained with DIRECT

Quick install

DIRECT is published to PyPI as direct-recon (the import package is still direct):

pip install direct-recon

For development, the recommended way is with uv:

git clone https://github.com/NKI-AI/direct.git
cd direct
uv sync                 # runtime + dev (default groups)

See the installation guide for Docker and conda alternatives.

Projects

In the projects folder baseline model configurations are provided for each project.

Baselines and trained models

We provide a set of baseline results and trained models in the DIRECT Model Zoo. Baselines and trained models include the vSHARP, Recurrent Variational Network (RecurrentVarNet), the Recurrent Inference Machine (RIM), the End-to-end Variational Network (VarNet), the Learned Primal Dual Network (LDPNet), the X-Primal Dual Network (XPDNet), the KIKI-Net, the U-Net, the Joint-ICNet, and the AIRS Medical fastmri model (MultiDomainNet).

License and usage

DIRECT is not intended for clinical use. DIRECT is released under the Apache 2.0 License.

Citing DIRECT

If you use DIRECT in your own research, or want to refer to baseline results published in the DIRECT Model Zoo, please use the following BiBTeX entry:

@article{DIRECTTOOLKIT,
    doi = {10.21105/joss.04278},
    url = {https://doi.org/10.21105/joss.04278},
    year = {2022},
    publisher = {The Open Journal},
    volume = {7},
    number = {73},
    pages = {4278},
    author = {George Yiasemis and Nikita Moriakov and Dimitrios Karkalousos and Matthan Caan and Jonas Teuwen},
    title = {DIRECT: Deep Image REConstruction Toolkit},
    journal = {Journal of Open Source Software}
}

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for jonasteuwen from gravatar.com jonasteuwen

Credits

Author: Jonas Teuwen

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache-2.0)

Requires

Python >=3.12

Tags

direct

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

direct_recon-2.1.1.tar.gz (3.2 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

direct_recon-2.1.1-cp313-cp313-win_amd64.whl (496.1 kB view details)

Uploaded CPython 3.13Windows x86-64

direct_recon-2.1.1-cp312-cp312-win_amd64.whl (496.0 kB view details)

Uploaded CPython 3.12Windows x86-64

direct_recon-2.1.1-cp312-abi3-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (499.2 kB view details)

Uploaded CPython 3.12+manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

direct_recon-2.1.1-cp312-abi3-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl (500.5 kB view details)

Uploaded CPython 3.12+manylinux: glibc 2.24+ ARM64manylinux: glibc 2.28+ ARM64

direct_recon-2.1.1-cp312-abi3-macosx_11_0_arm64.whl (477.8 kB view details)

Uploaded CPython 3.12+macOS 11.0+ ARM64

direct_recon-2.1.1-cp312-abi3-macosx_10_13_x86_64.whl (486.3 kB view details)

Uploaded CPython 3.12+macOS 10.13+ x86-64

File details

Details for the file direct_recon-2.1.1.tar.gz.

File metadata

  • Download URL: direct_recon-2.1.1.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for direct_recon-2.1.1.tar.gz
Algorithm Hash digest
SHA256 dd9e7bd18135bf2398edecab820460fdabbd615883e34809cda34aad57b0205c
MD5 569fc125cbafd5f32ba3a2fe2fcfcd12
BLAKE2b-256 3765c6e7d73eb33f4a347cb4480d309365a2b1310acceba3623fa6a297b8bdff

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1.tar.gz:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_recon-2.1.1-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for direct_recon-2.1.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 16d1bbd56635e69b105c2de9c8ed6d88a4a9d6053a3332cfd130fe42b8ed4d85
MD5 112ec10dfafc8075897af775a9e44fc7
BLAKE2b-256 9e5e6c92e9e4f2a1e5a3c524b82e6ffaa408e55f1ea89952fb794540406604b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1-cp313-cp313-win_amd64.whl:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_recon-2.1.1-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for direct_recon-2.1.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 43d81b88f3684203196f548ecc27f65bfbee0663d09e17f94a750438ffbcec08
MD5 08941903ac9a9039a5190e07bbc4489a
BLAKE2b-256 b27a7d8ae7a83fcfbc629ba1130b65029a04a55340b5b0724f2ef595a0f71b5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1-cp312-cp312-win_amd64.whl:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_recon-2.1.1-cp312-abi3-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for direct_recon-2.1.1-cp312-abi3-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 399cd8b97712298e5d601373c29e5ce1c8413a24aaa35eaf6c6d248fca038c68
MD5 d258ff0ad1bed33402f2ad1d689edd9d
BLAKE2b-256 43f76c1b10741172224d4d4115fc498f91c7d54f7a1728b4cd0ab7f74477b3f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1-cp312-abi3-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_recon-2.1.1-cp312-abi3-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for direct_recon-2.1.1-cp312-abi3-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 798b46d7932c78c02fe7695b0a98c76ed8b89162127cba3d549c31d080585571
MD5 2c78e48bf87ad2e99078c53370f7487e
BLAKE2b-256 a2c6682eb60fde720ab84d388fa8847acc842d731063d823c43bf73904546b48

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1-cp312-abi3-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_recon-2.1.1-cp312-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for direct_recon-2.1.1-cp312-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 24039b0187cbc68c20e150f0453629908d7370760cf4ad76e116222520d8067c
MD5 3a23cd57c3c579ba96db9ab365c623f8
BLAKE2b-256 48442d23d9188bde7b5cf6a723971dbb2b3dbc5b434163ae1674f5f3a50c3f95

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1-cp312-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_recon-2.1.1-cp312-abi3-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for direct_recon-2.1.1-cp312-abi3-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 f3b33a701e594a864c8cf9f72edde241ec50eb26ef0ee4d27aac6862fa992ade
MD5 a01b971d7807e231011794c8ac1c2592
BLAKE2b-256 d4926fa88f8c5cc04e06d315d3867dd4a56a27166b394a9f5cfca154aff6b751

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_recon-2.1.1-cp312-abi3-macosx_10_13_x86_64.whl:

Publisher: release.yml on NKI-AI/direct

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page