From 66fc66d633b682b5c3de3dd88aa730662fbbac06 Mon Sep 17 00:00:00 2001 From: Brian Rosenberg Date: Fri, 22 Dec 2023 13:05:08 -0500 Subject: [PATCH 1/2] Update REST API doc to use path parameters for pipelines --- docs/docs/html/REST-API.html | 400 ++++++++++++++++++++++++++++++++++- docs/site/html/REST-API.html | 400 ++++++++++++++++++++++++++++++++++- docs/site/index.html | 2 +- docs/site/sitemap.xml | 54 ++--- 4 files changed, 808 insertions(+), 48 deletions(-) diff --git a/docs/docs/html/REST-API.html b/docs/docs/html/REST-API.html index fcca14175ec3..09d48d5c4af2 100644 --- a/docs/docs/html/REST-API.html +++ b/docs/docs/html/REST-API.html @@ -183,7 +183,7 @@

Version 7.2


-
Last updated on: December 14, 2023
+
Last updated on: December 22, 2023

Introduction

@@ -260,15 +260,19 @@

2. Paths

POST   /rest/components/registerUnmanaged
DELETE   /rest/components/{componentName}
GET   /rest/pipelines
+
GET   /rest/pipelines/{name}
POST   /rest/pipelines
-
DELETE   /rest/pipelines?name={name}
+
DELETE   /rest/pipelines/{name}
GET   /rest/tasks
+
GET   /rest/tasks/{name}
POST   /rest/tasks
-
DELETE   /rest/tasks?name={name}
+
DELETE   /rest/tasks/{name}
GET   /rest/actions
+
GET   /rest/actions/{name}
POST   /rest/actions
-
DELETE   /rest/actions?name={name}
+
DELETE   /rest/actions/{name}
GET   /rest/algorithms
+
GET   /rest/algorithms{name}
POST   /rest/jobs/tiesdbrepost
@@ -4539,6 +4543,100 @@

2. Paths

+
+ 
GET   /rest/pipelines/{name}
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single pipeline. +
Description +
Operation Id
ProducesPipeline
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathPipeline NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no pipeline with the given name. +
+
+
+
+ 
POST  /rest/pipelines
@@ -4639,7 +4737,7 @@

2. Paths

- 
DELETE  /rest/pipeline?name={name}
+ 
DELETE  /rest/pipeline/{name}
@@ -4682,7 +4780,7 @@

2. Paths

- + @@ -4784,6 +4882,99 @@

2. Paths

+
+ 
GET   /rest/tasks/{name}
+
+
namequery stringpath Name of pipeline
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single task. +
Description +
Operation Id
ProducesTask
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathTask NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no task with the given name. +
+
+
+ 
POST  /rest/tasks
@@ -4884,7 +5075,7 @@

2. Paths

- 
DELETE  /rest/tasks?name={name}
+ 
DELETE  /rest/tasks/{name}
@@ -4927,7 +5118,7 @@

2. Paths

- + @@ -5028,6 +5219,100 @@

2. Paths

+
+ 
GET   /rest/actions/{name}
+
+
namequery stringpath Name of task.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single action. +
Description +
Operation Id
ProducesAction
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathAction NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no action with the given name. +
+
+
+
+ 
POST  /rest/actions
@@ -5127,7 +5412,7 @@

2. Paths

- 
DELETE  /rest/actions?name={name}
+ 
DELETE  /rest/actions/{name}
@@ -5170,7 +5455,7 @@

2. Paths

- + @@ -5271,6 +5556,101 @@

2. Paths
namequery stringpath Name of action.
+ +
+ 
GET   /rest/algorithms/{name}
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single algorithm. +
Description +
Operation Id
ProducesAlgorithm
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathAlgorithm NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no algorithm with the given name. +
+
+
+
+ 
POST  /rest/jobs/tiesdbrepost
diff --git a/docs/site/html/REST-API.html b/docs/site/html/REST-API.html index fcca14175ec3..09d48d5c4af2 100644 --- a/docs/site/html/REST-API.html +++ b/docs/site/html/REST-API.html @@ -183,7 +183,7 @@

Version 7.2


-
Last updated on: December 14, 2023
+
Last updated on: December 22, 2023

Introduction

@@ -260,15 +260,19 @@

2. Paths

POST   /rest/components/registerUnmanaged
DELETE   /rest/components/{componentName}
GET   /rest/pipelines
+
GET   /rest/pipelines/{name}
POST   /rest/pipelines
-
DELETE   /rest/pipelines?name={name}
+
DELETE   /rest/pipelines/{name}
GET   /rest/tasks
+
GET   /rest/tasks/{name}
POST   /rest/tasks
-
DELETE   /rest/tasks?name={name}
+
DELETE   /rest/tasks/{name}
GET   /rest/actions
+
GET   /rest/actions/{name}
POST   /rest/actions
-
DELETE   /rest/actions?name={name}
+
DELETE   /rest/actions/{name}
GET   /rest/algorithms
+
GET   /rest/algorithms{name}
POST   /rest/jobs/tiesdbrepost
@@ -4539,6 +4543,100 @@

2. Paths

+
+ 
GET   /rest/pipelines/{name}
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single pipeline. +
Description +
Operation Id
ProducesPipeline
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathPipeline NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no pipeline with the given name. +
+
+
+
+ 
POST  /rest/pipelines
@@ -4639,7 +4737,7 @@

2. Paths

- 
DELETE  /rest/pipeline?name={name}
+ 
DELETE  /rest/pipeline/{name}
@@ -4682,7 +4780,7 @@

2. Paths

- + @@ -4784,6 +4882,99 @@

2. Paths

+
+ 
GET   /rest/tasks/{name}
+
+
namequery stringpath Name of pipeline
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single task. +
Description +
Operation Id
ProducesTask
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathTask NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no task with the given name. +
+
+
+ 
POST  /rest/tasks
@@ -4884,7 +5075,7 @@

2. Paths

- 
DELETE  /rest/tasks?name={name}
+ 
DELETE  /rest/tasks/{name}
@@ -4927,7 +5118,7 @@

2. Paths

- + @@ -5028,6 +5219,100 @@

2. Paths

+
+ 
GET   /rest/actions/{name}
+
+
namequery stringpath Name of task.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single action. +
Description +
Operation Id
ProducesAction
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathAction NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no action with the given name. +
+
+
+
+ 
POST  /rest/actions
@@ -5127,7 +5412,7 @@

2. Paths

- 
DELETE  /rest/actions?name={name}
+ 
DELETE  /rest/actions/{name}
@@ -5170,7 +5455,7 @@

