IDyOM Project

h1. Adding Viewpoints

h2. Basic viewpoints

1. Add the viewpoint definition to <code>basic-viewpoints.lisp</code> in the directory <code>viewpoints</code>:

<pre>

(define-basic-viewpoint ornament (events)

   (let ((x (amuse-mtp::%mtp-ornament (car (last events)))))

     (if x x viewpoints:+undefined+)))

</pre>

Ideally, we would have an amuse interface to ornaments to make this general. I.e., we would replace the call the <code>%mtp-ornament</code> (which is specific to the mtp backend) above with one to <code>amuse:event-ornament</code> 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

<pre> 

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

</pre>

2b. In <code>amuse/implementations/mtp/classes.lisp</code>: 

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

2c. In <code>amuse/implementations/mtp/methods.lisp</code>: 

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

h2. Derived viewpoints

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

<pre>(define-viewpoint (viewpoint-name viewpoint-type (type-set)) (events element) :function viewpoint-function :function* inverse-function)</pre>

* _viewpoint-name_: a symbol naming the viewpoint 

* _viewpoint-type_: a symbol giving the type of the derived viewpoint (<code>derived</code> for primitive derived; <code>test</code> for test; <code>threaded</code> 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 <code>events</code> symbol above, representing a melody and returns a value from the domain of the viewpoint being defined or the <code>+undefined+</code> 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).

h3. Example

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

<pre>

(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))))))

</pre>