Skip to content

Commit 2d6ed79

Browse files
clnowackijrobble
andauthored
Add quality selection guide (#180)
* Added Quality Selection Guide and updated Feed-Forward Guide Co-authored-by: Jeff Robble <jrobble@mitre.org>
1 parent 20d2aff commit 2d6ed79

42 files changed

Lines changed: 941 additions & 158 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/docs/Admin-Guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ An admin user can click inside of the "Value" field for any of the properties an
3232

3333
Note that if the admin user types in the original value of the property, or clicks the "Reset" button, then it will return back to the normal coloration.
3434

35-
<div style="background-color:orange"><p style="color:white; padding:5px"><b>WARNING:</b> Changing the value of these properties can prevent the workflow manager from running after the web server is restarted. Also, no validation checks are performed on the user-provided values. Proceed with caution!</p></div>
35+
<div style="background-color:orange"><p style="color:white; padding:5px"><b>WARNING:</b> Changing the value of these properties can prevent the Workflow Manager from running after the web server is restarted. Also, no validation checks are performed on the user-provided values. Proceed with caution!</p></div>
3636

37-
At the bottom of the properties table is the "Save Properties" button. The number of modified properties is shown in parentheses. Clicking the button will make the necessary changes to the properties file on the file system, but the changes will not take effect until the workflow manager is restarted. The saved properties will be colored blue and a blue icon will be displayed to the right of the property name. Additionally, a notification will appear at the top of the page alerting all system users that a restart is required:
37+
At the bottom of the properties table is the "Save Properties" button. The number of modified properties is shown in parentheses. Clicking the button will make the necessary changes to the properties file on the file system, but the changes will not take effect until the Workflow Manager is restarted. The saved properties will be colored blue and a blue icon will be displayed to the right of the property name. Additionally, a notification will appear at the top of the page alerting all system users that a restart is required:
3838

3939
![Properties Settings Page](img/mpf-adm-property-settings-change.png "Properties Settings Page")
4040

docs/docs/CPP-Streaming-Component-API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,11 +177,11 @@ Process a single video frame for the current segment.
177177

178178
Must return true when the component begins generating the first track for the current segment. After it returns true, the Component Executable will ignore the return value until the component begins processing the next segment.
179179

180-
If the `job_properties` map contained in the `MPFStreamingVideoJob` struct passed to the component constructor contains a CONFIDENCE_THRESHOLD entry, then this function should only return true for a detection with a confidence value that meets or exceeds that threshold. After the Component Executable invokes `EndSegment()` to retrieve the segment tracks, it will discard detections that are below the threshold. If all the detections in a track are below the threshold, then the entire track will be discarded.
180+
If the `job_properties` map contained in the `MPFStreamingVideoJob` struct passed to the component constructor contains a `QUALITY_SELECTION_THRESHOLD` entry, then this function should only return true for a detection with a quality value that meets or exceeds that threshold. Refer to the [Quality Selection Guide](Quality-Selection-Guide/index.html). After the Component Executable invokes `EndSegment()` to retrieve the segment tracks, it will discard detections that are below the threshold. If all the detections in a track are below the threshold, then the entire track will be discarded.
181181

182-
Note that this function may not be invoked for every frame in the current segment. For example, if FRAME_INTERVAL = 2, then this function will only be invoked for every other frame since those are the only ones that need to be processed.
182+
Note that this function may not be invoked for every frame in the current segment. For example, if `FRAME_INTERVAL = 2`, then this function will only be invoked for every other frame since those are the only ones that need to be processed.
183183

184-
Also, it may not be invoked for the first nor last frame in the segment. For example, if FRAME_INTERVAL = 3 and the segment size is 10, then it will be invoked for frames {0, 3, 6, 9} for the first segment, and frames {12, 15, 18} for the second segment.
184+
Also, it may not be invoked for the first nor last frame in the segment. For example, if `FRAME_INTERVAL = 3` and the segment size is 10, then it will be invoked for frames {0, 3, 6, 9} for the first segment, and frames {12, 15, 18} for the second segment.
185185

186186
* Function Definition:
187187
```c++

docs/docs/Development-Environment-Guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ drag and drop the file onto the "Upload a new component" dropzone area or click
436436
the dropzone area to open a file browser and select the file that way.
437437
In either case, the component will begin to be uploaded to the system. If the
438438
admin user dragged and dropped the file onto the dropzone area then the upload
439-
progress will be shown in that area. Once uploaded, the workflow manager will
439+
progress will be shown in that area. Once uploaded, the Workflow Manager will
440440
automatically attempt to register the component. Notification messages will
441441
appear in the upper right side of the screen to indicate success or failure if
442442
an error occurs. The "Current Components" table will display the component
@@ -447,7 +447,7 @@ status.
447447
If for some reason the component package upload succeeded but the component
448448
registration failed then the admin user will be able to click the "Register"
449449
button again to try to another registration attempt. For example, the admin
450-
user may do this after reviewing the workflow manager logs and resolving any
450+
user may do this after reviewing the Workflow Manager logs and resolving any
451451
issues that prevented the component from successfully registering the first
452452
time. One reason may be that a component with the same name already exists on
453453
the system. Note that an error will also occur if the top-level directory of

0 commit comments

Comments
 (0)