jams.AnnotationMetadata

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

Bases: JObject

Data structure for metadata corresponding to a specific annotation.

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

Create an AnnotationMetadata object.

Parameters:
curatorCurator, default=None

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

versionstring, default=’’

Version of this annotation.

annotatordict, default=None

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

corpusstr, default=’’

Collection assignment.

annotation_toolsstr, default=’’

Description of the tools used to create the annotation.

annotation_rulesstr, default=’’

Description of the rules provided to the annotator.

validationstr, default=’’

Methods for validating the integrity of the data.

data_sourcestr, default=’’

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

Attributes

type

The type (class name) of a derived JObject type

Methods

__init__([curator, version, corpus, ...])

Create an AnnotationMetadata object.

dumps(**kwargs)

Serialize the JObject to a string.

keys()

Return a list of the attributes of the object.

loads(string)

De-serialize a JObject

search(**kwargs)

Query this object (and its descendants).

update(**kwargs)

Update the attributes of a JObject.

validate([strict])

Validate a JObject against its schema