/usr/share/perl5/Chart/Gnuplot.pm is in libchart-gnuplot-perl 0.17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 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 127 128 129 130 131 132 133 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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 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 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 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 | package Chart::Gnuplot;
use strict;
use vars qw($VERSION);
use Carp;
use File::Copy qw(move);
use File::Temp qw(tempdir);
use Chart::Gnuplot::Util qw(_lineType _pointType _borderCode _copy);
$VERSION = '0.17';
# Constructor
sub new
{
my ($class, %hash) = @_;
# Create temporary file to store Gnuplot instructions
if (!defined $hash{_multiplot}) # if not in multiplot mode
{
my $dirTmp = tempdir(CLEANUP => 1);
($^O eq 'MSWin32')? ($dirTmp .= '\\'): ($dirTmp .= '/');
$hash{_script} = $dirTmp . "plot";
}
# Default terminal: postscript terminal with color drawing elements
if (!defined $hash{terminal} && !defined $hash{term})
{
$hash{terminal} = "postscript enhanced color";
$hash{_terminal} = 'auto';
}
# Default setting
if (defined $hash{output})
{
my @a = split(/\./, $hash{output});
my $ext = $a[-1];
$hash{terminal} .= " eps" if ($hash{terminal} =~ /^post/ &&
$ext eq 'eps');
}
my $self = \%hash;
return bless($self, $class);
}
# Generic attribute methods
sub AUTOLOAD
{
my ($self, $key) = @_;
my $attr = our $AUTOLOAD;
$attr =~ s/.*:://;
return if ($attr eq 'DESTROY'); # ignore destructor
$self->{$attr} = $key if (defined $key);
return($self->{$attr});
}
# General set method
sub set
{
my ($self, %opts) = @_;
foreach my $opt (keys %opts)
{
($opts{$opt} eq 'on')? $self->$opt('') : $self->$opt($opts{$opt});
}
return($self);
}
# Add a 2D data set to the chart object
# - used with multiplot
sub add2d
{
my ($self, @dataSet) = @_;
push(@{$self->{_dataSets2D}}, @dataSet);
}
# Add a 3D data set to the chart object
# - used with multiplot
sub add3d
{
my ($self, @dataSet) = @_;
push(@{$self->{_dataSets3D}}, @dataSet);
}
# Add a 2D data set to the chart object
# - redirect to &add2d
# - for backward compatibility
sub add {&add2d(@_);}
# Plot 2D graphs
# - call _setChart()
#
# TODO:
# - Consider using pipe instead of system call
# - support MS time format: %{yyyy}-%{mmm}-%{dd} %{HH}:%{MM}
sub plot2d
{
my ($self, @dataSet) = @_;
&_setChart($self, \@dataSet);
my $plotString = join(', ', map {$_->_thaw($self)} @dataSet);
open(GPH, ">>$self->{_script}") || confess("Can't write $self->{_script}");
print GPH "\nplot $plotString\n";
close(GPH);
# Generate image file
&_execute($self);
return($self);
}
# Plot 3D graphs
# - call _setChart()
#
# TODO:
# - Consider using pipe instead of system call
# - support MS time format: %{yyyy}-%{mmm}-%{dd} %{HH}:%{MM}
sub plot3d
{
my ($self, @dataSet) = @_;
&_setChart($self, \@dataSet);
my $plotString = join(', ', map {$_->_thaw($self)} @dataSet);
open(GPH, ">>$self->{_script}") || confess("Can't write $self->{_script}");
print GPH "\nsplot $plotString\n";
close(GPH);
# Generate image file
&_execute($self);
return($self);
}
# Plot multiple plots in one single chart
sub multiplot
{
my ($self, @charts) = @_;
&_setChart($self);
&_reset($self);
open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}");
# Emulate the title when there is background color fill
if (defined $self->{title} && defined $self->{bg})
{
print PLT "set label \"$self->{title}\" at screen 0.5, screen 1 ".
"center offset 0,-1\n";
}
if (scalar(@charts) == 1 && ref($charts[0]) eq 'ARRAY')
{
my $nrows = scalar(@{$charts[0]});
my $ncols = scalar(@{$charts[0][0]});
&_setMultiplot($self, $nrows, $ncols);
for (my $r = 0; $r < $nrows; $r++)
{
for (my $c = 0; $c < $ncols; $c++)
{
my $chart = $charts[0][$r][$c];
$chart->_script($self->{_script});
$chart->_multiplot(1);
delete $chart->{bg};
my $plot;
my @dataSet;
if (defined $chart->{_dataSets2D})
{
$plot = 'plot';
@dataSet = @{$chart->{_dataSets2D}};
}
elsif (defined $chart->{_dataSets3D})
{
$plot = 'splot';
@dataSet = @{$chart->{_dataSets3D}};
}
&_setChart($chart, \@dataSet);
open(PLT, ">>$self->{_script}") ||
confess("Can't write $self->{_script}");
print PLT "\n$plot ";
print PLT join(', ', map {$_->_thaw($self)} @dataSet), "\n";
close(PLT);
&_reset($chart);
}
}
}
else
{
# Start multi-plot
&_setMultiplot($self);
foreach my $chart (@charts)
{
$chart->_script($self->{_script});
$chart->_multiplot(1);
delete $chart->{bg};
my $plot;
my @dataSet;
if (defined $chart->{_dataSets2D})
{
$plot = 'plot';
@dataSet = @{$chart->{_dataSets2D}};
}
elsif (defined $chart->{_dataSets3D})
{
$plot = 'splot';
@dataSet = @{$chart->{_dataSets3D}};
}
&_setChart($chart, \@dataSet);
open(PLT, ">>$self->{_script}") ||
confess("Can't write $self->{_script}");
print PLT "\n$plot ";
print PLT join(', ', map {$_->_thaw($self)} @dataSet), "\n";
close(PLT);
&_reset($chart);
}
}
close(PLT);
# Generate image file
&_execute($self);
return($self);
}
# Pass generic commands
sub command
{
my ($self, $cmd) = @_;
open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}");
print PLT "$cmd\n";
close(PLT);
return($self);
}
# Set how the chart looks like
# - call _setTitle(), _setAxisLabel(), _setTics(), _setGrid(), _setBorder(),
# _setTimestamp()
# - called by plot2d() and plot3d()
sub _setChart
{
my ($self, $dataSets) = @_;
my @sets = ();
# Orientation
$self->{terminal} .= " $self->{orient}" if (defined $self->{orient});
# Set canvas size
if (defined $self->{imagesize})
{
my ($ws, $hs) = split(/,\s?/, $self->{imagesize});
if (defined $self->{_terminal} && $self->{_terminal} eq 'auto')
{
# for post terminal
if (defined $self->{orient} && $self->{orient} eq 'portrait')
{
$ws *= 7 if ($ws =~ /^([1-9]\d*)?0?(\.\d+)?$/);
$hs *= 10 if ($hs =~ /^([1-9]\d*)?0?(\.\d+)?$/);
}
else
{
$ws *= 10 if ($ws =~ /^([1-9]\d*)?0?(\.\d+)?$/);
$hs *= 7 if ($hs =~ /^([1-9]\d*)?0?(\.\d+)?$/);
}
}
$self->{terminal} .= " size $ws,$hs";
}
# Prevent changing terminal in multiplot mode
delete $self->{terminal} if (defined $self->{_multiplot});
# Start writing gnuplot script
my $pltTmp = $self->{_script};
open(PLT, ">>$pltTmp") || confess("Can't write gnuplot script $pltTmp");
# Set character encoding
#
# Quote from Gnuplot manual:
# "Generally you must set the encoding before setting the terminal type."
if (defined $self->{encoding})
{
print PLT "set encoding $self->{encoding}\n";
}
# Chart background color
if (defined $self->{bg})
{
my $bg = $self->{bg};
if (ref($bg) eq 'HASH')
{
print PLT "set object rect from screen 0, screen 0 to ".
"screen 1, screen 1 fillcolor rgb \"$$bg{color}\"";
print PLT " fillstyle solid $$bg{density}" if
(defined $$bg{density});
print PLT " behind\n";
}
else
{
print PLT "set object rect from screen 0, screen 0 to ".
"screen 1, screen 1 fillcolor rgb \"$bg\" behind\n";
}
push(@sets, 'object');
}
# Plot area background color
if (defined $self->{plotbg})
{
my $bg = $self->{plotbg};
if (ref($bg) eq 'HASH')
{
print PLT "set object rect from graph 0, graph 0 to ".
"graph 1, graph 1 fillcolor rgb \"$$bg{color}\"";
print PLT " fillstyle solid $$bg{density}" if
(defined $$bg{density});
print PLT " behind\n";
}
else
{
print PLT "set object rect from graph 0, graph 0 to ".
"graph 1, graph 1 fillcolor rgb \"$bg\" behind\n";
}
push(@sets, 'object');
}
# Set date/time data
#
# For xrange to work for time-sequence, time-axis ("set xdata time")
# and timeformat ("set timefmt '%Y-%m-%d'") MUST be set BEFORE
# the range command ("set xrange ['2009-01-01','2009-01-07']")
#
# Thanks to Holyspell
if (defined $self->{timeaxis})
{
my @axis = split(/,\s?/, $self->{timeaxis});
foreach my $axis (@axis)
{
print PLT "set $axis"."data time\n";
push(@sets, $axis."data");
}
foreach my $ds (@$dataSets)
{
if (defined $ds->{timefmt})
{
print PLT "set timefmt \"$ds->{timefmt}\"\n";
last;
}
}
}
# Parametric plot
foreach my $ds (@$dataSets)
{
# Determine if there is paramatric plot
if (defined $ds->{func} && ref($ds->{func}) eq 'HASH')
{
$self->{parametric} = '';
last;
}
}
my $setGrid = 0; # detect whether _setGrid has been run
# Loop and process other chart options
foreach my $attr (keys %$self)
{
if ($attr eq 'output')
{
print PLT "set output \"$self->{output}\"\n";
}
elsif ($attr eq 'title')
{
print PLT "set title ".&_setTitle($self->{title})."\n";
push(@sets, 'title')
}
elsif ($attr =~ /^((x|y)2?|z)label$/)
{
print PLT "set $attr ".&_setAxisLabel($self->{$attr})."\n";
push(@sets, $attr);
}
elsif ($attr =~ /^((x|y)2?|z|t|u|v)range$/)
{
if (ref($self->{$attr}) eq 'ARRAY')
{
# Deal with ranges from array reference
if (defined $self->{timeaxis} &&
$self->{timeaxis} =~ /(^|,)\s*$1\s*(,|$)/)
{
# $1-axis is a time axis
print PLT "set $attr ['".join("':'", @{$self->{$attr}}).
"']\n";
}
else
{
print PLT "set $attr [".join(":", @{$self->{$attr}})."]\n";
}
}
elsif ($self->{$attr} eq 'reverse')
{
print PLT "set $attr [*:*] reverse\n";
}
else
{
print PLT "set $attr $self->{$attr}\n";
}
push(@sets, $attr);
}
elsif ($attr =~ /^(x|y|x2|y2|z)tics$/)
{
if (defined $self->{$attr})
{
my ($axis) = ($attr =~ /^(.+)tics$/);
print PLT "set $attr".&_setTics($self->{$attr})."\n";
if (ref($self->{$attr}) eq 'HASH')
{
if (defined ${$self->{$attr}}{labelfmt})
{
print PLT "set format $axis ".
"\"${$self->{$attr}}{labelfmt}\"\n";
push(@sets, 'format');
}
if (defined ${$self->{$attr}}{minor})
{
my $nTics = ${$self->{$attr}}{minor}+1;
print PLT "set m$axis"."tics $nTics\n";
push(@sets, "m$axis"."tics");
}
}
push(@sets, $attr);
}
else
{
print PLT "unset $attr\n";
}
}
elsif ($attr eq 'legend')
{
print PLT "set key".&_setLegend($self->{legend})."\n";
push(@sets, 'key');
}
elsif ($attr eq 'border')
{
if (defined $self->{border})
{
print PLT "set border";
print PLT " ".&_borderCode($self->{border}->{sides}) if
(defined $self->{border}->{sides});
print PLT &_setBorder($self->{border})."\n";
push(@sets, 'border');
}
else
{
print PLT "unset border\n";
}
}
elsif ($attr =~ /^(minor)?grid$/)
{
next if ($setGrid == 1);
print PLT "set grid".&_setGrid($self)."\n";
push(@sets, 'grid');
$setGrid = 1;
}
elsif ($attr eq 'timestamp')
{
print PLT "set timestamp".&_setTimestamp($self->{timestamp})."\n";
push(@sets, 'timestamp');
}
elsif ($attr eq 'terminal')
{
print PLT "set $attr $self->{$attr}\n";
}
# Non-gnuplot options / options specially treated before
elsif (!grep(/^$attr$/, qw(
gnuplot
convert
encoding
imagesize
orient
bg
plotbg
timeaxis
)) &&
$attr !~ /^_/)
{
(defined $self->{$attr} && $self->{$attr} ne '')?
(print PLT "set $attr $self->{$attr}\n"):
(print PLT "set $attr\n");
push(@sets, $attr);
}
}
# Write labels
foreach my $label (@{$self->{_labels}})
{
print PLT "set label $label\n";
}
# Draw arrows
foreach my $arrow (@{$self->{_arrows}})
{
print PLT "set arrow $arrow\n";
}
close(PLT);
$self->_sets(\@sets);
}
# Set the details of the title
# - called by _setChart()
#
# Usage example:
# title => {
# text => "My title",
# font => "arial, 14",
# color => "brown",
# offset => "0, -1",
# },
sub _setTitle
{
my ($title) = @_;
if (ref($title))
{
my $out = "\"$$title{text}\"";
$out .= " offset $$title{offset}" if (defined $$title{offset});
# Font and size
my $font;
$font = $$title{font} if (defined $$title{font});
$font .= ",$$title{fontsize}" if (defined $$title{fontsize});
$out .= " font \"$font\"" if (defined $font);
# Color
$out .= " textcolor rgb \"$$title{color}\"" if (defined $$title{color});
# Switch of the enhanced mode. Default: off
$out .= " noenhanced" if (!defined $$title{enhanced} ||
$$title{enhanced} ne 'on');
return($out);
}
else
{
return("\"$title\" noenhanced");
}
}
# Set the details of the axis labels
# - called by _setChart()
#
# Usage example:
# xlabel => {
# text => "My x-axis label",
# font => "arial, 14",
# color => "brown",
# offset => "0, -1",
# rotate => 45,
# },
#
# TODO
# - support radian and pi in "rotate"
sub _setAxisLabel
{
my ($label) = @_;
if (ref($label))
{
my $out = "\"$$label{text}\"";
# Location offset
$out .= " offset $$label{offset}" if (defined $$label{offset});
# Font and size
my $font;
$font = $$label{font} if (defined $$label{font});
$font .= ",$$label{fontsize}" if (defined $$label{fontsize});
$out .= " font \"$font\"" if (defined $font);
# Color
$out .= " textcolor rgb \"$$label{color}\"" if (defined $$label{color});
# Switch of the enhanced mode. Default: off
$out .= " noenhanced" if (!defined $$label{enhanced} ||
$$label{enhanced} ne 'on');
# Text rotation
$out .= " rotate by $$label{rotate}" if (defined $$label{rotate});
return($out);
}
else
{
return("\"$label\" noenhanced");
}
}
# Set the details of the tics and tic labels
# - called by _setChart()
#
# Usage example:
# xtics => {
# labels => [-10, 15, 20, 25],
# labelfmt => "%3f",
# font => "arial",
# fontsize => 14,
# fontcolor => "brown",
# offset => "0, -1",
# rotate => 45,
# length => "2,1",
# along => 'axis',
# minor => 3,
# mirror => 'off',
# },
#
# TODO
# - able to replace the label for specified text
# - implement "add" option to add addition tics other than default
# - support radian and pi in "rotate"
sub _setTics
{
my ($tic) = @_;
my $out = '';
if (ref($tic) eq 'HASH')
{
$out .= " $$tic{along}" if (defined $$tic{along});
$out .= " nomirror" if (
defined $$tic{mirror} && $$tic{mirror} eq 'off'
);
$out .= " scale $$tic{length}" if (defined $$tic{length});
$out .= " rotate by $$tic{rotate}" if (defined $$tic{rotate});
$out .= " offset $$tic{offset}" if (defined $$tic{offset});
$out .= " (". join(',', @{$$tic{labels}}) . ")" if
(defined $$tic{labels});
# Font, font size and font color
if (defined $$tic{font})
{
my $font = $$tic{font};
$font = "$$tic{font},$$tic{fontsize}" if ($font !~ /\,/ &&
defined $$tic{fontsize});
$out .= " font \"$font\"";
}
$out .= " textcolor rgb \"$$tic{fontcolor}\"" if
(defined $$tic{fontcolor});
}
elsif (ref($tic) eq 'ARRAY')
{
$out = " (". join(',', @$tic) . ")";
}
elsif ($tic ne 'on')
{
$out = "\"$tic\"";
}
return($out);
}
# Set the details of the grid lines
# - called by _setChart()
#
# Usage example:
# grid => {
# type => 'dash, dot', # default: dot
# width => 2, # default: 0
# color => 'blue', # default: black
# xlines => 'on', # default: on
# ylines => 'off', # default: on
# zlines => 'off', # default:
# x2lines => 'off', # default: off
# y2lines => 'off', # default: off
# },
#
# minorgrid => {
# width => 1, # default: 0
# color => 'gray', # default: black
# xlines => 'on', # default: off
# ylines => 'on', # default: off
# x2lines => 'off', # default: off
# y2lines => 'off', # default: off
# }
#
# # OR
#
# grid => 'on',
#
# TODO:
# - support polar grid
# - support layer <front/back>
sub _setGrid
{
my ($self) = @_;
my $grid = $self->{grid};
my $mgrid = $self->{minorgrid} if (defined $self->{minorgrid});
my $out = '';
if (ref($grid) eq 'HASH' || ref($mgrid) eq 'HASH')
{
$grid = &_gridString2Hash($grid);
$mgrid = &_gridString2Hash($mgrid);
# Set whether the major grid lines are drawn
(defined $$grid{xlines} && $$grid{xlines} =~ /^off/)?
($out .= " noxtics"): ($out .= " xtics");
(defined $$grid{ylines} && $$grid{ylines} =~ /^off/)?
($out .= " noytics"): ($out .= " ytics");
(defined $$grid{zlines} && $$grid{zlines} =~ /^off/)?
($out .= " noztics"): ($out .= " ztics");
# Set whether the vertical minor grid lines are drawn
$out .= " mxtics" if ( (defined $$grid{xlines} &&
$$grid{xlines} =~ /,\s?on$/) ||
(defined $self->{minorgrid} && (!defined $$mgrid{xlines} ||
$$mgrid{xlines} eq 'on')) );
# Set whether the horizontal minor grid lines are drawn
$out .= " mytics" if ( (defined $$grid{ylines} &&
$$grid{ylines} =~ /,\s?on$/) ||
(defined $mgrid && (!defined $$mgrid{ylines} ||
$$mgrid{ylines} eq 'on')) );
# Major grid on secondary axes
$out .= " x2tics" if (defined $$grid{x2lines} &&
$$grid{x2lines} eq 'on');
$out .= " y2tics" if (defined $$grid{y2lines} &&
$$grid{y2lines} eq 'on');
# Minor grid on secondary axes
$out .= " mx2tics" if (defined $$mgrid{x2lines} &&
$$mgrid{x2lines} eq 'on');
$out .= " my2tics" if (defined $$mgrid{y2lines} &&
$$mgrid{y2lines} eq 'on');
# Set the line type of the grid lines
my $major = my $minor = '';
my $majorType = my $minorType = 4; # dotted lines
if (defined $$grid{linetype})
{
$majorType = $minorType = $$grid{linetype};
($majorType, $minorType) = split(/\,\s?/, $$grid{linetype}) if
($$grid{linetype} =~ /\,/);
}
$minorType = $$mgrid{linetype} if (defined $$mgrid{linetype});
$major .= " linetype ".&_lineType($majorType);
$minor .= " linetype ".&_lineType($minorType);
# Set the line width of the grid lines
my $majorWidth = my $minorWidth = 0;
if (defined $$grid{width})
{
$majorWidth = $minorWidth = $$grid{width};
($majorWidth, $minorWidth) = split(/\,\s?/, $$grid{width}) if
($$grid{width} =~ /\,/);
}
$minorWidth = $$mgrid{width} if (defined $$mgrid{width});
$major .= " linewidth $majorWidth";
$minor .= " linewidth $minorWidth";
# Set the line color of the grid lines
my $majorColor = my $minorColor = 'black';
if (defined $$grid{color})
{
$majorColor = $minorColor = $$grid{color};
($majorColor, $minorColor) = split(/\,\s?/, $$grid{color}) if
($$grid{color} =~ /\,/);
}
$minorColor = $$mgrid{color} if (defined $$mgrid{color});
$major .= " linecolor rgb \"$majorColor\"";
$minor .= " linecolor rgb \"$minorColor\"";
$out .= "$major" if ($major ne '');
$out .= ",$minor" if ($minor ne '');
}
else
{
if (defined $grid)
{
return($grid) if ($grid !~ /^(on|off)$/);
($grid eq 'off')? ($out = " noxtics noytics"):
($out = " xtics ytics");
}
$out .= " mxtics mytics" if (defined $mgrid && $mgrid eq 'on');
}
return($out);
}
# Convert grid string to hash
# - called by _setGrid
sub _gridString2Hash
{
my ($grid) = @_;
return($grid) if (ref($grid) eq 'HASH');
my %out;
$out{xlines} = $out{ylines} = $out{zlines} = $grid;
return(\%out);
}
# Set the details of the graph border
# - called by _setChart()
#
# Usage example:
# border => {
# linetype => 3, # default: solid
# width => 2, # default: 0
# color => '#ff00ff', # default: system defined
# },
#
# Remark:
# - By default, the color of the axis tics would follow the border unless
# specified otherwise.
#
# TODO:
# - support layer <front/back>
sub _setBorder
{
my ($border) = @_;
my $out = '';
$out .= " linetype ".&_lineType($$border{linetype}) if
(defined $$border{linetype});
$out .= " linewidth $$border{width}" if (defined $$border{width});
$out .= " linecolor rgb \"$$border{color}\"" if (defined $$border{color});
return($out);
}
# Format the legend (key)
#
# Usage example:
# legend => {
# position => "outside bottom",
# width => 3,
# height => 4,
# align => "right",
# order => "horizontal reverse",
# title => "Title of the legend",
# sample => {
# length => 3,
# position => "left",
# spacing => 2,
# },
# border => {
# linetype => 2,
# width => 1,
# color => "blue",
# },
# },
sub _setLegend
{
my ($legend) = @_;
my $out = '';
if (defined $$legend{position})
{
($$legend{position} =~ /\d/)? ($out .= " at $$legend{position}"):
($out .= " $$legend{position}");
}
$out .= " width $$legend{width}" if (defined $$legend{width});
$out .= " height $$legend{height}" if (defined $$legend{height});
if (defined $$legend{align})
{
$out .= " Left" if ($$legend{align} eq 'left');
$out .= " Right" if ($$legend{align} eq 'right');
}
if (defined $$legend{order})
{
my $order = $$legend{order};
$order =~ s/reverse/invert/;
$out .= " $order";
}
if (defined $$legend{title})
{
if (ref($$legend{title}) eq 'HASH')
{
my $title = $$legend{title};
$out .= " title \"$$title{text}\"";
$out .= " noenhanced" if (!defined $$title{enhanced} ||
$$title{enhanced} ne 'on');
}
else
{
$out .= " title \"$$legend{title}\" noenhanced";
}
}
if (defined $$legend{sample})
{
$out .= " samplen $$legend{sample}{length}" if
(defined $$legend{sample}{length});
$out .= " reverse" if (defined $$legend{sample}{position} ||
$$legend{sample}{position} eq "left");
$out .= " spacing $$legend{sample}{spacing}" if
(defined $$legend{sample}{spacing});
}
if (defined $$legend{border})
{
if (ref($$legend{border}) eq 'HASH')
{
$out .= " box ".&_setBorder($$legend{border});
}
elsif ($$legend{border} eq "off")
{
$out .= " no box";
}
elsif ($$legend{border} eq "on")
{
$out .= " box";
}
}
return($out);
}
# Set title and layout of the multiplot
sub _setMultiplot
{
my ($self, $nrows, $ncols) = @_;
open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}");
print PLT "set multiplot";
print PLT " title \"$self->{title}\"" if (defined $self->{title});
print PLT " layout $nrows, $ncols" if (defined $nrows);
print PLT "\n";
close(PLT);
}
# Usage example:
# timestamp => {
# fmt => '%d/%m/%y %H:%M',
# offset => "10,-3"
# font => "Helvetica",
# },
# # OR
# timestamp => 'on';
sub _setTimestamp
{
my ($ts) = @_;
my $out = '';
if (ref($ts) eq 'HASH')
{
$out .= " \"$$ts{fmt}\"" if (defined $$ts{fmt});
$out .= " $$ts{offset}" if (defined $$ts{offset});
$out .= " \"$$ts{font}\"" if (defined $$ts{font});
}
elsif ($ts ne 'on')
{
return($ts);
}
return($out);
}
# Generate the image file
sub _execute
{
my ($self) = @_;
# Execute gnuplot
my $gnuplot = 'gnuplot';
$gnuplot = $self->{gnuplot} if (defined $self->{gnuplot});
my $cmd = "$gnuplot $self->{_script}";
$cmd .= " -" if ($self->{terminal} =~ /^(ggi|pm|windows|wxt|x11)(\s|$)/);
my $err = `$cmd 2>&1`;
# my $err;
# system("$cmd");
# Capture and process error message from Gnuplot
if (defined $err && $err ne '')
{
my ($errTmp) = ($err =~ /\", line \d+:\s(.+)/);
die "$errTmp\n" if (defined $errTmp);
warn "$err\n";
}
# Convert the image to the user-specified format
if (defined $self->{_terminal} && $self->{_terminal} eq 'auto')
{
my @a = split(/\./, $self->{output});
my $ext = $a[-1];
&convert($self, $ext) if ($ext !~ /^e?ps$/);
}
}
# Unset the chart properties
# - called by multiplot()
sub _reset
{
my ($self) = @_;
open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}");
foreach my $opt (@{$self->{_sets}})
{
print PLT "unset $opt\n";
if ($opt =~ /range$/)
{
print PLT "set $opt [*:*]\n";
}
elsif (!grep(/^$opt$/, qw(grid object parametric)) && $opt !~ /tics$/)
{
print PLT "set $opt\n";
}
}
close(PLT);
}
# Arbitrary labels placed in the chart
#
# Usage example:
# $chart->label(
# text => "This is a label",
# position => "0.2, 3 left",
# offset => "2,2",
# rotate => 45,
# font => "arial, 15",
# fontcolor => "dark-blue",
# pointtype => 3,
# pointsize => 5,
# pointcolor => "blue",
# );
#
# TODO:
# - support layer <front/back>
sub label
{
my ($self, %label) = @_;
my $out = "\"$label{text}\"";
$out .= " at $label{position}" if (defined $label{position});
$out .= " offset $label{offset}" if (defined $label{offset});
$out .= " rotate by $label{rotate}" if (defined $label{rotate});
$out .= " font \"$label{font}\"" if (defined $label{font});
$out .= " textcolor rgb \"$label{fontcolor}\"" if
(defined $label{fontcolor});
$out .= " noenhanced" if (!defined $label{enhanced} ||
$label{enhanced} ne 'on');
if (defined $label{pointtype} || defined $label{pointsize} ||
defined $label{pointcolor})
{
$out .= " point";
$out .= " pt ".&_pointType($label{pointtype}) if
(defined $label{pointtype});
$out .= " ps $label{pointsize}" if (defined $label{pointsize});
$out .= " lc rgb \"$label{pointcolor}\"" if
(defined $label{pointcolor});
}
push(@{$self->{_labels}}, $out);
return($self);
}
# Arbitrary arrows placed in the chart
#
# Usage example:
# $chart->arrow(
# from => "0,2",
# to => "0.3,0.1",
# linetype => 'dash',
# width => 2,
# color => "dark-blue",
# headsize => 3,
# head => 'both',
# );
sub arrow
{
my ($self, %arrow) = @_;
confess("Starting position of arrow not found") if (!defined $arrow{from});
my $out = '';
$out .= " from $arrow{from}";
$out .= " to $arrow{to}" if (defined $arrow{to});
$out .= " rto $arrow{rto}" if (defined $arrow{rto});
$out .= " linetype ".&_lineType($arrow{linetype}) if
(defined $arrow{linetype});
$out .= " linewidth $arrow{width}" if (defined $arrow{width});
$out .= " linecolor rgb \"$arrow{color}\"" if (defined $arrow{color});
$out .= " size $arrow{headsize}" if (defined $arrow{headsize});
if (defined $arrow{head})
{
if ($arrow{head} eq 'off')
{
$out .= " nohead";
}
elsif ($arrow{head} eq 'back')
{
$out .= " backhead";
}
elsif ($arrow{head} eq 'both')
{
$out .= " heads";
}
}
push(@{$self->{_arrows}}, $out);
return($self);
}
# Output a test image for the terminal
#
# Usage example:
# $chart = Chart::Gnuplot->new(output => "test.png");
# $chart->test;
sub test
{
my ($self) = @_;
my $pltTmp = "$self->{_script}";
open(PLT, ">$pltTmp") || confess("Can't write gnuplot script $pltTmp");
print PLT "set terminal $self->{terminal}\n";
print PLT "set output \"$self->{output}\"\n";
print PLT "test\n";
close(PLT);
# Execute gnuplot
my $gnuplot = 'gnuplot';
$gnuplot = $self->{gnuplot} if (defined $self->{gnuplot});
system("$gnuplot $pltTmp");
return($self);
}
# Create animated gif
#
# Usage example:
# $chart->animate(
# charts => \@charts, # sequence of chart object
# delay => 10, # delay in units of 0.01 second
# );
sub animate
{
my ($self, %animate) = @_;
my $charts = $animate{charts};
# Force the terminal to be 'gif'
# - Only the 'gif' terminal supports animation
if (defined $self->{_terminal} && $self->{_terminal} eq 'auto')
{
$self->{terminal} = $self->{_terminal} = 'gif';
}
elsif ($self->{terminal} !~ /^gif/)
{
croak "animate() is supported only by the gif terminal";
}
$self->{terminal} .= " animate";
$self->{terminal} .= " delay $animate{delay}" if (defined $animate{delay});
&_setChart($self);
open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}");
foreach my $chart (@$charts)
{
$chart->_script($self->{_script});
$chart->_multiplot(1);
my $plot;
my @dataSet;
if (defined $chart->{_dataSets2D})
{
$plot = 'plot';
@dataSet = @{$chart->{_dataSets2D}};
}
elsif (defined $chart->{_dataSets3D})
{
$plot = 'splot';
@dataSet = @{$chart->{_dataSets3D}};
}
&_setChart($chart, \@dataSet);
open(PLT, ">>$self->{_script}") ||
confess("Can't write $self->{_script}");
print PLT "\n$plot ";
print PLT join(', ', map {$_->_thaw($self)} @dataSet), "\n";
close(PLT);
&_reset($chart);
}
# Generate image file
&_execute($self);
return($self);
}
# Change the image format
# - called by plot2d()
#
# Usage example:
# my $chart = Chart::Gnuplot->new(...);
# my $data = Chart::Gnuplot::DataSet->new(...);
# $chart->plot2d($data);
# $chart->convert('gif');
sub convert
{
my ($self, $imgfmt) = @_;
return($self) if (!-e $self->{output});
# Generate temp file
my $temp = "$self->{_script}.tmp";
move($self->{output}, $temp);
# Execute gnuplot
my $convert = 'convert';
$convert = $self->{convert} if (defined $self->{convert});
# Rotate 90 deg for landscape image
if (defined $self->{orient} && $self->{orient} eq 'portrait')
{
my $cmd = "$convert $temp $temp".".$imgfmt 2>&1";
my $err = `$cmd`;
if (defined $err && $err ne '')
{
die "Unsupported image format ($imgfmt)\n" if
($err =~ /^convert: unable to open module file/);
my ($errTmp) = ($err =~ /^convert: (.+)/);
die "$errTmp Perhaps the image format is not supported\n" if
(defined $errTmp);
die "$err\n";
}
}
else
{
my $cmd = "$convert -rotate 90 $temp $temp".".$imgfmt 2>&1";
my $err = `$cmd`;
if (defined $err && $err ne '')
{
die "Unsupported image format ($imgfmt)\n" if
($err =~ /^convert: unable to open module file/);
my ($errTmp) = ($err =~ /^convert: (.+)/);
die "$errTmp Perhaps the image format is not supported\n" if
(defined $errTmp);
die "$err\n";
}
}
# Remove the temp file
move("$temp".".$imgfmt", $self->{output});
unlink($temp);
return($self);
}
# Change the image format to PNG
#
# Usage example:
# my $chart = Chart::Gnuplot->new(...);
# my $data = Chart::Gnuplot::DataSet->new(...);
# $chart->plot2d($data)->png;
sub png
{
my $self = shift;
&convert($self, 'png');
return($self)
}
# Change the image format to GIF
#
# Usage example:
# my $chart = Chart::Gnuplot->new(...);
# my $data = Chart::Gnuplot::DataSet->new(...);
# $chart->plot2d($data)->gif;
sub gif
{
my $self = shift;
&convert($self, 'gif');
return($self)
}
# Change the image format to JPG
#
# Usage example:
# my $chart = Chart::Gnuplot->new(...);
# my $data = Chart::Gnuplot::DataSet->new(...);
# $chart->plot2d($data)->jpg;
sub jpg
{
my $self = shift;
&convert($self, 'jpg');
return($self)
}
# Change the image format to PS
#
# Usage example:
# my $chart = Chart::Gnuplot->new(...);
# my $data = Chart::Gnuplot::DataSet->new(...);
# $chart->plot2d($data)->ps;
sub ps
{
my $self = shift;
&convert($self, 'ps');
return($self)
}
# Change the image format to PDF
#
# Usage example:
# my $chart = Chart::Gnuplot->new(...);
# my $data = Chart::Gnuplot::DataSet->new(...);
# $chart->plot2d($data)->pdf;
sub pdf
{
my $self = shift;
&convert($self, 'pdf');
return($self)
}
# Copy method of the chart object
sub copy
{
my ($self, $num) = @_;
my @clone = &_copy(@_);
foreach my $clone (@clone)
{
my $dirTmp = tempdir(CLEANUP => 1);
($^O eq 'MSWin32')? ($dirTmp .= '\\'): ($dirTmp .= '/');
$clone->{_script} = $dirTmp . "plot";
}
return($clone[0]) if (!defined $num);
return(@clone);
}
################## Chart::Gnuplot::DataSet class ##################
package Chart::Gnuplot::DataSet;
use strict;
use Carp;
use File::Temp qw(tempdir);
use Chart::Gnuplot::Util qw(_lineType _pointType _copy);
# Constructor
sub new
{
my ($class, %hash) = @_;
my $dirTmp = tempdir(CLEANUP => 1);
($^O eq 'MSWin32')? ($dirTmp .= '\\'): ($dirTmp .= '/');
$hash{_data} = $dirTmp . "data";
my $self = \%hash;
return bless($self, $class);
}
# Generic attribute methods
sub AUTOLOAD
{
my ($self, $key) = @_;
my $attr = our $AUTOLOAD;
$attr =~ s/.*:://;
return if ($attr eq 'DESTROY'); # ignore destructor
$self->{$attr} = $key if (defined $key);
return($self->{$attr});
}
# xdata get-set method
sub xdata
{
my ($self, $xdata) = @_;
return($self->{xdata}) if (!defined $xdata);
delete $self->{points};
delete $self->{datafile};
delete $self->{func};
$self->{xdata} = $xdata;
}
# ydata get-set method
sub ydata
{
my ($self, $ydata) = @_;
return($self->{ydata}) if (!defined $ydata);
delete $self->{points};
delete $self->{datafile};
delete $self->{func};
$self->{ydata} = $ydata;
}
# zdata get-set method
sub zdata
{
my ($self, $zdata) = @_;
return($self->{zdata}) if (!defined $zdata);
delete $self->{points};
delete $self->{datafile};
delete $self->{func};
$self->{zdata} = $zdata;
}
# points get-set method
sub points
{
my ($self, $points) = @_;
return($self->{points}) if (!defined $points);
delete $self->{xdata};
delete $self->{ydata};
delete $self->{zdata};
delete $self->{datafile};
delete $self->{func};
$self->{points} = $points;
}
# datafile get-set method
sub datafile
{
my ($self, $datafile) = @_;
return($self->{datafile}) if (!defined $datafile);
delete $self->{xdata};
delete $self->{ydata};
delete $self->{zdata};
delete $self->{points};
delete $self->{func};
$self->{datafile} = $datafile;
}
# func get-set method
sub func
{
my ($self, $func) = @_;
return($self->{func}) if (!defined $func);
delete $self->{xdata};
delete $self->{ydata};
delete $self->{zdata};
delete $self->{points};
delete $self->{datafile};
$self->{func} = $func;
}
# Thaw the data set object to string
# - call _fillStyle()
#
# TODO:
# - data file delimiter
# - data labels
# - zdata
sub _thaw
{
my ($self, $chart) = @_;
my $string;
my $using = '';
# Data points stored in arrays
# - in any case, ydata need to be defined
if (defined $self->{ydata})
{
my $ydata = $self->{ydata};
my $fileTmp = $self->{_data};
open(DATA, ">$fileTmp") || confess("Can't write data to temp file");
# Process 3D data set
# - zdata is defined
if (defined $self->{zdata})
{
my $zdata = $self->{zdata};
my $xdata = $self->{xdata};
croak("x-data and y-data have unequal length") if
(scalar(@$ydata) ne scalar(@$xdata));
croak("y-data and z-data have unequal length") if
(scalar(@$ydata) ne scalar(@$zdata));
for (my $i = 0; $i < @$xdata; $i++)
{
print DATA "\n" if ($i > 0 && $$xdata[$i] != $$xdata[$i-1]);
print DATA "$$xdata[$i] $$ydata[$i] $$zdata[$i]\n";
}
$string = "'$fileTmp'";
# Construst using statement for date-time data
if (defined $self->{timefmt})
{
my @a = split(/\s+/, $$xdata[0]);
my $yCol = scalar(@a) + 1;
$using = "1:$yCol";
my @b = split(/\s+/, $$ydata[0]);
my $zCol = scalar(@b) + $yCol;
$using .= ":$zCol";
}
}
# Treatment for financebars and candlesticks styles
# - Both xdata and ydata are defined
elsif (defined $self->{xdata} && defined $self->{style} &&
$self->{style} =~ /^(financebars|candlesticks)$/)
{
my $xdata = $self->{xdata};
croak("x-data and y-data have unequal length") if
(scalar(@{$$ydata[0]}) ne scalar(@$xdata));
for (my $i = 0; $i < @$xdata; $i++)
{
print DATA "$$xdata[$i] $$ydata[0][$i] $$ydata[1][$i] ".
"$$ydata[2][$i] $$ydata[3][$i]\n";
}
$string = "'$fileTmp'";
# Construst using statement for date-time data
if (defined $self->{timefmt})
{
my @a = split(/\s+/, $$xdata[0]);
my $yCol = scalar(@a) + 1;
$using = "1:".join(':', ($yCol .. $yCol+3));
}
}
# Treatment for errorbars and errorlines styles
# - Both xdata and ydata are defined
# - Style is defined and contain "error"
elsif (defined $self->{xdata} && defined $self->{style} &&
$self->{style} =~ /error/)
{
my $xdata = $self->{xdata};
# Error bars along x-axis
if ($self->{style} =~ /^xerror/)
{
croak("x-data and y-data have unequal length") if
(scalar(@{$$xdata[0]}) ne scalar(@$ydata));
for (my $i = 0; $i < @$ydata; $i++)
{
print DATA "$$xdata[0][$i] $$ydata[$i]";
for(my $j = 1; $j < @$xdata; $j++)
{
print DATA " $$xdata[$j][$i]";
}
print DATA "\n";
}
}
# Error bars along y-axis
elsif ($self->{style} =~ /^(y|box)error/)
{
croak("x-data and y-data have unequal length") if
(scalar(@{$$ydata[0]}) ne scalar(@$xdata));
for (my $i = 0; $i < @$xdata; $i++)
{
print DATA "$$xdata[$i] $$ydata[0][$i]";
for(my $j = 1; $j < @$ydata; $j++)
{
print DATA " $$ydata[$j][$i]";
}
print DATA "\n";
}
}
# Error bars along both x and y-axis
elsif ($self->{style} =~ /^(box)?xyerror/)
{
if (scalar(@$xdata) == scalar(@$ydata))
{
for (my $i = 0; $i < @{$$xdata[0]}; $i++)
{
print DATA "$$xdata[0][$i] $$ydata[0][$i]";
for(my $j = 1; $j < @$ydata; $j++)
{
print DATA " $$xdata[$j][$i] $$ydata[$j][$i]";
}
print DATA "\n";
}
}
else
{
for (my $i = 0; $i < @{$$xdata[0]}; $i++)
{
print DATA "$$xdata[0][$i] $$ydata[0][$i]";
if (scalar(@$xdata) == 2)
{
my $ltmp = $$xdata[0][$i] - $$xdata[1][$i]*0.5;
my $htmp = $$xdata[0][$i] + $$xdata[1][$i]*0.5;
print DATA " $ltmp $htmp ".
"$$ydata[1][$i] $$ydata[2][$i]\n";
}
else
{
my $ltmp = $$ydata[0][$i] - $$ydata[1][$i]*0.5;
my $htmp = $$ydata[0][$i] - $$ydata[1][$i]*0.5;
print DATA " $$xdata[1][$i] $$xdata[2][$i] ".
"$ltmp $htmp\n";
}
}
}
}
$string = "'$fileTmp'";
# Construst using statement for date-time data
if (defined $self->{timefmt})
{
my ($xTmp) = (ref($$xdata[0]) eq 'ARRAY')? ($$xdata[0][0]):
($$xdata[0]);
my @a = split(/\s+/, $xTmp);
my $yCol = scalar(@a) + 1;
$using = "1:$yCol";
}
}
# Treatment for hbars
# - use "boxxyerrorbars" style to mimic
elsif (defined $self->{xdata} && defined $self->{style} &&
$self->{style} eq 'hbars')
{
my $xdata = $self->{xdata};
my $ylow = my $yhigh = $$ydata[0];
if (scalar(@$ydata) > 1)
{
$ylow = 0.5*(3*$$ydata[0]-$$ydata[1]);
$yhigh = 0.5*(3*$$ydata[-1]-$$ydata[-2]);
}
for (my $i = 0; $i < @$xdata; $i++)
{
$ylow = 0.5*($$ydata[$i]+$$ydata[$i-1]) if ($i > 0);
$yhigh = 0.5*($$ydata[$i]+$$ydata[$i+1]) if ($i < $#$ydata);
print DATA "0 $$ydata[$i] 0 $$xdata[$i] $ylow $yhigh\n";
}
$self->{style} = "boxxyerrorbars";
$string = "'$fileTmp'";
}
# Treatment for hlines
# - use "boxxyerrorbars" style to mimic
elsif (defined $self->{xdata} && defined $self->{style} &&
$self->{style} eq 'hlines')
{
my $xdata = $self->{xdata};
for (my $i = 0; $i < @$xdata; $i++)
{
print DATA "0 $$ydata[$i] 0 $$xdata[$i] $$ydata[$i] ".
"$$ydata[$i]\n";
}
$self->{style} = "boxxyerrorbars";
$string = "'$fileTmp'";
}
# Normal x-y plot
# - Both xdata and ydata are defined
elsif (defined $self->{xdata})
{
my $xdata = $self->{xdata};
croak("x-data and y-data have unequal length") if
(scalar(@$ydata) ne scalar(@$xdata));
for (my $i = 0; $i < @$xdata; $i++)
{
print DATA "$$xdata[$i] $$ydata[$i]\n";
}
$string = "'$fileTmp'";
# Construst using statement for date-time data
if (defined $self->{timefmt})
{
my @a = split(/\s+/, $$xdata[0]);
my $yCol = scalar(@a) + 1;
$using = "1:$yCol";
}
}
# Only ydata is defined
else
{
# Treatment for financebars and candlesticks styles
if (defined $self->{style} &&
$self->{style} =~ /^(financebars|candlesticks)$/)
{
for (my $i = 0; $i < @{$$ydata[0]}; $i++)
{
print DATA "$i $$ydata[0][$i] $$ydata[1][$i] ".
"$$ydata[2][$i] $$ydata[3][$i]\n";
}
}
# Treatment for errorbars and errorlines styles
# - Style is defined and contain "error"
elsif (defined $self->{style} && $self->{style} =~ /^yerror/)
{
for (my $i = 0; $i < @{$$ydata[0]}; $i++)
{
print DATA "$i $$ydata[0][$i]";
for(my $j = 1; $j < @$ydata; $j++)
{
print DATA " $$ydata[$j][$i]";
}
print DATA "\n";
}
}
# ydata vs index
else
{
for (my $i = 0; $i < @$ydata; $i++)
{
print DATA "$i $$ydata[$i]\n";
}
}
$string = "'$fileTmp'";
if (defined $self->{timefmt})
{
$using = "1:2";
}
}
close(DATA);
}
# Data in points
elsif (defined $self->{points})
{
my $pt = $self->{points};
my $fileTmp = $self->{_data};
open(DATA, ">$fileTmp") || confess("Can't write data to temp file");
# 2D data points
if (scalar(@{$$pt[0]}) == 2 ||
(defined $self->{style} && $self->{style} =~ /error/))
{
# hlines plotting style
if (defined $self->{style} && $self->{style} eq 'hlines')
{
for(my $i = 0; $i < @$pt; $i++)
{
print DATA "0 $$pt[$i][1] 0 $$pt[$i][0] $$pt[$i][1] ".
"$$pt[$i][1]\n";
}
$self->{style} = "boxxyerrorbars";
}
# hbars plotting style
elsif (defined $self->{style} && $self->{style} eq 'hbars')
{
my $ylow = my $yhigh = $$pt[0][1];
if (scalar(@$pt) > 1)
{
$ylow = 0.5*(3*$$pt[0][1]-$$pt[1][1]);
$yhigh = 0.5*(3*$$pt[-1][1]-$$pt[-2][1]);
}
for(my $i = 0; $i < @$pt; $i++)
{
$ylow = 0.5*($$pt[$i][1]+$$pt[$i-1][1]) if ($i > 0);
$yhigh = 0.5*($$pt[$i][1]+$$pt[$i+1][1]) if ($i < $#$pt);
print DATA "0 $$pt[$i][1] 0 $$pt[$i][0] $ylow $yhigh\n";
}
$self->{style} = "boxxyerrorbars";
}
else
{
for(my $i = 0; $i < @$pt; $i++)
{
print DATA join(" ", @{$$pt[$i]}), "\n";
}
}
}
# 3D data points
elsif (scalar(@{$$pt[0]}) == 3)
{
my $xLast;
for(my $i = 0; $i < @$pt; $i++)
{
print DATA join(" ", @{$$pt[$i]}), "\n";
print DATA "\n" if (defined $xLast && $$pt[$i][0] != $xLast);
$xLast = $$pt[$i][0];
}
}
else
{
for(my $i = 0; $i < @$pt; $i++)
{
print DATA join(" ", @{$$pt[$i]}), "\n";
}
}
close(DATA);
$string = "'$fileTmp'";
# Construst using statement for date-time data
if (defined $self->{timefmt})
{
my $col = 1;
$using = "1";
for (my $i = 0; $i < @{$$pt[0]}-1; $i++)
{
my @a = split(/\s+/, $$pt[0][$i]);
$col += scalar(@a);
$using .= ":$col";
}
}
}
# File
elsif (defined $self->{datafile})
{
$string = "'$self->{datafile}'";
$string .= " every $self->{every}" if (defined $self->{every});
$string .= " index $self->{index}" if (defined $self->{index});
}
# Function
elsif (defined $self->{func})
{
# Parametric function
if (ref($self->{func}) eq 'HASH')
{
if (defined ${$self->{func}}{z})
{
$string = "${$self->{func}}{x},${$self->{func}}{y},".
"${$self->{func}}{z}";
}
else
{
$string = "${$self->{func}}{x},${$self->{func}}{y}";
}
}
else
{
$string = "$self->{func}";
}
}
else
{
croak("Unknown or undefined data source");
}
# Process the Gnuplot "using" feature
$using = $self->{using} if (defined $self->{using});
$string .= " using $using" if ($using ne '');
# Add title for the data sets
(defined $self->{title})? ($string .= " title \"$self->{title}\""):
($string .= " title \"\"");
# Change plotting style, color, width and point size
$string .= " smooth $self->{smooth}" if (defined $self->{smooth});
$string .= " axes $self->{axes}" if (defined $self->{axes});
$string .= " with $self->{style}" if (defined $self->{style});
$string .= " linetype ".&_lineType($self->{linetype}) if
(defined $self->{linetype});
$string .= " linecolor rgb \"$self->{color}\"" if (defined $self->{color});
$string .= " linewidth $self->{width}" if (defined $self->{width});
$string .= " pointtype ".&_pointType($self->{pointtype}) if
(defined $self->{pointtype});
$string .= " pointsize $self->{pointsize}" if (defined $self->{pointsize});
$string .= " fill".&_fillStyle($self->{fill}) if (defined $self->{fill});
return($string);
}
# Generate box filling style string
# - called by _thaw()
sub _fillStyle
{
my ($fill) = @_;
if (ref($fill) eq 'HASH')
{
my $style = " solid $$fill{density}";
$style .= " noborder" if (defined $$fill{border} &&
$$fill{border} =~ /^(off|no)$/);
return($style);
}
return(" solid $fill");
}
# Copy method of the data set object
sub copy
{
my ($self, $num) = @_;
my @clone = &_copy(@_);
foreach my $clone (@clone)
{
my $dirTmp = tempdir(CLEANUP => 1);
($^O eq 'MSWin32')? ($dirTmp .= '\\'): ($dirTmp .= '/');
$clone->{_data} = $dirTmp . "data";
}
return($clone[0]) if (!defined $num);
return(@clone);
}
1;
__END__
=head1 NAME
Chart::Gnuplot - Plot graph using Gnuplot in Perl on the fly
=head1 SYNOPSIS
use Chart::Gnuplot;
# Data
my @x = (-10 .. 10);
my @y = (0 .. 20);
# Create chart object and specify the properties of the chart
my $chart = Chart::Gnuplot->new(
output => "fig/simple.png",
title => "Simple testing",
xlabel => "My x-axis label",
ylabel => "My y-axis label",
....
);
# Create dataset object and specify the properties of the dataset
my $dataSet = Chart::Gnuplot::DataSet->new(
xdata => \@x,
ydata => \@y,
title => "Plotting a line from Perl arrays",
style => "linespoints",
....
);
# Plot the data set on the chart
$chart->plot2d($dataSet);
##################################################
# Plot many data sets on a single chart
$chart->plot2d($dataSet1, $dataSet2, ...);
=head1 DESCRIPTION
This Perl module is to plot graphs uning GNUPLOT on the fly. In order to use
this module, gnuplot need to be installed. If image format other than PS and
EPS is required to generate, the convert program of ImageMagick is also needed.
To plot chart using Chart::Gnuplot, a chart object and at least one dataset
object are required. Information about the chart such as output file, chart
title, axes labels and so on is specified in the chart object. Dataset object
contains information about the dataset to be plotted, including source of the
data points, dataset label, color used to plot and more.
After chart object and dataset object(s) are created, the chart can be plotted
using the plot2d, plot3d or multiplot method of the chart object, e.g.
# $chart is the chart object
$chart->plot2d($dataSet1, $dataSet2, ...);
To illustate the features of Chart::Gnuplot, the best way is to show by
examples. A lot of examples can be found in SourceForge L<http://chartgnuplot.sourceforge.net>.
=head1 CHART OBJECT
The chart object can be initiated by the c<new> method. Properties of the chart
may be specified optionally when the object is initiated:
my $chart = Chart::Gnuplot->new(%options);
=head2 Chart Options
=head3 output
Output file of the graph. By default, the image format is detected
automatically by the extension of the filename. However, it can also be changed
manually by using the format conversion methods such as C<convert> and C<png>
(see sessions below).
The supported image formats are:
bmp : Microsoft Windows bitmap
epdf : Encapsulated Portable Document Format
epi : Encapsulated PostScript Interchange format
eps : Encapsulated PostScript
gif : Graphics Interchange Format
jpg : Joint Photographic Experts Group JFIF format
pdf : Portable Document Format
png : Portable Network Graphics
ppm : Portable Pixmap Format
ps : PostScript file
psd : Adobe Photoshop bitmap file
xpm : X Windows system pixmap
If the filename has no extension, postscipt will be used.
=head3 title
Title of the chart. E.g.,
title => "Chart title"
Properties of the chart title can be specified in hash. E.g.,
title => {
text => "Chart title",
font => "arial, 20",
....
}
Supported properties are:
text : title in plain text
font : font face (and optionally font size)
color : font color
offset : offset relative to the default position
enhanced : title contains subscript/superscipt/greek? (on/off)
Default values would be used for properties not specified. These properties has
no effect on the main title of the multi-chart (see L<multiplot>).
=head3 xlabel, ylabel, zlabel
Label of the x-axis, y-axis and z-axis. E.g.
xlabel => "Bottom axis label"
Properties of the axis label can be specified in hash, similar to the chart
title. Supported properties are:
text : title in plain text
font : font face (and optionally font size)
color : font color
offset : offset relative to the default position
rotate : rotation in degrees
enhanced : title contains subscript/superscipt/greek? (on/off)
=head3 x2label, y2label
Label of the secondary x-axis (displayed on the top of the graph) and the
secondary y-axis (displayed on the right of the graph). See L<xlabel>.
=head3 xrange, yrange, zrange
Range of the x-axis, y-axis and z-axis in the plot, e.g.
xrange => [0, "pi"]
would make the plot from x = 0 to x = 3.14159...
=head3 x2range, y2range
Range of the secondary (top horizontal and right vertical) axes of the plot.
See L<xrange, yrange, zrange>.
=head3 trange, urange, vrange
Range of the parametric parameter (t for 2D plots, while u and v for 3D plots).
See L<xrange, yrange, zrange>.
=head3 xtics, ytics, ztics
The tics and tic label on the x-axis, y-axis and z-axis. E.g.
xtics => {
labels => [-10, 15, 20, 25],
labelfmt => "%3f",
....
}
If you set this to C<undef>. E.g.,
xtics => undef
Then this option will be explicitly I<unset> and the chart will have not have
tic marks on the specified axis.
Supported properties are:
labels : the locations of the tic labels
labelfmt : format of the labels
font : font of the labels
fontsize : font size of the lebals
fontcolor : font color of the label
offset : position of the tic labels shifted from its default
rotate : rotation of the tic labels
length : length of the tics
along : where the tics are put (axis/border)
minor : number of minor tics between adjacant major tics
mirror : turn on and off the tic label of the secondary axis. No effect
: for C<ztics> (on/off)
=head3 x2tics, y2tics
The tics and tic label of the secondary axes. See L<xtics, ytics, ztics>.
=head3 legend
Legend describing the plots. Supported properties are:
position : position of the legend
width : number of character widths to be added or subtracted to the
: region of the legend
height : number of character heights to be added or subtracted to the
: region of the legend
align : alignment of the text label. Left or right (default)
order : order of the keys
title : title of the legend
sample : format of the sample lines
border : border of the legend
See L<border> for the available options of border
E.g.
legend => {
position => "outside bottom",
width => 3,
height => 4,
align => "right",
order => "horizontal reverse",
title => "Title of the legend",
sample => {
length => 3,
position => "left",
spacing => 2,
},
border => {
linetype => 2,
width => 1,
color => "blue",
},
}
=head3 timeaxis
Specify the axes of which the tic labels are date/time string. Possible values
are combinations of "x", "y", "x2", and "y2" joined by ",". E.g.
timeaxis => "x, y2"
means that the x-axis and y2-axis are data/time axes.
=head3 border
Border of the graph. Properties supported are "sides", "linetype", "width", and
"color". E.g.
border => {
sides => "bottom, left",
linetype => 3,
width => 2,
color => '#ff00ff',
}
C<sides> tells which side(s) will be displayed. Default is all four borders for
2D plots, and four bottom and left vertial borders for 3D plots. Acceptable
valurs are the 12-bit code (see the Gnuplot manual) or the following names:
bottom
left
top
right
bottom left front
bottom left back
bottom right front
bottom right back
left vertical
right vertical
front vertical
back vertical
top left front
top left back
top right front
top right back
If you set this to C<undef>. E.g.,
border => undef
Then this option will be explicitly I<unset> and the chart will have not have
any border.
=head3 grid
Major grid lines. E.g.
grid => {
type => 'dash',
width => 2,
....
}
Supported properties are:
type : line type of the grid lines (default: dot)
width : line width (defaulr: 0)
color : line color (default: black)
xlines : whether the vertical grid lines are drawn (on/off)
ylines : whether the horizontal grid lines are drawn (on/off)
=head3 tmargin, bmargin
Top and bottom margin (in character height). This option has no effect in 3D
plots. E.g.
tmargin => 10
=head3 lmargin, rmargin
Left amd right margin (in character width). This option has no effect in 3D
plots. See L<tmargin, bmargin>.
=head3 orient
Orientation of the image. Possible values are "lanscape" (default) and
"portrait". E.g.
orient => "portrait"
=head3 imagesize
Size (length and height) of the image relative to the default. E.g.
imagesize => "0.8, 0.5"
=head3 size
Size of the plot relative to the chart size. This is useful in some
multi-plot such as inset chart. E.g.
size => "0.5, 0.4"
=head3 origin
Origin of the chart. This is useful in some multi-plot such as inset chart.
E.g.
origin => "0.1, 0.5"
=head3 timestamp
Time stamp of the plot. To place the time stamp with default setting,
timestamp => 'on'
To set the format of the time stamp as well, e.g.,
timestamp => {
fmt => '%d/%m/%y %H:%M',
offset => "10,-3",
font => "Helvetica",
}
=head3 bg (experimental)
Background color of the chart. This option has no effect in the sub-chart of
multiplot and is experimental. E.g.
bg => "yellow"
Properties can be specified in hash. E.g.,
bg => {
color => "yellow",
density => 0.2,
}
Supported properties are:
color : color (name ot RRGGBB value)
density : density of the coloring
=head3 plotbg (experimental)
Background color of the plot area. This option has no effect in 3D plots and is
experimental. See L<bg>.
=head3 gnuplot
The path of Gnuplot executable. This option is useful if you are using Windows
or have multiple versions of Gnuplot installed. E.g.,
gnuplot => "C:\Program Files\...\gnuplot\bin\wgnuplot.exe"; # for Windows
=head3 convert
The path of convert executable of ImageMagick. This option is useful if you
have multiple convert executables.
=head3 terminal
The terminal driver that Gnuplot uses. The default terminal is "postscript".
This attribute is not recommended to be changed unless you are familiar with
the Gnuplot syntax. Please check the output image carefully if you use this in
production code.
Terminal is not necessarily related to the output image format. You may convert
the image format by the C<convert()> method.
=head2 Chart Methods
=head3 new
my $chart = Chart::Gnuplot->new(%options);
Constructor of the chart object. If no option is specified, default values
would be used. See L<Chart Options> for available options.
=head3 set
General set methods for arbitrary number of options.
$chart->set(%options);
=head3 plot2d
$chart->plot2d(@dataSets);
Plot the data sets in a 2D chart. Each dataset is represented by a dataset
object.
=head3 plot3d
$chert->plot3d(@dataSets);
Plot the data sets in a 3D chart. Each dataset is represented by a dataset
object. It is not yet completed. Only basic features are supported.
=head3 multiplot
$chert->multiplot(@charts);
Plot multiple charts in the same image.
=head3 animate
Create animated gif. E.g.
my $chart = Chart::Gnuplot->new(
output => "animate.gif",
);
my $T = 30; # number of frames
my @c;
for (my $i = 0; $i < $T; $i++)
{
$c[$i] = Chart::Gnuplot->new(xlabel => 'x');
my $ds = Chart::Gnuplot::DataSet->new(
func => "sin($i*2*pi/$T + x)",
);
$c[$i]->add2d($ds);
}
$chart->animate(
charts => \@c,
delay => 10, # delay 0.1 sec between successive images
);
Supported properties are:
charts : chart sequence used to create the animation
delay : delay (in units of 0.01 second) between successive images, default
: value is 5
See L<add2d> and L<add3d>.
=head3 add2d
Add a 2D dataset to a chart without plotting it out immediately. Used with
C<multiplot> or C<animate>.
=head3 add3d
Add a 3D dataset to a chart without plotting it out immediately. Used with
C<multiplot> or C<animate>.
=head3 label
Add an arbitrary text label. e.g.,
$chart->label(
text => "This is a label",
position => "0.2, 3 left",
offset => "2,2",
rotate => 45,
font => "arial, 15",
fontcolor => "dark-blue",
pointtype => 3,
pointsize => 5,
pointcolor => "blue",
);
=head3 arrow
Draw arbitrary arrow. e.g.,
$chart->arrow(
from => "0,2",
to => "0.3,0.1",
linetype => 'dash',
width => 2,
color => "dark-blue",
headsize => 3,
head => 'both',
);
=head3 copy
Copy the chart object. This method is especially useful when you want to copy a
chart with highly customized format. E.g.
my $chart = Chart::Gnuplot->new(
...
);
# $copy and $chart will have the same format
my $copy = $chart->copy;
You may also make multiple copies . E.g.
my @copies = $chart->copy(10); # make 10 copies
=head3 convert
$chart->convert($imageFmt);
Convert the image format to C<$imageFmt>. See L<Chart Options> for supported
image formats.
=head3 png
$chart->png;
Change the image format to PNG.
=head3 gif
$chart->gif;
Change the image format to GIF.
=head3 jpg
$chart->jpg;
Change the image format to JPEG.
=head3 ps
$chart->ps;
Change the image format to postscript.
=head3 pdf
$chart->pdf
Change the image format to PDF.
=head3 command
$chart->command($gnuplotCommand);
Add a gnuplot command. This method is useful for the Gnuplot features that have
not yet implemented.
=head1 DATASET OBJECT
The dataset object can be initiated by the C<new> method. Properties of the
dataset may be specified optionally when the object is initiated:
my $dataset = Chart::Gnuplot::DataSet->new(%options);
The data source of the dataset can be specified by either one of the following
ways:
=over
=item 1. Arrays of x values, y values and z values (in 3D plots) of the data
points.
=item 2. Array of data points. Each point is specified as an array of x, y, z
coordinates
=item 3. Data file.
=item 4. Mathematical expression (for a function).
=back
=head2 Dataset Options
=head3 xdata, ydata, zdata
The x, y, z values of the data points. E.g.
xdata => \@x
If C<xdata> is omitted but C<ydata> is defined, the integer index starting from
0 would be used for C<xdata>.
=head3 points
Data point matrix of the format [[x1,y1], [x2,y2], [x3,y3], ...]
points => \@points
=head3 datafile
Input data file
datafile => $file
The data files are assumed to be space-separated, with each row corresponding
to one data point. Lines beginning with "#" are considered as comments and
would be ignored. Other formats are not supported at this moment.
=head3 func
Mathematical function to be plotted. E.g.
func => "sin(x)*x**3"
Supported functions:
abs(x) : absolute value
acos(x) : inverse cosine
acosh(x) : inverse hyperbolic cosine
arg(x) : complex argument
asin(x) : inverse sine
asinh(x) : inverse hyperbolic sine
atan(x) : inverse tangent
atanh(x) : inverse hyperbolic tangent
besj0(x) : zeroth order Bessel function of the first kind
besj1(x) : first order Bessel function of the first kind
besy0(x) : zeroth order Bessel function of the second kind
besy1(x) : first order Bessel function of the second kind
ceil(x) : ceiling function
cos(x) : cosine
cosh(x) : hyperbolic cosine
erf(x) : error function
erfc(x) : complementary error function
exp(x) : expontial function
floor(x) : floor function
gamma(x) : gamma function
ibeta(a,b,x) : incomplete beta function
inverf(x) : inverse error function
igamma(a,x) : incomplete gamma function
imag(x) : imaginary part
invnorm(x) : inverse normal distribution function
int(x) : integer part
lambertw(x) : Lambert W function
lgamma(x) : log gamma function
log(x) : natural logarithm
log10(x) : common logarithm
norm(x) : normal distribution function
rand(x) : pseudo random number
real(x) : real part
sgn(x) : sign function
sin(x) : sine
sinh(x) : hyperbolic sine
sqrt(x) : square root
tan(x) : tangent
tanh(x) : hyperbolic tangent
Please see the Gnuplot manual for updated information.
Supported mathematical constants:
pi : the circular constant 3.14159...
Supported arithmetic operators:
addition : +
division : /
exponentiation : **
factorial : !
modulo : %
multiplication : *
subtraction : -, e.g., 1-2
unary minus : -, e.g., -1
Supported logical operations:
and : &&
complement : ~
equality : ==
greater than : >
greater than or equal to : >=
inequality : !=
less than : <
less than or equal to : <=
negation : !
or : ||
if ... than else ... : ?:, e.g., a ? b : c
Parametric functions may be represented as hash. E.g.
func => {x => 'sin(t)', y => 'cos(t)'}
will draw a circle.
=head3 title
Title of the dataset (shown in the legend).
=head3 style
The plotting style for the dataset, including
lines : join adjacent points by straight lines
points : mark each points by a symbol
linespoints : both "lines" and "points"
dots : dot each points. Useful for large datasets
impluses : draw a vertical line from the x-axis to each point
steps : join adjacent points by steps
boxes : draw a centered box from the x-axis to each point
xerrorbars : "dots" with horizontal error bars
yerrorbars : "dots" with vertical error bars
xyerrorbars : both "xerrorbars" and "yerrorbars"
xerrorlines : "linespoints" with horizontal error bars
yerrorlines : "linespoints" with vertical error bars
xyerrorlines : both "xerrorlines" and "yerrorlines"
boxerrorbars : "boxes" with "yerrorbars"
boxxyerrorbars : use rectangles to represent the data with errors
financebars : finance bars for open, high, low and close price
candlesticks : candle sticks for open, high, low and close price
hbars : horizontal bars (experimental)
hlines : horizontal lines (experimental)
=head3 color
Color of the dataset in the plot. Can be a named color ot RBG (#RRGGBB) value.
The supported color names can be found in the file F<doc/colors.txt> in the
distribution. E.g.
color => "#99ccff"
# or
color => "dark-red"
=head3 width
Line width used in the plot.
=head3 linetype
Line type.
=head3 pointtype
Point type.
=head3 pointsize
Point size of the plot.
=head3 fill
Filling string. Has effect only on plotting styles "boxes", "boxxyerrorbars"
and "financebars".
=head3 axes
Axes used in the plot. Possible values are "x1y1", "x1y2", "x2y1" and "x2y2".
=head3 timefmt
Time format of the input data. The valid format are:
%d : day of the month, 1-31
%m : month of the year, 1-12
%y : year, 2-digit, 0-99
%Y : year, 4-digit
%j : day of the year, 1-365
%H : hour, 0-24
%M : minute, 0-60
%s : seconds since the Unix epoch (1970-01-01 00:00 UTC)
%S : second, 0-60
%b : name of the month, 3-character abbreviation
%B : name of the month
=head3 smooth
The smooth method used in plotting data points. Supported methods include cubic
splines (csplines), Bezier curve (bezier) and other. Please see Gnuplot manual
for details.
=head2 Dataset Methods
=head3 new
my $dataset = Chart::Gnuplot::DataSet->new(%options);
Constructor of the dataset object. If no option is specified, default values
would be used. See L<Dataset Options> for available options.
=head3 copy
Copy the dataset object. This method is especially useful when you want to copy
a dataset with highly customized format. E.g.
my $dataset = Chart::Gnuplot::DataSet->new(
...
);
# $copy and $dataset will have the same format and contain the same data
my $copy = $dataset->copy;
You may also make multiple copies . E.g.
my @copies = $dataset->copy(10); # make 10 copies
=head1 EXAMPLES
Some simple examples are shown below. Many more come with the distribution.
=over
=item 1. Plot a mathematical expression
my $chart = Chart::Gnuplot->new(
output => "expression.png"
);
my $dataSet = Chart::Gnuplot::DataSet->new(
func => "sin(x)"
);
$chart->plot2d($dataSet);
=item 2. Plot from two Perl arrays, one for the x-axis data and the other the
y-axis.
my $chart = Chart::Gnuplot->new(
output => "arrays.png"
);
my $dataSet = Chart::Gnuplot::DataSet->new(
xdata => \@x,
ydata => \@y,
);
$chart->plot2d($dataSet);
=item 3. Plot x-y pairs
# Data
my @xy = (
[1.1, -3],
[1.2, -2],
[3.5, 0],
...
);
my $chart = Chart::Gnuplot->new(
output => "points.png"
);
my $dataSet = Chart::Gnuplot::DataSet->new(
points => \@xy
);
$chart->plot2d($dataSet);
=item 4. Plot data from a data file
my $chart = Chart::Gnuplot->new(
output => "file.png"
);
my $dataSet = Chart::Gnuplot::DataSet->new(
datafile => "in.dat"
);
$chart->plot2d($dataSet);
=item 5. Chart title, axis label and legend
# Chart object
my $chart = Chart::Gnuplot->new(
output => "trigonometric.gif",
title => "Three basic trigonometric functions",
xlabel => "angle in radian",
ylabel => "function value"
);
# Data set objects
my $sine = Chart::Gnuplot::DataSet->new(
func => "sin(x)",
title => "sine function"
);
my $cosine = Chart::Gnuplot::DataSet->new(
func => "cos(x)",
title => "cosine function"
);
my $tangent = Chart::Gnuplot::DataSet->new(
func => "tan(x)",
title => "tangent function"
);
$chart->plot2d($sine, $cosine, $tangent);
=item 6. Title in non-English characters (Thanks to WOLfgang Schricker)
use Encode;
my $title = ... # Title with German umlauts
$title = decode("utf8", $title);
Chart::Gnuplot->new(
encoding => 'iso-8859-1',
title => $title,
);
=item 7. Plot a financial time series
my $chart = Chart::Gnuplot->new(
output => "dj.ps",
title => "Dow-Jones Index time series",
timeaxis => 'x',
xtics => {
labelfmt => '%b%y',
},
);
my $dow = Chart::Gnuplot::DataSet->new(
file => "dj.dat",
timefmt => '%Y-%m-%d', # time format of the input data
style => "candlesticks",
grid => 'on',
);
$chart->plot2d($dow);
=item 8. Plot several graphs on the same image
my $chart = Chart::Gnuplot->new(
output => "multiplot.gif",
);
my $left = Chart::Gnuplot->new();
my $sine = Chart::Gnuplot::DataSet->new(
func => "sin(x)",
);
$left->add2d($sine);
my $center = Chart::Gnuplot->new();
my $cosine = Chart::Gnuplot::DataSet->new(
func => "cos(x)",
);
$center->add2d($cosine);
my $right = Chart::Gnuplot->new();
my $tangent = Chart::Gnuplot::DataSet->new(
func => "tan(x)",
);
$right->add2d($tangent);
# Place the Chart::Gnuplot objects in matrix to indicate their locations
$chart->multiplot([
[$left, $center, $right]
]);
=back
=head1 WISH LIST
=over
=item 1. Improve the manual.
=item 2. Add more control to the 3D plots.
=item 3. Add curve fitting method.
=item 4. Improve the testsuite.
=item 5. Reduce number of temporary files generated.
=back
=head1 REQUIREMENTS
L<Carp>, L<File::Copy>, L<File::Temp>, L<Storable>
Gnuplot L<http://www.gnuplot.info>
ImageMagick L<http://www.imagemagick.org> (for full feature)
=head1 SEE ALSO
Gnuplot official website L<http://www.gnuplot.info>
=head1 AUTHOR
Ka-Wai Mak <kwmak@cpan.org>
=head1 COPYRIGHT
Copyright (c) 2008-2011 Ka-Wai Mak. All rights reserved.
=head1 LICENSE
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
|