view tools/segmentation/generics.lisp @ 85:c81375b9304f

tools/segmentation: s/documenatation/documentation

darcs-hash:20070717164946-c0ce4-a7b73d1d9c894d48bc9b586910ec9f0133f913b6.gz

(in-package "AMUSE-SEGMENTATION")

(defgeneric boundary-strength (segmenter object composition)
  (:documentation "Returns a (positive?) number, with 0
  indicating no boundary. N.B. Whether this indicates a boundary
  before or after moment-designator is the responsibility of the
  caller to know."))

(defgeneric boundary-time (segmenter object)
  (:documentation "Returns the moment that the value returned by
  boundary-strength applies to if object is the second input to
  the method. Essentially, this distinguishes between segmenters
  that look to the beginning of a note and those that look at the
  end."))

(defgeneric ground-truth-segmenter-before (composition)
  (:documentation "Returns the segmenter that, when put into
  boundary-strength, supplies segmentation as given in a
  ground truth for the composition. N.B. This needs to return one
  segmenter only, so in cases of multiple ground truths, this
  method must arbitrate."))

(defgeneric ground-truth-segmenter-after (composition)
  (:documentation "Returns the segmenter that, when put into
  boundary-strength-after, supplies segmentation as given in a
  ground truth for the composition. N.B. This needs to return one
  segmenter only, so in cases of multiple ground truths, this
  method must arbitrate."))

(defgeneric ground-truth-segmenterp (segmenter)
  (:method ((s ground-truth-segmenter)) t)
  (:method (s) nil)) ;; prob not necessary?
(defgeneric segments-beforep (segmenter)
  (:method ((s before-segmenter)) t)
  (:method ((s after-segmenter)) nil))
(defgeneric segments-afterp (segmenter)
  (:method (s) (not (segments-beforep s))))

(defgeneric make-segmentation (segmenter composition)
  (:documentation "Basic way to generate segmentation
  object. N.B. Requires segmenter to do more work than
  hitherto."))

(defgeneric ground-truth-segmentation (segmentation)
  (:documentation "Returns the relevant ground-truth for
  evaluating segmentation"))
(defgeneric (setf ground-truth-segmentation) (segmentation value)
  (:documentation "Sets the segmentation to be used as ground
  truth by segmentation to value"))
(defgeneric precision (segmentation)
  (:documentation "Returns the precision ratio for segmentation
  when compared with the (ground-truth-segmentation
  segmentation)"))
(defgeneric recall (segmentation)
  (:documentation "Returns the precision ratio for segmentation
  when compared with the (ground-truth-segmentation
  segmentation)"))
(defgeneric fall-out (segmentation)
  (:documentation "Returns the precision ratio for segmentation
  when compared with the (ground-truth-segmentation
  segmentation)"))
(defgeneric F-measure (segmentation)
  (:documentation "Returns the precision ratio for segmentation
  when compared with the (ground-truth-segmentation
  segmentation)"))

(defgeneric boundary-list (segmentation)
  (:documentation "Returns a list of moments corresponding to the
  boundary points of the segmentation"))
(defgeneric segment-list (segmentation)
  (:documentation "Returns a list of anchored periods
  corresponding to the segments resulting from the segmentation"))