Interface IUnitizingAnnotationStudy

All Superinterfaces:
IAnnotationStudy, java.io.Serializable
All Known Implementing Classes:
UnitizingAnnotationStudy

public interface IUnitizingAnnotationStudy
extends IAnnotationStudy
Data model for unitizing studies. Unitizing studies are characterized by a continuum in which a number of (human) raters are asked to identify the boundaries of annotation units and optionally code the units with a certain category. The continuum is represented on a sampled, discretized integer scale starting with 0 (unless otherwise specified). Note that this interface allows reusing existing data representations by implementing the required methods. Use UnitizingAnnotationStudy as a default implementation if no existing data representation exists. The default implementation facilitates adding the individual units.
Author:
Christian M. Meyer
See Also:
UnitizingAnnotationStudy, IUnitizingAnnotationUnit
  • Method Details

    • getUnits

      java.util.Collection<IUnitizingAnnotationUnit> getUnits()
      Allows iterating all annotation units of this study.
    • getContinuumBegin

      long getContinuumBegin()
      Returns the begin of the continuum (i.e., the first offset that is considered valid for annotation units).
    • getContinuumLength

      long getContinuumLength()
      Returns the length of the continuum (i.e., the last possible right delimiter of an annotation unit).
    • getUnitCount

      long getUnitCount​(int aRaterIdx)
      Returns the number of units rated by the given rater.