Skip to main content

Nyxus

Documentation Status PyPI PyPI Downloads Conda Conda Downloads

Nyxus computes intensity, texture, morphology and image quality features for every region of interest (ROI) in 2D images and 3D volumes: 758 features in all, 539 for 2D images, 213 for 3D volumes and 6 image quality features. It runs from Python or the command line, reads TIFF, OME-TIFF, OME-Zarr, NIfTI and DICOM files (OME-TIFF and OME-Zarr with up to five dimensions), and assembles ROIs that span several image tiles. Each feature's validation against reference tools such as PyRadiomics, MIRP, MATLAB and CellProfiler is listed in the documentation.

ROIs larger than the memory budget are processed out of core when they come from files; which features then keep their in-memory values is listed under large images.

The Nyxus pipeline

Documentation: https://nyxus.readthedocs.io

Installation

pip install nyxus

or

conda install nyxus -c conda-forge

The conda-forge package has no build for Apple Silicon Macs or Linux aarch64; use pip there. On Windows, the PyPI wheels do not read OME-Zarr or compressed NIfTI (.nii.gz), and the conda-forge packages of 0.11.0 need Visual Studio installed (they were built in Debug mode). GPU wheels, the Docker image and building from source are described in Installation.

Quick start

2D, from arrays in memory

import numpy as np
from nyxus import Nyxus

intensity = np.array([[1, 4, 4, 1],
                      [1, 4, 6, 1],
                      [4, 1, 6, 4],
                      [4, 4, 6, 4]], dtype=np.uint16)
labels = np.array([[1, 1, 0, 2],
                   [1, 1, 0, 2],
                   [1, 1, 0, 2],
                   [1, 1, 0, 2]], dtype=np.uint32)

nyx = Nyxus(["*ALL_INTENSITY*"])
features = nyx.featurize(intensity, labels)
print(features[["ROI_label", "MEAN", "MAX"]])

A directory of image files and their label images is featurized with nyx.featurize_directory("intensities/", "labels/").

3D, from volume files

This example writes its volume with tifffile (pip install tifffile).

import numpy as np
import tifffile
from nyxus import Nyxus3D

volume = np.random.default_rng(0).integers(1, 100, size=(8, 32, 32), dtype=np.uint16)
labels = np.zeros_like(volume)
labels[2:6, 8:24, 8:24] = 1
tifffile.imwrite("volume.ome.tif", volume, ome=True, metadata={"axes": "ZYX"})
tifffile.imwrite("labels.ome.tif", labels, ome=True, metadata={"axes": "ZYX"})

nyx = Nyxus3D(["*3D_ALL_INTENSITY*"])
features = nyx.featurize_files(["./volume.ome.tif"], ["./labels.ome.tif"], False)
print(features[["ROI_label", "3MEAN", "3MAX"]])

Command line

The Python packages do not include the command-line program; run it from the Docker image or build it from source (see Installation). The output directory must already exist.

nyxus --features="*ALL_INTENSITY*,*ALL_MORPHOLOGY*" --intDir=/data/int --segDir=/data/seg --outDir=/data/out --outputType=singlecsv

Where to go next

Citing Nyxus

If you use Nyxus in your work, please cite it as described in CITATION.cff; GitHub's Cite this repository button gives APA and BibTeX.

License

Nyxus is released under the MIT License.

Metadata

Release files for nyxus-cuda12x 0.12.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for nyxus-cuda12x 0.12.1
File Actions
nyxus_cuda12x-0.12.1-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for nyxus_cuda12x-0.12.1-cp313-cp313-win_amd64.whl
nyxus_cuda12x-0.12.1-cp313-cp313-manylinux_2_28_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.28+ x86-64 Details for nyxus_cuda12x-0.12.1-cp313-cp313-manylinux_2_28_x86_64.whl
nyxus_cuda12x-0.12.1-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for nyxus_cuda12x-0.12.1-cp312-cp312-win_amd64.whl
nyxus_cuda12x-0.12.1-cp312-cp312-manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64 Details for nyxus_cuda12x-0.12.1-cp312-cp312-manylinux_2_28_x86_64.whl
nyxus_cuda12x-0.12.1-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for nyxus_cuda12x-0.12.1-cp311-cp311-win_amd64.whl
nyxus_cuda12x-0.12.1-cp311-cp311-manylinux_2_28_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.28+ x86-64 Details for nyxus_cuda12x-0.12.1-cp311-cp311-manylinux_2_28_x86_64.whl
nyxus_cuda12x-0.12.1-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for nyxus_cuda12x-0.12.1-cp310-cp310-win_amd64.whl
nyxus_cuda12x-0.12.1-cp310-cp310-manylinux_2_28_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.28+ x86-64 Details for nyxus_cuda12x-0.12.1-cp310-cp310-manylinux_2_28_x86_64.whl

