Skip to content

Commit ab0b0f7

Browse files
committed
Update links and tutorials
1 parent b91bb26 commit ab0b0f7

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ pip install --upgrade opticalmapping[all]
3838

3939
## Getting Started
4040

41-
See [Tutorials](https://optimap.readthedocs.io/en/latest/tutorials/basics/) and the [Getting Started](https://optimap.readthedocs.io/en/latest/chapters/getting_started/) guide for an introduction to optimap and installation instructions.
41+
See the [Getting Started](https://optimap.readthedocs.io/en/latest/chapters/getting_started/) guide and the [Tutorials](https://optimap.readthedocs.io/en/latest/tutorials/) for an introduction to optimap and installation instructions.
4242

4343
## About optimap
4444

45-
`optimap` is a script-based software, which means that you run Python-based analysis scripts rather than using a graphical user interface. We provide several example scripts which explain the usage of `optimap`, see [Tutorials](https://optimap.readthedocs.io/en/latest/tutorials/basics/). The example scripts can also be downloaded directly by clicking on the right link in the green box at the top of each tutorial page. `optimap` is developed by members of the [Cardiac Vision Laboratory](https://cardiacvision.ucsf.edu) at the [University of California, San Franicsco](https://www.ucsf.edu). `optimap` was created for cardiovascular scientists in particular, but might also be useful for scientists in other fields, for instance, when performing calcium imaging or physiological research with moving cells or tissues. `optimap` is open-source, freely available, and relies on open-source packages such as NumPy, SciPy, matplotlib and OpenCV.
45+
`optimap` is a script-based software, which means that you run Python-based analysis scripts rather than using a graphical user interface. We provide several example scripts which explain the usage of `optimap`, see [Tutorials](https://optimap.readthedocs.io/en/latest/tutorials/). The example scripts can also be downloaded directly by clicking on the right link in the green box at the top of each tutorial page. `optimap` is developed by members of the [Cardiac Vision Laboratory](https://cardiacvision.ucsf.edu) at the [University of California, San Franicsco](https://www.ucsf.edu). `optimap` was created for cardiovascular scientists in particular, but might also be useful for scientists in other fields, for instance, when performing calcium imaging or physiological research with moving cells or tissues. `optimap` is open-source, freely available, and relies on open-source packages such as NumPy, SciPy, matplotlib and OpenCV.
4646

4747
## Links
4848

docs/tutorials/basics.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@
112112
"\n",
113113
"The following file formats are currently supported by ``optimap``:\n",
114114
"\n",
115-
"* .tif, .tiff (TIFF stack or folder with a series of individual TIFFs)\n",
116-
"* .png (folder with a series of PNGs)\n",
115+
"* .tif, .tiff (TIFF) image stacks\n",
116+
"* Folder containing sequence of TIFF or .png (PNG) images\n",
117117
"* .gsd, .gsh (SciMedia MiCAM 05)\n",
118118
"* .rsh, .rsm, .rsd (SciMedia MiCAM ULTIMA)\n",
119119
"* .dat (MultiRecorder)\n",
120120
"* .npy (numpy array)\n",
121121
"* .mat (MATLAB), loads the first field in the file\n",
122122
"\n",
123-
"We can use the `optimap.load_video` function to load a video file, see also [Tutorial 13](io.ipynb). The code below will automatically download an example file from our website [cardiacvision.ucsf.edu](https://cardiacvision.ucsf.edu) and load it into our workspace as a video. Alternatively, you could load your own file by replacing `filepath` with the filename of your video which you have stored somewhere on your computer. After loading, the video corresponds to a three-dimensional `NumPy`-array where the first dimension is time and the other two dimensions are the x- and y-dimensions, respectively. The example file shows a fibrillating, weakly contracting rabbit heart stained with voltage-sensitive dye (Di-4-ANEPPS) imaged using a Basler acA720-520um camera at 500fps. Due to the staining, the action potential wave is inverted, i.e. an upstroke is observed as a negative deflection. The data is from {cite}`Chowdhary2023` and we extracted a short part of the original recording and saved the otherwise unprocessed raw video data as a numpy file (`.npy`). Experimenters: Jan Lebert, Shrey Chowdhary & Jan Christoph (University of California, San Francisco, USA), 2023."
123+
"We can use the {func}`optimap.load_video` function to load a video file, see also [Tutorial 13](io.ipynb). The code below will automatically download an example file from our website [cardiacvision.ucsf.edu](https://cardiacvision.ucsf.edu) and load it into our workspace as a video. Alternatively, you could load your own file by replacing `filepath` with the filename of your video which you have stored somewhere on your computer. The example file shows a fibrillating, weakly contracting rabbit heart stained with voltage-sensitive dye (Di-4-ANEPPS) imaged using a Basler acA720-520um camera at 500fps. Due to the staining, the action potential wave is inverted, i.e. an upstroke is observed as a negative deflection. The data is from {cite}`Chowdhary2023` and we extracted a short part of the original recording and saved the otherwise unprocessed raw video data as a numpy file (`.npy`). Experimenters: Jan Lebert, Shrey Chowdhary & Jan Christoph (University of California, San Francisco, USA), 2023."
124124
]
125125
},
126126
{
@@ -131,7 +131,7 @@
131131
"source": [
132132
"filepath = om.utils.retrieve_example_data('Example_02_VF_Rabbit_Di-4-ANEPPS_Basler_acA720-520um.npy')\n",
133133
"# alternative if you downloaded the file to your desktop\n",
134-
"# filepath = '/Users/userxyz/Desktop/Example_02_VF_Rabbit_Di-4-ANEPPS_Basler_acA720-520um.npy'\n",
134+
"# filepath = 'Example_02_VF_Rabbit_Di-4-ANEPPS_Basler_acA720-520um.npy'\n",
135135
"video = om.load_video(filepath)\n",
136136
"\n",
137137
"om.print_properties(video)"
@@ -141,7 +141,7 @@
141141
"cell_type": "markdown",
142142
"metadata": {},
143143
"source": [
144-
"`optimap` imports video data as three-dimensional numpy arrays with shape (Time, Height, Width). This convention is used throughout the library. The function `optimap.print_properties()` displays the dimensions and maximal and minimal intensity values of a video. Our example file has 1040 video frames. See {func}`load_video` for additional arguments, e.g. to load only a subset of the frames or to use memory mapping to reduce memory usage.\n",
144+
"`optimap` imports video data as three-dimensional NumPy array, where the first dimension is time and the other two dimensions are the x- and y-dimensions, respectively. This convention is used throughout the library. The function `optimap.print_properties()` displays the dimensions and maximal and minimal intensity values of a video. Our example file has 1040 video frames. See {func}`load_video` for additional arguments, e.g. to load only a subset of the frames or to use memory mapping to reduce memory usage.\n",
145145
"\n",
146146
"```python\n",
147147
"video = om.load_video('Example.dat', start_frame=100, frames=1000, step=2, use_mmap=True)\n",

docs/tutorials/io.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
"The following file formats can be imported with ``optimap``:\n",
9393
"\n",
9494
"* .tif, .tiff (TIFF) image stacks\n",
95-
"* Folder containing TIFF or .png (PNG) images\n",
95+
"* Folder containing sequence of TIFF or .png (PNG) images\n",
9696
"* .gsd, .gsh (SciMedia MiCAM 05)\n",
9797
"* .rsh, .rsm, .rsd (SciMedia MiCAM ULTIMA)\n",
9898
"* .dat (MultiRecorder)\n",

0 commit comments

Comments
 (0)