From 69c5bd17abdbc84e418adf2fc7983538727172e0 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Tue, 29 Mar 2022 17:28:34 +0100
Subject: [PATCH] DOC: some clarifications
---
fsl/data/image.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/fsl/data/image.py b/fsl/data/image.py
index a9dce5de2..fc0f40c50 100644
--- a/fsl/data/image.py
+++ b/fsl/data/image.py
@@ -1009,7 +1009,10 @@ class Image(Nifti):
2. As soon as any data is modified, the ``Image`` class will
load the image data as a numpy array into memory and will maintain its
- own reference to the array for subsequent access.
+ own reference to the array for subsequent access. Note that this
+ array is entirely independent of any array that is cached by
+ the underlying ``nibabel.Nifti1Image`` object (refer to
+ https://nipy.org/nibabel/images_and_memory.html)
3. For more complicated requirements, a :class:`DataManager`,
implementing custom data access management logic, can be provided when
@@ -1024,6 +1027,7 @@ class Image(Nifti):
- will not result in any notifications (described below)
- will not affect the value of :meth:`saveState`
+ - have undefined semantics when a custom :class:`DataManager` is in use
The ``Image`` class adds some :class:`.Notifier` topics to those which are
--
GitLab