Package: catsim 0.2.4

catsim: Binary and Categorical Image Similarity Index

Computes a structural similarity metric (after the style of MS-SSIM for images) for binary and categorical 2D and 3D images. Can be based on accuracy (simple matching), Cohen's kappa, Rand index, adjusted Rand index, Jaccard index, Dice index, normalized mutual information, or adjusted mutual information. In addition, has fast computation of Cohen's kappa, the Rand indices, and the two mutual informations. Implements the methods of Thompson and Maitra (2020) <doi:10.48550/arXiv.2004.09073>.

Authors:Geoffrey Thompson [aut, cre]

catsim_0.2.4.tar.gz
catsim_0.2.4.zip(r-4.7)catsim_0.2.4.zip(r-4.6)catsim_0.2.4.zip(r-4.5)
catsim_0.2.4.tgz(r-4.6-x86_64)catsim_0.2.4.tgz(r-4.6-arm64)catsim_0.2.4.tgz(r-4.5-x86_64)catsim_0.2.4.tgz(r-4.5-arm64)
catsim_0.2.4.tar.gz(r-4.7-arm64)catsim_0.2.4.tar.gz(r-4.7-x86_64)catsim_0.2.4.tar.gz(r-4.6-arm64)catsim_0.2.4.tar.gz(r-4.6-x86_64)
catsim_0.2.4.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
catsim/json (API)
NEWS

# Install 'catsim' in R:

install.packages('catsim', repos = c('https://gzt.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/gzt/catsim/issues

Pkgdown/docs site:https://gzt.github.io

Uses libs:

c++– GNU Standard C++ Library v3

Datasets:

besag - A hand-constructed image from Besag
hoffmanphantom - An example fMRI phantom

On CRAN:

binary-data binary-image-classification binary-image-processing categorical-data categorical-images classification image-processing cpp

4.40 score 5 stars 5 scripts 195 downloads 14 exports 24 dependencies

Last updated from:eceeb92f1b. Checks:13 OK. Indexed: yes.

Target	Result	Time
linux-devel-arm64	OK	143
linux-devel-x86_64	OK	153
source / vignettes	OK	262
linux-release-arm64	OK	143
linux-release-x86_64	OK	146
macos-release-arm64	OK	86
macos-release-x86_64	OK	284
macos-oldrel-arm64	OK	111
macos-oldrel-x86_64	OK	444
windows-devel	OK	123
windows-release	OK	139
windows-oldrel	OK	112
wasm-release	OK	121

Exports:adj_rand adjusted_mi binssim catmssim_2d catmssim_3d_cube catmssim_3d_slice catsim cohen_kappa gini ginicorr normalized_mi rand_index sqrtgini sqrtginicorr

Dependencies:brio callr cli crayon desc diffobj evaluate fs glue jsonlite lifecycle magrittr pkgbuild pkgload praise processx ps R6 Rcpp rlang rprojroot testthat waldo withr

Two-Dimensional Examples of CatSIM

Rendered fromtwo-dimensional-example.Rmdusingknitr::rmarkdownon Jun 02 2026.

Last update: 2024-09-30
Started: 2020-03-23

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
A hand-constructed image from Besag (1986)	besag
Categorical Structural Similarity Index Metric (whole image)	binssim
Multiscale Categorical Structural Similarity Index Measure (2D)	catmssim_2d
Multiscale Categorical Structural Similarity Index Measure for a Cube (3D)	catmssim_3d_cube
Multiscale Categorical Structural Similarity Index Measure by Slice (3D)	catmssim_3d_slice
Multiscale Categorical Structural Similarity Index Measure	catsim
Diversity Indices	Corrected Gini-Simpson index gini ginicorr Modified Corrected Gini index Modified Gini-Simpson index sqrtgini sqrtginicorr
An example fMRI phantom	hoffmanphantom
Similarity Indices	Adjusted Mutual Information Adjusted Rand Index adjusted_mi adj_rand Cohen's kappa cohen_kappa Normalized Mutual Information normalized_mi rand rand_index