included in: 1.0.2
Thing > Annotation > Region > Interval > TimeFrame
Definition | A temporal interval in an audio or video stream. This is similar to the term segment used in audio processing, but that term has a different meaning in the image and video community. |
URI | http://mmif.clams.ai/vocabulary/TimeFrame/v3 |
Metadata
Metadata from Region
Property | Type | Description |
---|---|---|
timeUnit | String | Specifies which unit of time the measurement is based. Can be *seconds* or *milliseconds*, or in case of annotations on a VideoDocument, *frames*. |
Metadata from Annotation
Property | Type | Description |
---|---|---|
document | ID | The identifier of the document that the annotation is over. This has to be defined either at the metadata level, in which case it has scope over all annotations of the same type in a view, or at the instance level, in which it has scope over just the single annotation. |
labelset | List of Strings |
When an annotation object contains results of a classification task, this metadata is used to specify the label values used in classification. Individual annotations then must have label property that is one of the values in this list. [Note] Annotations from a classifier app must have this metadata or labelsetUri metadata. [Note] Not all of labels specified in the labelset must occur in the output annotations. For example, a labelset can contain a catch-all negative label, but if the negative label can be not interesting enough to keep in the output annotation.
|
labelsetUri | String |
A URI to an externally defined labelset. Since the labelset metadata is a list of simple strings, this URI can be used to point to a more detailed definition of the labelset. This can be a JSON-LD document or a SKOS concept scheme, for example. [Note] Annotations from a classifier app must have this metadata or labelset metadata.
|
Properties
Property | Type | Description |
---|---|---|
frameType | String |
The type of TimeFrame. Possible values include, but are not limited to, bars, tones, bars-and-tones, speech, noise, music, slate, chyron, lower-third, credits, and other. No longer encouraged to use, instead label property should replace this property.
|
Properties from Interval
Property | Type | Description |
---|---|---|
start | Integer | The starting offset in the primary data. This point is inclusive. For time intervals, the unit is determined by the *timeUnit* metadata key. For text intervals, the unit is Unicode code point. |
end | Integer | The ending offset in the primary data. This point is exclusive. For time intervals, the unit is determined by the *timeUnit* metadata key. For text intervals, the unit is Unicode code point. |
targets | List of IDs | IDs of a sequence of annotations covering the region of primary data referred to by this annotation. Used as an alternative to *start* and *end* to point to component annotations (for example a token sequence) rather than directly into primary data, or to link two or more annotations (for example in a coreference annotation). |
Properties from Annotation
Property | Type | Description |
---|---|---|
document | ID | The identifier of the document that the annotation is over. |
label | String |
A label given to this object by a classifier. The value must be a simple string value of the label and must be one of the values defined in the labelset or labelsetUri annotation metadata. [Note] Annotations from a classifier app must have this property. |
classifications | Map from String to Number |
A map from label values to their "score" numbers provided by a classifier. The score can be probability, similarity, confidence, or any other real number that was used to determine the label value. [Optional] on top of the label property. However when this property is used, the label property must be one of the keys and the keys must match to the values defined in the labelset
or labelsetUri annotation metadata.
|
Properties from Thing
Property | Type | Description |
---|---|---|
id | ID | A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file. [Required] |