Skip to content

Commit c290bb1

Browse files
committed
merging
1 parent 0acd5de commit c290bb1

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,16 @@ To update the package via pip, you can use:
4747
pip install --user --upgrade pyaesthetics
4848
```
4949

50+
51+
### Verifying the installation
52+
To verify wether all the modules are working correctly, you can run:
53+
54+
```python
55+
#load only the neede functions from the specific module
56+
import pyaesthetics
57+
pyaesthetics.utils.runtest()
58+
```
59+
5060
## Example
5161
pyaeshtetics modules can be used one at the time to estimate one specific feature, or they can be automatically called using an automated entrypoint that calls all the available modules at once.
5262

paper/paper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Despite the volume of research on visual empirical aesthetics, the majority of t
2929

3030
`pyaesthetics` is a Python package for estimating visual features from still images. The package addresses the lack of available free, open-source, and easy-to-use tools for estimating a wide range of visual features. The API for `pyaesthetics` was designed to provide modules for various visual features commonly used in empirical aesthetics studies. It also offers simple entry points for conducting automated analysis for users with limited coding knowledge.
3131

32-
Among the features, `pyaesthetics` allows for the estimation of brightness, contrast, saturation, visual complexity, symmetry, colorfulness, and color distribution. The updated list of features that can be estimated with `pyaesthetics` is available in the [repository of the project](https://github.com/Gabrock94/pyaesthetics) as well as in the [documentation of the project](https://prettywebsite.readthedocs.io/en/latest/index.html), together with installation instructions, a getting started guide, and a few examples of applications. `pyaesthetics` can be used to extract single or multiple features from images, and for features where visualization helps in the interpretation of the results (e.g., visual complexity by quadratic tree decomposition), plotting utilities are provided (e.g.: Quadratic Tree Decomposition, Figure 1).
32+
Among the features, `pyaesthetics` allows for the estimation of brightness, contrast, saturation, visual complexity, symmetry, colorfulness, and color distribution. The updated list of features that can be estimated with `pyaesthetics` is available in the [repository of the project](https://github.com/Gabrock94/pyaesthetics) as well as in the [documentation of the project](https://prettywebsite.readthedocs.io/en/latest/index.html), together with installation instructions, a getting started guide, and a few examples of applications. `pyaesthetics` can be used to extract single or multiple features from images, and for features where visualization helps in the interpretation of the results (e.g.: visual complexity by quadratic tree decomposition), plotting utilities are provided (e.g.: Quadratic Tree Decomposition, Figure 1).
3333

3434
![Sample of a figure generated by `pyaesthetics`'s plotting utilities. The image depicts the analysis of visual complexity, estimated via quadratic tree decomposition, of a still image from the AVI14 dataset [@miniukovich2014quantification]. Each square represents a leaf of the decomposition tree, with the total number of leaves providing a measure of visual complexity; a higher number of leaves indicates greater visual complexity. The visual representation helps in understanding which parts of the image contribute most to the overall visual complexity.](QTDsample.png){ width=100% }
3535

0 commit comments

Comments
 (0)