nimare.nimads.Studyset

class Studyset(source, target_space=None, mask=None, annotations=None)

Bases: object

A collection of studies for meta-analysis.

New in version 0.0.14.

This is the primary target for Estimators and Transformers in NiMARE.

Variables:

• id (str) – A unique identifier for the Studyset.

• name (str) – A human-readable name for the Studyset.

• annotations (list of nimare.nimads.Annotation objects) – The Annotation objects associated with the Studyset.

• studies (list of nimare.nimads.Study objects) – The Study objects comprising the Studyset.

Methods

combine_analyses()	Combine analyses in Studyset.
copy()	Create a copy of the Studyset.
from_nimads(filename)	Create a Studyset from a NIMADS JSON file.
get_analyses_by_annotations()	Extract a list of Analyses with a given label/annotation.
get_analyses_by_coordinates(xyz[, r, n])	Extract a list of Analyses with at least one Point near the requested coordinates.
get_analyses_by_images()	Extract a list of Analyses with a given image.
get_analyses_by_mask(img)	Extract a list of Analyses with at least one Point in the specified mask.
get_analyses_by_metadata()	Extract a list of Analyses with a metadata field/value.
get_analyses_by_texts()	Extract a list of Analyses with a given text.
get_annotations(analyses)	Collect Annotations associated with specified Analyses.
get_images(analyses)	Collect image files associated with specified Analyses.
get_metadata(analyses)	Collect metadata associated with specified Analyses.
get_points(analyses)	Collect Points associated with specified Analyses.
get_texts(analyses)	Collect texts associated with specified Analyses.
load(filename)	Load a Studyset from a pickled file.
merge(right)	Merge a separate Studyset into the current one.
save(filename)	Write the Studyset to a pickled file.
slice(analyses)	Create a new Studyset with only requested Analyses.
to_dataset()	Convert the Studyset to a NiMARE Dataset.
to_dict()	Return a dictionary representation of the Studyset.
to_nimads(filename)	Write the Studyset to a NIMADS JSON file.
update_image_path(new_path)	Point to a new location for image files on the local filesystem.

Properties

annotations

Return existing Annotations.

property annotations

Return existing Annotations.

combine_analyses()

Combine analyses in Studyset.

copy()

Create a copy of the Studyset.

classmethod from_nimads(filename)

Create a Studyset from a NIMADS JSON file.

get_analyses_by_annotations()

Extract a list of Analyses with a given label/annotation.

get_analyses_by_coordinates(xyz, r=None, n=None)

Extract a list of Analyses with at least one Point near the requested coordinates.

get_analyses_by_images()

Extract a list of Analyses with a given image.

get_analyses_by_mask(img)

Extract a list of Analyses with at least one Point in the specified mask.

get_analyses_by_metadata()

Extract a list of Analyses with a metadata field/value.

get_analyses_by_texts()

Extract a list of Analyses with a given text.

get_annotations(analyses)

Collect Annotations associated with specified Analyses.

get_images(analyses)

Collect image files associated with specified Analyses.

get_metadata(analyses)

Collect metadata associated with specified Analyses.

get_points(analyses)

Collect Points associated with specified Analyses.

get_texts(analyses)

Collect texts associated with specified Analyses.

load(filename)

Load a Studyset from a pickled file.

merge(right)

Merge a separate Studyset into the current one.

save(filename)

Write the Studyset to a pickled file.

slice(analyses)

Create a new Studyset with only requested Analyses.

to_dataset()

Convert the Studyset to a NiMARE Dataset.

to_dict()

Return a dictionary representation of the Studyset.

to_nimads(filename)

Write the Studyset to a NIMADS JSON file.

update_image_path(new_path)

Point to a new location for image files on the local filesystem.

Examples using nimare.nimads.Studyset

Using NIMADS with NiMARE