Adding Viewpoints¶

Basic viewpoints¶

1. Add the viewpoint definition to viewpoint-definitions.lisp in amuse-viewpoints:

(define-basic-viewpoint ornament (events)
   (let ((x (amuse-mtp::%mtp-ornament (car (last events)))))
     (if x x viewpoints:+undefined+)))

Ideally, we would have an amuse interface to ornaments to make this general. I.e., we would replace the call the %mtp-ornament (which is specific to the mtp backend) above with one to amuse:event-ornament which would have implementations for all of the backends.

2. Here is how the implementation goes for the mtp backend:

2a. Add a column to the mtp-event table in the database

 
(clsql:execute-command "ALTER TABLE mtp_event ADD ornament INT DEFAULT '0';")

2b. In amuse/implementations/mtp/classes.lisp:

add the slot definition (ornament :initarg :ornament :accessor %mtp-ornament) to the class definition for mtp-event

2c. In amuse/implementations/mtp/methods.lisp:

add ornament to the obvious places in the variable *event-attributes* and the function db-event->mtp-event

Derived viewpoints¶

As of 2012-26-01, the procedure for adding derived viewpoints is to add the viewpoint definition to the file viewpoint-definitions.lisp in amuse-viewpoints using the macro define-viewpoint which has the following signature:

(define-viewpoint (_viewpoint-name_ _viewpoint-type_ (_type-set_)) (_events_ _element_) :function _viewpoint-function_ :function* _inverse-function_)

• viewpoint-name: a symbol naming the viewpoint
• viewpoint-type: a symbol giving the type of the derived viewpoint (derived for primitive derived; test for test; threaded for threaded)
• type-set: a list of basic viewpoints that this viewpoint is derived from and, therefore, capable of predicting
• events: a symbol denoting the first argument to ''viewpoint-function'' and ''inverse-function''
• element: a symbol denoting the second argument to ''inverse-function''
• viewpoint-function: a function of arity 1, which accepts a list of events, the events symbol above, representing a melody and returns a value from the domain of the viewpoint being defined or the +undefined+ symbol
• inverse-function: a function of arity 2, accepting a list of events and an element from the domain of the viewpoint, which returns the element from the domain of the basic viewpoint which would generate the supplied element if applied to the supplied event list with the last element removed (implemented for purposes of efficiency only and not required).

Example¶

Define a viewpoint cpint returning the pitch interval in semitones between the final two notes in a melodic sequence given a basic viewpoint cpitch which encodes chromatic pitch in semitones as midi note numbers:

(define-viewpoint (cpint derived (cpitch))
    (events element) 
  :function (multiple-value-bind (e1 e2)
                (values-list (last events 2))
              (if (or (null e1) (null e2)) +undefined+
                  (let ((cpitch1 (cpitch (list e1)))
                        (cpitch2 (cpitch (list e2))))
                    (if (undefined-p cpitch1 cpitch2) +undefined+
                        (- cpitch2 cpitch1)))))
  :function* (list (+ element (cpitch (list (penultimate-element events))))))