From be4fb16e3cebe4b81ae20c89fea75addeed8c1c8 Mon Sep 17 00:00:00 2001 From: "Patricio A. Vela" Date: Sat, 24 Feb 2024 19:03:40 -0500 Subject: [PATCH] doxygen parse improvements. --- build/parsequit.pl | 9 +- docs/annotated.html | 4 +- docs/centroid_8py.html | 2 +- docs/classbyRegion_1_1Planar-members.html | 2 +- docs/classbyRegion_1_1Planar.html | 44 +- ...classbyRegion_1_1imageRegions-members.html | 31 +- docs/classbyRegion_1_1imageRegions.html | 223 ++++++++--- ...35_1_1runner2_1_1D435__Runner-members.html | 43 +- ...ra_1_1d435_1_1runner2_1_1D435__Runner.html | 51 ++- ..._1_1d435_1_1runner2_1_1Replay-members.html | 45 ++- ...sscamera_1_1d435_1_1runner2_1_1Replay.html | 211 ++++++++++ ...era_1_1d435_1_1runner_1_1D435__Runner.html | 6 + ...asscamera_1_1d435new_1_1RGBD__Aligned.html | 6 + ...1height__estimator_1_1HeightEstimator.html | 1 + ...etop__plane_1_1tabletopPlaneEstimator.html | 7 + docs/classdetector_1_1base_1_1Base.html | 11 +- ...ector_1_1bgmodel_1_1GMM_1_1bgmodelGMM.html | 1 + ...r_1_1bgmodel_1_1GMM_1_1bgmodelGMM__cv.html | 1 + ...r_1_1bgmodel_1_1Gaussian_1_1bgConical.html | 1 + ..._1_1bgmodel_1_1Gaussian_1_1bgGaussian.html | 1 + ...model_1_1inCorner_1_1inCorner-members.html | 4 +- ...or_1_1bgmodel_1_1inCorner_1_1inCorner.html | 129 +++++- ...inCorner_1_1inCornerEstimator-members.html | 22 +- ...odel_1_1inCorner_1_1inCornerEstimator.html | 92 +++-- ...bgmodel_1_1onWorkspace_1_1onWorkspace.html | 1 + ...del_1_1Gaussian_1_1fgGaussian-members.html | 2 + ..._1_1fgmodel_1_1Gaussian_1_1fgGaussian.html | 101 +++++ ...fgmodel_1_1appearance_1_1fgAppearance.html | 1 + ...model_1_1targetCorner_1_1targetCorner.html | 1 + ...del_1_1targetMagenta_1_1targetMagenta.html | 1 + ..._1fgmodel_1_1targetNeon_1_1targetNeon.html | 1 + ...or_1_1fgmodel_1_1targetSG_1_1targetSG.html | 1 + ...tor_1_1fromState_1_1fromState-members.html | 2 +- ...assdetector_1_1fromState_1_1fromState.html | 102 ++--- ...etector_1_1inImageRGBD_1_1bgImageRBGD.html | 1 + ...etector_1_1inImageRGBD_1_1inImageRGBD.html | 3 +- docs/classdetector_1_1inImage_1_1bgImage.html | 1 + docs/classdetector_1_1inImage_1_1fgImage.html | 1 + docs/classdetector_1_1inImage_1_1inImage.html | 3 +- docs/classes.html | 82 ++-- .../classperceiver_1_1monitor_1_1Monitor.html | 8 +- ...ssperceiver_1_1perceiver_1_1Perceiver.html | 14 + ..._1perceiver_1_1PerceiverState-members.html | 87 ++++ ...ceiver_1_1perceiver_1_1PerceiverState.html | 164 ++++++++ ...lassperceiver_1_1progress_1_1Progress.html | 11 +- ...classperceiver_1_1simple_1_1Perceiver.html | 14 + ...ter_1_1centroid_1_1TrackState-members.html | 86 ++++ ...rackpointer_1_1centroid_1_1TrackState.html | 140 +++++++ docs/display__cv_8py.html | 30 +- docs/functions.html | 2 +- docs/functions_b.html | 3 +- docs/functions_c.html | 2 + docs/functions_d.html | 3 - docs/functions_func.html | 2 +- docs/functions_func_c.html | 2 + docs/functions_func_d.html | 3 - docs/functions_func_m.html | 3 + docs/functions_func_p.html | 9 + docs/functions_func_r.html | 12 + docs/functions_func_s.html | 12 +- docs/functions_func_u.html | 6 + docs/functions_h.html | 3 +- docs/functions_m.html | 3 + docs/functions_n.html | 4 +- docs/functions_p.html | 9 + docs/functions_r.html | 12 + docs/functions_s.html | 12 +- docs/functions_u.html | 6 + docs/functions_vars_b.html | 3 +- docs/functions_vars_h.html | 3 +- docs/functions_vars_n.html | 4 +- docs/functions_vars_x.html | 3 +- docs/functions_vars_z.html | 3 +- docs/functions_x.html | 3 +- docs/functions_z.html | 3 +- docs/group__Display__CV.html | 378 +++++++++++++----- docs/hierarchy.html | 28 +- docs/inherit_graph_26.map | 2 +- docs/inherit_graph_26.md5 | 2 +- docs/inherit_graph_26.png | Bin 1141 -> 1922 bytes docs/inherit_graph_27.map | 2 +- docs/inherit_graph_27.md5 | 2 +- docs/inherit_graph_28.map | 2 +- docs/inherit_graph_28.md5 | 2 +- docs/inherit_graph_28.png | Bin 1902 -> 1141 bytes docs/inherit_graph_29.map | 3 +- docs/inherit_graph_29.md5 | 2 +- docs/inherit_graph_29.png | Bin 2257 -> 1902 bytes docs/inherit_graph_30.map | 3 +- docs/inherit_graph_30.md5 | 2 +- docs/inherit_graph_30.png | Bin 2037 -> 2257 bytes docs/inherit_graph_31.map | 2 +- docs/inherit_graph_31.md5 | 2 +- docs/inherit_graph_32.map | 2 +- docs/inherit_graph_32.md5 | 2 +- docs/inherit_graph_32.png | Bin 1771 -> 2037 bytes docs/inherit_graph_33.map | 2 +- docs/inherit_graph_33.md5 | 2 +- docs/inherit_graph_34.map | 2 +- docs/inherit_graph_34.md5 | 2 +- docs/inherit_graph_34.png | Bin 1083 -> 1771 bytes docs/inherit_graph_35.map | 2 +- docs/inherit_graph_35.md5 | 2 +- docs/inherit_graph_36.map | 2 +- docs/inherit_graph_36.md5 | 2 +- docs/inherit_graph_36.png | Bin 1083 -> 1670 bytes docs/inherit_graph_37.map | 3 +- docs/inherit_graph_37.md5 | 2 +- docs/inherit_graph_37.png | Bin 1670 -> 3442 bytes docs/inherit_graph_38.map | 3 +- docs/inherit_graph_38.md5 | 2 +- docs/inherit_graph_38.png | Bin 3442 -> 1888 bytes docs/inherit_graph_39.map | 2 +- docs/inherit_graph_39.md5 | 2 +- docs/inherit_graph_39.png | Bin 1888 -> 1599 bytes docs/inherits.html | 42 +- docs/namespacebyRegion.html | 4 +- docs/namespacecamera_1_1d435new.html | 2 +- docs/namespaceivapy_1_1display__cv.html | 30 +- docs/namespacemembers.html | 15 +- docs/namespacemembers_a.html | 112 ++++++ docs/namespacemembers_b.html | 111 +++++ docs/namespacemembers_c.html | 125 ++++++ docs/namespacemembers_d.html | 149 +++++++ docs/namespacemembers_e.html | 89 +++++ docs/namespacemembers_f.html | 107 +++++ docs/namespacemembers_func.html | 15 +- docs/namespacemembers_g.html | 128 ++++++ docs/namespacemembers_h.html | 102 +++++ docs/namespacemembers_i.html | 121 ++++++ docs/namespacemembers_k.html | 83 ++++ docs/namespacemembers_l.html | 90 +++++ docs/namespacemembers_m.html | 97 +++++ docs/namespacemembers_n.html | 89 +++++ docs/namespacemembers_o.html | 85 ++++ docs/namespacemembers_p.html | 132 ++++++ docs/namespacemembers_r.html | 126 ++++++ docs/namespacemembers_s.html | 134 +++++++ docs/namespacemembers_t.html | 123 ++++++ docs/namespacemembers_u.html | 80 ++++ docs/namespacemembers_v.html | 105 +++++ docs/namespacemembers_w.html | 102 +++++ docs/namespacemembers_z.html | 81 ++++ docs/namespaceperceiver_1_1perceiver.html | 2 +- docs/namespacetrackpointer_1_1centroid.html | 2 +- docs/perceiver_8py.html | 2 +- docs/search/all_0.js | 2 +- docs/search/all_10.js | 75 ++-- docs/search/all_11.js | 121 +++--- docs/search/all_12.js | 92 ++--- docs/search/all_13.js | 14 +- docs/search/all_14.js | 32 +- docs/search/all_15.js | 22 +- docs/search/all_16.js | 2 +- docs/search/all_17.js | 2 +- docs/search/all_2.js | 2 +- docs/search/all_3.js | 2 +- docs/search/all_4.js | 2 +- docs/search/all_7.js | 22 +- docs/search/all_8.js | 22 +- docs/search/all_9.js | 82 ++-- docs/search/all_a.js | 4 +- docs/search/all_b.js | 24 +- docs/search/all_c.js | 50 +-- docs/search/all_d.js | 20 +- docs/search/all_e.js | 18 +- docs/search/all_f.js | 86 ++-- docs/search/classes_0.js | 4 +- docs/search/classes_1.js | 22 +- docs/search/classes_2.js | 46 +-- docs/search/classes_3.js | 14 +- docs/search/classes_4.js | 16 +- docs/search/classes_5.js | 6 +- docs/search/classes_6.js | 2 +- docs/search/classes_7.js | 16 +- docs/search/classes_8.js | 8 +- docs/search/classes_9.js | 2 +- docs/search/classes_a.js | 17 +- docs/search/classes_b.js | 12 +- docs/search/classes_c.js | 12 +- docs/search/classes_d.js | 16 +- docs/search/classes_e.js | 4 +- docs/search/files_0.js | 2 +- docs/search/files_1.js | 4 +- docs/search/files_10.js | 8 +- docs/search/files_11.js | 4 +- docs/search/files_2.js | 10 +- docs/search/files_3.js | 12 +- docs/search/files_4.js | 14 +- docs/search/files_5.js | 4 +- docs/search/files_6.js | 4 +- docs/search/files_7.js | 2 +- docs/search/files_8.js | 6 +- docs/search/files_9.js | 4 +- docs/search/files_a.js | 2 +- docs/search/files_b.js | 6 +- docs/search/files_c.js | 14 +- docs/search/files_d.js | 6 +- docs/search/files_e.js | 14 +- docs/search/files_f.js | 2 +- docs/search/functions_0.js | 2 +- docs/search/functions_1.js | 12 +- docs/search/functions_10.js | 22 +- docs/search/functions_11.js | 10 +- docs/search/functions_12.js | 2 +- docs/search/functions_13.js | 8 +- docs/search/functions_2.js | 58 +-- docs/search/functions_3.js | 48 +-- docs/search/functions_4.js | 37 +- docs/search/functions_5.js | 16 +- docs/search/functions_6.js | 4 +- docs/search/functions_7.js | 42 +- docs/search/functions_8.js | 10 +- docs/search/functions_9.js | 10 +- docs/search/functions_a.js | 10 +- docs/search/functions_b.js | 2 +- docs/search/functions_c.js | 6 +- docs/search/functions_d.js | 17 +- docs/search/functions_e.js | 33 +- docs/search/functions_f.js | 47 ++- docs/search/groups_0.js | 2 +- docs/search/groups_1.js | 10 +- docs/search/groups_2.js | 4 +- docs/search/groups_3.js | 2 +- docs/search/namespaces_0.js | 4 +- docs/search/namespaces_1.js | 38 +- docs/search/namespaces_2.js | 36 +- docs/search/namespaces_3.js | 2 +- docs/search/namespaces_4.js | 16 +- docs/search/namespaces_5.js | 16 +- docs/search/namespaces_6.js | 16 +- docs/search/namespaces_7.js | 12 +- docs/search/namespaces_8.js | 2 +- docs/search/pages_0.js | 4 +- docs/search/pages_1.js | 2 +- docs/search/pages_2.js | 4 +- docs/search/pages_3.js | 2 +- docs/search/pages_4.js | 4 +- docs/search/variables_0.js | 20 +- docs/search/variables_1.js | 18 +- docs/search/variables_10.js | 42 +- docs/search/variables_11.js | 24 +- docs/search/variables_12.js | 2 +- docs/search/variables_13.js | 16 +- docs/search/variables_14.js | 10 +- docs/search/variables_15.js | 2 +- docs/search/variables_16.js | 2 +- docs/search/variables_2.js | 48 +-- docs/search/variables_3.js | 56 +-- docs/search/variables_4.js | 8 +- docs/search/variables_5.js | 36 +- docs/search/variables_6.js | 10 +- docs/search/variables_7.js | 18 +- docs/search/variables_8.js | 38 +- docs/search/variables_9.js | 4 +- docs/search/variables_a.js | 14 +- docs/search/variables_b.js | 28 +- docs/search/variables_c.js | 18 +- docs/search/variables_d.js | 8 +- docs/search/variables_e.js | 36 +- docs/search/variables_f.js | 18 +- docs/todo.html | 8 +- 262 files changed, 5422 insertions(+), 1531 deletions(-) create mode 100644 docs/classperceiver_1_1perceiver_1_1PerceiverState-members.html create mode 100644 docs/classperceiver_1_1perceiver_1_1PerceiverState.html create mode 100644 docs/classtrackpointer_1_1centroid_1_1TrackState-members.html create mode 100644 docs/classtrackpointer_1_1centroid_1_1TrackState.html create mode 100644 docs/namespacemembers_a.html create mode 100644 docs/namespacemembers_b.html create mode 100644 docs/namespacemembers_c.html create mode 100644 docs/namespacemembers_d.html create mode 100644 docs/namespacemembers_e.html create mode 100644 docs/namespacemembers_f.html create mode 100644 docs/namespacemembers_g.html create mode 100644 docs/namespacemembers_h.html create mode 100644 docs/namespacemembers_i.html create mode 100644 docs/namespacemembers_k.html create mode 100644 docs/namespacemembers_l.html create mode 100644 docs/namespacemembers_m.html create mode 100644 docs/namespacemembers_n.html create mode 100644 docs/namespacemembers_o.html create mode 100644 docs/namespacemembers_p.html create mode 100644 docs/namespacemembers_r.html create mode 100644 docs/namespacemembers_s.html create mode 100644 docs/namespacemembers_t.html create mode 100644 docs/namespacemembers_u.html create mode 100644 docs/namespacemembers_v.html create mode 100644 docs/namespacemembers_w.html create mode 100644 docs/namespacemembers_z.html diff --git a/build/parsequit.pl b/build/parsequit.pl index acd3d281..dcd917fc 100755 --- a/build/parsequit.pl +++ b/build/parsequit.pl @@ -14,7 +14,7 @@ } exit; } - elsif ( $_ =~ /\@classf/ ) + elsif ( $_ =~ /\@classf/ ) { chomp($_); $_=~m/\@classf[ ]*([^\Z]*)\Z/; @@ -32,6 +32,13 @@ $restOfLine = $1; print "class $namespace\:\:$restOfLine"; } + elsif ( $_ =~ /\#\ CCfgPerceiverConfiguration instance for a perceiver  CInfo  CPerceiverSimple perceiver class. Most basic implementation - CState + CPerceiverState  Nprogress  CBuildCfgProgressBuild configuration instance for a progress monitor.
@@ -237,7 +237,7 @@  Ccentroid  CCfgCentroid  CCfgCentroindConfiguration setting specifier for centroidMulti - CState + CTrackState  NcentroidMulti  CcentroidMulti  CCfgCentMultiConfiguration setting specifier for centroidMulti diff --git a/docs/centroid_8py.html b/docs/centroid_8py.html index 795c6a1e..81e5dbd3 100644 --- a/docs/centroid_8py.html +++ b/docs/centroid_8py.html @@ -83,7 +83,7 @@ class  CfgCentroind  Configuration setting specifier for centroidMulti. More...
  -class  State +class  TrackState   - + diff --git a/docs/classbyRegion_1_1Planar.html b/docs/classbyRegion_1_1Planar.html index 445979bd..0b5b416c 100644 --- a/docs/classbyRegion_1_1Planar.html +++ b/docs/classbyRegion_1_1Planar.html @@ -105,16 +105,16 @@ - + - + - + - + @@ -123,16 +123,13 @@ - + - + - - - - + @@ -144,6 +141,9 @@ + + +

diff --git a/docs/classbyRegion_1_1Planar-members.html b/docs/classbyRegion_1_1Planar-members.html index 8e463c16..6bdb1192 100644 --- a/docs/classbyRegion_1_1Planar-members.html +++ b/docs/classbyRegion_1_1Planar-members.html @@ -88,7 +88,7 @@

predict(self)Planar
process(self, signal)Planar
processorfromState
save(self, fileName)fromState
save(self, fileName)Base
saveTo(self, fPtr)fromState
xBase
zfromState
 Instantiate a detector Base activity class object. More...
 
def adapt (self)
 Adapt any internal parameters based on activity state, signal, and any other historical information. More...
 Adapt detection model, if implemented. More...
 
def correct (self)
 Reconcile prediction and measurement as fitting. More...
 Correct detection state estimate, if implemented. More...
 
def measure (self, signal)
 Generate measurement of activity state from passed signal. More...
 Generate detection outcome from state signal. More...
 
def predict (self)
 Predict next state from current state. More...
 Predict detection state outcome, if implemented. More...
 
def process (self, signal)
 
 Constructor for fromState instance. More...
 
def detect (self, x)
 Run detection only processing pipeline (no adaptation). More...
 Perform detection only, which basically keeps the model static if it would normally update. More...
 
def getState (self)
 Return current/latest state. More...
 Get the current detection state estimate. More...
 
def save (self, fileName)
 Outer method for saving to a file given as a string. More...
 
def saveTo (self, fPtr)
 Empty method for saving internal information to HDF5 file. More...
 Save configuration or other data to HDF5 file. More...
 
- Public Member Functions inherited from Base
def emptyDebug (self)
def getDebug (self)
 Return current/latest debug state information. More...
 
def save (self, fileName)
 Outer method for saving to a file given as a string. More...
 
@@ -156,11 +156,14 @@ + + +

Additional Inherited Members

 
- Public Attributes inherited from fromState
 processor
 Pre-processor or similar. More...
 
 z
 The detection outcome. More...
 
- Public Attributes inherited from Base
 x
 Detection state. More...
 

Detailed Description

@@ -205,8 +208,8 @@

-

Adapt any internal parameters based on activity state, signal, and any other historical information.

-

Base method does not have adaptation. Should be customized to the implementation of the class.

+

Adapt detection model, if implemented.

+

Default implementation is no adaptation.

Reimplemented from fromState.

@@ -228,8 +231,8 @@

-

Reconcile prediction and measurement as fitting.

-

Correct state based on measurement and prediction states. Base method does not have correction.

+

Correct detection state estimate, if implemented.

+

Default implementation is to do nothing. Roll with measurement.

Reimplemented from fromState.

@@ -251,7 +254,7 @@

  - signal  + x  @@ -261,10 +264,10 @@

-

Generate measurement of activity state from passed signal.

+

Generate detection outcome from state signal.

Parameters
- +
[in]signalCurrent signal of interest for activity detection.
[in]xExternal signal to detect with.
@@ -289,9 +292,8 @@

-

Predict next state from current state.

-

If transition model known, generate state prediction. Else it is most likely a static transition model, which does nothing / keeps prior state. The base method employs a static state assumption.
-

+

Predict detection state outcome, if implemented.

+

Default implementation is to do nothing. State not updated.

Reimplemented from fromState.

@@ -322,7 +324,7 @@

-
Process the new income signal
+
@brief  Process the new income signal. Check if in a region of interest.
 

Reimplemented from fromState.

diff --git a/docs/classbyRegion_1_1imageRegions-members.html b/docs/classbyRegion_1_1imageRegions-members.html index 1b2d4e26..4b6a971a 100644 --- a/docs/classbyRegion_1_1imageRegions-members.html +++ b/docs/classbyRegion_1_1imageRegions-members.html @@ -73,16 +73,16 @@

This is the complete list of members for imageRegions, including all inherited members.

- - - - - - - - - - + + + + + + + + + + @@ -100,14 +100,17 @@ - + + + - - - + + + +
__init__(self, imRegions=None)imageRegions
detector::base::Base.__init__(self)Base
adapt(self)fromState
addRegionByMask(self, regMask)imageRegions
addRegionByPolygon(self, regPoly, imsize=None)imageRegions
buildFromPolygons(imsize, thePolygons)imageRegions
calibrateFromPolygonMouseInputOverImageRGB(theImage, theFile, initRegions=None)imageRegions
correct(self)fromState
detect(self, x)fromState
display_cv(self, ratio=1, window_name="Activity Regions")imageRegions
__init__(self, imRegions=None, processor=None)imageRegions
detector::fromState::fromState.__init__(self, processor=None)fromState
detector::base::Base.__init__(self)Base
adapt(self)fromState
addRegionByMask(self, regMask)imageRegions
addRegionByPolygon(self, regPoly, imsize=None)imageRegions
buildFromPolygons(imsize, thePolygons)imageRegions
calibrateFromPolygonMouseInputOverImageRGB(theImage, theFile, initRegions=None)imageRegions
correct(self)fromState
detect(self, x)fromState
emptyDebug(self)Base
emptyRegions(self)imageRegions
emptyState(self)Base
printState(self)imageRegions
process(self, x)fromState
processorfromState
save(self, fileName)fromState
regions_close_cv(self, window_name="Activity Regions")imageRegions
regions_display_cv(self, ratio=1, window_name="Activity Regions")imageRegions
save(self, fileName)Base
saveTo(self, fPtr, relpath="activity.byRegion")imageRegions
detector::fromState::fromState.saveTo(self, fPtr)fromState
setRegions(self, imRegions)imageRegions
specifyPolyRegionsFromImageRGB(self, theImage, doClear=False)imageRegions
wipeRegions(self)imageRegions
ximageRegions
zfromState
stringState(self)imageRegions
wipeRegions(self)imageRegions
xBase
zimageRegions