Skip to content

slideNormalize

Sander W. van der Laan edited this page Jan 8, 2024 · 2 revisions

slideNormalize is designed to normalise of histological high-resolution images. We have tested slideNormalize on CentOS7 and macOS Mojave+ (version 10.14.5+).

Installation

Download and install the latest version of the slideNormalize from GitHub. First create and go to the git directory, then download slideNormalize.

mkdir -p ~/git/ && cd ~/git
if [ -d ~/git/slideNormalize/.git ]; then \
		cd ~/git/slideNormalize && git pull; \
	else \
		cd ~/git/ && git clone https://github.com/swvanderlaan/slideNormalize.git; \
	fi

Binaries

For your convenience, we have created precompiled binaries for CentOS7+, Rocky8 and macOS Mojave (10.14.5+) using g++ and opencv2. These are available in the binaries folder:

  • slideNormalize_macOS_Mojave10145
  • slideNormalize_macOS_BigSur1152
  • slideNormalize_centos7

Compile from source

slideNormalize requires opencv2 which you can install via brew.

brew install opencv@2

It will probably be keg-only, so you need to make sure that opencv2 is in your $PKG_CONFIG. Add this to your .bashrc or .bash_profile

echo 'export PKG_CONFIG_PATH="/usr/local/opt/opencv@2/lib/pkgconfig:$PKG_CONFIG_PATH"' >> ~/.bashrc

slideNormalize in your path

You can add slideNormalize to your path by running the code below to make a symbolic link, while making sure to choose the binary appropriate for your system (macOS or Rocky).

mkdir -pv ~/bin/ && \
	ln -s -f -v ~/git/slideNormalize/binaries/slideNormalize_mac ~/bin/slideNormalize

Example usage

The program uses the TCLAP library for command-line argument parsing. Here is the list of command-line arguments:

Argument(s):

  • -f or --file
    • The filename of the NDPI/TIF file to process. (Example: -f input_image.tif)

Optional argument(s):

  • -o or --output
    • The output filename of the NDPI/TIF file to process. If not provided, a default filename will be generated based on the input filename. (Example: -o output_image.tif)
  • -e or --extension
    • The standard output filename extension of the image-tile to process. If provided, it will be used in the generated output filename. (Example: -e normalized)
  • -s or --show
    • Show results in a graphical interface. This is a switch, and if included, it will trigger the display of results. (Example: -s)

Here's an example of how you might run the program from the command line:

./slideNormalize -f input_image.tif -o output_image.tif -e normalized -s

The -f flag specifies the input file, -o specifies the output file, -e specifies the extension, and -s triggers the graphical display of results.

Overview

Welcome to slideToolKit

Manual

Introduction
General instructions

slideToolKit scripts

slide2Tiles
slideAppend.sh
slideAppendGCT.sh
slideConvert
slideDirectory
slideDupIdentify.py
slideEMask
slideEntropySegmentation.py
slideExtract.py
slideExtractTiles.py
slideInfo
slideInfo.py
slideJobChecker
slideLookup
slideMacro
slideMacro.py
slideMask
slideNormalize
slideRename
slideRename.py
slideThumb
slideThumb.py

slideQuantify v1

slideQuantify_v1
slideQuantify_v1_1_expresshist_mask.sh
slideQuantify_v1_2_expresshist_tile.sh
slideQuantify_v1_3_tile_normalizing.sh
slideQuantify_v1_4_cellprofiler.sh
slideQuantify_v1_5_wrapup.sh

slideQuantify v2

slideQuantify_v2
slideQuantify_v2_1_entropy_segmentation.sh
slideQuantify_v2_2_extract_tiles.sh
slideQuantify_v2_3_tile_normalizing.sh
slideQuantify_v2_4_cellprofiler.sh
slideQuantify_v2_5_wrapup.sh

slideQuantifyOSX

slideQuantifyOSX
slideQuantify_cellprofiler.sh
slideQuantify_mask.sh
slideQuantify_normalizing.sh
slideQuantify_tiling.sh
slideQuantify_wrapup.sh

Other scripts

slideToolKitTest.py

Installation

macOSX

Conda version (default/preferred)
Homebrew version

Linux

Rocky 8 Conda version (default/preferred)

Legacy

Ubuntu 16.04 LTS
Ubuntu 12.04 CentOS7 Conda version with modules
Administrator version

Conda vs brew

Clone this wiki locally