doc: Describe which properties will be modified by presets

norihiro · Aug 2, 2024 · 22c3ddc · 22c3ddc
1 parent 938d13e
commit 22c3ddc
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/doc/properties-ptz.md b/doc/properties-ptz.md
@@ -33,6 +33,8 @@ These properties upsize (or downsize) the recognized face by multiple of the wid
 
 The motivation is that the face recognition returns a rectangle that is smaller than the actual face.
 
+The properties will be saved to and recalled from presets.
+
 ### Scale image
 The frame will be scaled before sending into face detection and tracking algorithm.
 Default is `2`.
@@ -72,10 +74,14 @@ This property set the target zoom amount in multiple of the screen size.
 If set to `1.0`, face size and screen size is same.
 Smaller value results smaller face, i.e. less zoom.
 
+The property will be saved to and recalled from presets.
+
 ### X, Y
 This property set the location where the center of the face is placed.
 `0` indicates the center, `+/-0.5` will result the center of the face is located at the edge.
 
+The properties will be saved to and recalled from presets.
+
 ## Tracking response
 
 The tracking system has a PID control element + integrator.
@@ -86,29 +92,41 @@ Larger value will result faster response.
 Since the gain of the PTZ camera depends on the manufactures and models,
 you need to adjust Kp for your camera.
 
+The properties will be saved to and recalled from presets.
+
 ### Ki (X, Y, Z)
 This is an integral constant. The dimension is inverse time and the unit is s<sup>-1</sup>.
 Larger value results in more tracking of slow movement.
 
+The properties will be saved to and recalled from presets. (version 0.7.3 and later)
+
 ### Td (X, Y, Z)
 This is a derivative constant. The dimension is time and the unit is s.
 0 will result in no derivative term.
 Larger value will make tracking faster when the subject starts to move.
 
+The properties will be saved to and recalled from presets.
+
 ### LPF for Td (X, Y, Z)
 This is an inverse of the cut-off frequency for the low-pass filter (LPF), which affects the derivative term of the PID control element. The dimension is time and the unit is s.
 The LPF will reduce noise of face detection and small movement of the subject.
 This property is shared for X and Y axises.
 
+The properties will be saved to and recalled from presets.
+
 ### Dead band nonlinear band (X, Y, Z)
 These parameters make dead bands and nonlinear bands for the error signal that goes to PID control element.
 The unit is a percentage of the average of source width and height.
 If the error signal is within the dead band, error signal is forced to zero to avoid small move to be tracked.
 The nonlinear band makes smooth connection from the dead band to the linear range.
 
+The properties will be saved to and recalled from presets.
+
 ### Attenuation time for lost face
 After the face is lost, integral term will be attenuated by this time. The dimension is time and the unit is s.
 
+The property will be saved to and recalled from presets.
+
 ## Face lost behavior
 
 Make an action if the face has been lost.

diff --git a/doc/properties.md b/doc/properties.md
@@ -33,6 +33,8 @@ These properties upsize (or downsize) the recognized face by multiple of the wid
 
 The motivation is that the face recognition returns a rectangle that is smaller than the actual face.
 
+The properties will be saved to and recalled from presets.
+
 ### Scale image
 The frame will be scaled before sending into face detection and tracking algorithm.
 Default is `2`.
@@ -78,13 +80,19 @@ This property set the target zoom amount in multiple of the screen size.
 If set to `1.0`, face size and screen size is same.
 Smaller value results smaller face, i.e. less zoom.
 
+The property will be saved to and recalled from presets.
+
 ### X, Y
 This property set the location where the center of the face is placed.
 `0` indicates the center, `+/-0.5` will result the center of the face is located at the edge.
 
+The properties will be saved to and recalled from presets.
+
 ### Scale max
 This property set the maximum of the zoom.
 
+The property will be saved to and recalled from presets.
+
 ## Tracking response
 
 The tracking system has a PID control element + integrator.
@@ -93,19 +101,27 @@ The tracking system has a PID control element + integrator.
 This is a proportional constant. The dimension is inverse time and the unit is s<sup>-1</sup>.
 Larger value will result faster response.
 
+The property will be saved to and recalled from presets.
+
 ### Ki
 This is a integral constant. The dimension is inverse time and the unit is s<sup>-1</sup>.
 Larger value results more tracking of slow move.
 
+The property will be saved to and recalled from presets.
+
 ### Td
 This is a derivative constant. The dimension is time and the unit is s.
 0 will result no derivative term.
 Larger value will make faster tracking when the subject start to move.
 
+The property will be saved to and recalled from presets.
+
 ### LPF for Td
 This is an inverse of the cut-off frequency for the low-pass filter (LPF), which affects the derivative term of PID control element. The dimension is time and the unit is s.
 The LPF will reduce noise of face detection and small move of the subject.
 
+The property will be saved to and recalled from presets.
+
 ### Attenuation (Z)
 This is another proportional constant that affects only the zoom factor.
 Smaller value will result in slower response of the zoom.
@@ -116,6 +132,8 @@ The unit is a percentage of the average of source width and height.
 If the error signal is within the dead band, error signal is forced to zero to avoid small move to be tracked.
 The nonlinear band makes smooth connection from the dead band to the linear range.
 
+The properties will be saved to and recalled from presets.
+
 ## Source and output
 
 ### Source