Total release size: 146.4 MB

Release files / nyxus_cuda12x-0.12.1-cp313-cp313-win_amd64.whl

Download URL nyxus_cuda12x-0.12.1-cp313-cp313-win_amd64.whl
Size 10.0 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
5972f8a2c7435f11cd2565fd2a2a23496d3743850c7607e072a8cec9b39e3d55
BLAKE2b-256 checksum
How to use checksums
2644a39a57d9449f53f38652e722ae38e7ac0b8d8e723a60238f1b9fdc4a2d82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / nyxus_cuda12x-0.12.1-cp313-cp313-manylinux_2_28_x86_64.whl

Download URL nyxus_cuda12x-0.12.1-cp313-cp313-manylinux_2_28_x86_64.whl
Size 26.6 MB
Tags CPython 3.13 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
e29885574620b21f8e56cf9d1caf95c7ca27a3e7e5ba46a17a88ccc30310002f
BLAKE2b-256 checksum
How to use checksums
a3cf4cd49c5a6c538073027bd31846fd10936a9175de073786e48899f8db5e43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Release files / nyxus_cuda12x-0.12.1-cp312-cp312-win_amd64.whl

Download URL nyxus_cuda12x-0.12.1-cp312-cp312-win_amd64.whl
Size 10.0 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
ec2784ee3d9016a141c220265ede27cc2d9316dbdd3bfb92ef93bff897a49710
BLAKE2b-256 checksum
How to use checksums
5333fe94f3ed2f11d360009e9f79ef7ea17205321daa47e726e81333ede3cb99
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / nyxus_cuda12x-0.12.1-cp312-cp312-manylinux_2_28_x86_64.whl

Download URL nyxus_cuda12x-0.12.1-cp312-cp312-manylinux_2_28_x86_64.whl
Size 26.6 MB
Tags CPython 3.12 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
b3d7f2f13719a37ee2c95dfcab1e840a309f655caf43b67be797103120e89303
BLAKE2b-256 checksum
How to use checksums
722801b3d160d4ea70794d57b60b090be32243bd45cf5b8bb54c7cc83f65975a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Release files / nyxus_cuda12x-0.12.1-cp311-cp311-win_amd64.whl

Download URL nyxus_cuda12x-0.12.1-cp311-cp311-win_amd64.whl
Size 10.0 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
06c31f4734e942af09ef9f31ae54128c676ab086454a916811bbf2bade55685c
BLAKE2b-256 checksum
How to use checksums
f44440011669a4c43380397c58c14534ca76c44ce4ce092b7d6e6da56fa5262f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / nyxus_cuda12x-0.12.1-cp311-cp311-manylinux_2_28_x86_64.whl

Download URL nyxus_cuda12x-0.12.1-cp311-cp311-manylinux_2_28_x86_64.whl
Size 26.6 MB
Tags CPython 3.11 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
f01822fd6cc09e77f6ec928c07cf4db67be4f3b6b48f021e5ee5594b99980180
BLAKE2b-256 checksum
How to use checksums
cda9c89c28d7f4a825400933bfa2613d002285072d52f3f22fb9d101be3bfdc5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Release files / nyxus_cuda12x-0.12.1-cp310-cp310-win_amd64.whl

Download URL nyxus_cuda12x-0.12.1-cp310-cp310-win_amd64.whl
Size 10.0 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
6f3437cc5414cefe03b692c6984cd4aca2b6bd9c84e3f3b1e1bce727e0b38d02
BLAKE2b-256 checksum
How to use checksums
3900292f2364ba4b565e7fe37e4138a14fda7825d741ccf67890773b903b089f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / nyxus_cuda12x-0.12.1-cp310-cp310-manylinux_2_28_x86_64.whl

Download URL nyxus_cuda12x-0.12.1-cp310-cp310-manylinux_2_28_x86_64.whl
Size 26.6 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
5018c111309638e59b349053e3a091012ecbf6ef98212176689f8b31d7fa9f68
BLAKE2b-256 checksum
How to use checksums
59e1f5b808e424fce4f4a680cca723675b218b7626ec7174e37577cfda94990b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Security for nyxus-cuda12x 0.12.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page