kwneuro.external
================

.. py:module:: kwneuro.external


Classes
-------

.. autoapisummary::

   kwneuro.external.TemporaryDwiFiles


Functions
---------

.. autoapisummary::

   kwneuro.external.temporary_volume_file
   kwneuro.external.temporary_dwi_files
   kwneuro.external.temporary_structural_file


Module Contents
---------------

.. py:class:: TemporaryDwiFiles

   Temporary file paths for a DWI volume and FSL gradient sidecars.


   .. py:attribute:: volume
      :type:  pathlib.Path


   .. py:attribute:: bval
      :type:  pathlib.Path


   .. py:attribute:: bvec
      :type:  pathlib.Path


.. py:function:: temporary_volume_file(volume: kwneuro.resource.VolumeResource, *, filename: str = 'volume.nii.gz') -> collections.abc.Iterator[pathlib.Path]

   Write a volume to a temporary NIfTI file for an external file-based tool.


.. py:function:: temporary_dwi_files(dwi: kwneuro.dwi.Dwi, *, basename: str = 'dwi') -> collections.abc.Iterator[TemporaryDwiFiles]

   Write a DWI to temporary NIfTI/FSL files for an external file-based tool.


.. py:function:: temporary_structural_file(structural: kwneuro.structural.StructuralImage, *, filename: str = 'structural.nii.gz') -> collections.abc.Iterator[pathlib.Path]

   Write a structural image to a temporary NIfTI file for an external tool.