Package: colab-zirc-dims
colab_zirc_dimsThis repository contains code for dimensional analysis of heavy mineral grains in reflected light LA-ICP-MS alignment images using Google Colab, with or without the aid of RCNN (deep learning) segmentation. Because processing is done in Google Colab, this method should be available to anyone with an internet connection and access to Google services. Users who lack one or both of these can instead run the notebooks on a local machine aftera lengthier installation process.Detectron2was used for model training and is used for Colab/Jupyter implementation.FeaturesThe code in this repo enables organization (e.g., matching zircon/heavy mineral mosaic images to .scancsv scanlists), data extraction (e.g., mapping shots to subimages of mosaics), and post-segmentation processing (e.g., extracting accurate grain dimensions from segmentation masks) of mosaic-scanlist and single-shot-per-image reflected light zircon/heavy mineral image datasets from LA-ICP-MS facilities using Chromium targeting software. RCNN instance segmentation of grains is handled by Detectron2 and implemented in ready-to-run Google Colab/Jupyter notebooks (see 'Links'). Said code and notebooks have been tested with and fully support processing of image datasets from theUniversity of Arizona LaserChron Centerand theUCSB LA-ICP-MS facility; datasets from other facilities using Chromiumshouldwork with colab_zirc_dims but have not been tested. Users with reflected image datasets lacking Chromium image metadatacansegment their images (see 'single image-per-shot' notebook below) with some additional project folder organization and/or after manually adding image scaling information, but they (and researchers with non-reflected-light images) should also consider usingAnalyZr.In datasets with good image quality and well-exposed grains (i.e., with full cross-sections visible above mounts(s)), automated colab_zirg processing achieves measurements comparable to those produced by humans (with average absolute error along long and short axes <10 μm vs. humans in 17/19 tested samples) in a fraction of the time. See below for an example analysis of a single spot.AnalysisArea (µm^2)Convex area (µm^2)EccentricityEquivalent diameter (µm)Perimeter (µm)Major axis length (µm)Minor axis length (µm)CircularityLong axis rectangular diameter (µm)Short axis rectangular diameter (µm)Best long axis length (µm)Best short axis length (µm)Best axes calculated fromScale factor (µm/pixel)Spot 951037.11078.30.89836.3133.654.924.20.73054.424.854.924.22nd central moments1.027In sub-optimal datasets, automated processing is less successful and can produce inaccurate segmentations. To mitigate this, a semi-automated Colab/Jupyter-based GUI (extended fromTensorFlow object detection utils code) that allows users to view and edit automatically-generated segmentations before export has also been implemented. Semi-automated processing is recommended for production of publication-quality measurement datasets.Various functions for processing mosaic image datasets are available in (among others) modulesczd_utils,mos_match, andmos_proc.Models:A variety of Detectron2-based instance segmentation models are available for application to images via the provided notebooks. You can check them out in ourmodel library.Datasets:Please refer to thetraining datasets sectionof this repository to learn more about and/or download the datasets used to train models for application in colab_zirc_dims.LinksPer-sample mosaic image datasets (e.g., from ALC):Colab/Jupyter notebooks are available for:Matching ALC mosiacs to .scancsv files (dataset preparation)Automatically and/or semi-automatically segmenting and measuring grains from mosaics - v1.0.10A template project folder is available here.Single image-per-shot datasets (e.g., from UCSB):A Colab/Jupyter notebook for automatically and/or semi-automatically segmenting and measuring grains is available here - v1.0.10Template project folders are available for:Datasets where sample, shot information can be extracted from image filenames (e.g., from UCSB)Datasets where shot images have been manually organized by user(s)Other links:Video tutorial and demo - intro to Colab notebooks at 4:50Running notebooks without Google Colab (on local machines):The notebooks provided can be run as basic Jupyter notebooks in a local Anaconda environment. Some setup is required, though. Please refer to theadvanced local installation instructions.Installation outside of provided notebooks:A distribution of this package is available through the Python Package Index. It is recommended that this package only be used with the provided notebooks, but some functions could be useful to users working with mosaic or .Align files.To install inside of Google Colab, add:!pip install colab_zirc_dimsto a cell, then run the cell.To install outside of Google Colab (without segmentation functionalities), open command line and enter:pip install colab_zirc_dimsthen press enter.To install outside of Google Colab with full segmentation functionalities, please refer to theadvanced local installation instructions.Project Status (updated 11/16/2022)All features are functional. Bugs may exist, and are most likely to be encountered when using the package outside of the provided notebooks.All notebooks will now run as Jupyter notebooks in local Anaconda environments.New 'best axes' measurement that mitigates inaccuracies in moment-based axial measurements by defering to minimum-area rectangle measurements for most high-aspect ratio grains.Added new dataset, new models, and documentation pages.Automated processing notebooks updated on 05/19/2022 with V1.0.8.1 hotfix for incompatibility between latest Detectron2 binary release and new standard Colab PyTorch installation (v1.11).Additional NotesTraining and large-n zircon measurement datasets for this project were provided by Dr. Ryan Leary (New Mexico Tech). Also, motivation; see hisrecent workon the utility of augmenting LA-ICP-MS data with grain size data.Some additional training data are from theUCSB Petrochronology Center.Although models were trained on (and tests have only been performed on) detrital zircon mosaic images, I think that this method could probably be applied to LA-ICP-MS mosaics/samples of other minerals (e.g., monazite) without further model training.Any suggestions, comments, or questions about this project are also welcome.CitationThis project has been written up in as a technical note in collaboration with Dr. Ryan Leary and is currently in review at Geochronology. You can find the preprint (along with associated links to additional datasets and replication code)here. If you use colab_zirc_dims in your work prior to (hopeful(!)) full publication, please use the following preprint citation:Sitar, M. C. and Leary, R. J.: Technical Note: colab_zirc_dims: a Google-Colab-based Toolset for Automated and Semi-automated Measurement of Mineral Grains in LA-ICP-MS Images Using Deep Learning Models, Geochronology Discuss. [preprint], https://doi.org/10.5194/gchron-2022-12, in review, 2022.AuthorMichael Cole SitarM.S. student, Colorado State University Department of Geosciencesemail:mcsitar@colostate.eduReferencesYuxin Wu, Alexander Kirillov, Francisco Massa and Wan-Yen Lo, & Ross Girshick. (2019). Detectron2.https://github.com/facebookresearch/detectron2.TensorFlow Developers: TensorFlow, Zenodo,https://doi.org/10.5281/zenodo.5949169, 2022.