rapidtide 3.0.9__py3-none-any.whl → 3.0.11__py3-none-any.whl

rapidtide/io.py

@@ -1263,6 +1263,10 @@ def readlabelledtsv(inputfilename, compressed=False):
         theext = ".tsv.gz"
     else:
         theext = ".tsv"
+
+    if not os.path.isfile(inputfilename + theext):
+        raise FileNotFoundError(f"Labelled tsv file {inputfilename + theext} does not exist")
+
     df = pd.read_csv(inputfilename + theext, sep="\t", quotechar='"')
 
     # replace nans with 0
@@ -1290,6 +1294,9 @@ def readcsv(inputfilename, debug=False):
     NOTE:  If file does not exist or is not valid, return an empty dictionary
 
     """
+    if not os.path.isfile(inputfilename + ".csv"):
+        raise FileNotFoundError(f"csv file {inputfilename}.csv does not exist")
+
     timeseriesdict = {}
 
     # Read the data in initially with no header
@@ -1341,6 +1348,9 @@ def readfslmat(inputfilename, debug=False):
     NOTE:  If file does not exist or is not valid, return an empty dictionary
 
     """
+    if not os.path.isfile(inputfilename + ".mat"):
+        raise FileNotFoundError(f"FSL mat file {inputfilename}.mat does not exist")
+
     timeseriesdict = {}
 
     # Read the data in with no header
@@ -1364,8 +1374,7 @@ def readoptionsfile(inputfileroot):
         # options saved as text
         thedict = readdict(inputfileroot + ".txt")
     else:
-        print("no valid options file found")
-        return {}
+        raise FileNotFoundError(f"options file {inputfileroot}(.json/.txt) does not exist")
 
     # correct behavior for older options files
     try:
