Skip to content

A repository to generate and work with arrays of crops from images or videos.

License

Notifications You must be signed in to change notification settings

Colorado-State-University-Stasevich-Lab/croparray

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

croparray

Authors: Tim Stasevich.

Description

This module is intended for creating and manipulating an array of crops (or regions of interest) that were generated from a multicolor TIF video obtained from single-molecule microscopy.

drawing

Documentation

Colab implementation

  • Implementation in Google Colab Open In Colab

drawing

Local installation from the Github repository

  • Install anaconda.

  • Clone the Github repository

    git clone https://github.com/Colorado-State-University-Stasevich-Lab/croparray.git
  • To create a virtual environment navigate to your local repository and use:
    conda create -n croparray_env python=3.8 -y
    source activate croparray_env
  • To install the rest of requirements use:
    python3 -m pip install -r requirements.txt
  • To install napari use:
    python3 -m pip install "napari[all]"
  • To ensure the docstrings of functions in crop_array_tools.py appear in jupyter notebooks that import crop_array_tools:
conda develop .\croparray\
  • To install Pytorch for GPU usage in Cellpose (Optional step). Only for Linux and Windows users check the specific version for your computer on this link :
 conda install pytorch cudatoolkit=10.2 -c pytorch -y
  • To install Pytorch for CPU usage in Cellpose (Optional step). Only for Mac users check the specific version for your computer on this link :
 conda install pytorch -c pytorch

Local installation using PIP

  • To create a virtual environment using:
    conda create -n croparray_env python=3.8 -y
    source activate croparray_env
  • Open the terminal and use pip for the installation:
    python3 -m pip install croparray
  • To install napari use:
    python3 -m pip install "napari[all]"

Deactivating and removing the environment

  • To deactivate or remove the environment from your computer use:
    conda deactivate
  • To remove the environment use:
    conda env remove -n croparray_env
  • To unistall croparray use
    pip uninstall croparray

additional troubleshooting information

  • If you cannot see the package installed on your computer, try using pip3. For example:
    pip3 install croparray

Installing from yml env

  • To creating an environment file (yml) use:
source activate croparray_env
conda env export > croparray_env.yml
  • ToCreate an environment from this yml file.
conda env create -f croparray_env.yml

Usage

  • Organizes crops and measurements of spots of interest from tif images in a convenient x-array format for reduced filesize and more open and reproducible analyses.
  • Visualizes crops of detected spots from super-resolution microscope images.
  • Calculates the best maximum projection for each crop containing a detected spot.
  • Measures intensity of detected spots within crops.
  • Calculates the correlation between two equal-length, 1D signals.
  • Saves the crop array as a netcdf file at output_direction/output_filename.
  • Integrates with Napari for fast and convenient review of crops of detected spots.

Licenses for dependencies

  • License for Napari: BSD-3-Clause License. Copyright (c) 2018, Napari. All rights reserved.

  • License for xarray: Apache License. Version 2.0, January 2004. Copyright 2014-2019, xarray Developers

About

A repository to generate and work with arrays of crops from images or videos.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published