Skip to content

Commit 0e0e541

Browse files
committed
Update documentation
1 parent 24d5786 commit 0e0e541

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/fswAlgorithms/imageProcessing/centerOfBrightness/centerOfBrightness.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,10 @@ The normalized total brightness is equal to
6363
I_\mathrm{tot, normalized} = \frac{I_\mathrm{tot}}{255}
6464
6565
and the rolling average is computed over the last :math:`N` time steps, as specified by numberOfPointsBrightnessAverage.
66+
If the relative increase of the rolling brightness average from one time step to the next is below the threshold
67+
brightnessIncreaseThreshold, the image is tagged as invalid.
6668

67-
If the incomping image is not valid, or there were no pixels above the threshold, the image is tagged as invalid.
69+
If the incoming image is not valid, or there were no pixels above the threshold, the image is tagged as invalid.
6870
Downstream algorithms can therefore know when to skip a measurement.
6971

7072
User Guide
@@ -93,6 +95,10 @@ This section is to outline the steps needed to setup a Center of Brightness in P
9395

9496
cobAlgorithm.numberOfPointsBrightnessAverage = 5
9597

98+
#. Specify the minimum relative brightness increase of the rolling average of total brightness (optional)::
99+
100+
moduleConfig.setRelativeBrightnessIncreaseThreshold(0.1)
101+
96102
#. Subscribe to the image message output by the camera model or visualization interface::
97103

98104
cobAlgorithm.imageInMsg.subscribeTo(imgInMsg)

0 commit comments

Comments
 (0)