jams.AnnotationMetadata

class jams.AnnotationMetadata(curator=None, version='', corpus='', annotator=None, annotation_tools='', annotation_rules='', validation='', data_source='')[source]

Bases: jams.core.JObject

Data structure for metadata corresponding to a specific annotation.

__init__(self, curator=None, version='', corpus='', annotator=None, annotation_tools='', annotation_rules='', validation='', data_source='')[source]

Create an AnnotationMetadata object.

Parameters:
curator: Curator, default=None

Object documenting a name and email address for the person of correspondence.

version: string, default=’‘

Version of this annotation.

annotator: dict, default=None

Sandbox for information about the specific annotator, such as musical experience, skill level, principal instrument, etc.

corpus: str, default=’‘

Collection assignment.

annotation_tools: str, default=’‘

Description of the tools used to create the annotation.

annotation_rules: str, default=’‘

Description of the rules provided to the annotator.

validation: str, default=’‘

Methods for validating the integrity of the data.

data_source: str, default=’‘

Description of where the data originated, e.g. ‘Manual Annotation’.

Attributes

type The type (class name) of a derived JObject type

Methods

__init__(self[, curator, version, corpus, …]) Create an AnnotationMetadata object.
dumps(self, \*\*kwargs) Serialize the JObject to a string.
keys(self) Return a list of the attributes of the object.
loads(string) De-serialize a JObject
search(self, \*\*kwargs) Query this object (and its descendants).
update(self, \*\*kwargs) Update the attributes of a JObject.
validate(self[, strict]) Validate a JObject against its schema