CHIPS, or Cellular and Hemodynamic Image Processing Suite, is an open-source MATLAB toolbox designed to analyse functional images of cells and blood vessels, primarily from confocal or two-photon microscopy. CHIPS is hosted at GitHub.
CHIPS has been tested on computers running Windows, macOS and several Linux distributions, using MATLAB versions from R2013a. CHIPS is also expected to run in earlier MATLAB versions; however, this cannot be guaranteed since the unit testing framework did not exist prior to R2013a. Every effort has been made to eliminate the use of additional MATLAB toolboxes, but it is impractical in certain cases. In addition, while all algorithms work from R2013a, some function better in more recent versions.
R2014b and Newer
For MATLAB versions from R2014b, CHIPS can be installed by downloading the latest self-contained toolbox file found on the GitHub repository release page. The toolbox can be installed by dragging and dropping into the Command Window, or double clicking the toolbox file from the Current Folder browser. See here for more information on installing custom toolboxes.
R2014a and Older
MATLAB versions R2014a and earlier do not support custom toolbox files. Therefore, to install CHIPS, download the source code (either *.zip or *.tar.gz) from the GitHub repository release page, extract the source code to a folder, and then add that folder only, NOT including subfolders, to the MATLAB path. For more information on adding folders to the MATLAB path, see here.
Users wishing to load images using the Bio-Formats library will also need to download the bfmatlab toolbox, which includes the Bio-Formats Java bundle. This can be done manually, from the Open Microscopy Environment website, or automatically, by running the function
utils.install_bfmatlab() (see also here), which is included with CHIPS.
Users wishing to perform denoising using the
RawImg.denoise() function will also need to download additional files from the BM3D and invansc packages. This can be done manually, from the Tampere University of Technology website (BM3D and invansc), or automatically, by running the function
utils.install_denoise() (see also here), which is included with CHIPS.
Images and files for examples and tests
The images and other files used in the examples can be downloaded manually, from the University of Zurich website, or automatically, by running the function
utils.download_example_imgs() (see also here), which is included with CHIPS.
Quick start guides and examples
Find our quick start guides for many applications in the Documentation.
Classes and functions in CHIPS include documentation that is accessible via the standard MATLAB
doc functions. For example:
help BioFormats doc LineScanVel help RawImg.motion_correct help utils.CHIPS_version
There are also examples, along with further documentation, available via the Help browswer. To view them, open the Help browser (type
doc in the Command Window). There should be a link to documentation for CHIPS Toolbox at the bottom right of the home page (bottom left in older versions of MATLAB) under Supplemental Software.
Bug Reports and Further Assistance
Although we are unable to guarantee a response to all requests for assistance, please submit questions or bug reports via the GitHub repository issues page.
Please see the CONTRIBUTING.md file for details.
This project is licensed under the GNU General Public License. Please see the LICENSE.txt file for details.
Although the GNU General Public License does not permit terms requiring users to cite the research paper where this software was originally published (see here), we request that any research making use of this software does cite the paper, as well as papers describing any algorithms used, in keeping with normal academic practice. The function
utils.citation(), which is included with CHIPS (see also here), will output the citation details.
CHIPS has been developed at the University of Zurich by:
- Matthew J.P. Barrett
- Kim David Ferrari
- Martin Holub
- Jillian L. Stobart
- Bruno Weber
Code of Conduct
Please see the CODE_OF_CONDUCT.md file for details.
Please see the ACKNOWLEDGEMENTS.txt file for details.