Merge pull request #7 from kianmeng/fix-typos

Fix typos

README.md

@@ -49,21 +49,21 @@ pip install --user --upgrade pyaesthetics
 
 
 ### Verifying the installation
-To verify wether all the modules are working correctly, you can run:
+To verify whether all the modules are working correctly, you can run:
 
 ```python
-#load only the neede functions from the specific module
+#load only the needed functions from the specific module
 import pyaesthetics
 pyaesthetics.utils.runtest()
 ```
 
 ## Example
 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. 
 
-### Example 1: one single feature (e.g. Brigthness BT601)
+### Example 1: one single feature (e.g. Brightness BT601)
 
 ```python
-#load only the neede functions from the specific module
+#load only the needed functions from the specific module
 from pyaesthetics.brightness import relativeluminance_bt601
 from pyaeshtetics.utils import sRGB2RGB
 import cv2 #to open and handle images
@@ -137,7 +137,7 @@ Pyaesthetics has been used in different scientific publication. The most relevan
 - Music A., Maerten A., Wagemans J. (2023).*Beautification of images by generative adversarial networks*. Journal of Vision 2023;23(10):14.
 - Liu, Q., Zhu, S., Zhou, X., Liu, F., Becker, B., Kendrick, K. M., & Zhao, W. (2024). Mothers and fathers show different neural synchrony with their children during shared experiences. NeuroImage, 288, 120529.
 
-### Theses
+### Thesis
 - Gabrieli G. (2018), Using users' physiological response to predict aesthetic experience of websites, Master Degree in Human-Computer Interaction, University of Trento (Italy)
 - Veldhuizen M. (2024), Analyzing the Role of Aesthetic Features in Packaging Designs  on Consumer Responses: The Case of Specialty Coffee, Master Degree in Communication Science, Vrije Universiteit (Netherlands)
 

docs/bookthings.rst

@@ -5,7 +5,7 @@ Visual Complexity of books' cover
 
 In this tutorial we will analyze the visual complexity of two books' cover. We will start from two images taken in the wild, we will remove the background, interpolate the cover, and subsequently evaluate the visual complexity of the two covers.
 
-Please note that this tutorial uses rembg `https://github.com/danielgatis/rembg <https://github.com/danielgatis/rembg>`_ to remove the backgound. 
+Please note that this tutorial uses rembg `https://github.com/danielgatis/rembg <https://github.com/danielgatis/rembg>`_ to remove the background. 
 If you are having issues getting rembg working with numpy>=2, please use a nightly version (see `https://github.com/microsoft/onnxruntime/issues/21063 <https://github.com/microsoft/onnxruntime/issues/21063>`_ for more details):
 
 >>> python -m pip install coloredlogs flatbuffers numpy packaging protobuf sympy

docs/cakedLisa.rst

@@ -3,7 +3,7 @@
 Mona Lisa vs Caked Lisa
 =========================
 
-In May 2022 a man was arrested after he smeared the protective glass of Leonardo's famous panting with a cake.
+In May 2022 a man was arrested after he smeared the protective glass of Leonardo's famous painting with a cake.
 Pictures of the Mona Lisa covered in Cake were taken by visitors of the Louvre Museum, and rapidly published online. 
 
 .. image:: examples/guardianscreen.png
@@ -40,7 +40,7 @@ Then we defined required files and paths.
 
 >>> # Define the path to the different files and folders
 >>> BASEPATH = 'path/to/project/'
->>> DB = BASEPATH + 'Raw/db.csv' #ratings' databse
+>>> DB = BASEPATH + 'Raw/db.csv' #ratings' database
 >>> PAINTINGS = BASEPATH + 'Raw/paintings/' #folder with paintings' images
 >>> PROCESSED = BASEPATH + 'Processed/' #empty folder for processed data
 

docs/html/gettingstarted.html

@@ -42,7 +42,7 @@ <h2>Analysis of single feature<a class="headerlink" href="#analysis-of-single-fe
 <p>If you’d like to estimate a single feature, you can use the specific pair of module/function.
 Below, an example of the estimation of the brightness of an image, using the BT601 method.</p>
 <p>First load the modules you need.</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="c1">#load only the neede functions from the specific module</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="c1">#load only the needed functions from the specific module</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pyaesthetics.brightness</span> <span class="kn">import</span> <span class="n">relativeluminance_bt601</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pyaeshtetics.utils</span> <span class="kn">import</span> <span class="n">sRGB2RGB</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">cv2</span>

