From 5a391150a575111ff6d0dcbcc254fde43687fe30 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Tue, 4 Dec 2018 08:54:09 +0000
Subject: [PATCH] ENH: New module fsl.data.utils, which currently contains one
function for guessing the data type of a file/directory path.
---
fsl/data/__init__.py | 3 ++
fsl/data/utils.py | 79 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 82 insertions(+)
create mode 100644 fsl/data/utils.py
diff --git a/fsl/data/__init__.py b/fsl/data/__init__.py
index 29f4c3435..c1890b375 100644
--- a/fsl/data/__init__.py
+++ b/fsl/data/__init__.py
@@ -7,3 +7,6 @@
"""This module contains various data types and associated I/O routines,
models, constants, and other data-like things used throughout ``fslpy``.
"""
+
+
+from .utils import guessType # noqa
diff --git a/fsl/data/utils.py b/fsl/data/utils.py
new file mode 100644
index 000000000..e0fae151e
--- /dev/null
+++ b/fsl/data/utils.py
@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+#
+# utils.py - Miscellaneous utility functions
+#
+# Author: Paul McCarthy <pauldmccarthy@gmail.com>
+#
+"""This module is home to some miscellaneous utility functions for working
+with the data types defined in the :mod:`fsl.data` package.
+"""
+
+
+import os.path as op
+
+
+def guessType(path):
+ """A convenience function which, given the name of a file or directory,
+ attempts to figure out a suitable data type.
+
+ Returns a tuple containing two values - a type which should be able to
+ load the path, and the path itself, possibly adjusted. If the type
+ is unrecognised, the first tuple value will be ``None``.
+ """
+
+ import fsl.utils.path as fslpath
+ import fsl.data.image as fslimage
+ import fsl.data.vtk as fslvtk
+ import fsl.data.gifti as fslgifti
+ import fsl.data.freesurfer as fslfs
+ import fsl.data.mghimage as fslmgh
+ import fsl.data.featimage as featimage
+ import fsl.data.melodicimage as melimage
+ import fsl.data.dtifit as dtifit
+ import fsl.data.melodicanalysis as melanalysis
+ import fsl.data.featanalysis as featanalysis
+
+ # Support files opened via fsleyes:// URL
+ if path.startswith('fsleyes://'):
+ path = path[10:]
+
+ path = op.abspath(path)
+
+ # Accept images sans-extension
+ try:
+ path = fslimage.addExt(path, mustExist=True)
+ except fslimage.PathError:
+ pass
+
+ if op.isfile(path):
+
+ # Some types are easy - just check the extensions
+ if fslpath.hasExt(path, fslvtk.ALLOWED_EXTENSIONS):
+ return fslvtk.VTKMesh, path
+ elif fslpath.hasExt(path, fslgifti.ALLOWED_EXTENSIONS):
+ return fslgifti.GiftiMesh, path
+ elif fslfs.isGeometryFile(path):
+ return fslfs.FreesurferMesh, path
+ elif fslpath.hasExt(path, fslmgh.ALLOWED_EXTENSIONS):
+ return fslmgh.MGHImage, path
+
+ # Other specialised image types
+ elif melanalysis .isMelodicImage(path):
+ return melimage.MelodicImage, path
+ elif featanalysis.isFEATImage( path):
+ return featimage.FEATImage, path
+ elif fslimage.looksLikeImage(path):
+ return fslimage.Image, path
+
+ # Analysis directory?
+ elif op.isdir(path):
+ if melanalysis.isMelodicDir(path):
+ return melimage.MelodicImage, path
+ elif featanalysis.isFEATDir(path):
+ return featimage.FEATImage, path
+ elif dtifit.isDTIFitPath(path):
+ return dtifit.DTIFitTensor, path
+
+ # Otherwise, I don't
+ # know what to do
+ return None, path
--
GitLab