Skip to main content

Helper functions for BakingTray and StitchIt

Project description

StitchIt Python Tools

The directory contains Python code for managing BakingTray serial-section 2p data. The main functions of interest are compressRawData.py and transferToServer.py, which are aimed at end users of the microscope. The recipe.py and tools.py modules support these and are aimed at developers.

Install instructions

$ sudo pip install btpytools

Running as sudo allows the installer to add the most important programs to your path, allowing them to be run at the system command line:

  • transferToServer
  • compressRawData
  • summariseAcqs

In other words, after pip installing you can run compressRawData at the command line.

Usage instructions

Compressing the raw data directory

cd to the sample directory at the command line and run compressRawData. This works much faster if you to have installed lbzip2, which runs parallel bzip. Likely only works on Linux. The command also confirms there is enough disk space available to complete successfully.

$ cd /mnt/data/BakingTrayStacks/CC_125_1__125_2/ 
$ compressRawData  

Sending data to a remote server

The server should be mounted locally to a mount point writable by the user. The tranfer is via rsync. The command just ensures no uncompressed raw data or uncropped stacks are copied. It brute-force retries if there is a failure for some reason.

First cd to the directory which contains your samples. Not the sample directory. e.g.

$ cd /mnt/data/BakingTrayStacks

You can now run in either of the following two ways (either one acquisition or multiple acquisitions)

$ transferToServer RC_RabiesBrains01 /mnt/server/user/data/histology
$ transferToServer RC_RabiesBrains01 RC_TwoProbeTracks_test RC_MyOldSample /mnt/server/user/data/histology

NOTE: If RC_RabiesBrains01 contains a compressed raw data archive, the following will not transfer it:

$ transferToServer RC_RabiesBrains01/sample01 RC_RabiesBrains01/sample02 /mnt/server/user/data/histology

Wrapper for brainreg with BakingTray data

With this package installed and also brainreg installed you can run registrations with super easily at the command line:

  • cd to a BakingTray sample directory
  • Run brainregbt

Sample session

$ brainregbt
Select downsampled stack voxel size for registration.
(Enter a number and press return)
1. 25 micron
2. 50 micron

[2] ?
Choose channel for registration.
1. red channel
2. green channel

[1] ?


Registering data for sample SM_1099839 with 50 micron downsampled red stack.
Press return to start

Running brainregbt -D will run the registration with the above defaults

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

btpytools-0.1.23.tar.gz (144.5 kB view details)

Uploaded Source

File details

Details for the file btpytools-0.1.23.tar.gz.

File metadata

  • Download URL: btpytools-0.1.23.tar.gz
  • Upload date:
  • Size: 144.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for btpytools-0.1.23.tar.gz
Algorithm Hash digest
SHA256 e1f45ca97ad0b2881d9aed9a007bf2d400dc29bb2cc61b21dfd5e29307fddeee
MD5 012b42af91e5e101b752112937b4d56d
BLAKE2b-256 ca3c68a995d2bfc84feaf7716b67f41d68c312a80506c116570ed02fe495b6f2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page