Skip to content

Commit cecd936

Browse files
Update documentation
1 parent 95f68d9 commit cecd936

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

docs/musicalgestures/_motionanalysis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## area
1010

11-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionanalysis.py#L41)
11+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionanalysis.py#L42)
1212

1313
```python
1414
def area(motion_frame, height, width):
@@ -22,7 +22,7 @@ def area(motion_frame, height, width):
2222
def centroid(image, width, height):
2323
```
2424

25-
Computes the centroid of an image or frame.
25+
Computes the centroid and quantity of motion in an image or frame.
2626

2727
#### Arguments
2828

docs/musicalgestures/_motionvideo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ centroid of motion for each frame with timecodes in milliseconds.
8282

8383
## mg_motiondata
8484

85-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L427)
85+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L415)
8686

8787
```python
8888
def mg_motiondata(
@@ -162,7 +162,7 @@ Shortcut for [mg_motion](#mg_motion) to only render motiongrams.
162162

163163
## mg_motionplots
164164

165-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L505)
165+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L493)
166166

167167
```python
168168
def mg_motionplots(
@@ -240,7 +240,7 @@ Shortcut to only render the motion video. Uses musicalgestures._utils.motionvide
240240

241241
## save_analysis
242242

243-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L568)
243+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L556)
244244

245245
```python
246246
def save_analysis(
@@ -264,7 +264,7 @@ Helper function to plot the motion data using matplotlib.
264264

265265
## save_txt
266266

267-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L774)
267+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_motionvideo.py#L762)
268268

269269
```python
270270
def save_txt(

docs/musicalgestures/_show.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ General method to show an image or video file either in a window, or inline in a
3535

3636
## show_in_new_process
3737

38-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_show.py#L280)
38+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_show.py#L301)
3939

4040
```python
4141
def show_in_new_process(command):

docs/musicalgestures/_ssm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## mg_ssm
1010

11-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L43)
11+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L47)
1212

1313
```python
1414
def mg_ssm(
@@ -53,7 +53,7 @@ SSMs can be computed over different input features such as 'motiongrams', 'spect
5353

5454
## smooth_downsample_feature_sequence
5555

56-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L16)
56+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_ssm.py#L17)
5757

5858
```python
5959
def smooth_downsample_feature_sequence(

docs/musicalgestures/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
## Examples
4343

44-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/__init__.py#L156)
44+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/__init__.py#L158)
4545

4646
```python
4747
class Examples():

0 commit comments

Comments
 (0)