Skip to content

ghisvail/pydra-templateflow

Repository files navigation

pydra-templateflow

PyPI - Version PyPI - Python Version PyPI - Downloads


Pydra tasks for TemplateFlow.

Pydra is a dataflow engine which provides a set of lightweight abstractions for DAG construction, manipulation, and distributed execution.

TemplateFlow provides a framework for publicly hosting and distributing neuroimaging templates for human and nonhuman brains.

Table of contents

Available tasks

This package provides a get_template task, which takes a template_id argument and a output_queries mapping from output names to their respective file queries.

The following example showcases using get_template to download the template image, brain and head masks for the Linear ICBM Average Brain (ICBM152).

from pydra.tasks import templateflow

task = templateflow.get_template(
    template_id="MNI152Lin",
    output_queries={
        "brain_mask": {"resolution": "1", "suffix": "mask", "desc": "head"},
        "head_mask": {"resolution": "1", "suffix": "mask", "desc": "brain"},
        "t1w_image": {"resolution": "1", "suffix": "T1w"},
    },
)

result = task()

# result.output.brain_mask
# result.output.head_mask
# result.output.t1w_image

Please check the list of available templates here.

Installation

pip install pydra-templateflow

Development

This project is managed with Hatch:

pipx install hatch

To run the test suite:

hatch run test

To fix linting issues:

hatch run lint:fix

License

This project is distributed under the terms of the Apache License, Version 2.0.