2. Paths

- + @@ -5271,6 +5556,101 @@

2. Paths
namequery stringpath Name of action.
+ +
+ 
GET   /rest/algorithms/{name}
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets a single algorithm. +
Description +
Operation Id
ProducesAlgorithm
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathAlgorithm NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no algorithm with the given name. +
+
+
+
+ 
POST  /rest/jobs/tiesdbrepost
diff --git a/docs/site/index.html b/docs/site/index.html index 3bfc16bb41d3..4699452e8e34 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -388,5 +388,5 @@

Overview

diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml index af3460156217..ece92a8a0f83 100644 --- a/docs/site/sitemap.xml +++ b/docs/site/sitemap.xml @@ -2,137 +2,137 @@ /index.html - 2023-12-20 + 2023-12-22 daily /Release-Notes/index.html - 2023-12-20 + 2023-12-22 daily /License-And-Distribution/index.html - 2023-12-20 + 2023-12-22 daily /Acknowledgements/index.html - 2023-12-20 + 2023-12-22 daily /Install-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Admin-Guide/index.html - 2023-12-20 + 2023-12-22 daily /User-Guide/index.html - 2023-12-20 + 2023-12-22 daily /OpenID-Connect-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Media-Segmentation-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Feed-Forward-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Derivative-Media-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Object-Storage-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Markup-Guide/index.html - 2023-12-20 + 2023-12-22 daily /TiesDb-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Trigger-Guide/index.html - 2023-12-20 + 2023-12-22 daily /REST-API/index.html - 2023-12-20 + 2023-12-22 daily /Component-API-Overview/index.html - 2023-12-20 + 2023-12-22 daily /Component-Descriptor-Reference/index.html - 2023-12-20 + 2023-12-22 daily /CPP-Batch-Component-API/index.html - 2023-12-20 + 2023-12-22 daily /Python-Batch-Component-API/index.html - 2023-12-20 + 2023-12-22 daily /Java-Batch-Component-API/index.html - 2023-12-20 + 2023-12-22 daily /GPU-Support-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Contributor-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Development-Environment-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Node-Guide/index.html - 2023-12-20 + 2023-12-22 daily /Workflow-Manager-Architecture/index.html - 2023-12-20 + 2023-12-22 daily /CPP-Streaming-Component-API/index.html - 2023-12-20 + 2023-12-22 daily \ No newline at end of file From 8c186a5e347d65611ee88214f30e2fcfa04ae9d5 Mon Sep 17 00:00:00 2001 From: Brian Rosenberg Date: Wed, 17 Jan 2024 08:02:31 -0500 Subject: [PATCH 2/2] Address PR issues --- docs/docs/Markup-Guide.md | 8 ++--- docs/docs/html/REST-API.html | 2 +- docs/site/Markup-Guide/index.html | 6 ++-- docs/site/html/REST-API.html | 2 +- docs/site/index.html | 2 +- docs/site/search/search_index.json | 6 ++-- docs/site/sitemap.xml | 54 +++++++++++++++--------------- 7 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/docs/Markup-Guide.md b/docs/docs/Markup-Guide.md index 413c95dd47b0..6b21123442c5 100644 --- a/docs/docs/Markup-Guide.md +++ b/docs/docs/Markup-Guide.md @@ -16,7 +16,7 @@ default values can be changed be setting the system property listed for each: - `MARKUP_LABELS_ENABLED` - System property: `markup.labels.enabled` - - Default value: `true` + - Default value: `true` - If true, add a label to each detection box. - `MARKUP_LABELS_ALPHA` - System property: `markup.labels.alpha` @@ -80,7 +80,7 @@ default values can be changed be setting the system property listed for each: - The CRF value can be from 0-63. Lower values mean better quality. Recommended values range from 15-35, with 31 being recommended for 1080p HD video. This property is only used if generating VP9-encoded `.webm` files - `MARKUP_ANIMATION_ENABLED` - System property: `markup.video.animation.enabled` - - Default value: `true` + - Default value: `false` - If true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position. # Video Markup Icons @@ -115,10 +115,10 @@ The frame above shows a paper clip icon to indicate that the detection is the re ![Walking With Border Skies](img/markup/walking-with-border-skis.jpg "Walking With Border Skis") The frame above shows the person detection in addition to a new skis detection. The confidence for the latter is lower, which is good considering the algorithm misclassified the person's shadow as skis. The skis track is only a few frames long, so the WFM determined it was a non-moving (stationary) track. This is represented by the anchor icon at the start of the label. Also, notice that the labels are semi-transparent. This allows you to read labels and see frame content that would otherwise be hidden if the labels were completely opaque. Note that you may want to set `MARKUP_LABELS_ALPHA` to `0.75` or greater when using the `mjpeg` encoder. - + # Video Encoder Considerations -Performing markup on an image will always generate a `.png` file. Performing markup on a video will generate a video file based on the value of `MARKUP_VIDEO_ENCODER`. The `vp9`, `h264`, and `mjpg` encoders are supported. +Performing markup on an image will always generate a `.png` file. Performing markup on a video will generate a video file based on the value of `MARKUP_VIDEO_ENCODER`. The `vp9`, `h264`, and `mjpg` encoders are supported. The `vp9` and `h264` encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the `.avi` files resulting from the `mjpeg` format must be downloaded and played using a separate program like [VLC](https://www.videolan.org/vlc/index.html) or [mpv](https://mpv.io/). In general, `h264` encoding is much faster than `vp9` encoding, so you may want to use it instead of `vp9`. Please be aware that you may be required to pay [Usage Royalties](License-And-Distribution.md#usage-royalties) when using the `h264` encoder for commercial purposes. diff --git a/docs/docs/html/REST-API.html b/docs/docs/html/REST-API.html index 09d48d5c4af2..8f83df34b553 100644 --- a/docs/docs/html/REST-API.html +++ b/docs/docs/html/REST-API.html @@ -272,7 +272,7 @@

2. Paths

POST   /rest/actions
DELETE   /rest/actions/{name}
GET   /rest/algorithms
-
GET   /rest/algorithms{name}
+
GET   /rest/algorithms/{name}
POST   /rest/jobs/tiesdbrepost
diff --git a/docs/site/Markup-Guide/index.html b/docs/site/Markup-Guide/index.html index a2cb83a774d4..726229f16623 100644 --- a/docs/site/Markup-Guide/index.html +++ b/docs/site/Markup-Guide/index.html @@ -252,7 +252,7 @@

