skinoptics 0.0.1b5__tar.gz → 0.0.1b6__tar.gz

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: skinoptics
-Version: 0.0.1b5
+Version: 0.0.1b6
 Summary: SkinOptics: a python package with tools for building human skin computational models for Monte Carlo simulations of light transport
 Author-email: Victor Lima <victorporto@ifsc.usp.br>
 Project-URL: Homepage, https://github.com/victorportog/skinoptics
@@ -13,6 +13,7 @@ License-File: LICENSE.txt
 Requires-Dist: numpy<2.0.0,>=1.26.4
 Requires-Dist: scipy<2.0.0,>=1.13.0
 Requires-Dist: pandas<3.0.0,>=2.2.2
+Dynamic: license-file
 
 SkinOptics
 ==========
@@ -21,7 +22,7 @@ SkinOptics
 models for Monte Carlo simulations of light transport, as well as tools for analyzing simulation
 outputs. It can also be used for teaching and exploring about Optical Properties and Colorimetry.
 
-**SkinOptics** is under continuos development.
+**SkinOptics** is under continuous development.
 
 New features may be available in the future.
 

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/README.md

@@ -5,7 +5,7 @@ SkinOptics
 models for Monte Carlo simulations of light transport, as well as tools for analyzing simulation
 outputs. It can also be used for teaching and exploring about Optical Properties and Colorimetry.
 
-**SkinOptics** is under continuos development.
+**SkinOptics** is under continuous development.
 
 New features may be available in the future.
 

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/docs/source/index.rst

@@ -5,7 +5,7 @@ SkinOptics documentation
 | models for Monte Carlo simulations of light transport, as well as tools for analyzing simulation
 | outputs. It can also be used for teaching and exploring about Optical Properties and Colorimetry.
 
-**SkinOptics** is under continuos development.
+**SkinOptics** is under continuous development.
 
 New features may be available in the future.
 
@@ -73,7 +73,11 @@ Some ipynb files with usage examples will be available soon.
 Source Code
 -----------
 
-**SkinOptics** scripts are publicly available in a `GitHub repository <https://github.com/victorportog/skinoptics>`_.
+**SkinOptics** scripts are publicly available on `GitHub <https://github.com/victorportog/skinoptics>`_.
+
+Release History
+---------------
+A list of all **SkinOptics** versions, ordered by release date, is available on `PyPI <https://pypi.org/project/skinoptics/#history>`_.
 
 License
 -------
@@ -100,7 +104,7 @@ If **SkinOptics** is being useful for a presentation, publication or other purpo
 
 Suggestion:
 
-   | V. P. G., Lima. “SkinOptics documentation,” (2024).
+   | LIMA, V. P. G. SkinOptics documentation. 2024.
    | Available at <https://skinoptics.readthedocs.io/>.
 
 BibTex entry:

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "skinoptics"
-version = "0.0.1b5"
+version = "0.0.1b6"
 authors = [
   { name="Victor Lima", email="victorporto@ifsc.usp.br"},
 ]
