Update setup and docs

fourMs · Jun 10, 2022 · 802ab2a · 802ab2a
1 parent 7c7cfc5
commit 802ab2a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/docs/musicalgestures/_blurfaces.md b/docs/musicalgestures/_blurfaces.md
@@ -8,7 +8,7 @@
 
 ## mg_blurfaces
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_blurfaces.py#L32)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_blurfaces.py#L33)
 
 ```python
 def mg_blurfaces(
@@ -18,7 +18,8 @@ def mg_blurfaces(
     mask_scale=1.0,
     ellipse=True,
     draw_scores=False,
-    coordinates=False,
+    save_data=True,
+    data_format='csv',
     color=(0, 0, 0),
     target_name=None,
     overwrite=False,
@@ -38,7 +39,8 @@ Credits: `centerface.onnx` (original) and `centerface.py` are based on https://g
 - `mask_scale` *float, optional* - Scale factor for face masks, to make sure that the masks cover the complete face. Defaults to 1.0.
 - `ellipse` *bool, optional* - Mask faces with blurred ellipses. Defaults to True.
 - `draw_scores` *bool, optional* - Draw detection faceness scores onto outputs (a score between 0 and 1 that roughly corresponds to the detector's confidence that something is a face). Defaults to False.
-- `coordinates` *bool, optional* - A list of intergers corresponding to the scaled coordinates of the face masks (x1, y1, x2, y2) for each frame. When set to True the function returns two variables: the coordinates list and the MgVideo object. Defaults to False.
+- `save_data` *bool, optional* - Whether we save the scaled coordinates of the face mask (x1, y1, x2, y2) for each frame to a file. Defaults to True
+- `data_format` *str, optional* - Specifies format of blur_faces-data. Accepted values are 'csv', 'tsv' and 'txt'. For multiple output formats, use list, eg. ['csv', 'txt']. Defaults to 'csv'.
 - `color` *tuple, optional* - Customized color of the rectangle boxes. Defaults to black (0, 0, 0).
 - `target_name` *str, optional* - Target output name for the directogram. Defaults to None (which assumes that the input filename with the suffix "_blurred" should be used).
 - `overwrite` *bool, optional* - Whether to allow overwriting existing files or to automatically increment target filenames to avoid overwriting. Defaults to False.
@@ -49,7 +51,7 @@ Credits: `centerface.onnx` (original) and `centerface.py` are based on https://g
 
 ## scaling_mask
 
-[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_blurfaces.py#L10)
+[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_blurfaces.py#L11)
 
 ```python
 def scaling_mask(x1, y1, x2, y2, mask_scale=1.0):

diff --git a/setup.py b/setup.py
@@ -12,7 +12,7 @@
 setup(
     name='musicalgestures',
     packages=['musicalgestures'],
-    version='v1.2.1',
+    version='v1.2.2',
     license='GNU General Public License v3 (GPLv3)',
     description='Musical Gestures Toolbox for Python',
     long_description=README,
@@ -23,7 +23,7 @@
     author='University of Oslo fourMs Lab',
     author_email='a.r.jensenius@imv.uio.no',
     url='https://github.com/fourMs/MGT-python',
-    download_url='https://github.com/fourMs/MGT-python/archive/v1.2.1.tar.gz',
+    download_url='https://github.com/fourMs/MGT-python/archive/v1.2.2.tar.gz',
     keywords=['Computer Vision', 'Motion Analysis',
               'Musical Gestures', 'Video-Analysis'],
     install_requires=[