Annotator
=========

Annotator generates an annotated digital score from a given score and a JSON file generated by :doc:`calculator`.

The basic command line is:

.. code-block:: console

    rpscripts annotate -s score.xml score.json

.. figure:: ../../../examples/schumann-opus48no2-annotated.svg
    :alt: annotated-score

    Annotated score

Annotator does not work with trimmed scores :doc:`trimmer`.

Option ``-h`` returns the program's help:

.. code-block:: console

    usage: rpscripts annotate [-h] -s SCORE_FILENAME [-t TYPE] filename

    positional arguments:
    filename              JSON filename (calc's output)

    options:
    -h, --help            show this help message and exit
    -s SCORE_FILENAME, --score_filename SCORE_FILENAME
                            digital score filename (XML, MXL, MIDI and KRN)
    -t TYPE, --type TYPE  type of annotation (partitions, tclass, tcontour)

Types
-----

Annotator program can annotate multiple types of data into the given digital score. The default type is ``partitions``.

The ``-t`` option defines the type of annotation:

Textural class
~~~~~~~~~~~~~~

.. code-block:: console

    rpscripts annotate -t tclass -s score.xml score.json

.. figure:: ../../../examples/schumann-opus48no2-annotated-tclass.svg
    :alt: annotated-score-tclass

    Annotated score (tclass)

Textural complexity
~~~~~~~~~~~~~~~~~~~

.. code-block:: console

    rpscripts annotate -t tcontour -s score.xml score.json

.. figure:: ../../../examples/schumann-opus48no2-annotated-tcontour.svg
    :alt: annotated-score-tcontour

    Annotated score (tcontour)