Skip to main content

Python API to connect and work with the MedShapeNet Medical Shapes Database (https://medshapenet.ikim.nrw/)

Project description

MedShapeNet API

The MedShapeNet Package (MSN-API) is an API that enables direct connectivity to the MedShapeNet database, comprising over 100,000 3D shapes for the medical domain.

The included datasets comprise collections of anatomical shapes (e.g., bones, organs, vessels), 3D models of surgical instruments, and even molecular structures.

MedShapeNet has been established with the objective of facilitating the translation of data-driven vision algorithms for medical machine learning applications, extended reality, 3D printing, benchmarking and other related fields.

Further information on MedShapeNet can be found in the first MedShapeNet Paper, which describes the initial contributions. A subsequent paper will describe the new contributions and usage of the MedShapeNet API.

The API enables users to search the Database, retrieve author information, download data, visualise shapes, and transform shapes into file formats that are more suitable for machine learning (e.g. as numpy arrays in .npz format).

Samples on MSN-API usage and using it for machine learning applications will made available on the MedShapeNet 2.0 GitHub Page in the near future.

The initial version will be demonstrated during the MICCAI 2024 tutorial. Following the event, further functionality will be added, for example adding labels to the shapes and including more datasets. Additionally, a Streamlit websit has been created as a result of the first paper. Further information can be found on the Project Page of the Institute for Artificial Intelligence in Medicine (IKIM).

Functionality under constructions, functionality and all datasets will be added soon.
Want to contribute, checkout the MedShapeNet 2.0 GitHub Page.


Installation

You can install the package using pip:

pip install MedShapeNet

Help function

In the command line interface pip install:

msn_help

Or in Python:

import MedShapeNet
msn.msn_help()

Usage

The MedShapeNet object will be imported into the Python environment as msn, and the methods can be invoked directly via the msn.method(args) syntax.
For further information on the usage of methods and examples of the MedShapeNet API, we refer to the samples available on the MedShapeNet 2.0 GitHub Page.


Reference / citation

If you use MedShapeNet in your (research) project(s), we kindly request you to cite MedShapeNet as:

@article{li_medshapenet_2023,
	title = {MedShapeNet--A Large-Scale Dataset of 3D Medical Shapes for Computer Vision},
    journal={arXiv preprint arXiv:2308.16139},
	doi = {10.48550/arXiv.2308.16139},
	author = {Li, Jianning and Zhou, Zongwei and Yang, Jiancheng and Pepe, Antonio and Gsaxner, Christina and Luijten, Gijs and others},
	year = {2023},
}

Project details


Download files

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

Source Distribution

medshapenet-0.1.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

MedShapeNet-0.1.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file medshapenet-0.1.0.tar.gz.

File metadata

  • Download URL: medshapenet-0.1.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for medshapenet-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f12770c5787482c604c717fb3b2ef6cd0adf58a5b8b967ef94eca42c2dff550d
MD5 d62ef9a887a6d75abd6c3f673f6ef9fc
BLAKE2b-256 055b306616e06f303d532f6c8459dc88ea12f60afe9180bc63b0575b96e03dfc

See more details on using hashes here.

File details

Details for the file MedShapeNet-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: MedShapeNet-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for MedShapeNet-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21b1c7f6aa6d4b838693769b90fbc723f5af63750571626b059ab3654da88e43
MD5 bd808771385a54eefc9586cab15d24d4
BLAKE2b-256 8ed574e6c453a33e17abc7191ef341e603401a0b1313366d3b0ea4551f0ffae5

See more details on using hashes here.

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