@@ -26,4 +26,4 @@ dependencies = [
 Homepage = "https://github.com/victorportog/skinoptics"
 
 [tool.setuptools]
-packages = ["skinoptics", "skinoptics.datasets"]
+packages = ["skinoptics", "skinoptics.datasets", "skinoptics.datasets.optical_properties", "skinoptics.datasets.colors"]

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics/__init__.py

@@ -24,11 +24,7 @@ Copyright (C) 2024 Victor Lima
 | October 2024
 
 | Version History:
-| 0.0.1b1 - release date: 2024 October 10
-| 0.0.1b2 - release date: 2024 October 18
-| 0.0.1b3 - release date: 2024 October 18
-| 0.0.1b4 - release date: 2024 October 18
-| 0.0.1b5 - release date: 2024 October 18
+| available at <https://pypi.org/project/skinoptics/#history>
 '''
 
 __all__ = ['utils', 'dataframes',
@@ -39,10 +35,10 @@ __all__ = ['utils', 'dataframes',
 __version__major = '0'
 __version__minor = '0'
 __version__micro = '1'
-__version__suffix = 'b5'
+__version__suffix = 'b6'
 
 __author__ = "Victor Lima"
-__copyright__ = "Copyright (c) 2024 Victor Lima"
+__copyright__ = "Copyright (c) 2024-2025 Victor Lima"
 __license__ = "GNU General Public License v3.0"
 __maintainer__ = "Victor Lima"
 __version__ = '.'.join((__version__major, __version__minor, __version__micro)) + __version__suffix

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics/absorption_coefficient.py

@@ -482,8 +482,8 @@ def molarext_bil_Li(lambda0):
     r'''
     | The molar extinction coefficient of BILIRUBIN in chloroform as a function of wavelength.
     | Linear interpolation of experimental data obtained with a Cary 3 by J. Li on 1997,
-    | scaled to match 55,000 cm^-1 M^-1 at 450.8 nm [AF90] and publicly available by S. Jacques and
-    | S. Prahl at <https://omlc.org/spectra/PhotochemCAD/html/119.html>.
+    | scaled to match 55,000 cm^-1 M^-1 at 450.8 nm [AF90] and publicly available by S. Prahl
+    | at <https://omlc.org/spectra/PhotochemCAD/html/119.html>.
     | The data is also available at PhotochemCAD [TL23]
     | <https://www.photochemcad.com/databases/common-compounds/oligopyrroles/bilirubin>.
     
@@ -539,8 +539,7 @@ def mua_wat_Hale(lambda0):
     r'''
     | The absorption coefficient of WATER as a function of wavelength.
     | Linear interpolation of data from Hale & Querry 1973 [HQ73] collected and processed 
-    | by S. Jacques and S. Prahl and publicly available at
-    | <https://omlc.org/spectra/water/abs/index.html>.
+    | by S. Prahl and publicly available at <https://omlc.org/spectra/water/abs/index.html>.
     
     wavelength range: [200 nm, 200 μm]
     
@@ -560,8 +559,7 @@ def mua_wat_Segelstein(lambda0):
     r'''
     | The absorption coefficient of WATER as a function of wavelength.
     | Linear interpolation of data from D. J. Segelstein's M.S. Thesis 1981 [S81],
-    | collected by S. Jacques and S. Prahl and publicly available at
-    | <https://omlc.org/spectra/water/abs/index.html>.
+    | collected by S. Prahl and publicly available at <https://omlc.org/spectra/water/abs/index.html>.
     
     | wavelength range: [10 nm, 10 m].
         

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics/anisotropy_factor.py

@@ -22,7 +22,7 @@
 | Release Date:
 | October 2024
 | Last Modification:
-| October 2024
+| October 2025
 
 | References:
 
@@ -60,7 +60,7 @@
 
 | [D03] Draine 2003.
 | Scattering by Interstellar Dust Grains. I. Optical and Ultraviolet.
-| https://doi.org/10.48550/arXiv.astro-ph/0304060
+| https://doi.org/10.1086/379118
 
 | [F11] Frisvad 2011.
 | Importance sampling the Rayleigh phase function.
@@ -162,9 +162,9 @@ def ptheta_TTHG(theta, g1, g2, gamma):
     
     :math:`p_{TTHG}(\theta, g_1, g_2, \gamma) = \gamma \mbox{ } p_{HG}(\theta, g_1) + (1 - \gamma) \mbox{ } p_{HG}(\theta, g_2)`
 
-    :math:`g_1` characterises the shape and the strength of the forward scattering peak
+    :math:`g_1` characterizes the shape and the strength of the forward scattering peak
 
-    :math:`g_2` characterises the shape and the strength of the backward scattering peak
+    :math:`g_2` characterizes the shape and the strength of the backward scattering peak
 
     :param theta: scattering angle [degrees]
     :type theta: float or np.ndarray
@@ -234,9 +234,9 @@ def ptheta_TTRM(theta, g1, g2, alpha1, alpha2, gamma):
     
     :math:`p_{TTRM}(\theta, g_1, g_2, \alpha_1, \alpha_2, \gamma) =  \gamma \mbox{ } p_{RM}(\theta, g_1, \alpha_1) + (1 - \gamma) \mbox{ } p_{RM}(\theta, g_2, \alpha_2)`
 
-    :math:`g_1` characterises the shape and the strength of the forward scattering peak
+    :math:`g_1` characterizes the shape and the strength of the forward scattering peak
 
-    :math:`g_2` characterises the shape and the strength of the backward scattering peak
+    :math:`g_2` characterizes the shape and the strength of the backward scattering peak
 
     :param theta: scattering angle [degrees]
     :type theta: float or np.ndarray
@@ -308,7 +308,7 @@ def ptheta_D(theta, g, alpha):
     
     :math:`p_{D}(\theta, g, \alpha) = 3\frac{1 + \alpha \cos^2\theta}{3 + \alpha (1 + 2g^2)} \mbox{ } p_{HG}(\theta, g)`
     
-    | For :math:`\alpha = 1` and :math:`g = 0` it reduces to the Rayleigh phase function.
+    | For :math:`\alpha = 1` and :math:`g = 0` it reduces to the Rayleigh scattering phase function.
     | For :math:`\alpha = 0` it reduces to the Henyey-Greenstein scattering phase function.
     | For :math:`\alpha = 1` it reduces to the Cornette-Shanks scattering phase function
 
@@ -363,9 +363,9 @@ def ptheta_TTU2(theta, g1, g2, gamma):
     
     :math:`p_{TTU2}(\theta, g_1, g_2, \gamma) = \gamma \mbox{ } p_{U2}(\theta, g_1) + (1 - \gamma) \mbox{ } p_{U2}(\theta, g_2)`
 
-    :math:`g_1` characterises the shape and the strength of the forward scattering peak
+    :math:`g_1` characterizes the shape and the strength of the forward scattering peak
 
-    :math:`g_2` characterises the shape and the strength of the backward scattering peak
+    :math:`g_2` characterizes the shape and the strength of the backward scattering peak
 
     :param theta: scattering angle [degrees]
     :type theta: float or np.ndarray
@@ -535,9 +535,9 @@ def costheta_TTHG(g1, g2, gamma):
     
     :math:`\langle \cos\theta \rangle_{TTHG}(g_1, g_2, \gamma) = \gamma \mbox{ } g_1 + (1 - \gamma) \mbox { } g_2`
 
-    :math:`g_1` characterises the shape and the strength of the forward scattering peak
+    :math:`g_1` characterizes the shape and the strength of the forward scattering peak
 
-    :math:`g_2` characterises the shape and the strength of the backward scattering peak
+    :math:`g_2` characterizes the shape and the strength of the backward scattering peak
 
     :param g1: parameter :math:`g_1` [-] (must be in the range [0, 1])
     :type g1: float
@@ -670,9 +670,9 @@ def costheta_TTRM(g1, g2, alpha1, alpha2, gamma):
     
     :math:`\langle \cos\theta \rangle_{TTRM}(g_1, g_2, \alpha_1, \alpha_2, \gamma) = \gamma \mbox{ } \langle \cos\theta \rangle_{RM}(g_1, \alpha_1) + (1 - \gamma) \mbox{ } \langle \cos\theta \rangle_{RM}(g_2, \alpha_2)`
 
-    :math:`g_1` characterises the shape and the strength of the forward scattering peak
+    :math:`g_1` characterizes the shape and the strength of the forward scattering peak
 
-    :math:`g_2` characterises the shape and the strength of the backward scattering peak
+    :math:`g_2` characterizes the shape and the strength of the backward scattering peak
 
     :param g1: parameter :math:`g_1` [-] (must be in the range [0, 1])
     :type g1: float
@@ -760,7 +760,7 @@ def costheta_CS(g):
     | scattering phase function.
     | For details please check Cornette & Shanks 1992 [CS92].
     
-    :math:`\langle \cos\theta \rangle_{CS}(g) = g\frac{3(4 + g^2)}{5(2 + g^2)}`
+    :math:`\langle \cos\theta \rangle_{CS}(g) = \frac{3(4 + g^2)}{5(2 + g^2)} \mbox{ } g`
 
     :param g: parameter :math:`g` [-] (must be in the range [-1, 1])
     :type g: float
@@ -788,7 +788,7 @@ def costheta_D(g, alpha):
     | scattering phase function.
     | For details please check Draine 2003 [D03].
     
-    :math:`\langle \cos\theta \rangle_{D}(g, \alpha) = g\frac{1 + \alpha(3 + 2g^2)/5}{1 + \alpha(1 + 2g^2)/3}`
+    :math:`\langle \cos\theta \rangle_{D}(g, \alpha) = \frac{1 + \alpha(3 + 2g^2)/5}{1 + \alpha(1 + 2g^2)/3} \mbox{ } g`
 
     :param g: parameter :math:`g` [-] (must be in the range [-1, 1])
     :type g: float
@@ -849,9 +849,9 @@ def costheta_TTU2(g1, g2, gamma):
     
     :math:`\langle \cos\theta \rangle_{TTU2}(g_1, g_2, \gamma) = \gamma \mbox{ } \langle \cos\theta \rangle_{U2}(g_1) + (1 - \gamma) \mbox{ } \langle \cos\theta \rangle_{U2}(g_2)`
 
-    :math:`g_1` characterises the shape and the strength of the forward scattering peak
+    :math:`g_1` characterizes the shape and the strength of the forward scattering peak
 
-    :math:`g_2` characterises the shape and the strength of the backward scattering peak
+    :math:`g_2` characterizes the shape and the strength of the backward scattering peak
     
     :param g1: parameter :math:`g_1` [-] (must be in the range [0, 1])
     :type g1: float

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics/dataframes.py

@@ -22,34 +22,34 @@
 | Release Date:
 | October 2024
 | Last Modification:
-| October 2024
+| March 2025
 
 | Example:
-| wps_dataframe (respective to datasets/colors/wps.txt)
-
-+--------------+------------+---------+---------+---------+
-| illuminant   | observer   |   Xn[-] |   Yn[-] |   Zn[-] |
-+==============+============+=========+=========+=========+
-| A            | 2o         |  1.0985 |       1 |  0.3558 |
-+--------------+------------+---------+---------+---------+
-| D50          | 2o         |  0.9641 |       1 |  0.8250 |
-+--------------+------------+---------+---------+---------+
-| D55          | 2o         |  0.9568 |       1 |  0.9214 |
-+--------------+------------+---------+---------+---------+
-| D65          | 2o         |  0.9504 |       1 |  1.0888 |
-+--------------+------------+---------+---------+---------+
-| D75          | 2o         |  0.9497 |       1 |  1.2257 |
-+--------------+------------+---------+---------+---------+
-| A            | 10o        |  1.1114 |       1 |  0.3520 |
-+--------------+------------+---------+---------+---------+
-| D50          | 10o        |  0.9671 |       1 |  0.8141 |
-+--------------+------------+---------+---------+---------+
-| D55          | 10o        |  0.9580 |       1 |  0.9093 |
-+--------------+------------+---------+---------+---------+
-| D65          | 10o        |  0.9481 |       1 |  1.0733 |
-+--------------+------------+---------+---------+---------+
-| D75          | 10o        |  0.9442 |       1 |  1.2060 |
-+--------------+------------+---------+---------+---------+
+| Lab_Alaluf2002_dataframe (respective to datasets/colors/Lab_Alaluf2002.txt)
+
++------------------------------------------+------------------+------------------+------------------+
+| group(body_location)                     |   L*(D65,10o)[-] |   a*(D65,10o)[-] |   b*(D65,10o)[-] |
++==========================================+==================+==================+==================+
+| european(photoprotected_volar_upper_arm) |            65    |             7.1  |            13.3  |
++------------------------------------------+------------------+------------------+------------------+
+| chinese(photoprotected_volar_upper_arm)  |            62.1  |             8.4  |            16.3  |
++------------------------------------------+------------------+------------------+------------------+
+| mexican(photoprotected_volar_upper_arm)  |            61.9  |             8.3  |            15.3  |
++------------------------------------------+------------------+------------------+------------------+
+| indian(photoprotected_volar_upper_arm)   |            53.7  |            10.3  |            17.9  |
++------------------------------------------+------------------+------------------+------------------+
+| african(photoprotected_volar_upper_arm)  |            49.2  |            10.2  |            18.4  |
++------------------------------------------+------------------+------------------+------------------+
+| european(photoexposed_dorsal_forearm)    |            53.94 |            12.57 |            19.23 |
++------------------------------------------+------------------+------------------+------------------+
+| chinese(photoexposed_dorsal_forearm)     |            51.38 |            12.69 |            19.18 |
++------------------------------------------+------------------+------------------+------------------+
+| mexican(photoexposed_dorsal_forearm)     |            50.42 |            12.69 |            19.58 |
++------------------------------------------+------------------+------------------+------------------+
+| indian(photoexposed_dorsal_forearm)      |            43.71 |            12.89 |            17.15 |
++------------------------------------------+------------------+------------------+------------------+
+| african(photoexposed_dorsal_forearm)     |            38.14 |            12.66 |            15.04 |
++------------------------------------------+------------------+------------------+------------------+
 '''
 
 import os
@@ -92,7 +92,6 @@ folder2 = os.path.join(folder0, 'datasets', 'colors')
 rspds_A_D50_D65_dataframe = pd.read_csv(os.path.join(folder2, 'rspds_A_D50_D65.txt'), sep = ' ')
 rspds_D55_D75_dataframe = pd.read_csv(os.path.join(folder2, 'rspds_D55_D75.txt'), sep = ' ')
 cmfs_dataframe = pd.read_csv(os.path.join(folder2, 'cmfs.txt'), sep = ' ')
-wps_dataframe = pd.read_csv(os.path.join(folder2, 'wps.txt'), sep = ' ')
 
 Lab_Alaluf2002_dataframe = pd.read_csv(os.path.join(folder2, 'Lab_Alaluf2002.txt'), sep = ' ')
 Lab_Xiao2017_dataframe = pd.read_csv(os.path.join(folder2, 'Lab_Xiao2017.txt'), sep = ' ')

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics/refractive_index.py

@@ -22,7 +22,7 @@
 | Release Date:
 | October 2024
 | Last Modification:
-| October 2024
+| March 2025
 
 | References:
 
@@ -64,31 +64,31 @@ from scipy.interpolate import interp1d
 from skinoptics.utils import *
 from skinoptics.dataframes import *
 
-def n_Cauchy(lambda0, A0, A1, A2, A3):
+def n_Cauchy(lambda0, A, B, C, D):
     r'''
     The Cauchy's equation.
     
-    :math:`n(\lambda) = A_0 + \frac{A_1}{\lambda^2} + \frac{A_2}{\lambda^4} + \frac{A_3}{\lambda^6}`
+    :math:`n(\lambda) = A + \frac{B}{\lambda^2} + \frac{C}{\lambda^4} + \frac{D}{\lambda^6}`
     
     :param lambda0: wavelength [nm]
     :type lambda0: float or np.ndarray
     
-    :param A0: coefficient :math:`A_0` [-]
-    :type A0: float
+    :param A: coefficient :math:`A` [-]
+    :type A: float
     
-    :param A1: coefficient :math:`A_1` [nm^2]
-    :type A1: float
+    :param B: coefficient :math:`B` [nm^2]
+    :type B: float
     
-    :param A2: coefficient :math:`A_2` [nm^4]
-    :type A2: float
+    :param C: coefficient :math:`C` [nm^4]
+    :type C: float
     
-    :param A3: coefficient :math:`A_3` [nm^6]
-    :type A3: float
+    :param D: coefficient :math:`D` [nm^6]
+    :type D: float
     
     :return: - **n** (*float or np.ndarray*) – refractive index [-]
     '''
     
-    return A0 + A1/np.power(lambda0, 2., dtype = 'float64') + A2/np.power(lambda0, 4., dtype = 'float64') + A3/np.power(lambda0, 6., dtype = 'float64')
+    return A + B/np.power(lambda0, 2., dtype = 'float64') + C/np.power(lambda0, 4., dtype = 'float64') + D/np.power(lambda0, 6., dtype = 'float64')
 
 def n_Cornu(lambda0, A, B, C):
     r'''

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: skinoptics
-Version: 0.0.1b5
+Version: 0.0.1b6
 Summary: SkinOptics: a python package with tools for building human skin computational models for Monte Carlo simulations of light transport
 Author-email: Victor Lima <victorporto@ifsc.usp.br>
 Project-URL: Homepage, https://github.com/victorportog/skinoptics
@@ -13,6 +13,7 @@ License-File: LICENSE.txt
 Requires-Dist: numpy<2.0.0,>=1.26.4
 Requires-Dist: scipy<2.0.0,>=1.13.0
 Requires-Dist: pandas<3.0.0,>=2.2.2
+Dynamic: license-file
 
 SkinOptics
 ==========
@@ -21,7 +22,7 @@ SkinOptics
 models for Monte Carlo simulations of light transport, as well as tools for analyzing simulation
 outputs. It can also be used for teaching and exploring about Optical Properties and Colorimetry.
 
-**SkinOptics** is under continuos development.
+**SkinOptics** is under continuous development.
 
 New features may be available in the future.
 

{skinoptics-0.0.1b5 → skinoptics-0.0.1b6}/skinoptics.egg-info/SOURCES.txt

@@ -131,7 +131,6 @@ skinoptics/datasets/colors/Lab_Xiao2017.txt
 skinoptics/datasets/colors/cmfs.txt
 skinoptics/datasets/colors/rspds_A_D50_D65.txt
 skinoptics/datasets/colors/rspds_D55_D75.txt
-skinoptics/datasets/colors/wps.txt
 skinoptics/datasets/optical_properties/DE_Salomatina.txt
 skinoptics/datasets/optical_properties/DE_Shimojo.txt
 skinoptics/datasets/optical_properties/EP_Salomatina.txt

skinoptics-0.0.1b5/skinoptics/datasets/colors/wps.txt

@@ -1,11 +0,0 @@
-illuminant observer Xn[-] Yn[-] Zn[-]
-A 2o 1.0985 1.0000 0.3558
-D50 2o 0.9641 1.0000 0.8250
-D55 2o 0.9568 1.0000 0.9214
-D65 2o 0.9504 1.0000 1.0888
-D75 2o 0.9497 1.0000 1.2257
-A 10o 1.1114 1.0000 0.3520
-D50 10o 0.9671 1.0000 0.8141
-D55 10o 0.9580 1.0000 0.9093
-D65 10o 0.9481 1.0000 1.0733
-D75 10o 0.9442 1.0000 1.2060