API Reference¶
This is the class and function reference of gclda.
gclda.dataset: Importing and formatting data¶
Class and functions for dataset-related stuff.
dataset.Dataset(dataset_label, data_directory) |
Class object for a gcLDA dataset. |
dataset.import_neurosynth(…[, out_dir, …]) |
Transform Neurosynth’s data into gcLDA-compatible files. |
gclda.model: Model training and evaluation¶
Class and functions for model-related stuff.
model.Model(dataset[, n_topics, n_regions, …]) |
Class object for a gcLDA model. |
gclda.decode: Functional decoding and encoding¶
Functions for functional decoding/reverse inference using a GCLDA model.
decode.decode_roi(model, roi[, …]) |
Perform image-to-text decoding for discrete image inputs (e.g., regions of interest, significant clusters). |
decode.decode_continuous(model, image[, …]) |
Perform image-to-text decoding for continuous inputs (e.g., unthresholded statistical maps). |
decode.encode(model, text[, out_file, …]) |
Perform text-to-image encoding. |
gclda.utils: Miscellaneous utilities¶
Utility functions.
utils.get_resource_path() |
Returns the path to general resources, terminated with separator. |
utils.weight_priors(topic_priors, prior_weight) |
Combine topic priors with prior weight. |
utils.plot_brain(data, underlay[, x, y, z]) |
Create a figure of a brain. |