rfttoolbox
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: sjdavenport
- License: other
- Language: MATLAB
- Default Branch: master
- Size: 121 MB
Statistics
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
RFTtoolbox (Beta Version): A toolbox designed for generation and analysis of random fields both continuously sampled and on a lattice.
The RFTtoolbox currently contains code to perform image based inference using the tools of Random Field Theory. In particular it contains code to perform FWER inference using the Expected Euler characteristic, perform peak based inference using the distribution for the height of a peak in a random field, generate random fields with a variety of stationary and non-stationary covariance structures and a number of further features.
Feel free to use the functions available in your research. However if you do please cite us.
Table of contents
Installation
Main installation
In order to install either download the zip file or run git clone https://github.com/sjdavenport/RFTtoolbox/ from the commmand line.
Then in order to use the package, once you're in matlab you'll first need to add all the functions to the matlab path. If you have installed the package in the directory: dir, then to do so you need to run: addpath(genpath('dir')) within matlab.
Compiling C code - only need if running the hermite projection estimator
In order to compile the c-code required to efficiently run the hermite projection estimator
you will need to navigate to the folder EEC/csource/ and run
mex EulerCharCrit_c.cpp
you may need to install the MATLAB C/C++ compiler for your system in order to do this.
MATLAB give you instructions on how to do so in an error message obtained from
running the above code.
Folder Structure
Cluster Size Inference
A collection of functions to perform cluster size inference using random field theory. Many more functions will be added to this folder.
Convolution Fields
Functions to generate and infer on convolution fields.
Peak Inference
A collection of functions to perform peak inference on random fields.
Random Field Generation
Functions to generate isotropic random fields (and to generate the signal for them if you'd like this to be non-zero).
noisegen.m
noisegen generates (a specified number of) smooth mean zero Gaussian fields with a specified dimension (D = 1, 2 or 3) that have variance 1 and are smoothed with an isotropic Gaussian kernel with given FWHM.
The mean of 20 Gaussian random fields generated on a grid of 1x160 with
an isotropic Gaussian kernel with FWHM 6:
noise = noisegen(160,20,6);
plot(mean(noise,2), 'linewidth', 2)

The mean of 20 Gaussian random fields generated on a grid of 100x100 with
an isotropic Gaussian kernel with FWHM 6:
Dim = [100,100]
noise = noisegen(Dim, 20, 6);
noise_mean = mean(noise,3);
surf(noise_mean)

genRF.m
genRF returns a set of isotropic random fields (either Gaussian, t or F-fields) which have a specified number of degrees of freedom and smoothing.
gensig.m
gensig generates signal with peaks at locations within an image of specified dimension D = 1,2 or 3. It provides control over the extent, shape and magnitude of each peak. Below we provide a 2D illustration involving 2 peaks.
``` peakmagnitudes = [1.3,2] radii = 3; smoothing = [10,20]; imagedimensions = [100,150]; peak_locations = {[40,30], [70,120]}
Sig = gensig(peakmagnitudes, radii, smoothing, imagedimensions, peak_locations); surf(Sig) ```

Owner
- Name: Samuel Davenport
- Login: sjdavenport
- Kind: user
- Repositories: 4
- Profile: https://github.com/sjdavenport
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: RFTtoolbox
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Samuel
family-names: Davenport
email: sdavenport@health.ucsd.edu
affiliation: UCSD
orcid: 'https://orcid.org/0000-0002-9539-3200'
- given-names: Fabian
family-names: Telschow
email: fabian.telschow@hu-berlin.de
affiliation: Humboldt University of Berlin
repository-code: 'https://github.com/sjdavenport/RFTtoolbox'
keywords:
- Random Field Theory
- Multiple Testing
- Confidence Regions
- Peak Inference