/usr/lib/python2.7/dist-packages/pymol/viewing.py is in pymol 1.7.2.1-2.2.
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 | #A* -------------------------------------------------------------------
#B* This file contains source code for the PyMOL computer program
#C* Copyright (c) Schrodinger, LLC.
#D* -------------------------------------------------------------------
#E* It is unlawful to modify or remove this copyright notice.
#F* -------------------------------------------------------------------
#G* Please see the accompanying LICENSE file for further information.
#H* -------------------------------------------------------------------
#I* Additional authors of this source file include:
#-* Filipe Maia (slicing code)
#-*
#-*
#Z* -------------------------------------------------------------------
if __name__=='pymol.viewing':
import thread
import threading
import string
import types
import traceback
import pymol
import selector
import copy
import parsing
import re
import cmd
from cmd import _cmd,lock,unlock,Shortcut,QuietException,_raising, \
_feedback,fb_module,fb_mask, \
repres,repres_sc, is_string, is_list, is_ok, is_error, \
toggle_dict,toggle_sc,stereo_dict,stereo_sc, \
palette_dict, palette_sc, window_dict, window_sc, \
safe_list_eval, safe_alpha_list_eval, \
location_code, location_sc, boolean_dict, boolean_sc, \
DEFAULT_ERROR, DEFAULT_SUCCESS
import thread
palette_colors_dict = {
'rainbow_cycle' : 'magenta blue cyan green yellow orange red magenta',
'rainbow_cycle_rev' : 'magenta red orange yellow green cyan blue magenta',
'rainbow' : 'blue cyan green yellow orange red',
'rainbow_rev' : 'red orange yellow green cyan blue',
'rainbow2' : 'blue cyan green yellow orange red',
'rainbow2_rev' : 'red orange yellow green cyan blue',
'gcbmry' : 'green cyan blue magenta red yellow',
'yrmbcg' : 'yellow red magenta blue cyan green',
'cbmr' : 'cyan blue magenta red',
'rmbc' : 'red magenta blue cyan',
}
rep_list = [ "lines", "sticks", "spheres", "dots", "surface",
"mesh", "nonbonded", "nb_spheres", "cartoon",
"ribbon", "labels", "slice", "ellipsoids", "volume" ]
scene_action_sc = Shortcut(['store','recall','clear','insert_before',
'insert_after','next','previous',
'start', 'update','rename','delete',
'order', 'sort', 'first',
'append'])
scene_action_dict = {}
scene_action_dict_sc = Shortcut([])
view_sc = Shortcut(['store','recall','clear'])
def zoom(selection="all", buffer=0.0, state=0, complete=0, animate=0,_self=cmd):
'''
DESCRIPTION
"zoom" scales and translates the window and the origin to cover the
atom selection.
USAGE
zoom [ selection [, buffer [, state [, complete [, animate ]]]]]
EXAMPLES
zoom
zoom complete=1
zoom 142/, animate=3
zoom (chain A)
ARGUMENTS
selection = string: selection-expression or name pattern {default: all}
buffer = float: distance {default: 0}
state = 0: uses all coordinate states {default}
state = -1: uses only coordinates for the current state
state > 0: uses coordinates for a specific state
complete = 0 or 1: will insure no atoms centers are clipped
animate < 0: uses the default animation duration
animate = 0: no animation
animate > 0: animates using the provided duration in seconds
PYMOL API
cmd.zoom(string selection, float buffer, int state, int complete,
int animate)
NOTES
The zoom command normally tries to guess an optimal zoom level for
visualization, balancing closeness against occasional clipping of
atoms out of the field of view. You can change this behavior by
setting the complete option to 1, which will guarantee that the
atom positions for the entire selection will fit in the field of
an orthoscopic view.
To absolutely prevent clipping, you may also need to add an
additional buffer (typically 2 A) to account for graphical
representations which extend beyond the atom coordinates.
SEE ALSO
origin, orient, center
'''
# preprocess selection
selection = selector.process(selection)
#
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.zoom(_self._COb,str(selection),float(buffer),
int(state)-1,int(complete),float(animate))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def center(selection="all", state=0, origin=1, animate=0, _self=cmd):
'''
DESCRIPTION
"center" translates the window, the clipping slab, and the
origin to a point centered within the atom selection.
USAGE
center [ selection [, state [, origin [, animate ]]]]
EXAMPLES
chain chain B
center 145/
ARGUMENTS
selection = string: selection-expression or name pattern (default: "all").
state = 0 (default) use all coordinate states
state = -1 use only coordinates for the current state
state > 0 use coordinates for a specific state
origin = 1 (default) move the origin
origin = 0 leave the origin unchanged
PYMOL API
cmd.center(string selection, int state, int origin)
SEE ALSO
origin, orient, zoom
'''
r = DEFAULT_ERROR
# preprocess selection
selection = selector.process(selection)
#
try:
_self.lock(_self)
r = _cmd.center(_self._COb,str(selection),int(state)-1,int(origin),float(animate))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
clip_action_sc = Shortcut([ 'near','far','move','slab','atoms' ])
def clip(mode, distance, selection=None, state=0, _self=cmd):
'''
DESCRIPTION
"clip" alters the positions of the clipping planes.
USAGE
clip mode, distance [, selection [, state ]]
ARGUMENTS
mode = near, far, move, slab, or atoms
distance is a floating point value
selection = atom selection (for mode=atoms only)
EXAMPLES
clip near, -5 # moves near plane away from you by 5 A
clip far, 10 # moves far plane towards you by 10 A
clip move, -5 # moves the slab away from you by 5 A
clip slab, 20 # sets slab thickness to 20 A
clip slab, 10, resi 11 # clip 10 A slab about residue 11
clip atoms, 5, pept # clip atoms in "pept" with a 5 A buffer
# about their current camera positions
PYMOL API
cmd.clip(string mode, float distance, string selection, int state)
SEE ALSO
zoom, orient, reset
'''
r = DEFAULT_ERROR
mode = clip_action_sc.auto_err(str(mode),'mode')
if selection!=None:
selection = selector.process(selection)
else:
selection = ''
try:
_self.lock(_self)
r = _cmd.clip(_self._COb,str(mode),float(distance),
str(selection),int(state)-1)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def origin(selection="(all)", object=None, position=None, state=0, _self=cmd):
'''
DESCRIPTION
"origin" sets the center of rotation about a selection. If an
object name is specified, it can be used to set the center of
rotation for the object (for use in animation and editing).
USAGE
origin [ selection [, object [,position, [, state ]]]]
ARGUMENTS
selection = string: selection-expression or name-list {default: (all)}
state = 0 (default) use all coordinate states
state = -1 use only coordinates for the current state
state > 0 use coordinates for a specific state
EXAMPLES
origin chain A
origin position=[1.0,2.0,3.0]
PYMOL API
cmd.origin(string object-or-selection)
SEE ALSO
zoom, orient, reset
'''
#'
r = DEFAULT_ERROR
# preprocess selection
selection = selector.process(selection)
#
try:
_self.lock(_self)
if object==None: object=''
if position==None: position=(0.0,0.0,0.0)
else:
if _self.is_string(position):
position = safe_list_eval(position)
selection = ''
r = _cmd.origin(_self._COb,selection,str(object),
(float(position[0]),
float(position[1]),
float(position[2])
),int(state)-1)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def orient(selection="(all)", state=0, animate=0, _self=cmd):
'''
DESCRIPTION
"orient" aligns the principal components of the atoms in the
selection with the XYZ axes.
USAGE
orient [ selection [, state [, animate ]]]
ARGUMENTS
selection = a selection-expression or name-pattern {default: (all)}
state = 0: use all coordinate states {default}
state = -1: uses only coordinates for the current state
state > 0: uses coordinates for a specific state
EXAMPLES
orient organic
NOTES
The function is similar to the orient command in X-PLOR.
PYMOL API
cmd.orient(string object-or-selection, int state, float animate)
SEE ALSO
zoom, origin, reset
'''
r = DEFAULT_ERROR
# preprocess selection
selection = selector.process(selection)
#
try:
_self.lock(_self)
r = _cmd.orient(_self._COb,"("+selection+")",int(state)-1,float(animate))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def move(axis, distance, _self=cmd):
'''
DESCRIPTION
"move" translates the camera about one of the three primary axes.
USAGE
move axis, distance
EXAMPLES
move x, 3
move y, -1
PYMOL API
cmd.move(string axis, float distance)
SEE ALSO
turn, rotate, translate, zoom, center, clip
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.move(_self._COb,str(axis),float(distance))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def enable(name='all', parents=0, _self=cmd):
'''
DESCRIPTION
"enable" turns on display of one or more objects and/or selections.
USAGE
enable name
ARGUMENTS
name = name-pattern or selection.
NOTES
If name matches a selection name, then selection indicator dots
are shown for atoms in that selection. If name is a
selection-expression, then all objects with atoms in that
selection are enabled.
For an object\'s content to be displayed in the 3D viewer, the
object must be enabled AND at least one of the available
representations must be shown.
PYMOL API
cmd.enable(string object-name)
EXAMPLES
enable target_protein # enables the target_protein object
enable 1dn2.* # enables all entities starting with 1dn2.
enable *lig # enables all entities ending with lig
SEE ALSO
show, hide, disable
'''
r = DEFAULT_ERROR
if name[0]=='(':
selection = selector.process(name)
try:
_self.lock(_self)
r = _cmd.onoff_by_sele(_self._COb,selection,1)
finally:
_self.unlock(r,_self)
else:
try:
_self.lock(_self)
r = _cmd.onoff(_self._COb,str(name),1,int(parents));
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def disable(name='all',_self=cmd):
'''
DESCRIPTION
"disable" turns off display of one or more objects and/or selections.
USAGE
disable name
ARGUMENTS
name = name-pattern or selection.
PYMOL API
cmd.disable(string name)
SEE ALSO
show, hide, enable
'''
r = DEFAULT_ERROR
if name[0]=='(':
selection = selector.process(name)
try:
_self.lock(_self)
r = _cmd.onoff_by_sele(_self._COb,selection,0)
finally:
_self.unlock(r,_self)
else:
try:
_self.lock(_self)
r = _cmd.onoff(_self._COb,str(name),0,0);
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def toggle(representation="", selection="", _self=cmd):
'''
DESCRIPTION
"toggle" toggles the visibility of a representation within a
selection.
USAGE
toggle representation, selection
ARGUMENTS
representation = string
selection = string
NOTES
If no arguments are provided, then lines are toggled for all
objects in the aggregate.
PYMOL API
cmd.toggle(string representation, string selection)
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
if (representation=="") and (selection==""):
r = _cmd.toggle(_self._COb,"(all)",repres['lines']); # show lines by default
elif representation=='object':
if selection in cmd.get_names('all',enabled_only=1):
r = cmd.disable(selection)
else:
r = cmd.enable(selection)
elif (representation!="") and (selection!=""):
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep];
# preprocess selection
selection = selector.process(selection)
#
r = _cmd.toggle(_self._COb,str(selection),int(repn));
elif representation=='all':
r = _cmd.toggle(_self._COb,"all",repres['lines']); # toggle lines by default
elif (representation[0:1]=='(') or (string.find(representation,'/')>=0):
# preprocess selection
selection = selector.process(representation)
#
r = _cmd.toggle(_self._COb,str(selection),repres['lines']);
else: # selection==""
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep];
r = _cmd.toggle(_self._COb,"all",int(repn));
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def show(representation="", selection="", _self=cmd):
'''
DESCRIPTION
"show" turns on representations for objects and selections.
USAGE
show [ representation [, selection ]]
ARGUMENTS
representation = lines, spheres, mesh, ribbon, cartoon, sticks,
dots, surface, labels, extent, nonbonded, nb_spheres, slice,
extent, slice, dashes, angles, dihedrals, cgo, cell, callback,
or everything
selection = string: a selection-expression or name-pattern
NOTES
With no arguments, "show" alone turns on lines for all bonds and
nonbonded for all atoms in all molecular objects.
EXAMPLES
show
show ribbon
show lines, (name ca or name c or name n)
SEE ALSO
hide, enable, disable
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
if (representation=="") and (selection==""):
if is_ok(_cmd.showhide(_self._COb,"(all)",repres['lines'],1)): # show lines by default
r = _cmd.showhide(_self._COb,"(all)",repres['nonbonded'],2)
elif (representation!="") and (selection!=""):
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep];
# preprocess selection
selection = selector.process(selection)
#
r = _cmd.showhide(_self._COb,str(selection),int(repn),1);
elif representation=='all':
if is_ok(_cmd.showhide(_self._COb,"all",repres['lines'],1)): # show lines by default
r = _cmd.showhide(_self._COb,"all",repres['nonbonded'], 1) # nonbonded
elif (representation[0:1]=='(') or (string.find(representation,'/')>=0):
# preprocess selection
selection = selector.process(representation)
#
if is_ok(_cmd.showhide(_self._COb,str(selection),repres['lines'],1)):
r = _cmd.showhide(_self._COb,str(selection),repres['nonbonded'],2);
else: # selection==""
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep]
r = _cmd.showhide(_self._COb,"all",int(repn),1);
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def show_as(representation="", selection="", _self=cmd):
'''
DESCRIPTION
"as" turns on and off atom and bond representations.
The available representations are:
lines spheres mesh ribbon cartoon
sticks dots surface labels extent
nonbonded nb_spheres slice
USAGE
as representation [, selection ]
ARGUMENTS
representation = lines, spheres, mesh, ribbon, cartoon, sticks,
dots, surface, labels, extent, nonbonded, nb_spheres, slice,
extent, slice, dashes, angles, dihedrals, cgo, cell, callback,
or everything
selection = string {default: all}
EXAMPLES
as lines, name ca or name c or name n
as ribbon
PYMOL API
cmd.show_as(string representation, string selection)
NOTES
"selection" can be an object name
"as" alone will turn on lines and nonbonded and hide everything else.
SEE ALSO
show, hide, enable, disable
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
vis_sel = None
if (representation=="") and (selection==""):
if is_ok(_cmd.showhide(_self._COb,str(selection),-1,0)):
if is_ok(_cmd.showhide(_self._COb,"(all)",repres['lines'],1)):
r = _cmd.showhide(_self._COb,"(all)",repres['nonbonded'],1)
elif (representation!="") and (selection!=""):
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep]
# preprocess selection
selection = selector.process(selection)
# user specified 'visible' -- this has always been problematic
if "visible".startswith(selection.lower()) and len(string.split(selection))==1:
vis_sel = _self.get_unused_name("_vis")
_self.select(vis_sel, selection)
selection = vis_sel
if is_ok(_cmd.showhide(_self._COb,str(selection),-1,0)):
r = _cmd.showhide(_self._COb,str(selection),int(repn),1)
elif representation=='all':
if is_ok(_cmd.showhide(_self._COb,str(selection),-1,0)):
if if_ok(_cmd.showhide(_self._COb,"all",repres['lines'],1)): # show lines by default
r = _cmd.showhide(_self._COb,"all",repres['nonbonded'],1) # show nonbonded by default
elif (representation[0:1]=='(') or (string.find(representation,'/')>=0):
# preprocess selection
selection = selector.process(representation)
if is_ok(_cmd.showhide(_self._COb,str(selection),-1,0)):
r = _cmd.showhide(_self._COb,str(selection),repres['lines'],1)
else: # selection==""
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep];
if is_ok(_cmd.showhide(_self._COb,"all",-1,0)):
r = _cmd.showhide(_self._COb,"all",int(repn),1);
finally:
if vis_sel is not None:
_self.delete(vis_sel)
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def hide(representation="", selection="",_self=cmd):
'''
DESCRIPTION
"hide" turns off atom and bond representations.
USAGE
hide [ representation [, selection ]]
ARGUMENTS
representation = lines, spheres, mesh, ribbon, cartoon,
sticks, dots, surface, labels, extent, nonbonded, nb_spheres,
slice, extent, slice, dashes, angles, dihedrals, cgo, cell, callback,
or everything
selection = string: a selection-expression or name-pattern
EXAMPLES
hide lines, all
hide ribbon
PYMOL API
cmd.hide(string representation, string selection)
SEE ALSO
show, enable, disable
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
if (representation=="") and (selection==""):
r = _cmd.showhide(_self._COb,"@",0,0);
elif (representation!="") and (selection!=""):
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep];
selection = selector.process(selection)
r = _cmd.showhide(_self._COb,str(selection),int(repn),0);
elif (representation=='all'):
r = _cmd.showhide(_self._COb,"@",0,0);
elif (representation[0:1]=='(') or (string.find(representation,'/')>=0):
selection = selector.process(representation)
r = _cmd.showhide(_self._COb,str(selection),-1,0);
else: # selection == ""
rep = representation
rep = repres_sc.auto_err(rep,'representation')
repn = repres[rep];
r = _cmd.showhide(_self._COb,"all",int(repn),0);
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def get_view(output=1, quiet=1, _self=cmd):
'''
DESCRIPTION
"get_view" returns and optionally prints out the current view
information in a format which can be embedded into a command
script and can be used in subsequent calls to "set_view".
If a log file is currently open, get_view will not write the view
matrix to the screen unless the "output" parameter is 2.
USAGE
get_view [output]
ARGUMENTS
output = 0: output matrix to screen
output = 1: do not Output matrix to screen
output = 2: force output to screen even if log file is open
output = 3: return formatted string instead of a list
NOTES
Contents of the view matrix:
* 0 - 8: column-major 3x3 matrix which rotates model space to camera space
* 9 - 11: origin of rotation relative to camera (in camera space)
* 12 - 14: origin of rotation (in model space)
* 15: front plane distance from the camera
* 16: rear plane distance from the camera
* 17: orthoscopic flag (+/-) and field of view (if abs(value) > 1)
The camera always looks down -Z with its +X left and its +Y down.
Therefore, in the default view, model +X is to the observer\'s
right, +Y is upward, and +Z points toward the observer.
PYMOL API
cmd.get_view(output=1, quiet=1)
SEE ALSO
set_view
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.get_view(_self._COb)
finally:
_self.unlock(r,_self)
if is_ok(r):
if len(r):
if (_self.get_setting_legacy("logging")!=0.0) and (output<3):
if not quiet:
print " get_view: matrix written to log file."
_self.log("_ set_view (\\\n","cmd.set_view((\\\n")
_self.log("_ %14.9f, %14.9f, %14.9f,\\\n"%r[0:3] ,
" %14.9f, %14.9f, %14.9f,\\\n"%r[0:3])
_self.log("_ %14.9f, %14.9f, %14.9f,\\\n"%r[4:7] ,
" %14.9f, %14.9f, %14.9f,\\\n"%r[4:7])
_self.log("_ %14.9f, %14.9f, %14.9f,\\\n"%r[8:11] ,
" %14.9f, %14.9f, %14.9f,\\\n"%r[8:11])
_self.log("_ %14.9f, %14.9f, %14.9f,\\\n"%r[16:19],
" %14.9f, %14.9f, %14.9f,\\\n"%r[16:19])
_self.log("_ %14.9f, %14.9f, %14.9f,\\\n"%r[19:22],
" %14.9f, %14.9f, %14.9f,\\\n"%r[19:22])
_self.log("_ %14.9f, %14.9f, %14.9f )\n"%r[22:25] ,
" %14.9f, %14.9f, %14.9f ))\n"%r[22:25])
if output<2: # suppress if we have a log file open
output=0
if output and (not quiet) and (output<3):
print "### cut below here and paste into script ###"
print "set_view (\\"
print " %14.9f, %14.9f, %14.9f,\\"%r[0:3]
print " %14.9f, %14.9f, %14.9f,\\"%r[4:7]
print " %14.9f, %14.9f, %14.9f,\\"%r[8:11]
print " %14.9f, %14.9f, %14.9f,\\"%r[16:19]
print " %14.9f, %14.9f, %14.9f,\\"%r[19:22]
print " %14.9f, %14.9f, %14.9f )"%r[22:25]
print "### cut above here and paste into script ###"
if output==3:
return ("set_view (\\\n"+
" %14.9f, %14.9f, %14.9f,\\\n"%r[0:3] +
" %14.9f, %14.9f, %14.9f,\\\n"%r[4:7] +
" %14.9f, %14.9f, %14.9f,\\\n"%r[8:11] +
" %14.9f, %14.9f, %14.9f,\\\n"%r[16:19] +
" %14.9f, %14.9f, %14.9f,\\\n"%r[19:22] +
" %14.9f, %14.9f, %14.9f )\n"%r[22:25])
r = r[0:3]+r[4:7]+r[8:11]+r[16:25]
elif _self._raising(r,_self):
raise QuietException
return r
def set_view(view,animate=0,quiet=1,hand=1,_self=cmd):
'''
DESCRIPTION
"set_view" sets viewing information for the current scene,
including the rotation matrix, position, origin of rotation,
clipping planes, and the orthoscopic flag.
USAGE
set_view [ view ]
EXAMPLE
set_view (\
0.999876618, -0.000452542, -0.015699286,\
0.000446742, 0.999999821, -0.000372844,\
0.015699454, 0.000365782, 0.999876678,\
0.000000000, 0.000000000, -150.258514404,\
11.842411041, 20.648729324, 8.775371552,\
118.464958191, 182.052062988, 0.000000000 )
PYMOL API
cmd.set_view(string-or-sequence view)
SEE ALSO
get_view
'''
r = DEFAULT_ERROR
if cmd.is_string(view):
try:
view = eval(re.sub(r"[^0-9,\-\)\(\.]","",view))
except:
traceback.print_exc()
print "Error: bad view argument; should be a sequence of 18 floats."
raise QuietException
if len(view)!=18:
print "Error: bad view argument; should be a sequence of 18 floats."
raise QuietException
else:
try:
_self.lock(_self)
r = _cmd.set_view(_self._COb,(
float(view[ 0]),float(view[ 1]),float(view[ 2]),0.0,
float(view[ 3]),float(view[ 4]),float(view[ 5]),0.0,
float(view[ 6]),float(view[ 7]),float(view[ 8]),0.0,
0.0,0.0,0.0,1.0,
float(view[ 9]),float(view[10]),float(view[11]),
float(view[12]),float(view[13]),float(view[14]),
float(view[15]),float(view[16]),float(view[17])),
int(quiet),float(animate),int(hand))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def view(key, action='recall', animate=-1,_self=cmd):
'''
DESCRIPTION
"view" saves and restore camera views.
USAGE
view key [, action [, animate]]
ARGUMENTS
key = string or *
action = store or recall: {default: recall}
NOTES
Views F1 through F12 are automatically bound to function keys
provided that "set_key" has not been used to redefine the
behaviour of the respective key, and that a "scene" has not been
defined for that key.
EXAMPLES
view 0, store
view 0
PYMOL API
cmd.view(string key, string action)
SEE ALSO
scene, set_view, get_view
'''
pymol=_self._pymol
if key=='*':
action = view_sc.auto_err(action,'action')
if action=='clear':
pymol._view_dict = {}
pymol._view_dict_sc = Shortcut(pymol._view_dict.keys())
else:
print " view: stored views:"
lst = pymol._view_dict.keys()
lst.sort()
parsing.dump_str_list(lst)
else:
action = view_sc.auto_err(action,'action')
if action=='recall':
key = pymol._view_dict_sc.auto_err(key,'view')
_self.set_view(pymol._view_dict[key],animate=animate)
if _feedback(fb_module.scene,fb_mask.actions,_self): # redundant
print " view: \"%s\" recalled."%key
elif (action=='store') or (action=='update'):
pymol._view_dict_sc.append(key)
pymol._view_dict[key]=_self.get_view(0)
if _feedback(fb_module.scene,fb_mask.actions,_self):
print " view: view "+action+"d as \"%s\"."%key
elif action=='clear':
key = pymol._view_dict_sc.auto_err(key,'view')
if pymol._view_dict.has_key(key):
del pymol._view_dict[key]
pymol._view_dict_sc = Shortcut(pymol._view_dict.keys())
if _feedback(fb_module.scene,fb_mask.actions,_self): # redundant
print " view: '%s' deleted."%key
def get_viewport(output=1, quiet=1, _self=cmd):
'''
DESCRIPTION
"get_viewport" returns and optionally prints out the screen viewport size
If a log file is currently open, get_viewport will not write the view
matrix to the screen unless the "output" parameter is 2.
USAGE
get_viewport [output]
ARGUMENTS
output = 0: output matrix to screen
output = 1: do not Output matrix to screen
output = 2: force output to screen even if log file is open
output = 3: return formatted string instead of a list
PYMOL API
cmd.get_viewport(output=1, quiet=1)
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.get_viewport(_self._COb)
finally:
_self.unlock(r,_self)
if is_ok(r):
if len(r):
if (_self.get_setting_legacy("logging")!=0.0) and (output<3):
if not quiet:
print " get_viewport: data written to log file."
_self.log("_ viewport (\\\n","cmd.viewport((\\\n")
_self.log("_ %14.9f, %14.9f )\n"% r)
if output<2: # suppress if we have a log file open
output=0
if output and (not quiet) and (output<3):
print "### cut below here and paste into script ###"
print "viewport %4d, %4d"% r
print "### cut above here and paste into script ###"
if output==3:
return ("viewport ( %14.9f, %14.9f )\n"% r)
elif _self._raising(r,_self):
raise QuietException
return r
def get_vis(_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.get_vis(_self._COb)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def set_vis(dict,_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.set_vis(_self._COb,dict)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def get_colorection(key,_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.get_colorection(_self._COb,key)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def set_colorection(dict,key,_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.set_colorection(_self._COb,dict,key)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def set_colorection_name(dict,key,new_key,_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.set_colorection_name(_self._COb,dict,key,new_key)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def del_colorection(dict,key,_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.del_colorection(_self._COb,dict,key)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def get_scene_dict(_self=cmd):
pymol=_self._pymol
r = DEFAULT_ERROR
try:
_self.lock(_self)
cpy = copy.deepcopy(pymol._scene_dict)
finally:
_self.unlock(r,_self)
return cpy
def get_scene_list(_self=cmd):
return copy.deepcopy(_scene_validate_list(_self))
scene_sort_dict = {
'F1' : 'F01',
'F2' : 'F02',
'F3' : 'F03',
'F4' : 'F04',
'F5' : 'F05',
'F6' : 'F06',
'F7' : 'F07',
'F8' : 'F08',
'F9' : 'F09',
'SHFT-F1' : 'SHFT-F01',
'SHFT-F2' : 'SHFT-F02',
'SHFT-F3' : 'SHFT-F03',
'SHFT-F4' : 'SHFT-F04',
'SHFT-F5' : 'SHFT-F05',
'SHFT-F6' : 'SHFT-F06',
'SHFT-F7' : 'SHFT-F07',
'SHFT-F8' : 'SHFT-F08',
'SHFT-F9' : 'SHFT-F09',
}
def _scene_get_unique_key(_self=cmd):
pymol=_self._pymol
keys = pymol._scene_dict.keys()
while 1:
key = "%03d"%pymol._scene_counter
if pymol._scene_dict.has_key(key):
pymol._scene_counter = pymol._scene_counter + 1
else:
break;
return key
def _scene_validate_list(_self=cmd):
pymol=_self._pymol
new_list = []
new_dict = {}
for a in pymol._scene_order:
if pymol._scene_dict.has_key(a) and not new_dict.has_key(a):
new_list.append(a)
new_dict[a] = 1
lst = map(lambda x:(scene_sort_dict.get(x,x),x), pymol._scene_dict.keys())
lst.sort()
lst = map(lambda x:x[1],lst)
for a in lst:
if not new_dict.has_key(a):
new_list.append(a)
pymol._scene_order = new_list
# update shortcuts
pymol._scene_dict_sc.rebuild( pymol._scene_dict.keys() )
# update PyMOL internally
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd._set_scene_names(_self._COb,pymol._scene_order)
finally:
_self.unlock(r,_self);
return pymol._scene_order
def chain_session(_self=cmd):
import os
# assumes locked interpreter
r = 0
session_file = str(_self.get("session_file"))
re_pat = re.compile("[0-9]+\.")
if len(session_file): # find next session file, if it exists
mo = re_pat.search(session_file)
if mo!=None:
pat = mo.group(0)
if len(pat):
file_no = int(float(pat)) + 1
new_form = r"%0"+str(len(pat)-1)+"d."
for new_num in range(file_no, file_no+11):
new_pat = new_form % new_num
new_file = re_pat.sub(new_pat, session_file)
# try both PSE and PSW
if not os.path.exists(new_file):
new_file = re.sub("\.pse$",".psw",new_file,re.I)
if not os.path.exists(new_file):
new_file = re.sub("\.psw$",".pse",new_file,re.I)
if os.path.exists(new_file):
_self.do("_ cmd.load(r'''"+new_file+"''',format='psw')")
return 1
return 0
def scene_order(names,sort=0,location='current',quiet=1,_self=cmd):
'''
DESCRIPTION
"scene_order" changes the ordering of scenes.
USAGE
scene_order names, sort, location
ARGUMENTS
names = string: a space-separated list of names
sort = yes or no {default: no}
location = top, current, or bottom {default: current}
EXAMPLES
scene_order *,yes
scene_order F6 F4 F3
scene_order 003 006 004, location=top
PYMOL API
cmd.scene_order(string names, string sort, string location)
SEE ALSO
scene
'''
pymol=_self._pymol
r = DEFAULT_ERROR
location=location_code[location_sc.auto_err(location,'location')]
if is_string(sort):
sort=boolean_dict[boolean_sc.auto_err(sort,'sort option')]
if is_string(names):
if names=='*':
names = _scene_validate_list(_self)
else:
names = names.split()
r = DEFAULT_SUCCESS
if len(names):
name_dict = {}
for name in names:
if not pymol._scene_dict.has_key(name):
print " Error: scene '%s' is not defined."%name
r = DEFAULT_ERROR
name_dict[name] = 1
if sort: # special F-key-name aware sort
sort_list = []
fkey_re = re.compile("[fF]([1-9][0-9]*).*")
for name in names:
mo = fkey_re.match(name)
if mo != None:
sort_list.append( ("F%02d\n"%int(mo.group(1)),name) )
else:
sort_list.append( (name,name) )
sort_list.sort()
names = []
for name in sort_list:
names.append(name[1])
if not is_error(r):
old_list = _scene_validate_list(_self)
if location < 0: # top
new_list = names
for name in old_list:
if not name_dict.has_key(name):
new_list.append(name)
pymol._scene_order = new_list
elif location == 0: # current
start = old_list.index(names[0])
if start >= 0: # guaranteed?
new_list = []
for name in old_list[:start]:
if not name_dict.has_key(name):
new_list.append(name)
new_list.extend(names)
for name in old_list[start:]:
if not name_dict.has_key(name):
new_list.append(name)
pymol._scene_order = new_list
else: # bottom
new_list = []
for name in old_list:
if not name_dict.has_key(name):
new_list.append(name)
new_list.extend(names)
pymol._scene_order = new_list
if _self._raising(r,_self):
raise pymol.CmdException
_scene_validate_list(_self) # force scene buttons to be updated
if not quiet and not is_error(r):
_self.scene('*')
return r
def scene(key='auto', action='recall', message=None, view=1,
color=1, active=1, rep=1, frame=1, animate=-1,
new_key=None, hand=1, quiet=1, _self=cmd):
'''
DESCRIPTION
"scene" saves and restores scenes. A scene consists of the camera
view, all object activity information, all atom-wise visibilities,
all atom-wise colors, all representations, the global frame index,
and may contain a text message to display on playback.
USAGE
scene [key [,action [, message, [ new_key=new-key-value ]]]]
ARGUMENTS
key = string, new, auto, or *: use new for an automatically
numbered new scene, use auto for the current scene (if one
exists), and use * for all scenes (clear and recall actions only).
action = store, recall, insert_after, insert_before, next,
previous, update, rename, or clear: (default = recall). If
rename, then a new_key argument must be explicitly defined.
message = string: a text message to display with the scene.
new_key = string: the new name for the scene
EXAMPLES
scene *
scene F1, store
scene F2, store, Please note the critical hydrogen bond shown in yellow.
scene F1
scene F2
scene F1, rename, new_key=F5
NOTES
Scenes F1 through F12 are automatically bound to function keys
provided that "set_key" has not been used to redefine the behaviour
of the respective key.
SEE ALSO
view, set_view, get_view
'''
pymol=_self._pymol
r = DEFAULT_SUCCESS
view = int(view)
rep = int(rep)
color = int(color)
active = int(active)
frame = int(frame)
quiet = int(quiet)
if not view:
animate=0
elif animate<0:
scene_animation = int(_self.get_setting_legacy("scene_animation"))
if scene_animation<0:
scene_animation = int(_self.get_setting_legacy("animation"))
if scene_animation!=0:
animate = _self.get_setting_legacy("scene_animation_duration")
else:
animate = 0
try:
_self.lock(_self) # manipulating global data, so need lock
if key=='auto':
action = scene_action_sc.auto_err(action,'action')
if action=='recall':
action='next'
if action=='start':
lst = _scene_validate_list(_self)
if len(lst):
key = lst[0]
action='recall'
if action == 'delete':
action='clear'
if action == 'append':
action='store'
if key=='*':
action = scene_action_sc.auto_err(action,'action')
if action=='clear':
for key in pymol._scene_dict.keys():
# free selections
scene_list = pymol._scene_dict[key]
if len(scene_list)>3:
colorection = scene_list[3]
if colorection!=None:
_self.del_colorection(colorection,key)
name = "_scene_"+key+"_*"
_self.delete(name)
pymol._scene_dict = {}
pymol._scene_order = []
_scene_validate_list(_self)
elif action in ['sort']:
_self.scene_order(key,1,quiet=quiet)
else:
print " scene: current order:"
lst = _scene_validate_list(_self)
parsing.dump_str_list(lst)
else:
action = scene_action_sc.auto_err(action,'action')
if action=='insert_before':
key = _scene_get_unique_key(_self=_self)
cur_scene = setting.get("scene_current_name",_self=_self)
_scene_validate_list(_self)
if cur_scene in pymol._scene_order:
ix = pymol._scene_order.index(cur_scene)
else:
ix = 0
pymol._scene_order.insert(ix,key)
action='store'
elif action=='rename':
if not pymol._scene_dict.has_key(key):
print "Error: scene '%s' not found."%key
elif new_key==None:
print "Error: must provide the 'new_key' argument"
elif new_key == key:
print "scene: '%s' not changed" % key
else:
new_scene_order = []
for a in pymol._scene_order:
if a==key:
new_scene_order.append(new_key)
else:
new_scene_order.append(a)
pymol._scene_order=new_scene_order
pymol._scene_dict[new_key] = pymol._scene_dict[key]
del pymol._scene_dict[key]
valid_names = _self.get_names("all")
for rep_name in rep_list:
name = "_scene_"+key+"_"+rep_name
if name in valid_names:
new_name = "_scene_"+new_key+"_"+rep_name
_self.set_name(name,new_name)
scene_list = pymol._scene_dict[new_key]
if len(scene_list)>3:
_self.set_colorection_name(scene_list[3],key,new_key)
print" scene: '%s' renamed to '%s'."%(key,new_key)
pymol._scene_dict_sc.rebuild( pymol._scene_dict.keys())
_self.set("session_changed",1,quiet=1)
_scene_validate_list(_self) # force update of scene buttons
elif action=='insert_after':
key = _scene_get_unique_key(_self=_self)
cur_scene = setting.get("scene_current_name",_self=_self)
_scene_validate_list(_self)
if cur_scene in pymol._scene_order:
ix = pymol._scene_order.index(cur_scene) + 1
else:
ix = len(pymol._scene_order)
pymol._scene_order.insert(ix,key)
action='store'
if action=='recall':
_self.set("scenes_changed",1,quiet=1);
key = pymol._scene_dict_sc.auto_err(key,'scene')
_self.set('scene_current_name', key, quiet=1)
scene_list = pymol._scene_dict[key]
ll = len(scene_list)
if (ll>1) and (active):
if scene_list[1]!=None:
_self.disable()
_self.deselect()
_self.set_vis(scene_list[1])
if (ll>2) and (frame):
if scene_list[2]!=None:
if not _self.get_movie_playing(): # don't set frame when movie is already playing
if _self.get_frame()!=scene_list[2]: # only set the frame when it isn't already correct
_self.frame(scene_list[2],scene=1) # let frame know that it is being set by a scene
else:
_self.set_frame(1,10) # seek scene
if (ll>3) and (color):
if scene_list[3]!=None:
_self.set_colorection(scene_list[3],key)
if (ll>4) and (rep):
if scene_list[4]==None:
rep = 0
if (ll>5) and (message==None):
if scene_list[5]!=None:
message=scene_list[5]
if rep!=0:
_self.hide("(all)")
valid_names = _self.get_names("all")
for rep_name in rep_list:
name = "_scene_"+key+"_"+rep_name
if name in valid_names:
_self.show(rep_name,name)
replace_flag = 0
wiz = _self.get_wizard()
if wiz!=None:
if str(wiz.__class__) == 'pymol.wizard.message.Message':
if hasattr(wiz,'from_scene'):
replace_flag = 1
mess_flag = 0
if message!=None:
if is_string(message):
if len(message):
if(replace_flag):
_self.replace_wizard("message",message)
else:
_self.wizard("message",message)
_self.get_wizard().from_scene = 1
mess_flag = 1
if is_list(message):
if len(message):
if(replace_flag):
apply(_self.replace_wizard,("message",)+tuple(message))
else:
apply(_self.wizard,("message",)+tuple(message))
_self.get_wizard().from_scene = 1
mess_flag = 1
if replace_flag and not mess_flag:
_self.wizard()
if (ll>0) and (view):
if scene_list[0]!=None:
_self.set_view(scene_list[0],animate,quiet,hand)
if not quiet and _feedback(fb_module.scene,fb_mask.actions,_self): # redundant
print " scene: \"%s\" recalled."%key
elif (action=='store') or (action=='update'):
if key =='new':
key=_scene_get_unique_key(_self=_self)
if key =='auto':
key = setting.get("scene_current_name",_self=_self)
if key=='':
key=_scene_get_unique_key(_self=_self)
if not pymol._scene_dict.has_key(key):
pymol._scene_dict_sc.append(key)
else: # get rid of existing one (if exists)
scene_list = pymol._scene_dict[key]
if (action=='update') and (message==None) and len(scene_list)>5:
message = pymol._scene_dict[key][5]
if len(scene_list)>3:
colorection = scene_list[3]
if colorection!=None:
_self.del_colorection(colorection,key) # important -- free RAM
name = "_scene_"+key+"_*"
_self.delete(name)
if key not in pymol._scene_order:
pymol._scene_order.append(key)
if rep:
for rep_name in rep_list:
name = "_scene_"+key+"_"+rep_name
_self.select(name,"rep "+rep_name)
if is_string(message):
if message:
if (message[0:1] in [ '"',"'"] and
message[-1:] in [ '"',"'"]):
message=message[1:-1]
else:
message = message.splitlines()
pymol._scene_dict[key] = [
_self.get_view(0) if view else None,
_self.get_vis() if active else None,
_self.get_frame() if frame else None,
_self.get_colorection(key) if color else None,
1 if rep else None,
message,
]
if _feedback(fb_module.scene,fb_mask.actions,_self):
print " scene: scene "+action+"d as \"%s\"."%key
_scene_validate_list(_self)
_self.set("scenes_changed",1,quiet=1);
_self.set('scene_current_name',key,quiet=1)
_self.set("session_changed",1,quiet=1)
elif action=='clear':
if key=='auto':
key = setting.get("scene_current_name",_self=_self)
if not key and _feedback(fb_module.scene,fb_mask.actions,_self):
print " scene: no current scene"
else:
key = pymol._scene_dict_sc.auto_err(key,'scene')
if pymol._scene_dict.has_key(key):
scene_list = pymol._scene_dict[key]
if len(scene_list)>3:
colorection = scene_list[3]
if colorection!=None:
_self.del_colorection(colorection,key) # important -- free RAM
lst = _scene_validate_list(_self)
if key == setting.get("scene_current_name",_self=_self):
ix = lst.index(key) - 1
if ix<0:
ix = lst.index(key) + 1
if ix>=0 and ix < len(lst):
setting.set("scene_current_name",lst[ix],quiet=1,_self=_self)
else:
setting.set("scene_current_name","",quiet=1,_self=_self)
_self.set("scenes_changed",1,quiet=1);
del pymol._scene_dict[key]
name = "_scene_"+key+"_*"
_self.delete(name)
_scene_validate_list(_self)
if _feedback(fb_module.scene,fb_mask.actions,_self):
print " scene: '%s' deleted."%key
_self.set("session_changed",1,quiet=1)
elif action=='next':
lst = _scene_validate_list(_self)
if (len(lst)==0) and cmd.get_movie_length()>0:
_self.do("mtoggle") # alternate SPACEBAR behavior if no scenes defined...
return
cur_scene = setting.get('scene_current_name',quiet=1,_self=_self)
if cur_scene in lst:
ix = lst.index(cur_scene) + 1
else:
ix = 0
animate = 0
if ((pymol._scene_quit_on_action==action) and
(setting.get("presentation",_self=_self)=="on") and
(setting.get("presentation_auto_quit",_self=_self)=="on")):
_self.quit()
if ix<len(lst):
scene_name = lst[ix]
_self.set('scene_current_name', scene_name, quiet=1)
scene(scene_name,'recall',animate=animate,_self=_self)
elif setting.get("scene_loop",_self=_self)=="on": # loop back to the beginning
if len(lst):
scene_name = lst[0]
_self.set('scene_current_name', scene_name, quiet=1)
scene(scene_name,'recall',animate=animate,_self=_self)
else: # otherwise put up blank screen
_self.set('scene_current_name','',quiet=1)
chained = 0
if (setting.get("presentation",_self=_self)=="on"):
chained = chain_session(_self)
if (not chained) and (setting.get("presentation_auto_quit",_self=_self)=="on"):
pymol._scene_quit_on_action = action
if not chained: # and len(lst):
_self.disable() # just hide everything
_self.wizard()
_self.mstop() # and stop movie from playing...
elif action=='previous':
lst = _scene_validate_list(_self)
cur_scene = setting.get('scene_current_name',quiet=1,_self=_self)
if cur_scene in lst:
ix = lst.index(cur_scene) - 1
else:
ix = len(lst)-1
animate = 0
if ((pymol._scene_quit_on_action==action) and
(setting.get("presentation",_self=_self)=="on") and
(setting.get("presentation_auto_quit",_self=_self)=="on")):
_self.quit()
elif setting.get("presentation",_self=_self)=="on":
if _self.get_movie_length()>0:
_self.mplay() # restart movie
if ix>=0:
scene_name = lst[ix]
scene(scene_name,'recall',animate=animate,hand=-1,_self=_self)
elif setting.get("scene_loop",_self=_self)=="on": # loop back to the end
print setting.get("scene_loop",_self=_self)
if len(lst):
scene_name = lst[-1]
_self.set('scene_current_name', scene_name, quiet=1)
scene(scene_name,'recall',animate=animate,hand=-1,_self=_self)
else: # otherwise put up blank screen
_self.set('scene_current_name','',quiet=1)
if ((setting.get("presentation",_self=_self)=="on") and
(setting.get("presentation_auto_quit",_self=_self)=="on")):
pymol._scene_quit_on_action = action
if len(lst):
_self.disable() # just hide everything
_self.wizard()
elif action=='order':
_self.scene_order(key,quiet=quiet)
elif action=='sort':
_self.scene_order(key,1,quiet=quiet)
elif action=='first':
_self.scene_order(key,location='top',quiet=quiet)
finally:
_self.unlock(r,_self)
return r
def session_save_views(session,_self=cmd):
pymol=_self._pymol
session['view_dict']=copy.deepcopy(pymol._view_dict)
return 1
def session_restore_views(session,_self=cmd):
pymol=_self._pymol
if session.has_key('view_dict'):
pymol._view_dict=copy.deepcopy(session['view_dict'])
pymol._view_dict_sc.rebuild(pymol._view_dict.keys())
return 1
def session_save_scenes(session,_self=cmd):
pymol=_self._pymol
session['scene_dict']=copy.deepcopy(pymol._scene_dict)
session['scene_order']=copy.deepcopy(pymol._scene_order)
return 1
def session_restore_scenes(session,_self=cmd):
pymol=_self._pymol
if session.has_key('scene_dict'):
pymol._scene_dict = copy.deepcopy(session['scene_dict'])
pymol._scene_dict_sc.rebuild(pymol._scene_dict.keys())
if session.has_key('scene_order'):
pymol._scene_order = copy.deepcopy(session['scene_order'])
else:
pymol._scene_order = []
_scene_validate_list(_self=_self)
return 1
def stereo(toggle='on', quiet=1, _self=cmd):
'''
DESCRIPTION
"stereo" activates or deactives stereo mode.
USAGE
stereo [toggle]
ARGUMENTS
toggle = on, off, crosseye, walleye, quadbuffer, sidebyside, or geowall
EXAMPLES
stereo on
stereo off
stereo crosseye
NOTES
"quadbuffer" is the default stereo mode if hardware stereo is available.
otherwise, "crosseye" is the default.
PYMOL API
cmd.stereo(string toggle)
'''
toggle = stereo_dict[stereo_sc.auto_err(str(toggle),'toggle')]
r = DEFAULT_ERROR
try:
_self.lock(_self)
if(toggle>0) : # stereo mode code
_self.set("stereo_mode",str(toggle),quiet=quiet)
toggle=1
r = _cmd.stereo(_self._COb,toggle)
if is_error(r):
print "Error: Selected stereo mode is not available."
finally:
_self.unlock(r,_self);
if _self._raising(r,_self): raise QuietException
return r
def turn(axis, angle, _self=cmd):
'''
DESCRIPTION
"turn" rotates the camera about one of the three primary axes,
centered at the origin.
USAGE
turn axis, angle
EXAMPLES
turn x, 90
turn y, 45
PYMOL API
cmd.turn(string axis, float angle)
SEE ALSO
move, rotate, translate, zoom, center, clip
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.turn(_self._COb,str(axis),float(angle))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def full_screen(toggle=-1, _self=cmd):
'''
DESCRIPTION
"full_screen" enables or disables full screen mode.
USAGE
full_screen [toggle]
EXAMPLES
full_screen
full_screen on
full_screen off
NOTES
This does not work correctly on all platforms. If you encounter
trouble, try using the maximize button on the viewer window
instead.
'''
toggle = toggle_dict[toggle_sc.auto_err(str(toggle),'toggle')]
if thread.get_ident() == pymol.glutThread:
try:
_self.lock(_self)
r = _cmd.full_screen(_self._COb,int(toggle))
finally:
_self.unlock(r,_self)
else:
try:
_self.lock(_self)
r = _self._do("_cmd.full_screen(_self._COb,%d)"%int(toggle))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def rock(mode=-1,_self=cmd):
'''
DESCRIPTION
"rock" toggles Y axis rocking.
USAGE
rock
PYMOL API
cmd.rock()
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.rock(_self._COb,int(mode))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def label(selection="(all)", expression="", quiet=1,_self=cmd):
'''
DESCRIPTION
"label" labels one or more atoms in a selection by evaluating an
Python expression referencing properties for each atom.
USAGE
label [ selection [, expression ]]
ARGUMENTS
selection = string: a selection-expression
expression = string: a Python expression that can be converted to a string
EXAMPLES
label chain A, chain
label name ca,"%s-%s" % (resn,resi)
label resi 200,"%1.3f" % partial_charge
NOTES
The symbols defined in the label name space for each atom are:
name, resi, resn, resv, chain, segi, model, alt, q, b, type,
index, rank, ID, ss, vdw, elec_radius, label, elem, geom,
flags, color, cartoon, valence, formal_charge, partial_charge,
numeric_type, text_type, stereo
All strings in the expression must be explicitly quoted.
This operation typically takes several seconds per thousand atoms
labelled.
To clear labels, simply omit the expression or set it to ''.
'''
# preprocess selection
selection = selector.process(selection)
#
r = DEFAULT_ERROR
try:
_self.lock(_self)
if len(str(expression))==0:
r= _cmd.label(_self._COb,"("+str(selection)+")",'',quiet)
else:
r = _cmd.label(_self._COb,"("+str(selection)+")",'label='+str(expression),quiet)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def label2(selection="(all)", expression="", quiet=1,_self=cmd):
# preprocess selection
selection = selector.process(selection)
#
r = DEFAULT_ERROR
try:
_self.lock(_self)
if len(str(expression))==0:
r= _cmd.label2(_self._COb,"("+str(selection)+")",'',quiet)
else:
r = _cmd.label2(_self._COb,"("+str(selection)+")",str(expression),quiet)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def window(action='show', x=0, y=0, width=0, height=0, _self=cmd):
'''
DESCRIPTION
"window" controls the visibility of PyMOL\'s output window
USAGE
window [ action [, x [, y [, width [, height ]]]]]
NOTES
This command is not fully implemented in MacPyMOL.
PYMOL API
cmd.window(string action, int x, int y, int width, int height)
'''
action = window_sc.auto_err(action,'action')
action = window_dict[str(action)]
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.window(_self._COb,action,int(x),int(y),int(width),int(height))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def viewport(width=-1,height=-1,_self=cmd):
'''
DESCRIPTION
"viewport" changes the size of the graphics display area.
USAGE
viewport width, height
PYMOL API
cmd.viewport(int width, int height)
'''
r = None
if cmd.is_string(width) and height < 0:
try:
width = eval(re.sub(r"[^0-9,\-\)\(\.]","",width))
except:
traceback.print_exc()
print "Error: bad viewport argument; should be 2 floats, width and height."
raise QuietException
if len(width)!=2:
print "Error: bad viewport argument; should be 2 floats, width and height."
raise QuietException
height = width[1]
width = width[0]
if not cmd.is_glut_thread():
_self.do("viewport %d,%d"%(int(width),int(height)),0)
else:
try:
_self.lock(_self)
r = _cmd.viewport(_self._COb,int(width),int(height))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def bg_color(color="black", _self=cmd):
'''
DESCRIPTION
"bg_color" sets the background color.
USAGE
bg_color [ color ]
ARGUMENTS
color = string: color name or number {default: black}
EXAMPLES
bg_color grey30
bg_color
NOTES
To obtain a transparent background, "unset opaque_background", and
then use "ray".
SEE ALSO
set_color, ray
PYMOL API
cmd.bg_color(string color)
'''
color = _self._interpret_color(_self,color)
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.bg_color(_self._COb,str(color))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
cartoon_dict = {
'skip' : -1,
'automatic' : 0,
'loop' : 1,
'rectangle' : 2,
'oval' : 3,
'tube' : 4,
'arrow' : 5,
'dumbbell' : 6,
'putty' : 7,
}
cartoon_sc = Shortcut(cartoon_dict.keys())
def cartoon(type, selection="(all)", _self=cmd):
'''
DESCRIPTION
"cartoon" changes the default cartoon representation for a set of atoms.
USAGE
cartoon type, selection
ARGUMENTS
type = automatic, skip, loop, rectangle, oval, tube, arrow, dumbbell
PYMOL API
cmd.cartoon(string type, string selection)
EXAMPLES
cartoon rectangle, chain A
cartoon skip, resi 145-156
NOTES
This command is rarely required since the default "automatic" mode
chooses cartoons according to the information in the PDB HELIX and
SHEET records.
'''
# preprocess selection
selection = selector.process(selection)
#
type = cartoon_dict[cartoon_sc.auto_err(str(type),'type')];
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.cartoon(_self._COb,"("+str(selection)+")",int(type))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def _ray(width,height,antialias,angle,shift,renderer,quiet,_self=cmd):
r = DEFAULT_ERROR
try:
_self.lock_without_glut(_self)
try:
_cmd.set_busy(_self._COb,1)
r = _cmd.render(_self._COb,int(width),int(height),
int(antialias),
float(angle),
float(shift),int(renderer),
int(quiet))
finally:
_cmd.set_busy(_self._COb,0)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def capture(quiet=1, _self=cmd):
_self.draw(antialias=-2,quiet=quiet)
def draw(width=0, height=0, antialias=-1, quiet=1, _self=cmd):
'''
DESCRIPTION
"draw" creates an OpenGL-based image of the current frame.
USAGE
draw [width [,height [,antialias ]]]
ARGUMENTS
width = integer {default: 0 (current)}
height = integer {default: 0 (current)}
antialias = integer {default: -1 (use antialias setting)}
EXAMPLES
draw
draw 1600
NOTES
Default width and height are taken from the current viewpoint. If
one is specified but not the other, then the missing value is
scaled so as to preserve the current aspect ratio.
Because this feature uses the OpenGL rendering context to piece
together the image, it does not work when running in the
command-line only mode.
On certain graphics hardware, "unset opaque_background" followed
by "draw" will produce an image with a transparent background.
However, better results can usually be obtained using "ray".
PYMOL API
cmd.draw(int width, int height, int antialias, int quiet)
SEE ALSO
ray, png, save
'''
# stop movies and sculpting if they're on...
if _self.get_movie_playing():
_self.mstop()
if int(_self.get_setting_legacy("sculpting"))!=0:
_self.set("sculpting","off",quiet=1)
# make sure that there aren't any pending display events
_self.refresh()
#
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.draw(_self._COb,int(width),int(height),
int(antialias),int(quiet))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def ray(width=0, height=0, antialias=-1, angle=0.0, shift=0.0,
renderer=-1, quiet=1, async=0, _self=cmd):
'''
DESCRIPTION
"ray" creates a ray-traced image of the current frame. This
can take some time (up to several minutes, depending on image
complexity).
USAGE
ray [width [,height [,antialias [,angle [,shift [,renderer [,quiet
[,async ]]]]]]]]]
ARGUMENTS
width = integer {default: 0 (current)}
height = integer {default: 0 (current)}
antialias = integer {default: -1 (use antialias setting)}
angle = float: y-axis rotation for stereo image generation
{default: 0.0}
shift = float: x-axis translation for stereo image generation
{default: 0.0}
renderer = -1, 0, 1, or 2: respectively, default, built-in,
pov-ray, or dry-run {default: 0}
async = 0 or 1: should rendering be done in a background thread?
EXAMPLES
ray
ray 1024,768
ray renderer=2
NOTES
Default width and height are taken from the current viewpoint. If
one is specified but not the other, then the missing value is
scaled so as to preserve the current aspect ratio.
angle and shift can be used to generate matched stereo pairs
renderer = 1 uses PovRay. This is Unix-only and you must have
"povray" in your path. It utilizes two two temporary files:
"tmp_pymol.pov" and "tmp_pymol.png".
See "help faster" for optimization tips with the builtin renderer.
See "help povray" for how to use PovRay instead of PyMOL\'s
built-in ray-tracing engine.
PYMOL API
cmd.ray(int width, int height, int antialias, float angle,
float shift, int renderer, int quiet, int async)
SEE ALSO
draw, png, save
'''
arg_tup = (int(width),int(height),
int(antialias),float(angle),
float(shift),int(renderer),int(quiet),_self)
# stop movies, rocking, and sculpting if they're on...
if _self.get_movie_playing():
_self.mstop()
if int(_self.get_setting_legacy("sculpting"))!=0:
_self.set("sculpting","off",quiet=1)
if _self.rock(-2)>0:
_self.rock(0)
#
r = DEFAULT_ERROR
if not async:
r = apply(_ray, arg_tup)
else:
render_thread = threading.Thread(target=_ray, args=arg_tup)
render_thread.setDaemon(1)
render_thread.start()
r = DEFAULT_SUCCESS
if _self._raising(r,_self): raise QuietException
return r
def refresh(_self=cmd):
'''
DESCRIPTION
"refresh" causes the scene to be redrawn as soon as the operating
system allows it to be done.
USAGE
refresh
PYMOL API
cmd.refresh()
SEE ALSO
rebuild
'''
r = None
if thread.get_ident() == pymol.glutThread:
try:
_self.lock(_self)
r = _cmd.refresh_now(_self._COb)
finally:
_self.unlock(r,_self)
else:
try:
_self.lock(_self)
r = _self._do("_ cmd._refresh(_self=cmd)",_self=_self)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def reset(object='',_self=cmd):
'''
DESCRIPTION
"reset" restores the rotation matrix to identity, sets the origin
to the center of mass (approx.) and zooms the window and clipping
planes to cover all objects. Alternatively, it can reset object
matrices.
USAGE
reset [ object ]
PYMOL API
cmd.reset()
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.reset(_self._COb,0,str(object))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def dirty(_self=cmd): # OBSOLETE?
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.dirty(_self._COb)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def meter_reset(_self=cmd):
'''
DESCRIPTION
"meter_reset" resets the frames per secound counter.
USAGE
meter_reset
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.reset_rate(_self._COb)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def load_png(filename, movie=1, stereo=-1, quiet=0, _self=cmd):
'''
DESCRIPTION
"load_png" loads and displays a PNG file from disk.
USAGE
load_png filename
NOTES
If the displayed image is too big for the window, it will be
reduced 2-fold repeatedly until it fits.
'''
r = DEFAULT_ERROR
filename = _self.exp_path(str(filename))
try:
_self.lock(_self)
r = _cmd.load_png(_self._COb,str(filename),int(movie),int(stereo),int(quiet))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def rebuild(selection='all',representation='everything',_self=cmd):
'''
DESCRIPTION
"rebuild" forces PyMOL to recreate geometric objects in
case any of them have gone out of sync.
USAGE
rebuild [selection [, representation ]]
ARGUMENTS
selection = string {default: all}
representation = string: {default: everything}
PYMOL API
cmd.rebuild(string selection, string representation)
SEE ALSO
refresh
'''
selection = selector.process(selection)
representation = repres_sc.auto_err(representation,'representation')
repn = repres[representation];
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.rebuild(_self._COb,selection,repn)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def recolor(selection='all', representation='everything', _self=cmd):
'''
DESCRIPTION
"recolor" forces reapplication of colors to existing objects.
USAGE
recolor [selection [, representation ]]
ARGUMENTS
selection = string {default: all}
representation = string {default: everything}
NOTES
This command often needs to be executed after "set_color" has been
used to redefine one or more existing colors.
PYMOL API
cmd.recolor(string selection = 'all', string representation = 'everything')
SEE ALSO
color, set_color
'''
selection = selector.process(selection)
representation = repres_sc.auto_err(representation,'representation')
repn = repres[representation];
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.recolor(_self._COb,selection,repn)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def color(color, selection="(all)", quiet=1, flags=0, _self=cmd):
'''
DESCRIPTION
"color" changes the color of objects or atoms.
USAGE
color color [, selection ]
ARGUMENTS
color = string: color name or number
selection = string: selection-expression or name-pattern
corresponding to the atoms or objects to be colored
{default: (all)}.
NOTES
When using color ramps, the ramp can be used as a color.
PYMOL API
cmd.color(string color, string selection, int quiet)
SEE ALSO
set_color, recolor
EXAMPLE
color cyan
color yellow, chain A
'''
# preprocess selection
selection = selector.process(selection)
color = _self._interpret_color(_self,str(color))
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.color(_self._COb,str(color),str(selection),int(flags),int(quiet))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def spectrumany(expression, colors, selection='(all)', minimum=None,
maximum=None, quiet=1, _self=cmd):
'''
DESCRIPTION
Pure python implementation of the spectrum command. Supports arbitrary
color lists instead of palettes and any numerical atom property which
works in iterate as expression.
Non-numeric values (like resn) will be enumerated.
This is not a separate PyMOL command but is used as a fallback in "spectrum".
'''
from . import CmdException
if ' ' not in colors:
colors = palette_colors_dict.get(colors) or colors.replace('_', ' ')
quiet, colors = int(quiet), colors.split()
n_colors = len(colors)
if n_colors < 2:
raise CmdException('please provide at least 2 colors')
col_tuples = [_self.get_color_tuple(i) for i in colors]
if None in col_tuples:
raise CmdException('unknown color')
expression = {'pc': 'partial_charge', 'fc': 'formal_charge',
'resi': 'resv'}.get(expression, expression)
if expression == 'count':
e_list = range(_self.count_atoms(selection))
else:
e_list = []
_self.iterate(selection, 'e_list.append(%s)' % (expression), space=locals())
try:
v_list = [float(v) for v in e_list if v is not None]
except (TypeError, ValueError):
if not quiet:
print ' Spectrum: Expression is non-numeric, enumerating values'
v_list = e_list = map(sorted(set(e_list)).index, e_list)
if not v_list:
return (0., 0.)
if minimum is None: minimum = min(v_list)
if maximum is None: maximum = max(v_list)
r = minimum, maximum = float(minimum), float(maximum)
if not quiet:
print ' Spectrum: range (%.5f to %.5f)' % r
val_range = maximum - minimum
if not val_range:
_self.color(colors[0], selection)
return r
e_it = iter(e_list)
def next_color():
v = e_it.next()
if v is None:
return False
v = min(1.0, max(0.0, (float(v) - minimum) / val_range)) * (n_colors - 1)
i = min(int(v), n_colors - 2)
p = v - i
rgb = [int(255 * (col_tuples[i+1][j] * p + col_tuples[i][j] * (1.0 - p)))
for j in range(3)]
return 0x40000000 + rgb[0] * 0x10000 + rgb[1] * 0x100 + rgb[2]
_self.alter(selection, 'color = next_color() or color', space=locals())
_self.recolor(selection)
return r
def spectrum(expression="count", palette="rainbow",
selection="(all)", minimum=None, maximum=None,
byres=0, quiet=1, _self=cmd):
'''
DESCRIPTION
"spectrum" colors atoms with a spectrum of colors based on an atomic
property.
USAGE
spectrum [expression [, palette [, selection [, minimum [, maximum [, byres ]]]]]]
ARGUMENTS
expression = count, b, q, or pc: respectively, atom count, temperature factor,
occupancy, or partial charge {default: count}
palette = string: palette name or space separated list of colors
{default: rainbow}
selection = string: atoms to color {default: (all)}
minimum = float: {default: None (automatic)}
maximum = float: {default: None (automatic)}
byres = integer: controls whether coloring is applied per-residue {default: 0}
EXAMPLES
spectrum b, blue_red, minimum=10, maximum=50
spectrum count, rainbow_rev, chain A, byres=1
NOTES
Available palettes include:
blue_green blue_magenta blue_red blue_white_green
blue_white_magenta blue_white_red blue_white_yellow blue_yellow
cbmr cyan_magenta cyan_red cyan_white_magenta cyan_white_red
cyan_white_yellow cyan_yellow gcbmry green_blue green_magenta
green_red green_white_blue green_white_magenta green_white_red
green_white_yellow green_yellow green_yellow_red magenta_blue
magenta_cyan magenta_green magenta_white_blue
magenta_white_cyan magenta_white_green magenta_white_yellow
magenta_yellow rainbow rainbow2 rainbow2_rev rainbow_cycle
rainbow_cycle_rev rainbow_rev red_blue red_cyan red_green
red_white_blue red_white_cyan red_white_green red_white_yellow
red_yellow red_yellow_green rmbc yellow_blue yellow_cyan
yellow_cyan_white yellow_green yellow_magenta yellow_red
yellow_white_blue yellow_white_green yellow_white_magenta
yellow_white_red yrmbcg
PYMOL API
def spectrum(string expression, string palette,
string selection, float minimum, float maximum,
int byres, int quiet)
'''
palette_hit = palette_sc.shortcut.get(palette)
if palette_hit:
palette = palette_hit
if expression not in ('count', 'b', 'q', 'pc') or not palette_hit:
return spectrumany(expression, palette, selection,
minimum, maximum, quiet, _self)
(prefix,digits,first,last) = palette_dict[str(palette)]
if (maximum==None) or (minimum==None):
minimum = 0 # signal to auto-adjust levels
maximum = -1
# preprocess selection
selection = selector.process(selection)
#
r = DEFAULT_ERROR
try:
_self.lock(_self)
r = _cmd.spectrum(_self._COb,str(selection),str(expression),
float(minimum),float(maximum),
int(first),int(last),str(prefix),
int(digits),int(byres),int(quiet))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
def set_color(name, rgb, mode=0, quiet=1, _self=cmd):
'''
DESCRIPTION
"set_color" defines a new color using the red, green, and blue
(RGB) color components.
USAGE
set_color name, rgb
ARGUMENTS
name = string: name for the new or existing color
rgb = list of numbers: [red, green, blue] each and all in the range
(0.0, 1.0) or (0, 255)
EXAMPLES
set_color red, [ 1.0, 0.0, 0.0 ]
set_color yellow, [ 255, 255, 0 ]
NOTES
PyMOL automatically infers the range based on the input arguments.
It may be necessary to issue "recolor" command in order to force
recoloring of existing objects.
SEE ALSO
recolor
PYMOL API
cmd.set_color(string name, list-of-numbers rgb, int mode )
'''
r = DEFAULT_ERROR
if _self.is_string(rgb):
rgb = safe_list_eval(rgb)
if not (isinstance(rgb,types.ListType) or isinstance(rgb,types.TupleType)):
print "Error: color specification must be a list such as [ 1.0, 0.0, 0.0 ]"
elif len(rgb)!=3:
print "Error: color specification must be a list such as [ 1.0, 0.0, 0.0 ]"
else:
rgb = [float(rgb[0]),float(rgb[1]),float(rgb[2])]
if (rgb[0]>1.0) or (rgb[1]>1.0) or (rgb[2]>1.0):
# these days, we'll accept 0-1 or 0-255, so long as [1,1,1] is white
rgb[0] = rgb[0]/255.0
rgb[1] = rgb[1]/255.0
rgb[2] = rgb[2]/255.0
try:
_self.lock(_self)
if len(rgb)==3:
r = _cmd.colordef(_self._COb,str(name),rgb[0],rgb[1],rgb[2],int(mode),int(quiet))
_self._invalidate_color_sc(_self)
else:
print "Error: invalid color."
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise QuietException
return r
# Aliases for Mother England.
colour = color
set_colour = set_color
bg_colour = bg_color
recolour = recolor
import setting
|