Skip to content

Commit

Permalink
API: Change deltaf_raw shape to be (1, time)
Browse files Browse the repository at this point in the history
Add an extra dimension so the axes align with other attributes.
  • Loading branch information
scottclowe committed Jun 26, 2021
1 parent d3bc2a6 commit ad6e055
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions fissa/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -318,14 +318,18 @@ class Experiment():
deltaf_raw : :class:`numpy.ndarray`
A :class:`numpy.ndarray` of shape ``(n_rois, n_trials)``, each element
of which is itself a :class:`numpy.ndarray` shaped ``(n_timepoint, )``.
of which is itself a :class:`numpy.ndarray` shaped ``(1, n_timepoint)``.
The amount of change in fluorence relative to the baseline fluorence
(Δf/f\ :sub:`0`).
This field is only populated after :meth:`calc_deltaf` has been run;
until then, it is set to ``None``.
.. versionchanged:: 1.0.0
The shape of the interior arrays changed from ``(n_timepoint, )``
to ``(1, n_timepoint)``.
deltaf_result : :class:`numpy.ndarray`
A :class:`numpy.ndarray` of shape ``(n_rois, n_trials)``, each element
of which is itself a :class:`numpy.ndarray` shaped
Expand Down Expand Up @@ -804,7 +808,7 @@ def calc_deltaf(self, freq, use_raw_f0=True, across_trials=True):
for trial in range(self.nTrials):
nextTrial = curTrial + self.raw[cell][trial].shape[1]
signal = raw_conc[curTrial:nextTrial]
deltaf_raw[cell][trial] = signal
deltaf_raw[cell][trial] = np.expand_dims(signal, axis=0)
signal = result_conc[:, curTrial:nextTrial]
deltaf_result[cell][trial] = signal
curTrial = nextTrial
Expand All @@ -828,7 +832,7 @@ def calc_deltaf(self, freq, use_raw_f0=True, across_trials=True):
result_sig = (result_sig - result_f0) / result_f0

# store deltaf/f0s
deltaf_raw[cell][trial] = raw_sig
deltaf_raw[cell][trial] = np.expand_dims(raw_sig, axis=0)
deltaf_result[cell][trial] = result_sig

self.deltaf_raw = deltaf_raw
Expand Down

0 comments on commit ad6e055

Please sign in to comment.