docs/index.rst

@@ -77,7 +77,7 @@ To test your installation you can run:
 >>> import pyaesthetics
 >>> pyaesthetics.utils.runtest()
 
-If no error is reported, your installation is sucessful. 
+If no error is reported, your installation is successful. 
 
 Updating pyaeshtetics
 ***************************
@@ -106,7 +106,7 @@ Scientific Publications that used pyaesthetic
 * Music A., Maerten A., Wagemans J. (2023).Beautification of images by generative adversarial networks. Journal of Vision 2023;23(10):14.
 * Liu, Q., Zhu, S., Zhou, X., Liu, F., Becker, B., Kendrick, K. M., & Zhao, W. (2024). Mothers and fathers show different neural synchrony with their children during shared experiences. NeuroImage, 288, 120529.
 
-Theses
+Thesis
 *********************
 * Gabrieli G. (2018), Using users' physiological response to predict aesthetic experience of websites, Master Degree in Human-Computer Interaction, University of Trento (Italy)
 * Veldhuizen M. (2024), Analyzing the Role of Aesthetic Features in Packaging Designs  on Consumer Responses: The Case of Specialty Coffee, Master Degree in Communication Science, Vrije Universiteit (Netherlands)

paper/paper.md

@@ -57,7 +57,7 @@ results = pyaesthetics.analysis.analyze_image(path_to_img, method="complete")
 
 # Use in Scientific Publications
 
-The package has already been utilized in several peer-reviewed scientific publications and theses. The package was used by @bizzego2022dataset and @liu2024mothers to verify that the visual complexity of different visual stimuli was consistent across trials, by @gabrieli2023machine to investigate the effect of various visual features of still images of websites on participants' aesthetic judgments of the websites, by @cianfanelli2023binding to investigate the visual complexity of IAPS images, by @music2023beautification to explore which visual features contribute to the perception of beauty in images, and by @Veldhuizen2024 to investigate which aesthetic features are most important in influencing consumers’ aesthetic judgments of packaging labels.
+The package has already been utilized in several peer-reviewed scientific publications and thesis. The package was used by @bizzego2022dataset and @liu2024mothers to verify that the visual complexity of different visual stimuli was consistent across trials, by @gabrieli2023machine to investigate the effect of various visual features of still images of websites on participants' aesthetic judgments of the websites, by @cianfanelli2023binding to investigate the visual complexity of IAPS images, by @music2023beautification to explore which visual features contribute to the perception of beauty in images, and by @Veldhuizen2024 to investigate which aesthetic features are most important in influencing consumers’ aesthetic judgments of packaging labels.
 
 # Acknowledgements
 

pyaesthetics.egg-info/PKG-INFO

@@ -88,10 +88,10 @@ pip install --user --upgrade pyaesthetics
 ## Example
 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. 
 
-### Example 1: one single feature (e.g. Brigthness BT601)
+### Example 1: one single feature (e.g. Brightness BT601)
 
 ```python
-#load only the neede functions from the specific module
+#load only the needed functions from the specific module
 from pyaesthetics.brightness import relativeLuminance_BT601, sRGB2RGB
 import cv2 #to open and handle images
 
@@ -107,7 +107,7 @@ print(relativeLuminance_BT601(img)) #evaluate luminance on the BT601 standard
 ```python
 import pyaesthetics
 img = "/path/to/image/image.jpg" #path to a sample image
-results = pyaesthetics.analysis.analyzeImage(img, method="complete") #perform all the availabe analysis using standard parameters
+results = pyaesthetics.analysis.analyzeImage(img, method="complete") #perform all the available analysis using standard parameters
 print(results)
 ```
 Or for a faster analysis:

pyaesthetics/quadtreedecomposition.py

@@ -34,7 +34,7 @@ class quadTree:
     blocks divided by the total possible number of blocks is stored in `self.standardized_complexity`. 
     Standardized complexity may range from 0 to 1 (with one being the highest complexity possible).
     The minSize parameter can be automatically adjusted to the common divisor of image width and height closest 
-    to the imputted minSize via the `autoadjust` parameter (default to False). The adjusted `minSize` can be 
+    to the inputted minSize via the `autoadjust` parameter (default to False). The adjusted `minSize` can be 
     obtained (if `autoadjust` = True) by accessing self.minSize.
     """