nimare.nimads.Annotation

class Annotation(source, studyset)[source]

Bases: object

A collection of labels and associated weights from the same Annotator.

Added in version 0.0.14.

Variables:

term_weights (pandas.DataFrame) – A pandas DataFrame containing the annotation group’s labels and weights. This is the main attribute of interest for NeuroStore. A dictionary could also work.

Notes

Where would p(term|topic) and p(voxel|topic) arrays/DataFrames go? Having one Annotation per Analysis (for each Annotator), and storing these arrays in the Annotation, would make for a lot of duplication. The same goes for metadata/provenance, but that will generally be much lighter on memory than the arrays.

Could be a dictionary with analysis objects as keys? (need to define __hash__ and __eq__ for Analysis) Or could use Analysis.id as key.

Methods

to_dict()

Convert the Annotation to a dictionary.
to_dict()[source]

Convert the Annotation to a dictionary.