User Guide

Preprocessing of Race Tube Images

  1. Crop your scanned race tube image as desired, in the image viewer program of choice, leaving a small amount of background on either long edge

  2. No need to make your image greyscale, fix its rotation, or increase contrast- Rhythmidia will take care of all of this internally!

  3. Race tube images can be .png, .tif, .tiff, .jpg, .jpeg, or .svg

Uploading and Analyzing an Image

  1. Upon opening the software, you will be greeted with the “Home” tab, which will look like this:

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/HomeTabBlank.png?raw=trueNOTE:Ifyouwanttoaddtubestoanexistingexperimentfile,gotoFile->OpenexperimentFile(orpress⌘O),althoughthisisnotnecessary
  1. To upload a new race tube image, click the button labeled “Upload Race Tube Image”

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/UploadImageButton.png?raw=truea.Yourimagewillappearinthecenterofthescreen..image::https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageAnal1.png?raw=trueb.Uploadinganimageenablestheoptionstorotateandtolock&analyzeyourimage..image::https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageChangeButtons.png?raw=true
  1. Rotate your image so that the growth direction of the tubes is from left to right across your screen
    1. To rotate your image 90 degrees clockwise, click the button labeled “Rotate”

  2. If necessary, update the Time Sheet table to correspond to the times at which you marked your race tubes, located to the left of the image box
    1. Time Sheet entries are in days:hours:minutes, starting at 0:00:00 at the first time mark

    2. Entries past the greatest number of identified time marks in a single tube will be ignored, so there is no need to address them

  3. When you are satisfied with your image’s orientation, click the button labeled “Lock & Analyze Image”

  4. Rhythmidia will try to identify horizontal lines corresponding to the horizontal boundaries of the tubes in your image, including the lower and upper bounds below and above the final and first tubes
    1. One line between each two tubes

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageAnal2.png?raw=true
  1. You will be directed to verify these lines:
    1. To remove an incorrect line, simply click on the line

    2. To add a missing line, simply click in an unoccupied position on the image

  2. When you are satisfied with the positions of all tube demarcation lines, click the button labeled “Proceed”

  3. Repeat steps 6-8 for time marks (red) and for bands (orange)

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageAnal3.png?raw=true https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageAnal4.png?raw=true https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageAnal5.png?raw=trueNOTE:Atanytimebeforesavingtubestothefile,youmayclickthebuttonlabeled“Cancelimageanalysis”,whichwillresettheimageanalysisprocessandremoveyouruploadedimage,whileleavingopenanyopenexperimentfileNOTE:Becertaintorecordanydifferencesinmarkingtimesinthemarksheet(left)beforeproceedingfurther.Iftubesweremarkedatthesametimeeveryday,leaveasthedefaultsetting(0forall)NOTE:Thetimemarkswilltemporarilydisappearwhilemarkingconidialpeaks.
  1. After you are satisfied with the positions of the bands and click “Proceed”, you will be able to see a preliminary calculation of the period of each tube below NOTE: if there is an issue at this stage (i.e. a missed or duplicated identifier) cancel image analysis and reload the image

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ImageAnal6.png?raw=true
  1. You will now have the option to click the button labeled “Save Tubes to File” a. This will bring up a popup asking for a name for the pack of tubes in the current image before it saves them to file

    https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/PackName.png?raw=true
    1. If you are working within an existing experiment file, this will simply add this pack to the file and update it

    2. Otherwise, you will be prompted to Save As a new experiment file for these tubes

The Experiment Tab

  1. Whether opening an existing experiment file or working from a new pack image, granular experiment data, plots, and statistical analysis data are located on the Experiment tab

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ExperimentTabBlank.png?raw=true
  1. Experiment data (Entry, Pack, Tube # in pack, Period calculated 3 ways, and Growth rate) is located in the table in the top left

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ExperimentTab.png?raw=true https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ExperimentTab2.png?raw=true
  1. In the top right is the frame for statistical analysis of any number of tubes:

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/ManualStatAnal.png?raw=true https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/WaveletStatAnal.png?raw=truea.Selectpacks,tubes,andamethodofperiodanalysisinthe3listsb.Toselectmultiplepacksortubes,usecontrol-clickc.Clickthebuttonlabeled“Analyze”togeneratemeanperiod,standarddeviation,andstandarderrord.Clickthebuttonlabeled“ExportData”toexporta.csvofthedataforeachtubeselectede.Clickthebuttonlabeled“ExportAnalysis”toexporta.csvoftheanalysisoftheselectedtubes
  1. In the bottom half is the plot frame for plotting densitometry and a periodogram of a single tube:

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/SokoloveBushellPlot.png?raw=true https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/LombScarglePlot.png?raw=true https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/WaveletPlot.png?raw=truea.Selectpack,tube,andtypeofperiodograminthe3listsb.Clickthebuttonlabeled“Plot”togenerateadensitometryplotandperiodogramoftheselecteddatac.Clickthebuttonlabeled“SavePlot”tosaveanimageofthedualplotinfileformatofchoiced.Clickthebuttonlabeled“SaveDensitometry”tosavea.csvofthedensitometrydatae.Clickthebuttonlabeled“SavePeriodogrammetry”tosavea.csvoftheperiodogrammetrydata
  1. At the bottom left is a button labeled “Display Pack Image”
    1. This button will display a popup window containing the greyscale version of the image corresponding to whichever pack is selected in the bottom left list that was the exact image used for analysis

https://github.com/Pelham-Lab/rhythmidia/blob/main/images/screenshots/PackImagePopup.png?raw=true

Functions Overview

Open Experiment File (⌘O)

Close Experiment File (⌘C)

Save File (⌘S)

Save as… (↑⌘S)

Set working directory (⌘D)

Open graphics preferences (⌘P)