From d6b11c3392d3515e00a808ccf4fe82f2c7536ffc Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Tue, 24 Mar 2020 18:00:35 +0000
Subject: [PATCH] RF: note about differences between Image and nibabel

---
 advanced_topics/08_fslpy.ipynb | 8 ++++++++
 advanced_topics/08_fslpy.md    | 8 ++++++++
 2 files changed, 16 insertions(+)

diff --git a/advanced_topics/08_fslpy.ipynb b/advanced_topics/08_fslpy.ipynb
index 4e073c4..92d917e 100644
--- a/advanced_topics/08_fslpy.ipynb
+++ b/advanced_topics/08_fslpy.ipynb
@@ -191,6 +191,14 @@
     "- Ability to load metadata from BIDS sidecar files\n",
     "\n",
     "\n",
+    "> The `Image` class behaves differently to the `nibabel.Nifti1Image`. For\n",
+    "> example, when you create an `Image` object, the default behaviour is to load\n",
+    "> the image data into memory. This is configurable however; take a look at\n",
+    "> [the\n",
+    "> documentation](https://users.fmrib.ox.ac.uk/~paulmc/fsleyes/fslpy/latest/fsl.data.image.html#fsl.data.image.Image)\n",
+    "> to explore all of the options.\n",
+    "\n",
+    "\n",
     "Some simple image processing routines are also provided - these are covered\n",
     "[below](#image-processing).\n",
     "\n",
diff --git a/advanced_topics/08_fslpy.md b/advanced_topics/08_fslpy.md
index 0f54aba..798cfdb 100644
--- a/advanced_topics/08_fslpy.md
+++ b/advanced_topics/08_fslpy.md
@@ -161,6 +161,14 @@ as:
 - Ability to load metadata from BIDS sidecar files
 
 
+> The `Image` class behaves differently to the `nibabel.Nifti1Image`. For
+> example, when you create an `Image` object, the default behaviour is to load
+> the image data into memory. This is configurable however; take a look at
+> [the
+> documentation](https://users.fmrib.ox.ac.uk/~paulmc/fsleyes/fslpy/latest/fsl.data.image.html#fsl.data.image.Image)
+> to explore all of the options.
+
+
 Some simple image processing routines are also provided - these are covered
 [below](#image-processing).
 
-- 
GitLab