statistic_image methods, organized by area

May 7, 2026 ยท View on GitHub

This is a functional index of methods available on a statistic_image object. statistic_image is a subclass of image_vector for storing and manipulating statistical images (t-maps, p-maps, thresholded results). Multiple images can be stored in a single object, thresholding is reversible (via the threshold method) without changing the underlying values, and standard visualizations (orthviews, surface, montage) honor the .sig field so only suprathreshold voxels are shown.

This class also inherits all image_vector methods listed in image_vector_methods.md. Only methods owned by statistic_image (defined in @statistic_image/) are listed below; where a method also exists in @image_vector/, the statistic_image override wins. Type methods(my_obj) in MATLAB for the live list on any instance.

Properties

statistic_image inherits all image_vector properties (dat, volInfo, removed_voxels, removed_images, image_names, fullpath, files_exist, history, dat_descrip, source_notes) and adds the following:

PropertyDescription
typeString with image type: generic, t, p, r, robreg
pMatrix of p-values for images, [voxels x images]
p_typeString with source info for p-values
steMatrix of standard error values for images, [voxels x images]
thresholdLatest statistical threshold applied
thr_typeInformation about the statistical threshold applied
sigLogical matrix of which voxels are significant, [voxels x images]
NSample size
dfeError degrees of freedom for the test
image_labelsSemantic labels for each image, cell array

Basic image math and operations

MethodFromOne-liner
cat@statistic_imageConcatenate statistic_image objects, resampling to first as needed
select_one_image@statistic_imageSelect a single image, reducing .p, .ste, .sig, .dat accordingly
reparse_contiguous@statistic_imageRe-build the contiguous-cluster index for the statistic_image (override)
convert2mask@statistic_imageConvert to fmri_mask_image based on the .sig field

Display and visualization

MethodFromOne-liner
orthviews@statistic_imageOrthviews honoring .sig so only suprathreshold voxels show (override)
riverplot@statistic_imageRiverplot of relationships among images in the object

Statistics

MethodFromOne-liner
threshold@statistic_imageThreshold based on statistical p-values, FDR, extent, etc. (reversible; override)
multi_threshold@statistic_imageMultiple-threshold visualization for nested significance
conjunction@statistic_imageConjunction of two thresholded statistic_images (positive and negative separately)
estimateBayesFactor@statistic_imageVoxel-wise Bayes Factors for t-tests, correlations, or proportions

Tables

MethodFromOne-liner
table@statistic_imagePrint a table of labeled regions from a thresholded statistic_image (override)

Misc utilities

MethodFromOne-liner
check_properties@statistic_imageFill in empty .p, .ste, .sig fields to the full in-mask grid (under construction)