Skip to content
Clara Bird edited this page Sep 6, 2020 · 3 revisions

Welcome to the collatrix wiki!

CollatriX

DOI DOI

Background

This function collates the csv outputs from the MorphoMetriX photogrammetry GUI (https://github.com/wingtorres/morphometrix) into one large single data frame containing the image, animal ID, measurements, and notes.
CollatriX was designed with several add-ons. A figure showing the different routes available is included below:
alt text

The altitude calibration function (collatrix.altitude_calib) can be used to calculate corrected altitudes using images of an object of known length. If used, this function should be used before the main function. The output can be used to create the safety input file for the main collatrix function. Note that the altitude calibration function is not required, the user can start the workflow using the main collatrix function. The output of this main function can then be used to calculate metrics of whale body condition (collatrix.whale_bc) if desired.

This wiki

This wiki was designed to help the user easily find the instructions for each function in collatrix. It will be updated frequently and new pages will be created when new functions are added.

Table of Contents

01. Installing and Running: Instructions on how to install and run the package.
02. Important Tips: Tips for using collatrix, we highly recommend reading before using collatrix for the first time.
03. CollatriX Main Function: Guide for running main collatrix function.
04. Altitude Calibration Function: Guide for running collatrix.altitude_calib function.
05. Whale Body Condition Function: Guide for running collatrix.whale_bc function.
06. Example Code: Example code used while setting up the input files.

Clone this wiki locally