Update documentation

fourMs · Mar 4, 2023 · cecd936 · cecd936
1 parent 95f68d9
commit cecd936
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/docs/musicalgestures/_motionanalysis.md b/docs/musicalgestures/_motionanalysis.md
@@ -8,7 +8,7 @@
 
 ## area
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionanalysis.py#L41)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionanalysis.py#L42)
 
 ```python
 def area(motion_frame, height, width):
@@ -22,7 +22,7 @@ def area(motion_frame, height, width):
 def centroid(image, width, height):
 ```
 
-Computes the centroid of an image or frame.
+Computes the centroid and quantity of motion in an image or frame.
 
 #### Arguments
 

diff --git a/docs/musicalgestures/_motionvideo.md b/docs/musicalgestures/_motionvideo.md
@@ -82,7 +82,7 @@ centroid of motion for each frame with timecodes in milliseconds.
 
 ## mg_motiondata
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L427)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L415)
 
 ```python
 def mg_motiondata(
@@ -162,7 +162,7 @@ Shortcut for [mg_motion](#mg_motion) to only render motiongrams.
 
 ## mg_motionplots
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L505)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L493)
 
 ```python
 def mg_motionplots(
@@ -240,7 +240,7 @@ Shortcut to only render the motion video. Uses musicalgestures._utils.motionvide
 
 ## save_analysis
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L568)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L556)
 
 ```python
 def save_analysis(
@@ -264,7 +264,7 @@ Helper function to plot the motion data using matplotlib.
 
 ## save_txt
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L774)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L762)
 
 ```python
 def save_txt(

diff --git a/docs/musicalgestures/_show.md b/docs/musicalgestures/_show.md
@@ -35,7 +35,7 @@ General method to show an image or video file either in a window, or inline in a
 
 ## show_in_new_process
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_show.py#L280)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_show.py#L301)
 
 ```python
 def show_in_new_process(command):

diff --git a/docs/musicalgestures/_ssm.md b/docs/musicalgestures/_ssm.md
@@ -8,7 +8,7 @@
 
 ## mg_ssm
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L43)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L47)
 
 ```python
 def mg_ssm(
@@ -53,7 +53,7 @@ SSMs can be computed over different input features such as 'motiongrams', 'spect
 
 ## smooth_downsample_feature_sequence
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L16)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L17)
 
 ```python
 def smooth_downsample_feature_sequence(

diff --git a/docs/musicalgestures/index.md b/docs/musicalgestures/index.md
@@ -41,7 +41,7 @@
 
 ## Examples
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/__init__.py#L156)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/__init__.py#L158)
 
 ```python
 class Examples():