Skip to content

Commit 802ab2a

Browse files
Update setup and docs
1 parent 7c7cfc5 commit 802ab2a

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/musicalgestures/_blurfaces.md

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

99
## mg_blurfaces
1010

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

1313
```python
1414
def mg_blurfaces(
@@ -18,7 +18,8 @@ def mg_blurfaces(
1818
mask_scale=1.0,
1919
ellipse=True,
2020
draw_scores=False,
21-
coordinates=False,
21+
save_data=True,
22+
data_format='csv',
2223
color=(0, 0, 0),
2324
target_name=None,
2425
overwrite=False,
@@ -38,7 +39,8 @@ Credits: `centerface.onnx` (original) and `centerface.py` are based on https://g
3839
- `mask_scale` *float, optional* - Scale factor for face masks, to make sure that the masks cover the complete face. Defaults to 1.0.
3940
- `ellipse` *bool, optional* - Mask faces with blurred ellipses. Defaults to True.
4041
- `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.
41-
- `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.
42+
- `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
43+
- `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'.
4244
- `color` *tuple, optional* - Customized color of the rectangle boxes. Defaults to black (0, 0, 0).
4345
- `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).
4446
- `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
4951

5052
## scaling_mask
5153

52-
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_blurfaces.py#L10)
54+
[[find in source code]](https://github.com/fourMs/MGT-python/blob/master/musicalgestures/_blurfaces.py#L11)
5355

5456
```python
5557
def scaling_mask(x1, y1, x2, y2, mask_scale=1.0):

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
setup(
1313
name='musicalgestures',
1414
packages=['musicalgestures'],
15-
version='v1.2.1',
15+
version='v1.2.2',
1616
license='GNU General Public License v3 (GPLv3)',
1717
description='Musical Gestures Toolbox for Python',
1818
long_description=README,
@@ -23,7 +23,7 @@
2323
author='University of Oslo fourMs Lab',
2424
author_email='[email protected]',
2525
url='https://github.com/fourMs/MGT-python',
26-
download_url='https://github.com/fourMs/MGT-python/archive/v1.2.1.tar.gz',
26+
download_url='https://github.com/fourMs/MGT-python/archive/v1.2.2.tar.gz',
2727
keywords=['Computer Vision', 'Motion Analysis',
2828
'Musical Gestures', 'Video-Analysis'],
2929
install_requires=[

0 commit comments

Comments
 (0)