Configuration

  • MARKUP_LABELS_ENABLED
    • System property: markup.labels.enabled
      • -
    • Default value: true
      • +
    • Default value: true
    • If true, add a label to each detection box.
    • @@ -346,7 +346,7 @@

    Configuration

  • MARKUP_ANIMATION_ENABLED
    • System property: markup.video.animation.enabled
      • -
    • Default value: true
      • +
    • Default value: false
    • If true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.
    • @@ -405,7 +405,7 @@

    Video Markup Examples

    Walking With Border Skies

    The frame above shows the person detection in addition to a new skis detection. The confidence for the latter is lower, which is good considering the algorithm misclassified the person's shadow as skis. The skis track is only a few frames long, so the WFM determined it was a non-moving (stationary) track. This is represented by the anchor icon at the start of the label. Also, notice that the labels are semi-transparent. This allows you to read labels and see frame content that would otherwise be hidden if the labels were completely opaque. Note that you may want to set MARKUP_LABELS_ALPHA to 0.75 or greater when using the mjpeg encoder.

    Video Encoder Considerations

    -

    Performing markup on an image will always generate a .png file. Performing markup on a video will generate a video file based on the value of MARKUP_VIDEO_ENCODER. The vp9, h264, and mjpg encoders are supported.

    +

    Performing markup on an image will always generate a .png file. Performing markup on a video will generate a video file based on the value of MARKUP_VIDEO_ENCODER. The vp9, h264, and mjpg encoders are supported.

    The vp9 and h264 encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the .avi files resulting from the mjpeg format must be downloaded and played using a separate program like VLC or mpv. In general, h264 encoding is much faster than vp9 encoding, so you may want to use it instead of vp9. Please be aware that you may be required to pay Usage Royalties when using the h264 encoder for commercial purposes.

    The mjpeg encoder is faster than both the vp9 and h264 encoders, but produces lower quality video. Specifically, the label text is not as clear. You may want to use it when developing components or marking up large video files.

    To give you a sense of performance, here are the results of a very limited batch of tests. Note that if you choose to use the vp9 encoder, you can increase the CRF value to reduce processing time at the cost of reduced video quality.

    diff --git a/docs/site/html/REST-API.html b/docs/site/html/REST-API.html index 09d48d5c4af2..8f83df34b553 100644 --- a/docs/site/html/REST-API.html +++ b/docs/site/html/REST-API.html @@ -272,7 +272,7 @@

    2. Paths

    POST   /rest/actions
    DELETE   /rest/actions/{name}
    GET   /rest/algorithms
    -
    GET   /rest/algorithms{name}
    +
    GET   /rest/algorithms/{name}
    POST   /rest/jobs/tiesdbrepost
diff --git a/docs/site/index.html b/docs/site/index.html index 4699452e8e34..fdd964691623 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -388,5 +388,5 @@

Overview

