nimare.studyset.AnnotationSet
- class AnnotationSet(id: str, name: str = '', columns: ColumnStore = None, note_key_types: dict = <factory>, metadata: dict = <factory>, description: str | None = None)[source]
Bases:
objectOne annotation: identity, declared types, and columns over the analyses.
NIMADS gives an annotation its own id, name and
note_keystypes, and a studyset may carry several. Keeping the set intact is what makes that representable – and prevents two annotations that share a label name from overwriting one another, which matters because compose’s default note key isincluded, so any two compose annotations on one studyset collide.Methods
copy()Return a shallow copy of the annotation.
dtype(label)Return the type NIMADS declared for
label, if any.keys()Return every label in the annotation.
Properties
columnsdescriptionnameidnote_key_typesmetadata