@@ -1476,7 +1485,7 @@ def writebidstsv(
         reshapeddata = data
     if append:
         insamplerate, instarttime, incolumns, indata, incompressed, incolsource = readbidstsv(
-            outputfileroot + ".json", debug=debug
+            outputfileroot + ".json", neednotexist=True, debug=debug,
         )
         if debug:
             print("appending")
@@ -1723,7 +1732,7 @@ def readvectorsfromtextfile(fullfilespec, onecol=False, debug=False):
     return thesamplerate, thestarttime, thecolumns, thedata, compressed, filetype
 
 
-def readbidstsv(inputfilename, colspec=None, warn=True, debug=False):
+def readbidstsv(inputfilename, colspec=None, warn=True, neednotexist=False, debug=False):
     r"""Read time series out of a BIDS tsv file
 
     Parameters
@@ -1890,11 +1899,13 @@ def readbidstsv(inputfilename, colspec=None, warn=True, debug=False):
                 columnsource,
             )
     else:
-        print("file pair does not exist")
-        return [None, None, None, None, None, None]
+        if neednotexist:
+            return [None, None, None, None, None, None]
+        else:
+            raise FileNotFoundError(f"file pair {thefileroot}(.json/.tsv[.gz]) does not exist")
 
 
-def readcolfrombidstsv(inputfilename, columnnum=0, columnname=None, debug=False):
+def readcolfrombidstsv(inputfilename, columnnum=0, columnname=None, neednotexist=False, debug=False):
     r"""
 
     Parameters
@@ -1908,7 +1919,7 @@ def readcolfrombidstsv(inputfilename, columnnum=0, columnname=None, debug=False)
 
     """
     samplerate, starttime, columns, data, compressed, colsource = readbidstsv(
-        inputfilename, debug=debug
+        inputfilename, neednotexist=neednotexist, debug=debug
     )
     if data is None:
         print("no valid datafile found")

rapidtide/simFuncClasses.py

@@ -694,9 +694,9 @@ class SimilarityFunctionFitter:
                 while peakpoints[peakstart - 1] == 1:
                     peakstart -= 1
             else:
-                while thegrad[peakend + 1] <= 0.0 and peakpoints[peakend + 1] == 1:
+                while thegrad[peakend + 1] <= 0.0 and peakpoints[peakend + 1] == 1 and peakend < len(self.corrtimeaxis) - 2:
                     peakend += 1
-                while thegrad[peakstart - 1] >= 0.0 and peakpoints[peakstart - 1] == 1:
+                while thegrad[peakstart - 1] >= 0.0 and peakpoints[peakstart - 1] == 1 and peakstart >= 1:
                     peakstart -= 1
             if self.debug:
                 print("final peakstart, peakend:", peakstart, peakend)
@@ -819,12 +819,18 @@ class SimilarityFunctionFitter:
                 if self.debug:
                     print("fit input array:", p0)
                 try:
-                    plsq, dummy = sp.optimize.leastsq(
+                    plsq, ier = sp.optimize.leastsq(
                         tide_fit.gaussresiduals, p0, args=(data, X), maxfev=5000
                     )
-                    maxval = plsq[0] + baseline
-                    maxlag = np.fmod((1.0 * plsq[1]), self.lagmod)
-                    maxsigma = plsq[2]
+                    if ier not in [1, 2, 3, 4]:  # Check for successful convergence
+                        failreason |= self.FML_FITALGOFAIL
+                        maxval = np.float64(0.0)
+                        maxlag = np.float64(0.0)
+                        maxsigma = np.float64(0.0)
+                    else:
+                        maxval = plsq[0] + baseline
+                        maxlag = np.fmod((1.0 * plsq[1]), self.lagmod)
+                        maxsigma = plsq[2]
                 except:
                     failreason |= self.FML_FITALGOFAIL
                     maxval = np.float64(0.0)
@@ -929,7 +935,7 @@ class SimilarityFunctionFitter:
                 # different rules for mutual information peaks
                 if ((maxval - baseline) < self.lthreshval * baselinedev) or (maxval < baseline):
                     failreason |= self.FML_FITAMPLOW
-                    maxval_init = 0.0
+                    maxval = 0.0
                     if self.debug:
                         if (maxval - baseline) < self.lthreshval * baselinedev:
                             print(

rapidtide/tests/.coveragerc

@@ -6,17 +6,23 @@ sigterm = true
 source = .
 omit =
     __init__.py
-    ../__init__.py
-    ../scripts/__init__.py
-    ../OrthoImageItem.py
-    ../wiener2.py
-    ../tidepoolTemplate.py
-    ../tidepoolTemplate_qt6.py
-    ../tidepoolTemplate_alt.py
-    ../tidepoolTemplate_alt_qt6.py
-    ../tidepoolTemplate_big.py
-    ../tidepoolTemplate_big_qt6.py
-    ../notreadyforprimetime/*
+    scripts/__init__.py
+    OrthoImageItem.py
+    wiener2.py
+    fMRIData_class.py
+    tidepoolTemplate.py
+    tidepoolTemplate_qt6.py
+    tidepoolTemplate_alt.py
+    tidepoolTemplate_alt_qt6.py
+    tidepoolTemplate_big.py
+    tidepoolTemplate_big_qt6.py
+    */tidepool.py
+    */delayvar.py
+    */variabilityizer.py
+    */synthASL.py
+    */proj2flow.py
+    */adjustoffset.py
+    notreadyforprimetime/*
 
 [report]
 exclude_lines = 

rapidtide/tests/test_findmaxlag.py

@@ -26,7 +26,7 @@ import numpy as np
 import rapidtide.fit as tide_fit
 import rapidtide.io as tide_io
 import rapidtide.simFuncClasses as tide_simFuncClasses
-from rapidtide.tests.utils import get_examples_path
+from rapidtide.tests.utils import get_examples_path, get_test_temp_path
 
 
 def dumplists(results, targets, failflags):
@@ -39,7 +39,12 @@ def dumplists(results, targets, failflags):
         print(results[i], targets[i], failflags[i])
 
 
-def eval_fml_result(absmin, absmax, testvalues, foundvalues, failflags, tolerance=0.0001):
+def eval_fml_result(absmin, absmax, testvalues, foundvalues, failflags, tolerance=0.0001, debug=False):
+    if debug:
+        print(f"{absmin=}, {absmax=}, {tolerance=}")
+        print(f"{testvalues=}")
+        print(f"{foundvalues=}")
+        print(f"{failflags=}")
     for i in range(len(testvalues)):
         if testvalues[i] < absmin:
             if foundvalues[i] != absmin:
@@ -61,12 +66,22 @@ def eval_fml_result(absmin, absmax, testvalues, foundvalues, failflags, toleranc
     return True
 
 
-def test_findmaxlag(displayplots=False, debug=False):
+def test_findmaxlag(displayplots=False, local=False, debug=False):
+    # set input and output directories
+    if local:
+        exampleroot = "../data/examples/src"
+        testtemproot = "./tmp"
+    else:
+        exampleroot = get_examples_path()
+        testtemproot = get_test_temp_path()
+
+    if debug:
+        print("debug flag is set")
     # for fittype in ["gauss", "quad", "fastquad", "COM", "None", "fastgauss", "gausscf"]:
     for fittype in ["gauss"]:
         print("*************************************")
         print(f"testing fittype: {fittype}")
-        textfilename = op.join(get_examples_path(), "lt_rt.txt")
+        textfilename = op.join(exampleroot, "lt_rt.txt")
 
         # set default variable values
         searchfrac = 0.75
@@ -172,16 +187,16 @@ def test_findmaxlag(displayplots=False, debug=False):
             for i in range(len(testlags)):
                 print(testlags[i], fml_maxlags[i], fml_lfailreasons[i])
 
-        assert eval_fml_result(lagmin, lagmax, testlags, fml_maxlags, fml_lfailreasons)
-        assert eval_fml_result(absminval, absmaxval, testvals, fml_maxvals, fml_lfailreasons)
+        assert eval_fml_result(lagmin, lagmax, testlags, fml_maxlags, fml_lfailreasons, debug=debug)
+        assert eval_fml_result(absminval, absmaxval, testvals, fml_maxvals, fml_lfailreasons, debug=debug)
         assert eval_fml_result(
-            absminsigma, absmaxsigma, testsigmas, fml_maxsigmas, fml_lfailreasons
+            absminsigma, absmaxsigma, testsigmas, fml_maxsigmas, fml_lfailreasons, debug=debug
         )
 
-        assert eval_fml_result(lagmin, lagmax, testlags, fmlc_maxlags, fmlc_lfailreasons)
-        assert eval_fml_result(absminval, absmaxval, testvals, fmlc_maxvals, fmlc_lfailreasons)
+        assert eval_fml_result(lagmin, lagmax, testlags, fmlc_maxlags, fmlc_lfailreasons, debug=debug)
+        assert eval_fml_result(absminval, absmaxval, testvals, fmlc_maxvals, fmlc_lfailreasons, debug=debug)
         assert eval_fml_result(
-            absminsigma, absmaxsigma, testsigmas, fmlc_maxsigmas, fmlc_lfailreasons
+            absminsigma, absmaxsigma, testsigmas, fmlc_maxsigmas, fmlc_lfailreasons, debug=debug
         )
 
         if displayplots:
@@ -315,19 +330,19 @@ def test_findmaxlag(displayplots=False, debug=False):
             ax.legend(["findmaxlag_gauss", "classes"])
             plt.show()
 
-        assert eval_fml_result(lagmin, lagmax, testlags, fml_maxlags, fml_wfailreasons)
+        assert eval_fml_result(lagmin, lagmax, testlags, fml_maxlags, fml_wfailreasons, debug=debug)
         # assert eval_fml_result(absminval, absmaxval, testvals, fml_maxvals, fml_wfailreasons)
         assert eval_fml_result(
-            absminsigma, absmaxsigma, testsigmas, fml_maxsigmas, fml_wfailreasons
+            absminsigma, absmaxsigma, testsigmas, fml_maxsigmas, fml_wfailreasons, debug=debug
         )
 
-        assert eval_fml_result(lagmin, lagmax, testlags, fmlc_maxlags, fmlc_wfailreasons)
-        assert eval_fml_result(absminval, absmaxval, testvals, fmlc_maxvals, fmlc_wfailreasons)
+        assert eval_fml_result(lagmin, lagmax, testlags, fmlc_maxlags, fmlc_wfailreasons, debug=debug)
+        assert eval_fml_result(absminval, absmaxval, testvals, fmlc_maxvals, fmlc_wfailreasons, debug=debug)
         assert eval_fml_result(
-            absminsigma, absmaxsigma, testsigmas, fmlc_maxsigmas, fmlc_wfailreasons
+            absminsigma, absmaxsigma, testsigmas, fmlc_maxsigmas, fmlc_wfailreasons, debug=debug
         )
 
 
 if __name__ == "__main__":
     mpl.use("TkAgg")
-    test_findmaxlag(displayplots=True, debug=True)
+    test_findmaxlag(displayplots=True, local=True, debug=True)

rapidtide/tests/test_padvec.py

@@ -63,6 +63,23 @@ def maketestwaves(timeaxis):
             "waveform": 1.0 * scratch,
         }
     )
+
+    scratch = np.exp(-timeaxis / timeaxis[2])
+    testwaves.append(
+        {
+            "name": "damped exponential regressor",
+            "timeaxis": 1.0 * timeaxis,
+            "waveform": 1.0 * scratch,
+        }
+    )
+
+    testwaves.append(
+        {
+            "name": "white noise plus exponential",
+            "timeaxis": 1.0 * timeaxis,
+            "waveform": 0.3 * np.random.normal(size=tclen) + scratch,
+        }
+    )
     return testwaves
 
 
@@ -89,7 +106,7 @@ def eval_padvecprops(
     nperseg = np.min([tclen, 2048])
     f, dummy = sp.signal.welch(overall, fs=1.0 / sampletime, nperseg=nperseg)
 
-    padtypelist = ["reflect", "zero", "constant", "constant+"]
+    padtypelist = ["reflect", "zero", "cyclic", "constant", "constant+"]
     transferfunclist = ["brickwall", "trapezoidal", "butterworth"]
 
     # construct some test waveforms for end effects
@@ -184,6 +201,7 @@ def eval_padvecprops(
                     legend.append(thewave["name"] + ": " + thefilter["name"])
                     offset += 1.25
                 plt.legend(legend)
+                plt.title(padtype)
                 plt.show()
 
 

rapidtide/tests/test_simroundtrip.py

@@ -0,0 +1,124 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+#   Copyright 2016-2025 Blaise Frederick
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+import os
+
+import matplotlib as mpl
+
+import rapidtide.io as tide_io
+import rapidtide.workflows.parser_funcs as pf
+import rapidtide.workflows.rapidtide as rapidtide_workflow
+import rapidtide.workflows.rapidtide_parser as rapidtide_parser
+import rapidtide.workflows.simdata as rapidtide_simdata
+from rapidtide.tests.utils import get_examples_path, get_test_temp_path
+
+
+def test_simroundtrip(debug=False, local=False, displayplots=False):
+    # set input and output directories
+    if local:
+        exampleroot = "../data/examples/src"
+        testtemproot = "./tmp"
+    else:
+        exampleroot = get_examples_path()
+        testtemproot = get_test_temp_path()
+
+
+    # run initial rapidtide
+    inputargs = [
+        os.path.join(exampleroot, "sub-RAPIDTIDETEST.nii.gz"),
+        os.path.join(testtemproot, "sub-RAPIDTIDETESTSIM"),
+        "--spatialfilt",
+        "2",
+        "--simcalcrange",
+        "4",
+        "-1",
+        "--nprocs",
+        "-1",
+        "--passes",
+        "2",
+        "--despecklepasses",
+        "3",
+        "--delaypatchthresh",
+        "4.0",
+    ]
+    rapidtide_workflow.rapidtide_main(rapidtide_parser.process_args(inputargs=inputargs))
+
+    # now simulate data from maps
+    print(testtemproot)
+    inputargs = [
+        "1.5",
+        "260",
+        os.path.join( testtemproot, "sub-RAPIDTIDETESTSIM_desc-unfiltmean_map.nii.gz"),
+        os.path.join( testtemproot, "simulatedfmri_vn05"),
+        "--lfopctfile",
+        os.path.join( testtemproot, "sub-RAPIDTIDETESTSIM_desc-maxcorr_map.nii.gz"),
+        "--lfolagfile",
+        os.path.join( testtemproot, "sub-RAPIDTIDETESTSIM_desc-maxtimerefined_map.nii.gz"),
+        "--lforegressor",
+        os.path.join(testtemproot, "sub-RAPIDTIDETESTSIM_desc-movingregressor_timeseries.json:pass2"),
+        "--voxelnoiselevel",
+        "5.0"
+    ]
+
+    pf.generic_init(rapidtide_simdata._get_parser, rapidtide_simdata.simdata, inputargs=inputargs)
+
+    # run repeat rapidtide
+    inputargs = [
+        os.path.join(testtemproot, "simulatedfmri_vn05.nii.gz"),
+        os.path.join(testtemproot, "sub-RAPIDTIDETESTSIMRERUN"),
+        "--spatialfilt",
+        "2",
+        "--simcalcrange",
+        "4",
+        "-1",
+        "--nprocs",
+        "-1",
+        "--passes",
+        "2",
+        "--despecklepasses",
+        "3",
+        "--delaypatchthresh",
+        "4.0",
+    ]
+    rapidtide_workflow.rapidtide_main(rapidtide_parser.process_args(inputargs=inputargs))
+
+    absthresh = 1e-10
+    msethresh = 1e-12
+    spacetolerance = 1e-3
+    """for map in [
+        "maxtime",
+        "maxtimerefined",
+        "lfofilterCoeff",
+    ]:
+        print(f"Testing map={map}")
+        filename1 = os.path.join(testtemproot, f"sub-RAPIDTIDETESTSIM_desc-{map}_map.nii.gz")
+        filename2 = os.path.join(testtemproot, f"sub-RAPIDTIDETESTSIMRERUN_desc-{map}_map.nii.gz")
+        assert tide_io.checkniftifilematch(
+            filename1,
+            filename2,
+            absthresh=absthresh,
+            msethresh=msethresh,
+            spacetolerance=spacetolerance,
+            debug=debug,
+        )"""
+
+
+
+if __name__ == "__main__":
+    mpl.use("TkAgg")
+    test_simroundtrip(debug=True, local=True, displayplots=True)