References
Commands¶
Datasets¶
get_datasets [MFT, rawfiles, BWS, stdev]- Retrieve examples of data files.
Databases management¶
create_DB [folder]- Create two empty databases (projects and objects).get_creators- Retrieve a list of names corresponding to the persons that created the microfaded objects.get_DB [db]- Retrieve the databases.get_institutions- Retrieve a list of institutions owning the microfaded objects.get_path_DB- Retrieve the absolute path of the folder where the databases are stored.get_persons- Retrieve a list of persons that performed microfading analyses.add_new_institution- Add a new institution to the database.add_new_person- Add a new person to the list of persons doing microfading analyses.add_new_project- Add a new project to the database.add_new_object- Add a new object to the database.update_DB_project [new, old]- Modify or add a new parameter to the project database.update_DB_object [new, old]- Modify or add a new parameter to the object database.
Data processing¶
process_rawdata [files, device]- Process rawdata files into interim files.
MFT class¶
data_points- Select colourimetric values for one or multiple light dose values.
MFT
¶
Bases: object
Source code in src/microfading/microfading.py
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 | |
get_meas_ids
property
¶
Return the measurement id numbers corresponding to the input files.
get_objects
property
¶
Return the object id numbers corresponding to the input files.
get_wavelength
property
¶
Return the wavelength range of the microfading measurements.
__init__(files, BWS=True)
¶
Instantiate a Microfading (MFT) class object in order to manipulate and visualize microfading analysis data.
Parameters¶
files : list A list of string, where each string corresponds to the absolute path of text or csv file that contains the data and metadata of a single microfading measurement. The content of the file requires a specific structure, for which an example can be found in "datasets" folder of the microfading package folder (Use the get_datasets function to retrieve the precise location of such example files). If the file structure is not respected, the script will not be able to properly read the file and access its content.
bool, optional
When False, it ignores the measurements performed on BWS samples if included.
Source code in src/microfading/microfading.py
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 | |
add_info(parameters, values)
¶
Add information inside the info tab of microfading interim files.
Parameters¶
parameters : Union[list,str] Parameters defined in the info tab of microfading interim files. A single parameter as a string or a list of parameters can be given. When a list of parameters is given, make sure that the length of parameters is equal to the length of values. For a list of valid parameters, use the function get_parameters_info().
Union[list,str,int]
The new values that will be added in the info tab.
Raises¶
ValueError If the parameter is invalid, it will return an error message.
Source code in src/microfading/microfading.py
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 | |
compute_JND(dose_unit='Hv', JND_dE=1.5, light_intensity=50, daily_exposure=10, yearly_exposure=365, fitting=True)
¶
Compute the just noticeable difference (JND) corresponding to each input data file.
Parameters¶
dose_unit : Optional[str], optional Unit of the light dose energy, by default 'Hv' Any of the following units can be entered: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
float, optional
The dE00 value corresponding to one JND, by default 1.5
int, optional
The illuminance or the irradiance value of the intended light source, by default 50
Optional[int], optional
Amount of exposure hours per day, by default 10
Optional[int], optional
Amount of exposure days per year, by default 365
bool, optional
Whether to fit the microfading data necessary to compute the JND value, by default True
Returns¶
A list of numerical values as string (uncertainty string with a nominal and standard deviation value) It returns a list of numerical values corresponding to the amount of years necessary to reach one JND.
Source code in src/microfading/microfading.py
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 | |
compute_delta(coordinates=['dE00'], dose_unit='He', dose_values='all', derivation=False, rounding=4, concat=True)
¶
Retrieve the CIE delta values for a given set of colorimetric coordinates corresponding to the given microfading analyses.
Parameters¶
coordinates : list, optional List of colorimetric coordinates, by default ['dE00'] Any of the following coordinates can be added to the list: 'dE76', 'dE00', 'dR_vis' , 'L', 'a', 'b', 'C', 'h'.
str, optional
Define the light energy dose, by default 'He' Any of the following units can be entered: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
Union[int, float, list, tuple], optional
Dose values for which the colourimetric values will be returned, by default 'all' When 'all', it returns the colourimetric values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
bool, optional
Whether to return the first derivative values of the desired coordinates, by default False
int, optional
Rounding of the colorimetric values, by default 4 The value corresponds to the amount of digits after the decimal separator.
bool, optional
Whether to concat the data column-wise When True, it returns a single pandas dataframe When False, it returns a list of pandas dataframes
Returns¶
A list of pandas dataframes It returns a a list of pandas dataframes where each column corresponds to a light energy dose or a desired coordinate.
Source code in src/microfading/microfading.py
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 | |
compute_fitting(plot=True, return_data=False, dose_unit='Hv', coordinate='dE00', equation='power_3p', initial_params='auto', bounds=None, x_range=(0, 5.1, 0.1), save=False, path_fig='cwd')
¶
Fit the values of a given colourimetric coordinates.
Parameters¶
plot : bool, optional Whether to show the fitted data, by default True
bool, optional
Whether to return the fitted data, by default False
string, optional
Unit of the light energy dose, by default 'He' Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
string, optional
Select the desired colourimetric coordinate from the following list: ['L', 'a','b', 'C', 'h', 'dL', 'da','db', 'dC', 'dh', 'dE76', 'dE00', 'dR_vis'], by default 'dE00'
str, optional
Mathematical equation used to fit the coordinate values, by default 'c0(xc1)'. Any others mathematical can be given. The following equation is often relevant for fitting microfading data: '((x) / (c0 + (c1x))) + c2'.
List[float], optional
Initial guesses of the 'c' parameters given in the equation (c0, c1, c2, etc.), by default [0.1, 0.0]
List[float], optional
Bound with lower and upper limits the parameters of the equation computed by the algorithm, by default None.
Tuple[int], optional
Values along which the fitted values should be computed (start, end, step), by default (0, 1001, 1)
bool, optional
Whether to save the plot, by default False
str, optional
Absolute path of the figure to be saved, by default 'default'
Returns¶
Union[None, Tuple[np.ndarray, np.ndarray]] It returns a typle of four element: fitted_parameters, fitted_data, pcov values, r_squared value. When plot is set to True, a figure plotting the x and fitted y values will appear.
Source code in src/microfading/microfading.py
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 | |
compute_mean(return_data=True, criterion='spot_group', dose_unit='He', dose_values=(0, 'chd', 0.1), rounding=(4, 3), save=False, folder='.', filename='default')
¶
Compute mean and standard deviation values of several microfading measurements.
Parameters¶
bool, optional
Whether to return the data, by default True
str, optional
description, by default 'group'
str, optional
The ligth dose unit used to average the colorimetric and spectral data, by default 'He' Any of the following units can be entered: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
tuple, optional
Tuple of three values (start, end, step) defining the dose values for which the average values will be returned, by default (0, 'chd', 0.1) The logical start value is 0, but it does not have to be. Just make sure that it is smaller than the end values. The end value can be one of the following options: 'chd', 'max', an integer or float of your choice smaller or equal to the common highest available dose (chd).
When 'chd', it will compute the average values over the common light dose range. When 'max', it will compute the average values over the largest light dose range.
For example, let's say that you have three measurements - one from 0 to 2 MJ/m2, one from 0 to 1.5 MJ/m2m and a last one from 0 to 3 MJ/m2 - for which you want to compute the mean and standard deviation values. When selecting 'chd', it will return values from 0 to 1.5 MJ/m2. When selecting 'max', it will return values from 0 to 3 MJ/m2 with standard deviation values of 0 between 2 and 3 MJ/m2.
[int, tuple], optional
Rounding the spectral and colorimetric coordinates, by default (4,3) It represents the number of digits after the comma. When an integer is provided, it is applied to both the spectral and colorimetric value. When a tuple is provided, the first value relates to the spectral values while the second relates to the colorimetric values.
bool, optional
Whether to save the average data as an excel file, by default False
str, optional
Folder where the excel file will be saved, by default 'default' When 'default', the file will be saved in the same folder as the input files When '.', the file will be saved in the current working directory One can also enter a valid path as a string.
str, optional
Filename of the excel file containing the average values, by default 'default' When 'default', it will use the filename of the first input file One can also enter a filename, but without a filename extension.
Returns¶
tuple, excel file It returns a tuple composed of three elements (info, CIELAB data, spectral data). When 'save' is set to True, an excel is created to stored the tuple inside three distinct excel sheet (info, CIELAB, spectra).
Raises¶
RuntimeError description
Source code in src/microfading/microfading.py
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 | |
compute_sp_derivate()
¶
Compute the first derivative values of reflectance spectra.
Returns¶
a list of pandas dataframes It returns the first derivative values of the reflectance spectra inside dataframes where each column corresponds to a single spectra.
Source code in src/microfading/microfading.py
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 | |
get_XYZ(illuminant='default', observer='default', dose_unit='He', dose_values='all', rounding=2)
¶
Compute the XYZ values.
Parameters¶
illuminant : (str, optional)
Reference illuminant ('D65', or 'D50'). by default 'default'.
When 'default', it fetches the illuminant value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the illuminant value to 'D65'.
(str|int, optional)
Reference observer in degree ('10' or '2'). by default 'default'. When 'default', it fetches the observer value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the observer value to '10'.
Optional[str], optional
Unit of the light dose energy, by default ['He'] Any of the following units can be entered: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
Union[int, float, list, tuple], optional
Dose values for which the colourimetric values will be returned, by default 'all' When 'all', it returns the colourimetric values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
Optional[int], optional
Rounding of the colorimetric values, by default 2 The value corresponds to the amount of digits after the decimal separator.
Returns¶
pandas dataframe It returns the XYZ values inside a dataframe where each column corresponds to a single file.
Source code in src/microfading/microfading.py
2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 | |
get_cielab(coordinates=['dE00'], dose_unit='He', dose_values='all', data_type='all', rounding=4, concat=True)
¶
Retrieve the colourimetric values for one or multiple light dose values.
Parameters
----------
coordinates : Optional[list], optional
Select the desired colorimetric coordinates from the following list: ['L*', 'a*','b*', 'C*', 'h', 'dL*', 'da*','db*', 'dC*', 'dh', 'dE76', 'dE00', 'dR_vis'], by default ['dE00']
When 'all', it returns all the colorimetric coordinates.
dose_unit : Optional[str], optional
Unit of the light dose energy, by default ['He']
Any of the following units can be added to the list: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
dose_values : Union[int, float, list, tuple], optional
Dose values for which the colourimetric values will be returned, by default 'all'
When 'all', it returns the colourimetric values for all the dose values available in the given input data files.
A single dose value (an integer or a float number) can be entered.
' A list of dose values, as integer or float, can also be entered. ' A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
data_type : Union[str, list], optional
Select the type of data, by default 'all'
One can enter one of the following options ('nominal', 'mean', 'std') as a string, or combined inside a list, e.g. ['nominal', 'std']
rounding : Optional[int], optional
Rounding of the colorimetric values, by default 4
The value corresponds to the amount of digits after the decimal separator.
concat : Optional[bool], optional
Whether to concatenate the dataframes together, by default False
Returns
-------
A pandas dataframe or a list of pandas dataframes
It returns the values of the wanted colour coordinates inside dataframes where each coordinate corresponds to a column.
Source code in src/microfading/microfading.py
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 | |
get_data(data='all', xarray=False)
¶
A generic way to retrieve the microfading data. For more precise data retrieving, the function get_cielab() or get_spectra() will be more adequate.
Parameters¶
data : str|list, optional
Possibility to select the type of data, by default 'all'.
When 'all', it returns all the data (spectral and colorimetric).
When 'sp', it only returns the spectral data.
When 'cl', it only returns the colorimetric data.
When 'Lab', it returns the CIE Lab values.
A list of strings can be entered to select specific colourimetric data among the following: ['dE76,'dE00','dR_vis', 'L', 'a', 'b', 'C*', 'h'].
bool, optional
When True, the data are returned as an xarray.Dataset object, else as pandas dataframe object, by default False.
Returns¶
It returns a list of pandas dataframes or xarray.Dataset objects
Source code in src/microfading/microfading.py
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 | |
get_doses(dose_unit='all', max_doses=False, concat=True)
¶
Retrieve the light energy doses related to each microfading measurement.
Parameters¶
dose_unit : Union[str,list], optional Unit of the light dose energy, by default 'all' Any of the following units can be added to the list: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec). When a single unit is requested, it can be given as a string value ('He', 'Hv', or 't'). Otherwise, enter the dose unit values inside a list.
bool, optional
Whether to return the maximum light dose values, by default False.
Optional[bool], optional
Whether to concatenate the dose into a single dataframe, by default True When False, it returns a list of dataframes
Returns¶
a pandas dataframe or a list of pandas dataframes
Source code in src/microfading/microfading.py
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 | |
get_illuminant(illuminant='D65', observer='10')
¶
Retrieve data over the illuminant.
Parameters¶
illuminant : Optional[str], optional Select the illuminant, by default 'D65' It can be any value within the following list: ['A', 'B', 'C', 'D50', 'D55', 'D60', 'D65', 'D75', 'E', 'FL1', 'FL2', 'FL3', 'FL4', 'FL5', 'FL6', 'FL7', 'FL8', 'FL9', 'FL10', 'FL11', 'FL12', 'FL3.1', 'FL3.2', 'FL3.3', 'FL3.4', 'FL3.5', 'FL3.6', 'FL3.7', 'FL3.8', 'FL3.9', 'FL3.10', 'FL3.11', 'FL3.12', 'FL3.13', 'FL3.14', 'FL3.15', 'HP1', 'HP2', 'HP3', 'HP4', 'HP5', 'LED-B1', 'LED-B2', 'LED-B3', 'LED-B4', 'LED-B5', 'LED-BH1', 'LED-RGB1', 'LED-V1', 'LED-V2', 'ID65', 'ID50', 'ISO 7589 Photographic Daylight', 'ISO 7589 Sensitometric Daylight', 'ISO 7589 Studio Tungsten', 'ISO 7589 Sensitometric Studio Tungsten', 'ISO 7589 Photoflood', 'ISO 7589 Sensitometric Photoflood', 'ISO 7589 Sensitometric Printer']
Optional[str], optional
Standard observer in degree, by default '10' It can be either '2' or '10'
Returns¶
tuple It returns a tuple with two set of values: the chromaticity coordinates (x,y) of the illuminant (CCS) and the spectral distribution of the illuminant (SDS) from 300 to 780 nm.
Source code in src/microfading/microfading.py
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 | |
get_metadata(labels='all', section='all')
¶
Retrieve the metadata.
Parameters¶
labels : Union[list,str], optional A string or a list of strings corresponding to the wanted metadata labels, by default 'all' The metadata labels can be found in the 'info' sheet of microfading excel files. When 'all', it returns all the metadata
Optional[str], optional
Retrieve metadata from one of the following sections: 'project', 'object', 'device', 'analysis', 'spot', 'beam', 'results'. For example, if you want to retrieve all the information about the objects, you can enter 'object' as a value.
Returns¶
pandas dataframe It returns the metadata inside a pandas dataframe where each column corresponds to a single file.
Source code in src/microfading/microfading.py
2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 | |
get_observer(observer='10')
¶
Retrieve data over the observer.
Parameters¶
observer : Optional[str], optional Standard observer in degree, by default '10' It can be either '2' or '10'
Returns¶
Returns the x_bar, y_bar, z_bar spectra between 360 and 830 nm.
Source code in src/microfading/microfading.py
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 | |
get_sRGB(illuminant='default', observer='default', dose_unit='He', dose_values='all', clip=True)
¶
Compute the sRGB values.
Parameters¶
illuminant : (str, optional)
Reference illuminant ('D65', or 'D50'). by default 'default'.
When 'default', it fetches the illuminant value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the illuminant value to 'D65'.
(str|int, optional)
Reference observer in degree ('10' or '2'). by default 'default'. When 'default', it fetches the observer value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the observer value to '10'.
Optional[str], optional
Unit of the light dose energy, by default ['He'] Any of the following units can be entered: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
Union[int, float, list, tuple], optional
Dose values for which the colourimetric values will be returned, by default 'all' When 'all', it returns the colourimetric values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
Optional[bool], optional
Whether to constraint the srgb values between 0 and 1.
Returns¶
pandas dataframe It returns the sRGB values inside a dataframe where each column corresponds to a single file.
Source code in src/microfading/microfading.py
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 | |
get_spectra(wl_range='all', dose_unit='He', dose_values='all', spectral_mode='R', derivation=False, smoothing=[1, 0], concat=True)
¶
Retrieve the reflectance spectra related to the input files.
Parameters¶
wl_range : Union[int, float, list, tuple], optional Select the wavelengths for which the spectral values should be given with a two-values tuple corresponding to the lowest and highest wavelength values, by default 'all' When 'all', it will returned all the available wavelengths contained in the datasets. A single wavelength value (an integer or a float number) can be entered. A list of specific wavelength values as integer or float can also be entered. A tuple of two or three values (min, max, step) will take the range values between these two first values. By default the step is equal to 1.
string, optional
Unit of the light energy dose, by default 'He' Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec).
Union[int, float, list, tuple], optional
Dose values for which the reflectance values will be returned, by default 'all' When 'all', it returns the reflectance values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
string, optional
When 'R', it returns the reflectance spectra When 'A', it returns the absorption spectra using the following equation: A = -log(R)
bool, optional
Whether to return the first derivative values of the desired spectral values, by default False.
list of two integers, optional
Whether to smooth the reflectance data using the Savitzky-Golay filter from the Scipy package, by default [1,0] The first integer corresponds to the window length and should be less than or equal to the size of a reflectance spectrum. The second integer corresponds to the polyorder parameter which is used to fit the samples. The polyorder value must be less than the value of the window length.
bool, optional
Whether to concat the reflectance data column-wise When True, it returns a single pandas dataframe When False, it returns
Returns¶
A list of pandas dataframes It returns a list of pandas dataframes where the columns correspond to the dose values and the rows correspond to the wavelengths.
Source code in src/microfading/microfading.py
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 | |
get_xy(illuminant='default', observer='default', dose_unit='He', dose_values='all', rounding=4)
¶
Compute the xy values.
Parameters¶
illuminant : (str, optional)
Reference illuminant ('D65', or 'D50'). by default 'default'.
When 'default', it fetches the illuminant value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the illuminant value to 'D65'.
(str|int, optional)
Reference observer in degree ('10' or '2'). by default 'default'. When 'default', it fetches the observer value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the observer value to '10'.
Optional[str], optional
Unit of the light dose energy, by default ['He'] Any of the following units can be entered: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
Union[int, float, list, tuple], optional
Dose values for which the colourimetric values will be returned, by default 'all' When 'all', it returns the colourimetric values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
Optional[int], optional
Rounding of the colorimetric values, by default 4 The value corresponds to the amount of digits after the decimal separator.
Returns¶
pandas dataframe It returns the xy values inside a dataframe where each column corresponds to a single file.
Source code in src/microfading/microfading.py
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 | |
make_table(parameters=['BWSE'], sort_by='meas_id', title=None, subtitle=None)
¶
Create a table showing values from the 'info' sheets.
Parameters¶
parameters : Optional[list], optional Select which parameters of the info sheet to display, by default ['BWSE']
Optional[str], optional
Select the parameters on which to sort the rows of the table, by default 'meas_id'
Optional[str], optional
Whether to add a title above the table, by default None
Optional[str], optional
Whether to add a subtitle below the title, by default None
Returns¶
type description
Source code in src/microfading/microfading.py
4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 | |
plot_CIELAB(dE=False, stdev=True, data_settings={}, figure_settings={}, legend_settings={}, lines_settings={}, save=False, path_fig='cwd', report=False)
¶
Plot the Lab values related to the input the microfading files.
Parameters¶
bool, optional
Whether to display the dE00 curves in the bottom left suplots instead of the CIELAB 2D space, by default False
bool, optional
Whether to display the standard deviation values if any, by default True
dict, optional
Adjust settings related to the data, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'dose_unit', 'dose_values', 'data_type'.
'dose_unit' [str] corresponds to the unit of the light energy dose, by default 'He'. Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec). If you set dE to True, it will plot the dE00 values as a function of the chosen 'dose_unit'.
'dose values' [str,int,float,list,tuple] selects the light dose valules for which the colourimetric delta values will be returned, by default 'all'. When 'all', it returns the colourimetric values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
'data_type' [str,list] corresponds to the type of data to be displayed, by default 'all'. There are three data types you can choose from ('nominal', 'mean', 'std'). When 'all' it will select all the data_types, but you can enter a single data_type as a string or combined inside a list, e.g: ['nominal', 'mean']. For more information about the data types, please consult the online documentation (https://g-patin.github.io/microfading/datafiles/).
dict, optional
Adjust the settings related to the figure, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'title', 'xlabel', 'ylabel', 'fontsize', 'fontsize_title'.
'title' [str] defines the suptitle of the figure, by default None.
'xlabel' [str] defines the x-axis label of the bottom left subplot. It only works when dE is set to True. By default, it takes the value based on the dose_unit (see data_settings).
'ylabel' [str] defines the y-axis label of the bottom left subplot. It only works when dE is set to True. By default 'CIE \(\Delta E_{00}\)'.
'fontsize' [int] defines the fontsize of the axes labels and ticks, by default 18.
'fontsize_title' [int] defines the fontsize of the title if any, by default 20.
dict, optional
Adjust the settings related to the legend, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'fontsize','labels', 'ncols', 'obs_ill', 'position', 'title'.
'fontsize' [int] defines the fontsize of the legend, by default 14.
'labels' [str, list] defines the labels displayed inside the legend, by default 'default'. If you enter an empy list [] or an empty string '', the legend won't be displayed. When set to 'default', each label is made of the measurement id and the spot description. You can also enter a list of strings, as long as the number of string elements inside the list is equal to the number of measurements being displayed. Finally, you can enter a template string based on the parameters available in the info tab (metadata) of the measurement files. The parameters have to be inserted inside square brackets [], e.g: 'id: [meas_id] - [object_type]'. For more information about it, please consult the online documentation (https://g-patin.github.io/microfading/data-visualization/).
'ncols' [int] defines the number of columns inside the legend, by default 1.
'obs_ill' [bool] defines whether the observer and illuminant information should be displayed, by default False.
'position' [str] defines the position of the legend inside the figure, by default 'in'. When 'in' the legend is displayed inside the plot, when 'out' the legend is located outside the plot.
'title' [str] defines whether to add a title to the legend, by default None.
dict, optional
Adjust the settings related to the plot lines, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'alpha', 'colors', 'markers', 'size'.
'alpha' [int, float, list] defines the transparency of the markers, by default 1. It has to be a value between 0 and 1 included, where 0 corresponds to a fully transparent marker and 1 to an opaque marker. You can define a single alpha values (int or float) similar for all the measurements, or you can enter a list of numerical values if you wish to define the transparency related to individual measurements.
'colors' [str, list] defines the colors of the markers, by default None. When 'sample', it will compute the initial color the sample on which the measurement was performed and use it a color for the marker. A single color value as string can be entered and will then be applied to all the measurements. A list of string can be entered to individually define the color related to each measurement. Valid values for the string are based on the matplotlib color values.
'markers' [str, list] defines the style of the markers, by default 'o'. When 'random', it will applied different marker styles. A single marker style as a string can be entered and will be applied to all the measurements. A list of string can be entered to individually define the marker related to each measurement. Valid values for the string are based on the matplotlib marker styles.
'size' [int, list] defines the size of the markers, by default 6. When 'random', it will applied different marker sizes. A single marker size as a integer can be entered and will be applied to all the measurements. A list of integers can be entered to individually define the size of the marker related to each measurement.
bool, optional
Whether to save the figure, by default False
str, optional
Absolute path required to save the figure, by default 'cwd' When 'cwd', it will save the figure in the current working directory.
bool, optional
Whether to apply specific features for reports. [PARAMETER NOT ACTIVE YET]
Returns¶
png file It returns a figure with 4 subplots that can be saved as a png file.
Source code in src/microfading/microfading.py
2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 | |
plot_bars(BWS_lines=False, coordinate='dE00', dose_unit='Hv', dose_value='hcd', xlabels='default', group_objects=False, fontsize=24, rotate_xlabels=45, position_xlabels='right', position_text=(0.75, 0.98), colors=None, save=False, path_fig='cwd')
¶
Plot a bar graph of a given colorimetric coordinate for a given light dose value.
Parameters¶
BWS_lines : Optional[bool], optional Whether to display the blue wool standard values as horizontal lines or as bars, by default True
Optional[str], optional
Colorimetric coordinate to be displayed, by default 'dE00' It can be any coordinates among the following list : ['L','a','b','C','h','dL','da','db','dC','dh','dE76','dE00','dR_vis'].
Optional[str], optional
Unit of the light energy dose, by default 'Hv' Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
Union[int, float, str], optional
Values of the light dose energy, by default 'hcd' 'hcd' stands for 'highest common dose' value. When 'hcd' it will take the highest dose values common to all the microfading files.
Union[str, list], optional
Values of the labels on the x-axis (one label per bar), by default 'default' When 'default', it takes the measurement id as label.
Optional[int], optional
Fontsize of the plot (title, ticks, and labels), by default 24
Optional[int], optional
Whether to rotate the labels on the x-axis, by default 0 It can be any integer value between 0 and 360.
Optional[str], optional
Position of the labels according to each bar ('center', 'left', 'right'), by default 'center'
Optional[tuple], optional
Position (x,y) of the text with the exposure dose value, by default (0.03,0.92)
Union[str,float,list], optional
Colors of the bar, by default None When 'sample', the color of each bar will be based on srgb values computed from the reflectance values. A single string or float value can also be used to define the color of all the bars (see matplotlib colour values). A list string can also be given, in that case, the number of element in the list should be equal to the number of bars.
bool, optional
Whether to save the figure, by default False
str, optional
Absolute path required to save the figure, by default 'cwd' When 'cwd', it will save the figure in the current working directory.
Source code in src/microfading/microfading.py
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 | |
plot_delta(coordinates=['dE00'], stdev=True, data_settings={}, figure_settings={}, legend_settings={}, lines_settings={}, text_settings={}, save=False, path_fig='cwd')
¶
Plot the delta values of choosen colorimetric coordinates related to the microfading analyses.
Parameters¶
Union[list, str], optional
List of colorimetric coordinates, by default ['dE00'] Any of the following coordinates can be added to the list: 'dE76', 'dE00', 'dR_vis' , 'L', 'a', 'b', 'C', 'h'.
bool, optional
Whether to display the standard deviation values if any, by default True.
dict, optional
Adjust settings related to the data, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'dose_unit', 'dose_values', 'derivation', 'smoothing'.
'dose_unit' corresponds to the unit of the light energy dose, by default 'He'. Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
'dose values' selects the light dose valules for which the colourimetric delta values will be returned, by default 'all'. When 'all', it returns the colourimetric values for all the dose values available in the given input data files. A single dose value (an integer or a float number) can be entered. A list of dose values, as integer or float, can also be entered. A tuple of three values (min, max, step) will be used in a numpy.arange() function to return an array of dose values.
'derivation' defines whether to compute to first derivative values, by default False. When True, it will return and plot the derivative values of the colourimetric delta values.
'smoothing' defines whether to smooth the data, by default (1,0). It takes a tuple of two integers as value which is used as input for the Savitzky-Golay filter. The first value corresponds to the window_length and the second to the polyorder value.
dict, optional
Adjust the settings related to the figure, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'figsize', 'title', 'xlabel', 'ylabel', 'xlim', 'ylim', 'fontsize', 'fontsize_title'.
'figsize [tuple] defines the dimension of the figure, by default (15,9).
'title' [str] defines the suptitle of the figure, by default None.
'xlabel' [str] defines the x-axis label of the figure, by default, it takes the value based on the dose_unit (see data_settings). Nevertheless, you can also enter a value as a string and it will overrun the default behaviour.
'ylabel' [str] defines the y-axis label of the figure, by default the label is based on the colorimetric coordinates being plotted. Nevertheless, you can also enter a value as a string and it will overrun the default behaviour.
'xlim' [tuple] defines the limits of the x-axis, by default 0. Enter a tuple of two numerical values (start, end).
'ylim' [tuple] defines the limits of the y-axis, by default None. Enter a tuple of two numerical values (start, end).
'fontsize' [int] defines the fontsize of the axes labels and ticks, by default 18.
'fontsize_title' [int] defines the fontsize of the title if any, by default 20.
dict, optional
Adjust the settings related to the legend, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'fontsize','labels', 'ncols', 'position', 'title'.
'fontsize' [int] defines the fontsize of the legend, by default 14.
'labels' [str, list] defines the labels displayed inside the legend, by default 'default'. If you enter an empy list [] or an empty string '', the legend won't be displayed. When set to 'default', each label is made of the measurement id and the spot description. You can also enter a list of strings, as long as the number of string elements inside the list is equal to the number of measurements being displayed. Finally, you can enter a template string based on the parameters available in the info tab (metadata) of the measurement files. The parameters have to be inserted inside square brackets [], e.g: 'id: [meas_id] - [object_type]'. For more information about it, please consult the online documentation (https://g-patin.github.io/microfading/).
'ncols' [int] defines the number of columns inside the legend, by default 1.
'position' [str] defines the position of the legend inside the figure, by default 'in'. When 'in' the legend is displayed inside the plot, when 'out' the legend is located outside the plot.
'title' [str] defines whether to add a title to the legend, by default None.
dict, optional
Adjust the settings related to the plot lines, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'colors', 'ls', 'lw'.
'colors' [str, list] defines the colors of the markers, by default None. When 'sample', it will compute the initial color the sample on which the measurement was performed and use it a color for the marker. A single color value as string can be entered and will then be applied to all the measurements. A list of string can be entered to individually define the color related to each measurement. Valid values for the string are based on the matplotlib color values.
'ls' [str, list] defines the style of the lines, by default '-'. When 'random', it will applied different line styles. A single style as a string can be entered and will be applied to all the lines. A list of string can be entered to individually define the linestyle related to each measurement. Valid values for the line styles are based on the matplotlib library.
'lw' [int, list] defines the width of the lines, by default 2. A single width value can be entered and will be applied to all the lines. A list of integers can be entered to individually define the width related to each measurement.
bool, optional
Whether to save the figure, by default False
str, optional
Absolute path required to save the figure, by default 'cwd' When 'cwd', it will save the figure in the current working directory.
Source code in src/microfading/microfading.py
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 | |
plot_sp(spectra='i', stdev=False, data_settings={}, figure_settings={}, legend_settings={}, lines_settings={}, text_settings={}, save=False, path_fig='cwd', report=False)
¶
Plot the reflectance spectra corresponding to the associated microfading analyses.
Parameters¶
Optional[str], optional
Define which spectra to display, by default 'i' 'i' for initial spectral, 'f' for final spectra, 'i+f' for initial and final spectra, 'all' for all the spectra, a tuple of two values (a, b) can be entered to plot spectra for specific dose values. The first parameter ("a") indicates the dose_unit ('He', 'Hv', 't'). The second parameter ("b") corresponds to the dose values, it can be a single integer or float, a list of integers or floats, or a tuple of three integers (start, end, step). When a single value is given, it will plot the spectrum related to the given dose value. When a list of values is given, it will plot as much spectra as provided values. When a tuple is given, it will plot the requested amount of spectra. For more information and examples, please consult the online documentation (https://g-patin.github.io/microfading/).
bool, optional
Whether to show the standard deviation values, by default False
dict, optional
Adjust settings related to the data, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'mode', 'derivation, 'dose_unit', 'smoothing', 'wl_range'
'mode' [string] defines the type or mode of the measurement (absorbance or refectance), by default 'R'. When 'R', it returns reflectance spectra. When 'A', it returns absorption spectra using the following equation: A = -log(R).
'derivation' defines whether to compute to first derivative values, by default False. When True, it will return and plot the derivative values of the colourimetric delta values.
'dose_unit' corresponds to the unit of the light energy dose, by default 'He'. Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (sec)
'smoothing' defines whether to smooth the data, by default (1,0). It takes a tuple of two integers as value which is used as input for the Savitzky-Golay filter. The first value corresponds to the window_length and the second to the polyorder value.
'wl_range' [tuple] defines the wavelength range with a two-values integer tuple corresponding to the lowest and highest wavelength values, by default None
dict, optional
Adjust the settings related to the figure, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'figsize', 'title', 'xlabel', 'ylabel', 'xlim', 'ylim', 'fontsize', 'fontsize_title'.
'figsize [tuple] defines the dimension of the figure, by default (15,9).
'title' [str] defines the suptitle of the figure, by default None.
'xlabel' [str] defines the x-axis label of the figure, by default, it takes the value based on the dose_unit (see data_settings). Nevertheless, you can also enter a value as a string and it will overrun the default behaviour.
'ylabel' [str] defines the y-axis label of the figure, by default the label is based on the colorimetric coordinates being plotted. Nevertheless, you can also enter a value as a string and it will overrun the default behaviour.
'xlim' [tuple] defines the limits of the x-axis, by default 0. Enter a tuple of two numerical values (start, end).
'ylim' [tuple] defines the limits of the y-axis, by default None. Enter a tuple of two numerical values (start, end).
'fontsize' [int] defines the fontsize of the axes labels and ticks, by default 18.
'fontsize_title' [int] defines the fontsize of the title if any, by default 20.
dict, optional
Adjust the settings related to the legend, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'fontsize','labels', 'ncols', 'position', 'title'.
'fontsize' [int] defines the fontsize of the legend, by default 14.
'labels' [str, list] defines the labels displayed inside the legend, by default 'default'. If you enter an empy list [] or an empty string '', the legend won't be displayed. When set to 'default', each label is made of the measurement id and the spot description. You can also enter a list of strings, as long as the number of string elements inside the list is equal to the number of measurements being displayed. Finally, you can enter a template string based on the parameters available in the info tab (metadata) of the measurement files. The parameters have to be inserted inside square brackets [], e.g: 'id: [meas_id] - [object_type]'. For more information about it, please consult the online documentation (https://g-patin.github.io/microfading/).
'ncols' [int] defines the number of columns inside the legend, by default 1.
'position' [str] defines the position of the legend inside the figure, by default 'in'. When 'in' the legend is displayed inside the plot, when 'out' the legend is located outside the plot.
'title' [str] defines whether to add a title to the legend, by default None.
dict, optional
Adjust the settings related to the plot lines, by default {}. Enter key:value inside the dictionary. The following keys are valid : 'colors', 'ls', 'lw'.
'colors' [str, list] defines the colors of the markers, by default None. When 'sample', it will compute the initial color the sample on which the measurement was performed and use it a color for the marker. A single color value as string can be entered and will then be applied to all the measurements. A list of string can be entered to individually define the color related to each measurement. Valid values for the string are based on the matplotlib color values.
'ls' [str, list] defines the style of the lines, by default '-'. When 'random', it will applied different line styles. A single style as a string can be entered and will be applied to all the lines. A list of string can be entered to individually define the linestyle related to each measurement. Valid values for the line styles are based on the matplotlib library.
bool, optional
Whether to save the figure, by default False
str, optional
Absolute path required to save the figure, by default 'cwd' When 'cwd', it will save the figure in the current working directory.
Returns¶
type It returns a figure that can be save as a png file.
Source code in src/microfading/microfading.py
3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 | |
plot_swatches_circle(orientation='horizontal', light_doses=[0, 0.5, 1, 2, 5, 15], JND=[1, 2, 3, 5, 10], dose_unit='Hv', dE=True, museum_exposure=(), fontsize=32, equation='power_3p', initial_params='auto', bounds=(-np.inf, np.inf), save=False, path_fig='cwd', title=None, report=False, circle_h=0)
¶
Plot the microfading data with circular colored patches.
Parameters¶
list, optional
Light doses in Mlxh for which a coloured patches will be created, by default [0,0.5,1,2,5,1] There has been at least two numerical values in the list. The first value corresponds to the color background of the plot and is usually set to 0. The other values will be plotted as circular patches.
list, optional
Whether to plot circular patches of just noticeable differences, by default [1,2,3,5,10] NOT YET IMPLEMENTED
[str, tuple], optional
Unit of the light energy dose, by default 'Hv' Any of the following units can be used: 'He', 'Hv', 't'. Where 'He' corresponds to radiant energy (MJ/m2), 'Hv' to exposure dose (Mlxh), and 't' to times (hours) (exh,50,10,365)
bool, optional
Whether to include the dE00 value between the background and each circular patche, by default True
int, optional
Fontsize of the plot (title, ticks, and labels), by default 24
str, optional
Mathematical equation used to fit the coordinate values, by default 'c0(xc1) + c2'. Any others mathematical can be given. The following equation can also be used for fitting microfading data: '((x) / (c0 + (c1x)))'.
List[float], optional
Initial guesses of the 'c' parameters given in the equation (c0, c1, c2, etc.), by default [0.1, 0.0] In the default values, only c0 and c1 are provided ; c2 is retrieved from the initial value of each colorimetric coordinate plot.
bounds : List[float], optional
bool, optional
Whether to save the figure, by default False
str, optional
Absolute path required to save the figure, by default 'cwd' When 'cwd', it will save the figure in the current working directory.
str, optional
Whether to add a title to the plot, by default None, by default None
bool, optional
Whether to use the report configuration to create the visualization, by default False NOT YET IMPLEMENTED
float, optional
Adjust the height of the colored circles, by default 0 One can enter a negative or positive float number to shape the colored circles as desired (circular or more oval).
Returns¶
A png file description
Source code in src/microfading/microfading.py
3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 | |
plots(plots=['CIELAB', 'SP', 'SW', 'dE', 'dLab'])
¶
Create plots
Parameters¶
plots : list, optional description, by default ['CIELAB', 'SP', 'SW', 'dE', 'dLab']
Source code in src/microfading/microfading.py
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 | |
read_files(sheets=['info', 'CIELAB', 'spectra'])
¶
Read the data files given as argument when defining the instance of the MFT class.
Parameters¶
sheets : Union[list,str], optional Name of the excel sheets to be selected, by default ['info', 'CIELAB', 'spectra'] If you just want to retrieve a single sheet, you can enter it as a string, e.g: 'CIELAB'. Other enter the name of the sheets inside a list.
Returns¶
A list of list of pandas dataframes The content of each input data file is returned as a list pandas dataframes (3 dataframes maximum, one dataframe per sheet). Ultimately, the function returns a list of list, so that when there are several input data files, each list - related a single file - corresponds to a single element of a list.
Source code in src/microfading/microfading.py
4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 | |
create_DB()
¶
Create the database files on your local computer
Returns¶
ipywidgets The function returns ipywidgets inside which you can enter the name of the database files and the location of these files on your computer.
Source code in src/microfading/microfading.py
73 74 75 76 77 78 79 80 81 82 | |
delete_device_info(key=None)
¶
Delete information about devices stored in the config_info.json file
Parameters¶
key : Optional[str], optional Device ID value, by default None When None, it returns an ipywidget from which one can select the device ID.
Source code in src/microfading/microfading.py
85 86 87 88 89 90 91 92 93 94 95 | |
get_colorimetry_info()
¶
Retrieve the colorimetric information (observer, illuminant, and white standard) recorded in the config_info.json file of the microfading package.
Returns¶
pandas dataframe or string It returns the information inside a dataframe if they have been recorded.
Source code in src/microfading/microfading.py
264 265 266 267 268 269 270 271 272 | |
get_comments_info()
¶
Retrieve the information regarding the comments recorded inside raw microfading files.
Source code in src/microfading/microfading.py
235 236 237 238 | |
get_config(key='all')
¶
Retrieve the content of the config_info.json file
Parameters¶
key : str, optional Give you the possibility to retrieve a specific category of information, by default 'all' One can enter a key value among the following list: ['colorimetry', 'databases', 'devices', 'exposure', 'filters', 'functions', 'lamps', 'light_dose', 'institution', 'report_figures']
Returns¶
dict It returns the information inside a dictionary.
Source code in src/microfading/microfading.py
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | |
get_config_path()
¶
Retrieve the absolute path of the config_info.json file.
Source code in src/microfading/microfading.py
258 259 260 261 | |
get_databases_info()
¶
Retrieve the info related to the databases.
Source code in src/microfading/microfading.py
129 130 131 | |
get_datasets(MFT='fotonowy', rawfiles=False, BWS=True, stdev=False)
¶
Retrieve exemples of dataset files. These files are meant to give the users the possibility to test the MFT class and its functions.
Parameters¶
MFT : Optional[str], optional Microfading device that has been used to obtain the files, by default 'fotonowy' One can choose a single option among the following choices: 'fotonowy', 'sMFT', 'fotonowy' corresponds to the microfading device of the Polish company Fotonowy 'sMFT' corresponds to stereo-MFT (see Patin et al. 2022. Journal of Cultural Heritage, 57)
Optional[bool], optional
Whether to get rawdata files, by default False The raw files were obtained from microfading analyses performed with the Fotonowy device and consist of four files per analysis.
Optional[bool], optional
Whether to include the microfading measurements on blue wool standards (BWS), by default True
Optional[bool], optional
Whether to have microfading measurements wiht standard deviation values, by default False It only works if the rawfiles parameters is set to 'False'. The rawfiles do not have standard deviation values.
Returns¶
list It returns a list of strings, where each string corresponds to the absolute path of a microfading measurement excel file. Subsequently, one can use the list as input for the MFT class.
Source code in src/microfading/microfading.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
get_devices_info()
¶
Retrieve the configuration information related to the devices.
Returns¶
pandas dataframe It returns the list of devices inside a pandas dataframe with four columns: 'Id', 'name', 'description', 'process_function'
Source code in src/microfading/microfading.py
275 276 277 278 279 280 281 282 283 | |
get_exposure_conditions()
¶
Retrieve the exposure lighting conditions recorded in the config_info.json file of the microfading package.
Returns¶
pandas dataframe or string It returns the information inside a dataframe if they have been recorded.
Source code in src/microfading/microfading.py
286 287 288 289 290 291 292 293 294 | |
get_institution_info()
¶
Retrieve the information related to the institution that performed the microfading analysis.
Returns¶
pandas dataframe It returns the institution info inside a pandas dataframe.
Source code in src/microfading/microfading.py
297 298 299 300 301 302 303 304 305 | |
get_light_dose_info()
¶
Retrieve the light dose info recorded in the config_info.json file of the microfading package.
Returns¶
pandas dataframe or string It returns the information inside a dataframe if they have been recorded.
Source code in src/microfading/microfading.py
308 309 310 311 312 313 314 315 316 | |
get_parameters_info()
¶
Retrieve the names of the parameters used in the info tab of interim files.
Returns¶
list It returns a list containing the parameters used in the info tab of interim files.
Source code in src/microfading/microfading.py
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | |
is_DB()
¶
Check whether the databases files were created and registered.
Returns¶
(str, bool) If the dabasses files are created and registered, it returns True along with a print statement. Otherwise, it returns False.
Source code in src/microfading/microfading.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | |
process_rawdata(files, device, filenaming='none', folder='.', db='default', comment='', fading_mode='default', waiting_time=1, authors='XX', white_standard='default', rounding=(4, 3), interpolate_wl='default', interpolate_exposure=('He', 0.1), interpolation='default', dose_unit='default', step=0.1, average='undefined', observer='default', illuminant='default', background='undefined', beam_power=None, language=None, output_format='xlsx', delete_files='default', return_filename=False)
¶
Process the microfading raw files created by the software that performed the microfading analysis.
Parameters¶
files : list A list of string that corresponds to the absolute path of the raw files.
str
Define the microfading that has been used to generate the raw files ('fotonowy'). Currently, this function can only process raw files obtained with a Fotonowy. Don't hesitate to contact us, if you would like process your own specific microfading raw files with our package.
If you registered your microfading device using the function set_devices_info() (for more information about it: https://g-patin.github.io/microfading/retrieve-test-datasets/), you can also entered the ID number of your device and it will directly take into account the parameters and information that you provided.
[str | list], optional
Define the filename of the output excel file, by default 'none' When 'none', it uses the filename of the raw files When 'auto', it creates a filename based on the info provided by the databases A list of parameters provided in the info sheet of the excel output can be used to create a filename
str, optional
Folder where the final data files should be saved, by default '.'
bool, optional
Whether to make use of the databases, by default False When True, it will populate the info sheet in the interim file (the output excel file) with the data found in the databases. Make sure that the databases were created and that the information about about the project and the objects were recorded.
str, optional
ID number of the white standard used when performing the microfading analyses, by default 'default' When 'default', it will search for the registered values in the config_info.json file. If you have not registered any values, it assumes that you used the Fotolon provided by Fotonowy.
[int, tuple], optional
Rounding the spectral and colorimetric coordinates, by default (4,3) The value corresponds to the amount of digits after the decimal separator. When an integer is provided, it is applied to both the spectral and colorimetric value. When a tuple is provided, the first value relates to the spectral values while the second relates to the colorimetric values.
bool, optional
Whether to interpolate the spectral and colorimetric data, by default True When True, it will interpolate the data according to the "dose_unit" and "step" values provided in the following parameters. When True, it will also interpolate the spectral values along the wavelengths (1 value every 1 nm).
str, optional
The unit of the light dose energy for which the spectral values are being interpolated, by default 'default' When 'default', it will search for the registered values in the config_info.json file. If you have not registered any values, it will select 'He' by default. When 'He', it performs interpolation based on the radiant exposure (MJ/m²) and for which you can define a step (see next parameter) When 'Hv', it performs interpolation based on the exposure dose (Mlxh) and for which you can define a step (see next parameter) When 't', it performs interpolation based on the exposure duration (sec) and for which you can define a step (see next parameter)
[float | int], optional
Interpolation step related to the scale previously mentioned ('He', 'Hv', 't'), by default 0.1
[int], optional
Average of the measurements, by default 'undefined' If you use always the same average value, you can save it up in the config_info.json file (use the set_devices_info() function). Then enter 'default' as value for the average parameter in order to retrieve the average value savied in the config file.
str, optional
Reference CIE observer in degree ('10deg' or '2deg'). by default 'default'. When 'default', it fetches the observer value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the observer value to '10deg'.
(str, optional)
Reference CIE illuminant. It can be any value of the following list: ['A', 'B', 'C', 'D50', 'D55', 'D60', 'D65', 'D75', 'E', 'FL1', 'FL2', 'FL3', 'FL4', 'FL5', 'FL6', 'FL7', 'FL8', 'FL9', 'FL10', 'FL11', 'FL12', 'FL3.1', 'FL3.2', 'FL3.3', 'FL3.4', 'FL3.5', 'FL3.6', 'FL3.7', 'FL3.8', 'FL3.9', 'FL3.10', 'FL3.11', 'FL3.12', 'FL3.13', 'FL3.14', 'FL3.15', 'HP1', 'HP2', 'HP3', 'HP4', 'HP5', 'LED-B1', 'LED-B2', 'LED-B3', 'LED-B4', 'LED-B5', 'LED-BH1', 'LED-RGB1', 'LED-V1', 'LED-V2', 'ID65', 'ID50']. by default 'default'. When 'default', it fetches the illuminant value recorded in the db_config.json file of the package. If no value has been recorded, then it sets the illuminant value to 'D65'.
Optional[str], optional
The language of the computer used to perform the microfading analyses, by default None When None, English is assumed to be the language that was used. If you are working on a Windows computer, you can use of the following languages (non-exhaustive list) : 'en', 'fr', 'it', 'nl', 'de', 'es'. If you are working on a Linux OS, open a terminal, enter " locale -a ", and choose one language among the returned list. For more information, consult the online documentation (https://g-patin.github.io/microfading/language-setting/).
str, optional
Output file format for the interim files, by default 'xlsx'. By default, the interim files will be saved as '.xlxs' (excel). When 'ods', it will save the output files as '.ods', which is the open source version of excel.
bool, optional
Whether to delete the raw files, by default 'default'
Optional[bool], optional
Whether to return the filename of the created excel file that contains the microfading data and metadata, by default True
Returns¶
Excel file It returns an excel file composed of three tabs (info, CIELAB, spectra).
Source code in src/microfading/microfading.py
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 | |
reset_config(keys='all')
¶
Reset the content of config_info.json to its initial state, i.e. an empty dictionary.
Parameters¶
keys : Union[str, list], optional Select which dictionaries inside the config_info file to reset by entering the keys related to each dictionary, by default 'all' The following keys are valid: 'colorimetry', 'comments', 'databases', 'devices', 'exposure', 'filenaming', 'filters', 'functions', 'light_dose', 'lamps', 'institution', 'report_figures'.
When 'all', it resets all the dictionaries.
Source code in src/microfading/microfading.py
576 577 578 579 580 581 582 583 584 585 586 587 588 | |
set_DB(folder_path='', use=True)
¶
Record the databases info in the config_info.json file of the microfading package.
Parameters¶
folder_path : Optional[str], optional Location of the database files on your local computer, by default ''
Optional[bool], optional
Whether the functions of the microfading package should use by default the database files, by default True
Source code in src/microfading/microfading.py
615 616 617 618 619 620 621 622 623 624 625 626 627 628 | |
set_colorimetry_info()
¶
Record the colorimetric information (observer, illuminant, white standard) in the config_info.json file of the microfading package.
Source code in src/microfading/microfading.py
591 592 593 594 | |
set_comments_info()
¶
Set the type and position of info recorded in the comments section of raw microfading files.
Source code in src/microfading/microfading.py
597 598 599 600 | |
set_devices_info()
¶
Record the device info in the config_info.json file of the microfading package.
Source code in src/microfading/microfading.py
603 604 605 606 | |
set_exposure_conditions()
¶
Record the exposure lighting conditions in the config_info.json file of the microfading package.
Source code in src/microfading/microfading.py
609 610 611 612 | |
set_filenaming()
¶
Record the filenaming info in the config_info.json file of the microfading package.
Source code in src/microfading/microfading.py
631 632 633 634 | |
set_institution_info()
¶
Set the information regarding your institution. As a user of the microfading package, you can enter information regarding your professional environment. These information will be automatically added in the microfading data file and inside the reports.
Returns¶
It returns several ipywdigets where you can enter the information regarding your professional environment.
Source code in src/microfading/microfading.py
643 644 645 646 647 648 649 650 | |
set_light_dose()
¶
Record the unit of the light dose in the config_info.json file of the microfading package.
Source code in src/microfading/microfading.py
637 638 639 640 | |
set_report_figures()
¶
Configure some of the parameters when creating figures for reports.
Source code in src/microfading/microfading.py
653 654 655 656 657 658 | |
str, optional
Whether to include a comment in the final excel file, by default ''