`nimare.nimads`.Analysis

class Analysis(source, study=None)[source]

A single statistical contrast from a Study.

Added in version 0.0.14.

Variables:

id (str) – A unique identifier for the Analysis.
name (str) – A human readable name of the Analysis.
conditions (list of Condition objects) – The Conditions in the Analysis.
annotations (list of Annotation objects) – Any Annotations available for the Analysis. Each Annotation should come from the same Annotator.
images (dict of Image objects) – A dictionary of type: Image pairs.
points (list of Point objects) – Any significant Points from the Analysis.
metadata (dict) – A dictionary of metadata associated with the Analysis.

Notes

Should the images attribute be a list instead, if the Images contain type information?

Methods

`get_metadata`()	Get combined metadata from both analysis and parent study.
`to_dict`()	Convert the Analysis to a dictionary.

get_metadata() → dict[str, any][source]

Get combined metadata from both analysis and parent study.

Returns:: Combined metadata dictionary with analysis metadata taking precedence over study metadata for any overlapping keys.
Return type:: dict[str, any]

Examples using `nimare.nimads.Analysis`