diff --git a/docs/site/search/search_index.json b/docs/site/search/search_index.json index 1db5432f2843..d53ee7c175b1 100644 --- a/docs/site/search/search_index.json +++ b/docs/site/search/search_index.json @@ -462,7 +462,7 @@ }, { "location": "/Markup-Guide/index.html", - "text": "NOTICE:\n This software (or technical data) was produced for the U.S. Government under contract, and is subject to the\nRights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2023 The MITRE Corporation. All Rights Reserved.\n\n\nOverview\n\n\nOpenMPF provides a Markup component that can be used to draw bounding boxes and labels on images and videos. The\ncomponent provides one task called \nOCV GENERIC MARKUP TASK\n that can be added to the end of any image and/or video\npipeline. By default, many other OpenMPF components provide \n* (WITH MARKUP)\n pipelines that use this task. Note that\nthe Markup component will not appear in the list of components in the Component Registration web UI because it's a core\nfeature of OpenMPF.\n\n\nConfiguration\n\n\nThe following properties can be set as job properties or algorithm properties on the \nMARKUPCV\n algorithm. Also, the\ndefault values can be changed be setting the system property listed for each:\n\n\n\n\nMARKUP_LABELS_ENABLED\n\n\nSystem property: \nmarkup.labels.enabled\n\n\nDefault value: \ntrue\n \n\n\nIf true, add a label to each detection box.\n\n\n\n\n\n\nMARKUP_LABELS_ALPHA\n\n\nSystem property: \nmarkup.labels.alpha\n\n\nDefault value: \n0.5\n\n\nValue in range [0.0, 1.0] that specifies how transparent the labels and frame number overlay should be. 0.0 is invisible (not recommended) and 1.0 is fully opaque.\n\n\n\n\n\n\nMARKUP_LABELS_FROM_DETECTIONS\n\n\nSystem property: \nmarkup.labels.from.detections\n\n\nDefault value: \nfalse\n\n\nIf true, use detection-level details to populate the bounding box labels. Otherwise, use track-level details.\n\n\n\n\n\n\nMARKUP_LABELS_TRACK_INDEX_ENABLED\n\n\nSystem property: \nmarkup.labels.track.index.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, add the track index to the start of every bounding box label.\n\n\n\n\n\n\nMARKUP_LABELS_TEXT_PROP_TO_SHOW\n\n\nSystem property: \nmarkup.labels.text.prop.to.show\n\n\nDefault value: \nCLASSIFICATION\n\n\nName of the text property to show in the label before the numeric property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit.\n\n\n\n\n\n\nMARKUP_TEXT_LABEL_MAX_LENGTH\n\n\nSystem property: \nmarkup.labels.text.max.length\n\n\nDefault value: \n10\n\n\nThe maximum length of the label selected by \nMARKUP_LABELS_TEXT_PROP_TO_SHOW\n.\n If the label is longer than the limit, characters after limit will not be displayed.\n\n\n\n\n\n\nMARKUP_LABELS_NUMERIC_PROP_TO_SHOW\n\n\nSystem property: \nmarkup.labels.numeric.prop.to.show\n\n\nDefault value: \nCONFIDENCE\n\n\nName of the numeric property to show in the label after the text property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit. Set to CONFIDENCE to use the confidence value.\n\n\nNumeric values are displayed with a precision of 3 decimal places in the label.\n\n\n\n\n\n\nMARKUP_LABELS_CHOOSE_SIDE_ENABLED\n\n\nSystem property: \nmarkup.labels.choose.side.enabled\n\n\nDefault value: \ntrue\n\n\nLabels will always snap to the top-most corner of the box. If true, snap the label to the side of the corner that produces the least amount of overhang. If false, always show the label on the right side of the corner.\n\n\n\n\n\n\nMARKUP_BORDER_ENABLED\n\n\nSystem property: \nmarkup.border.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, generate the marked-up frame with a black border. Can be useful if boxes or labels extend beyond frame boundaries.\n\n\n\n\n\n\nMARKUP_VIDEO_EXEMPLAR_ICONS_ENABLED\n\n\nSystem property: \nmarkup.video.exemplar.icons.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, and labels are enabled, use an icon to indicate the exemplar detection for each track.\n\n\nThe icons are only used in video markup. This is because every detection is an exemplar in image markup.\n\n\n\n\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\nSystem property: \nmarkup.video.box.source.icons.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, and labels are enabled, use icons to indicate the source of each bounding box. For example, if the box is the result of an algorithm detection, tracking performing gap fill, or Workflow Manager animation.\n\n\n\n\n\n\nMARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED\n\n\nSystem property: \nmarkup.video.moving.object.icons.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, and labels are enabled, use icons to indicate if the object is considered moving or stationary. If using track-level details, and the \nMOVING\n property is not present at the track level, then the property for the track's exemplar will be used.\n\n\n\n\n\n\nMARKUP_VIDEO_FRAME_NUMBERS_ENABLED\n\n\nSystem property: \nmarkup.video.frame.numbers.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, add the frame number to each marked-up frame. This setting is independent of \nMARKUP_LABELS_ENABLED\n.\n\n\n\n\n\n\nMARKUP_VIDEO_ENCODER\n\n\nSystem property: \nmarkup.video.encoder\n\n\nDefault value: \nvp9\n\n\nUse \nvp9\n to generate VP9-encoded \n.webm\n video files. Use \nh264\n to generate H.264-encoded \n.mp4\n files. Use \nmjpeg\n to generate MJPEG-encoded \n.avi\n files. The \n.webm\n and \n.mp4\n files can display in most browsers, and are higher quality, but take longer to generate.\n\n\nPlease review the \nUsage Royalties\n section of the License and Distribution page before using the H.264 encoder for commercial purposes.\n\n\n\n\n\n\nMARKUP_VIDEO_VP9_CRF\n\n\nSystem property: \nmarkup.video.vp9.crf\n\n\nDefault value: \n31\n\n\nThe CRF value can be from 0-63. Lower values mean better quality. Recommended values range from 15-35, with 31 being recommended for 1080p HD video. This property is only used if generating VP9-encoded \n.webm\n files\n\n\n\n\n\n\nMARKUP_ANIMATION_ENABLED\n\n\nSystem property: \nmarkup.video.animation.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.\n\n\n\n\n\n\n\n\nVideo Markup Icons\n\n\n\n\n\n\n\n\nIcon\n\n\nMeaning\n\n\nSetting\n\n\n\n\n\n\n\n\n\n\n\n\nTrack exemplar\n\n\nMARKUP_VIDEO_EXEMPLAR_ICONS_ENABLED\n\n\n\n\n\n\n\n\nTrack or detection is moving\n\n\nMARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED\n\n\n\n\n\n\n\n\nTrack or detection is stationary\n\n\nMARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED\n\n\n\n\n\n\n\n\nDetection is the direct result of a component detection algorithm\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\n\n\n\n\n\n\nDetection is the result of a component performing tracking in an attempt to fill in the gaps between algorithm detections\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\n\n\n\n\n\n\nDetection is the result of the Workflow Manager interpolating (animating) the size and position of the bounding box to fill gaps between detections in the track\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\n\n\n\n\n\n\nVideo Markup Examples\n\n\n\n\nAbove we show frame 94 of a marked up video. Frame numbers are enabled so the frame number is shown in the top-right corner. Exemplar icons are enabled, and since this detection is the track exemplar a star icon is shown in the label. Also, the label shows the track's \nCLASSIFICATION\n property followed by the track confidence. All of the examples shown in this section will display track-level information because \nMARKUP_LABELS_FROM_DETECTIONS=false\n. The circle represents the top-left corner of the detection. See \nthis section\n of the C++ Batch Component API for more information on flip and rotation.\n\n\n\n\nAbove we show frame 25 of the marked up video. This time we configured markup to show a black border around the video frame. This is useful when the label extends beyond the edge of the original video frame, as shown here. Also, this time we configured markup to show icons indicating if the track is moving or stationary. The fast-forward icon at the start of the label indicates that this track is moving. Additionally, this time we configured markup to show icons indicating the bounding box source. The magnifying glass icon after the fast-forward icon indicates that this detection is a direct result of the component's detection algorithm. Note that the magnifying glass icon will be replaced with the star icon for exemplars.\n\n\n\n\nThe frame above shows a movie camera icon to indicate that the detection is the result of the Workflow Manager (WFM) interpolating (animating) the size and position of the bounding box to fill gaps between detections in the track. Considering how blurry the person appears in this frame, it's not surprising that the algorithm could not detect him. If you perform a job with \nFRAME_INTERVAL\n greater than one, or otherwise perform frame skipping, then all bounding boxes in skipped frames will be the result of WFM animation. Note that the classification and confidence values are simply carried over from the last detection that was not the result of WFM animation.\n\n\n\n\nThe frame above shows a paper clip icon to indicate that the detection is the result of the component performing tracking in an attempt to fill in the gaps between algorithm detections. In general, these detections are more trustworthy than the ones resulting from WFM animation, but not as trustworthy as the ones directly resulting from the detection algorithm.\n\n\n\n\nThe frame above shows the person detection in addition to a new skis detection. The confidence for the latter is lower, which is good considering the algorithm misclassified the person's shadow as skis. The skis track is only a few frames long, so the WFM determined it was a non-moving (stationary) track. This is represented by the anchor icon at the start of the label. Also, notice that the labels are semi-transparent. This allows you to read labels and see frame content that would otherwise be hidden if the labels were completely opaque. Note that you may want to set \nMARKUP_LABELS_ALPHA\n to \n0.75\n or greater when using the \nmjpeg\n encoder.\n\n\nVideo Encoder Considerations\n\n\nPerforming markup on an image will always generate a \n.png\n file. Performing markup on a video will generate a video file based on the value of \nMARKUP_VIDEO_ENCODER\n. The \nvp9\n, \nh264\n, and \nmjpg\n encoders are supported. \n\n\nThe \nvp9\n and \nh264\n encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the \n.avi\n files resulting from the \nmjpeg\n format must be downloaded and played using a separate program like \nVLC\n or \nmpv\n. In general, \nh264\n encoding is much faster than \nvp9\n encoding, so you may want to use it instead of \nvp9\n. Please be aware that you may be required to pay \nUsage Royalties\n when using the \nh264\n encoder for commercial purposes.\n\n\nThe \nmjpeg\n encoder is faster than both the \nvp9\n and \nh264\n encoders, but produces lower quality video. Specifically, the label text is not as clear. You may want to use it when developing components or marking up large video files.\n\n\nTo give you a sense of performance, here are the results of a very limited batch of tests. Note that if you choose to use the \nvp9\n encoder, you can increase the CRF value to reduce processing time at the cost of reduced video quality.\n\n\ninput media: 23 frames @ 3840x2160:\n\n\n\n\n\n\n\n\nEncoder\n\n\nCRF\n\n\nTime (secs)\n\n\nNotes\n\n\n\n\n\n\n\n\n\n\nmjpeg\n\n\n\n\n6.94\n\n\n\n\n\n\n\n\nh264\n\n\n\n\n9.478\n\n\n\n\n\n\n\n\nvp9\n\n\n60\n\n\n13.194\n\n\n\n\n\n\n\n\nvp9\n\n\n31\n\n\n21.431\n\n\n\n\n\n\n\n\n\n\ninput media: 509 frames @ 640x480:\n\n\n\n\n\n\n\n\nEncoder\n\n\nCRF\n\n\nTime (secs)\n\n\nNotes\n\n\n\n\n\n\n\n\n\n\nmjpeg\n\n\n\n\n6.927\n\n\nalpha 0.5 is hard to read when blended with dark background; 0.75 does better\n\n\n\n\n\n\nh264\n\n\n\n\n11.259\n\n\n\n\n\n\n\n\nvp9\n\n\n60\n\n\n35.945\n\n\ntext not acceptable due to low resolution\n\n\n\n\n\n\nvp9\n\n\n31\n\n\n52.178", + "text": "NOTICE:\n This software (or technical data) was produced for the U.S. Government under contract, and is subject to the\nRights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2023 The MITRE Corporation. All Rights Reserved.\n\n\nOverview\n\n\nOpenMPF provides a Markup component that can be used to draw bounding boxes and labels on images and videos. The\ncomponent provides one task called \nOCV GENERIC MARKUP TASK\n that can be added to the end of any image and/or video\npipeline. By default, many other OpenMPF components provide \n* (WITH MARKUP)\n pipelines that use this task. Note that\nthe Markup component will not appear in the list of components in the Component Registration web UI because it's a core\nfeature of OpenMPF.\n\n\nConfiguration\n\n\nThe following properties can be set as job properties or algorithm properties on the \nMARKUPCV\n algorithm. Also, the\ndefault values can be changed be setting the system property listed for each:\n\n\n\n\nMARKUP_LABELS_ENABLED\n\n\nSystem property: \nmarkup.labels.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, add a label to each detection box.\n\n\n\n\n\n\nMARKUP_LABELS_ALPHA\n\n\nSystem property: \nmarkup.labels.alpha\n\n\nDefault value: \n0.5\n\n\nValue in range [0.0, 1.0] that specifies how transparent the labels and frame number overlay should be. 0.0 is invisible (not recommended) and 1.0 is fully opaque.\n\n\n\n\n\n\nMARKUP_LABELS_FROM_DETECTIONS\n\n\nSystem property: \nmarkup.labels.from.detections\n\n\nDefault value: \nfalse\n\n\nIf true, use detection-level details to populate the bounding box labels. Otherwise, use track-level details.\n\n\n\n\n\n\nMARKUP_LABELS_TRACK_INDEX_ENABLED\n\n\nSystem property: \nmarkup.labels.track.index.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, add the track index to the start of every bounding box label.\n\n\n\n\n\n\nMARKUP_LABELS_TEXT_PROP_TO_SHOW\n\n\nSystem property: \nmarkup.labels.text.prop.to.show\n\n\nDefault value: \nCLASSIFICATION\n\n\nName of the text property to show in the label before the numeric property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit.\n\n\n\n\n\n\nMARKUP_TEXT_LABEL_MAX_LENGTH\n\n\nSystem property: \nmarkup.labels.text.max.length\n\n\nDefault value: \n10\n\n\nThe maximum length of the label selected by \nMARKUP_LABELS_TEXT_PROP_TO_SHOW\n.\n If the label is longer than the limit, characters after limit will not be displayed.\n\n\n\n\n\n\nMARKUP_LABELS_NUMERIC_PROP_TO_SHOW\n\n\nSystem property: \nmarkup.labels.numeric.prop.to.show\n\n\nDefault value: \nCONFIDENCE\n\n\nName of the numeric property to show in the label after the text property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit. Set to CONFIDENCE to use the confidence value.\n\n\nNumeric values are displayed with a precision of 3 decimal places in the label.\n\n\n\n\n\n\nMARKUP_LABELS_CHOOSE_SIDE_ENABLED\n\n\nSystem property: \nmarkup.labels.choose.side.enabled\n\n\nDefault value: \ntrue\n\n\nLabels will always snap to the top-most corner of the box. If true, snap the label to the side of the corner that produces the least amount of overhang. If false, always show the label on the right side of the corner.\n\n\n\n\n\n\nMARKUP_BORDER_ENABLED\n\n\nSystem property: \nmarkup.border.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, generate the marked-up frame with a black border. Can be useful if boxes or labels extend beyond frame boundaries.\n\n\n\n\n\n\nMARKUP_VIDEO_EXEMPLAR_ICONS_ENABLED\n\n\nSystem property: \nmarkup.video.exemplar.icons.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, and labels are enabled, use an icon to indicate the exemplar detection for each track.\n\n\nThe icons are only used in video markup. This is because every detection is an exemplar in image markup.\n\n\n\n\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\nSystem property: \nmarkup.video.box.source.icons.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, and labels are enabled, use icons to indicate the source of each bounding box. For example, if the box is the result of an algorithm detection, tracking performing gap fill, or Workflow Manager animation.\n\n\n\n\n\n\nMARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED\n\n\nSystem property: \nmarkup.video.moving.object.icons.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, and labels are enabled, use icons to indicate if the object is considered moving or stationary. If using track-level details, and the \nMOVING\n property is not present at the track level, then the property for the track's exemplar will be used.\n\n\n\n\n\n\nMARKUP_VIDEO_FRAME_NUMBERS_ENABLED\n\n\nSystem property: \nmarkup.video.frame.numbers.enabled\n\n\nDefault value: \ntrue\n\n\nIf true, add the frame number to each marked-up frame. This setting is independent of \nMARKUP_LABELS_ENABLED\n.\n\n\n\n\n\n\nMARKUP_VIDEO_ENCODER\n\n\nSystem property: \nmarkup.video.encoder\n\n\nDefault value: \nvp9\n\n\nUse \nvp9\n to generate VP9-encoded \n.webm\n video files. Use \nh264\n to generate H.264-encoded \n.mp4\n files. Use \nmjpeg\n to generate MJPEG-encoded \n.avi\n files. The \n.webm\n and \n.mp4\n files can display in most browsers, and are higher quality, but take longer to generate.\n\n\nPlease review the \nUsage Royalties\n section of the License and Distribution page before using the H.264 encoder for commercial purposes.\n\n\n\n\n\n\nMARKUP_VIDEO_VP9_CRF\n\n\nSystem property: \nmarkup.video.vp9.crf\n\n\nDefault value: \n31\n\n\nThe CRF value can be from 0-63. Lower values mean better quality. Recommended values range from 15-35, with 31 being recommended for 1080p HD video. This property is only used if generating VP9-encoded \n.webm\n files\n\n\n\n\n\n\nMARKUP_ANIMATION_ENABLED\n\n\nSystem property: \nmarkup.video.animation.enabled\n\n\nDefault value: \nfalse\n\n\nIf true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.\n\n\n\n\n\n\n\n\nVideo Markup Icons\n\n\n\n\n\n\n\n\nIcon\n\n\nMeaning\n\n\nSetting\n\n\n\n\n\n\n\n\n\n\n\n\nTrack exemplar\n\n\nMARKUP_VIDEO_EXEMPLAR_ICONS_ENABLED\n\n\n\n\n\n\n\n\nTrack or detection is moving\n\n\nMARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED\n\n\n\n\n\n\n\n\nTrack or detection is stationary\n\n\nMARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED\n\n\n\n\n\n\n\n\nDetection is the direct result of a component detection algorithm\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\n\n\n\n\n\n\nDetection is the result of a component performing tracking in an attempt to fill in the gaps between algorithm detections\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\n\n\n\n\n\n\nDetection is the result of the Workflow Manager interpolating (animating) the size and position of the bounding box to fill gaps between detections in the track\n\n\nMARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED\n\n\n\n\n\n\n\n\nVideo Markup Examples\n\n\n\n\nAbove we show frame 94 of a marked up video. Frame numbers are enabled so the frame number is shown in the top-right corner. Exemplar icons are enabled, and since this detection is the track exemplar a star icon is shown in the label. Also, the label shows the track's \nCLASSIFICATION\n property followed by the track confidence. All of the examples shown in this section will display track-level information because \nMARKUP_LABELS_FROM_DETECTIONS=false\n. The circle represents the top-left corner of the detection. See \nthis section\n of the C++ Batch Component API for more information on flip and rotation.\n\n\n\n\nAbove we show frame 25 of the marked up video. This time we configured markup to show a black border around the video frame. This is useful when the label extends beyond the edge of the original video frame, as shown here. Also, this time we configured markup to show icons indicating if the track is moving or stationary. The fast-forward icon at the start of the label indicates that this track is moving. Additionally, this time we configured markup to show icons indicating the bounding box source. The magnifying glass icon after the fast-forward icon indicates that this detection is a direct result of the component's detection algorithm. Note that the magnifying glass icon will be replaced with the star icon for exemplars.\n\n\n\n\nThe frame above shows a movie camera icon to indicate that the detection is the result of the Workflow Manager (WFM) interpolating (animating) the size and position of the bounding box to fill gaps between detections in the track. Considering how blurry the person appears in this frame, it's not surprising that the algorithm could not detect him. If you perform a job with \nFRAME_INTERVAL\n greater than one, or otherwise perform frame skipping, then all bounding boxes in skipped frames will be the result of WFM animation. Note that the classification and confidence values are simply carried over from the last detection that was not the result of WFM animation.\n\n\n\n\nThe frame above shows a paper clip icon to indicate that the detection is the result of the component performing tracking in an attempt to fill in the gaps between algorithm detections. In general, these detections are more trustworthy than the ones resulting from WFM animation, but not as trustworthy as the ones directly resulting from the detection algorithm.\n\n\n\n\nThe frame above shows the person detection in addition to a new skis detection. The confidence for the latter is lower, which is good considering the algorithm misclassified the person's shadow as skis. The skis track is only a few frames long, so the WFM determined it was a non-moving (stationary) track. This is represented by the anchor icon at the start of the label. Also, notice that the labels are semi-transparent. This allows you to read labels and see frame content that would otherwise be hidden if the labels were completely opaque. Note that you may want to set \nMARKUP_LABELS_ALPHA\n to \n0.75\n or greater when using the \nmjpeg\n encoder.\n\n\nVideo Encoder Considerations\n\n\nPerforming markup on an image will always generate a \n.png\n file. Performing markup on a video will generate a video file based on the value of \nMARKUP_VIDEO_ENCODER\n. The \nvp9\n, \nh264\n, and \nmjpg\n encoders are supported.\n\n\nThe \nvp9\n and \nh264\n encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the \n.avi\n files resulting from the \nmjpeg\n format must be downloaded and played using a separate program like \nVLC\n or \nmpv\n. In general, \nh264\n encoding is much faster than \nvp9\n encoding, so you may want to use it instead of \nvp9\n. Please be aware that you may be required to pay \nUsage Royalties\n when using the \nh264\n encoder for commercial purposes.\n\n\nThe \nmjpeg\n encoder is faster than both the \nvp9\n and \nh264\n encoders, but produces lower quality video. Specifically, the label text is not as clear. You may want to use it when developing components or marking up large video files.\n\n\nTo give you a sense of performance, here are the results of a very limited batch of tests. Note that if you choose to use the \nvp9\n encoder, you can increase the CRF value to reduce processing time at the cost of reduced video quality.\n\n\ninput media: 23 frames @ 3840x2160:\n\n\n\n\n\n\n\n\nEncoder\n\n\nCRF\n\n\nTime (secs)\n\n\nNotes\n\n\n\n\n\n\n\n\n\n\nmjpeg\n\n\n\n\n6.94\n\n\n\n\n\n\n\n\nh264\n\n\n\n\n9.478\n\n\n\n\n\n\n\n\nvp9\n\n\n60\n\n\n13.194\n\n\n\n\n\n\n\n\nvp9\n\n\n31\n\n\n21.431\n\n\n\n\n\n\n\n\n\n\ninput media: 509 frames @ 640x480:\n\n\n\n\n\n\n\n\nEncoder\n\n\nCRF\n\n\nTime (secs)\n\n\nNotes\n\n\n\n\n\n\n\n\n\n\nmjpeg\n\n\n\n\n6.927\n\n\nalpha 0.5 is hard to read when blended with dark background; 0.75 does better\n\n\n\n\n\n\nh264\n\n\n\n\n11.259\n\n\n\n\n\n\n\n\nvp9\n\n\n60\n\n\n35.945\n\n\ntext not acceptable due to low resolution\n\n\n\n\n\n\nvp9\n\n\n31\n\n\n52.178", "title": "Markup Guide" }, { @@ -472,7 +472,7 @@ }, { "location": "/Markup-Guide/index.html#configuration", - "text": "The following properties can be set as job properties or algorithm properties on the MARKUPCV algorithm. Also, the\ndefault values can be changed be setting the system property listed for each: MARKUP_LABELS_ENABLED System property: markup.labels.enabled Default value: true If true, add a label to each detection box. MARKUP_LABELS_ALPHA System property: markup.labels.alpha Default value: 0.5 Value in range [0.0, 1.0] that specifies how transparent the labels and frame number overlay should be. 0.0 is invisible (not recommended) and 1.0 is fully opaque. MARKUP_LABELS_FROM_DETECTIONS System property: markup.labels.from.detections Default value: false If true, use detection-level details to populate the bounding box labels. Otherwise, use track-level details. MARKUP_LABELS_TRACK_INDEX_ENABLED System property: markup.labels.track.index.enabled Default value: true If true, add the track index to the start of every bounding box label. MARKUP_LABELS_TEXT_PROP_TO_SHOW System property: markup.labels.text.prop.to.show Default value: CLASSIFICATION Name of the text property to show in the label before the numeric property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit. MARKUP_TEXT_LABEL_MAX_LENGTH System property: markup.labels.text.max.length Default value: 10 The maximum length of the label selected by MARKUP_LABELS_TEXT_PROP_TO_SHOW .\n If the label is longer than the limit, characters after limit will not be displayed. MARKUP_LABELS_NUMERIC_PROP_TO_SHOW System property: markup.labels.numeric.prop.to.show Default value: CONFIDENCE Name of the numeric property to show in the label after the text property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit. Set to CONFIDENCE to use the confidence value. Numeric values are displayed with a precision of 3 decimal places in the label. MARKUP_LABELS_CHOOSE_SIDE_ENABLED System property: markup.labels.choose.side.enabled Default value: true Labels will always snap to the top-most corner of the box. If true, snap the label to the side of the corner that produces the least amount of overhang. If false, always show the label on the right side of the corner. MARKUP_BORDER_ENABLED System property: markup.border.enabled Default value: false If true, generate the marked-up frame with a black border. Can be useful if boxes or labels extend beyond frame boundaries. MARKUP_VIDEO_EXEMPLAR_ICONS_ENABLED System property: markup.video.exemplar.icons.enabled Default value: true If true, and labels are enabled, use an icon to indicate the exemplar detection for each track. The icons are only used in video markup. This is because every detection is an exemplar in image markup. MARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED System property: markup.video.box.source.icons.enabled Default value: false If true, and labels are enabled, use icons to indicate the source of each bounding box. For example, if the box is the result of an algorithm detection, tracking performing gap fill, or Workflow Manager animation. MARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED System property: markup.video.moving.object.icons.enabled Default value: false If true, and labels are enabled, use icons to indicate if the object is considered moving or stationary. If using track-level details, and the MOVING property is not present at the track level, then the property for the track's exemplar will be used. MARKUP_VIDEO_FRAME_NUMBERS_ENABLED System property: markup.video.frame.numbers.enabled Default value: true If true, add the frame number to each marked-up frame. This setting is independent of MARKUP_LABELS_ENABLED . MARKUP_VIDEO_ENCODER System property: markup.video.encoder Default value: vp9 Use vp9 to generate VP9-encoded .webm video files. Use h264 to generate H.264-encoded .mp4 files. Use mjpeg to generate MJPEG-encoded .avi files. The .webm and .mp4 files can display in most browsers, and are higher quality, but take longer to generate. Please review the Usage Royalties section of the License and Distribution page before using the H.264 encoder for commercial purposes. MARKUP_VIDEO_VP9_CRF System property: markup.video.vp9.crf Default value: 31 The CRF value can be from 0-63. Lower values mean better quality. Recommended values range from 15-35, with 31 being recommended for 1080p HD video. This property is only used if generating VP9-encoded .webm files MARKUP_ANIMATION_ENABLED System property: markup.video.animation.enabled Default value: true If true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.", + "text": "The following properties can be set as job properties or algorithm properties on the MARKUPCV algorithm. Also, the\ndefault values can be changed be setting the system property listed for each: MARKUP_LABELS_ENABLED System property: markup.labels.enabled Default value: true If true, add a label to each detection box. MARKUP_LABELS_ALPHA System property: markup.labels.alpha Default value: 0.5 Value in range [0.0, 1.0] that specifies how transparent the labels and frame number overlay should be. 0.0 is invisible (not recommended) and 1.0 is fully opaque. MARKUP_LABELS_FROM_DETECTIONS System property: markup.labels.from.detections Default value: false If true, use detection-level details to populate the bounding box labels. Otherwise, use track-level details. MARKUP_LABELS_TRACK_INDEX_ENABLED System property: markup.labels.track.index.enabled Default value: true If true, add the track index to the start of every bounding box label. MARKUP_LABELS_TEXT_PROP_TO_SHOW System property: markup.labels.text.prop.to.show Default value: CLASSIFICATION Name of the text property to show in the label before the numeric property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit. MARKUP_TEXT_LABEL_MAX_LENGTH System property: markup.labels.text.max.length Default value: 10 The maximum length of the label selected by MARKUP_LABELS_TEXT_PROP_TO_SHOW .\n If the label is longer than the limit, characters after limit will not be displayed. MARKUP_LABELS_NUMERIC_PROP_TO_SHOW System property: markup.labels.numeric.prop.to.show Default value: CONFIDENCE Name of the numeric property to show in the label after the text property. If using track-level details, and this property is not present at the track level, then the detection property for the track's exemplar will be used. Leave empty to omit. Set to CONFIDENCE to use the confidence value. Numeric values are displayed with a precision of 3 decimal places in the label. MARKUP_LABELS_CHOOSE_SIDE_ENABLED System property: markup.labels.choose.side.enabled Default value: true Labels will always snap to the top-most corner of the box. If true, snap the label to the side of the corner that produces the least amount of overhang. If false, always show the label on the right side of the corner. MARKUP_BORDER_ENABLED System property: markup.border.enabled Default value: false If true, generate the marked-up frame with a black border. Can be useful if boxes or labels extend beyond frame boundaries. MARKUP_VIDEO_EXEMPLAR_ICONS_ENABLED System property: markup.video.exemplar.icons.enabled Default value: true If true, and labels are enabled, use an icon to indicate the exemplar detection for each track. The icons are only used in video markup. This is because every detection is an exemplar in image markup. MARKUP_VIDEO_BOX_SOURCE_ICONS_ENABLED System property: markup.video.box.source.icons.enabled Default value: false If true, and labels are enabled, use icons to indicate the source of each bounding box. For example, if the box is the result of an algorithm detection, tracking performing gap fill, or Workflow Manager animation. MARKUP_VIDEO_MOVING_OBJECT_ICONS_ENABLED System property: markup.video.moving.object.icons.enabled Default value: false If true, and labels are enabled, use icons to indicate if the object is considered moving or stationary. If using track-level details, and the MOVING property is not present at the track level, then the property for the track's exemplar will be used. MARKUP_VIDEO_FRAME_NUMBERS_ENABLED System property: markup.video.frame.numbers.enabled Default value: true If true, add the frame number to each marked-up frame. This setting is independent of MARKUP_LABELS_ENABLED . MARKUP_VIDEO_ENCODER System property: markup.video.encoder Default value: vp9 Use vp9 to generate VP9-encoded .webm video files. Use h264 to generate H.264-encoded .mp4 files. Use mjpeg to generate MJPEG-encoded .avi files. The .webm and .mp4 files can display in most browsers, and are higher quality, but take longer to generate. Please review the Usage Royalties section of the License and Distribution page before using the H.264 encoder for commercial purposes. MARKUP_VIDEO_VP9_CRF System property: markup.video.vp9.crf Default value: 31 The CRF value can be from 0-63. Lower values mean better quality. Recommended values range from 15-35, with 31 being recommended for 1080p HD video. This property is only used if generating VP9-encoded .webm files MARKUP_ANIMATION_ENABLED System property: markup.video.animation.enabled Default value: false If true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.", "title": "Configuration" }, { @@ -487,7 +487,7 @@ }, { "location": "/Markup-Guide/index.html#video-encoder-considerations", - "text": "Performing markup on an image will always generate a .png file. Performing markup on a video will generate a video file based on the value of MARKUP_VIDEO_ENCODER . The vp9 , h264 , and mjpg encoders are supported. The vp9 and h264 encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the .avi files resulting from the mjpeg format must be downloaded and played using a separate program like VLC or mpv . In general, h264 encoding is much faster than vp9 encoding, so you may want to use it instead of vp9 . Please be aware that you may be required to pay Usage Royalties when using the h264 encoder for commercial purposes. The mjpeg encoder is faster than both the vp9 and h264 encoders, but produces lower quality video. Specifically, the label text is not as clear. You may want to use it when developing components or marking up large video files. To give you a sense of performance, here are the results of a very limited batch of tests. Note that if you choose to use the vp9 encoder, you can increase the CRF value to reduce processing time at the cost of reduced video quality. input media: 23 frames @ 3840x2160: Encoder CRF Time (secs) Notes mjpeg 6.94 h264 9.478 vp9 60 13.194 vp9 31 21.431 input media: 509 frames @ 640x480: Encoder CRF Time (secs) Notes mjpeg 6.927 alpha 0.5 is hard to read when blended with dark background; 0.75 does better h264 11.259 vp9 60 35.945 text not acceptable due to low resolution vp9 31 52.178", + "text": "Performing markup on an image will always generate a .png file. Performing markup on a video will generate a video file based on the value of MARKUP_VIDEO_ENCODER . The vp9 , h264 , and mjpg encoders are supported. The vp9 and h264 encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the .avi files resulting from the mjpeg format must be downloaded and played using a separate program like VLC or mpv . In general, h264 encoding is much faster than vp9 encoding, so you may want to use it instead of vp9 . Please be aware that you may be required to pay Usage Royalties when using the h264 encoder for commercial purposes. The mjpeg encoder is faster than both the vp9 and h264 encoders, but produces lower quality video. Specifically, the label text is not as clear. You may want to use it when developing components or marking up large video files. To give you a sense of performance, here are the results of a very limited batch of tests. Note that if you choose to use the vp9 encoder, you can increase the CRF value to reduce processing time at the cost of reduced video quality. input media: 23 frames @ 3840x2160: Encoder CRF Time (secs) Notes mjpeg 6.94 h264 9.478 vp9 60 13.194 vp9 31 21.431 input media: 509 frames @ 640x480: Encoder CRF Time (secs) Notes mjpeg 6.927 alpha 0.5 is hard to read when blended with dark background; 0.75 does better h264 11.259 vp9 60 35.945 text not acceptable due to low resolution vp9 31 52.178", "title": "Video Encoder Considerations" }, { diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml index ece92a8a0f83..e7282c1af712 100644 --- a/docs/site/sitemap.xml +++ b/docs/site/sitemap.xml @@ -2,137 +2,137 @@ /index.html - 2023-12-22 + 2024-01-17 daily /Release-Notes/index.html - 2023-12-22 + 2024-01-17 daily /License-And-Distribution/index.html - 2023-12-22 + 2024-01-17 daily /Acknowledgements/index.html - 2023-12-22 + 2024-01-17 daily /Install-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Admin-Guide/index.html - 2023-12-22 + 2024-01-17 daily /User-Guide/index.html - 2023-12-22 + 2024-01-17 daily /OpenID-Connect-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Media-Segmentation-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Feed-Forward-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Derivative-Media-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Object-Storage-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Markup-Guide/index.html - 2023-12-22 + 2024-01-17 daily /TiesDb-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Trigger-Guide/index.html - 2023-12-22 + 2024-01-17 daily /REST-API/index.html - 2023-12-22 + 2024-01-17 daily /Component-API-Overview/index.html - 2023-12-22 + 2024-01-17 daily /Component-Descriptor-Reference/index.html - 2023-12-22 + 2024-01-17 daily /CPP-Batch-Component-API/index.html - 2023-12-22 + 2024-01-17 daily /Python-Batch-Component-API/index.html - 2023-12-22 + 2024-01-17 daily /Java-Batch-Component-API/index.html - 2023-12-22 + 2024-01-17 daily /GPU-Support-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Contributor-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Development-Environment-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Node-Guide/index.html - 2023-12-22 + 2024-01-17 daily /Workflow-Manager-Architecture/index.html - 2023-12-22 + 2024-01-17 daily /CPP-Streaming-Component-API/index.html - 2023-12-22 + 2024-01-17 daily \ No newline at end of file