niworkflows.data package

Niworkflows data files

niworkflows.data.load(*segments: str) → Path

Load package files relative to niworkflows.data.

This package contains the following (top-level) files/directories:

• antsBrainExtractionNoLaplacian_precise.json

• antsBrainExtractionNoLaplacian_testing.json

• antsBrainExtraction_precise.json

• antsBrainExtraction_testing.json

• boldref-mni_registration_precise_000.json

• boldref-mni_registration_precise_001.json

• boldref-mni_registration_precise_002.json

• boldref-mni_registration_testing_000.json

• boldref-mni_registration_testing_001.json

• boldref-mni_registration_testing_002.json

• epi_atlasbased_brainmask.json

• itkIdentityTransform.txt

• nipreps.json

• sentinel.nii.gz

• t1w-mni_registration_fast_000.json

• t1w-mni_registration_precise_000.json

• t1w-mni_registration_precise_001.json

• t1w-mni_registration_precise_002.json

• t1w-mni_registration_testing_000.json

• t1w-mni_registration_testing_001.json

• t1w-mni_registration_testing_002.json

load.readable(*segments: str) → Traversable

Provide read access to a resource through a Path-like interface.

This file may or may not exist on the filesystem, and may be efficiently used for read operations, including directory traversal.

This result is not cached or copied to the filesystem in cases where that would be necessary.

load.as_path(*segments: str) → AbstractContextManager[Path]

Ensure data is available as a Path.

This method generates a context manager that yields a Path when entered.

This result is not cached, and any temporary files that are created are deleted when the context is exited.

load.cached(*segments: str) → Path

Ensure data resource is available as a Path.

Any temporary files that are created remain available throughout the duration of the program, and are deleted when Python exits.

Results are cached so that multiple calls do not unpack the same data multiple times, but directories and their contents being requested separately may result in some duplication.