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
|
package Demeter::Data;
=for Copyright
.
Copyright (c) 2006-2019 Bruce Ravel (http://bruceravel.github.io/home).
All rights reserved.
.transmission
This file is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See The Perl
Artistic License.
.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
=cut
use Carp;
use File::Basename;
use List::MoreUtils qw(any);
use Demeter::Constants qw($NUMBER $PI $NULLFILE $EPSILON3 $EPSILON6);
use Scalar::Util qw(looks_like_number);
use YAML::Tiny;
use Moose;
extends 'Demeter';
#with 'MooseX::Clone';
with 'Demeter::Data::Arrays';
with 'Demeter::Data::Athena';
with 'Demeter::Data::Beamlines';
with 'Demeter::Data::Defaults';
with 'Demeter::Data::E0';
with 'Demeter::Data::FT';
with 'Demeter::Data::IO';
with 'Demeter::Data::Mu';
with 'Demeter::Data::Parts';
with 'Demeter::Data::Plot';
with 'Demeter::Data::Process';
with 'Demeter::Data::SelfAbsorption';
with 'Demeter::Data::Units';
with 'Demeter::Data::XDI';
if ($Demeter::mode->ui eq 'screen') {
with 'Demeter::UI::Screen::Progress';
};
with 'MooseX::Quenchable';
use MooseX::Aliases;
#use MooseX::AlwaysCoerce; # this might be useful....
use Moose::Util::TypeConstraints;
use MooseX::Types::LaxNum;
use Demeter::StrTypes qw( Element
Edge
Clamp
FitSpace
Window
Empty
DataType
FileName
);
use Demeter::NumTypes qw( Natural
PosInt
PosNum
NonNeg
);
with 'Demeter::UI::Screen::Pause' if ($Demeter::mode->ui eq 'screen');
## To do: triggers for keeping min/max pairs in the right order, respecting the complicated configuration rules
has '+plottable' => (default => 1);
has '+data' => (isa => Empty.'|Demeter::Data');
has 'is_mc' => (is => 'ro', isa => 'Bool', default => 0); # is not Demeter::Data::MultiChannel
has 'tag' => (is => 'rw', isa => 'Str', default => q{});
has 'cv' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'collided' => (is => 'rw', isa => 'Bool', default => 0);
has 'file' => (is => 'rw', isa => FileName, default => $NULLFILE,
trigger => sub{my ($self, $new) = @_;
if ($new and ($new ne $NULLFILE)) {
$self->update_data(1);
$self->source($new) if $self->source eq $NULLFILE;
};
});
has 'unreadable' => (is => 'rw', isa => 'Bool', default => 0);
has 'source' => (is => 'rw', isa => 'Str', default => $NULLFILE,);
has 'prjrecord' => (is => 'rw', isa => 'Str', default => q{});
has 'read_as_raw' => (is => 'rw', isa => 'Bool', default => 0);
has 'from_athena' => (is => 'rw', isa => 'Bool', default => 0);
has 'from_yaml' => (is => 'rw', isa => 'Bool', default => 0);
subtype 'FitSum'
=> as 'Str'
=> where { lc($_) =~ m{\A(?:\s*|fit|sum)\z} }
=> message { "This is either a fit or a sum." };
has 'fitsum' => (is => 'rw', isa => 'FitSum', default => q{});
has 'fitting' => (is => 'rw', isa => 'Bool', default => 0);
has 'plotkey' => (is => 'rw', isa => 'Str', default => q{});
has 'forcekey' => (is => 'rw', isa => 'Bool', default => 0);
has 'marked' => (is => 'rw', isa => 'Bool', default => 0);
has 'quickmerge' => (is => 'rw', isa => 'Bool', default => 0);
has 'provenance' => (is => 'rw', isa => 'Str', default => q{});
has 'annotation' => (is => 'rw', isa => 'Str', default => q{});
has 'importance' => (is => 'rw', isa => 'LaxNum', default => 1);
has 'merge_weight'=> (is => 'rw', isa => 'LaxNum', default => 1);
has 'is_z' => (is => 'rw', isa => Element.'|'.Empty);
has 'is_edge' => (is => 'rw', isa => Edge.'|'.Empty);
has 'is_edge_margin' => (is => 'rw', isa => 'LaxNum', default => 15);
has 'tying' => (is=>'rw', isa => 'Bool', default => 0);
has 'reference' => (is => 'rw', isa => Empty.'|Demeter::Data', default => q{},
trigger => sub{ my ($self, $new) = @_;
$self->tie_reference($new) if not $self->tying;
$self->tying(0);
$self->referencegroup($new->group) if (ref($new) =~ m{Demeter});
},
);
has 'referencegroup' => (is => 'rw', isa => 'Str', default => q{});
## -------- column selection attributes
has $_ => (is => 'rw', isa => 'Str', default => q{},
trigger => sub{ my ($self, $new) = @_;
if ($new) {
$self->datatype('xmu') if $self->denominator;
$self->datatype('xmu') if $self->datatype eq 'chi';
$self->update_columns(1);
$self->is_col(1)
}
})
foreach (qw(energy numerator));
has denominator => (is => 'rw', isa => 'Str', default => q{1},
trigger => sub{ my ($self, $new) = @_;
if ($new and $self->numerator) {
$self->datatype('xmu');
$self->update_columns(1);
$self->is_col(1)
}
});
has 'chi_column' => (is => 'rw', isa => 'Str', default => q{},
trigger => sub{ my ($self, $new) = @_;
if ($new) {
$self->datatype('chi') if $self->datatype ne 'chi';
$self->update_columns(1);
$self->is_col(1)
}
});
has $_ => (is => 'rw', isa => 'LaxNum', default => 0) foreach (qw(i0_scale signal_scale));
has $_ => (is => 'rw', isa => 'Str', default => q{})
foreach (qw(columns energy_string xmu_string i0_string signal_string chi_string));
has 'ln' => (is => 'rw', isa => 'Bool', default => 0,
trigger => sub{ my ($self, $new) = @_; $self->update_columns(1), $self->is_col(1) if $new});
has 'inv' => (is => 'rw', isa => 'Bool', default => 0,
trigger => sub{ my ($self, $new) = @_; $self->update_columns(1), $self->is_col(1) if $new});
has 'multiplier' => (is => 'rw', isa => 'LaxNum', default => 1,
trigger => sub{ my ($self, $new) = @_; $self->update_columns(1), $self->is_col(1) if $new});
has 'display' => (is => 'rw', isa => 'Bool', default => 0,);
## -------- data type flags
has 'datatype' => (is => 'rw', isa => Empty.'|'.DataType, default => q{},
trigger => sub{shift->explain_recordtype},
);
has $_ => (is => 'rw', isa => 'Bool', default => 0, trigger => sub{shift->explain_recordtype},)
foreach (qw(is_col is_nor is_kev is_pixel is_special is_fit));
has 'is_merge' => (is => 'rw', isa => 'Str', default => q{});
#foreach (qw(is_col is_xmu is_xmudat is_chi is_nor is_xanes is_merge));
has 'generated' => (is => 'rw', isa => 'Bool', default => 0,
trigger => sub{ my ($self, $new) = @_;
$self->update_data(0);
$self->update_columns(0);
$self->is_col(0);
$self->columns(q{});
$self->energy(q{});
$self->numerator(q{});
$self->denominator(q{});
$self->ln(0);
$self->energy_string(q{});
$self->xmu_string(q{});
$self->signal_string(q{});
$self->i0_string(q{});
$self->file(q{});
});
has 'rebinned' => (is => 'rw', isa => 'Bool', default => 0,);
## -------- stuff for about dialog
has 'recordtype' => (is => 'rw', isa => 'Str', default => q{});
has 'plotspaces' => (is => 'rw', isa => 'Str', default => q{any});
has 'npts' => (is => 'rw', isa => 'Int', default => 0);
has 'xmax' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'xmin' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'epsk' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'epsr' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'recommended_kmax' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'nknots' => (is => 'rw', isa => 'LaxNum', default => 0);
has 'maxk' => (is => 'rw', isa => 'LaxNum', default => 0);
## -------- data processing status flags
has 'update_data' => (is => 'rw', isa => 'Bool', default => 1,
trigger => sub{ my($self, $new) = @_; $self->update_columns(1) if $new});
has 'update_columns' => (is => 'rw', isa => 'Bool', default => 1,
trigger => sub{ my($self, $new) = @_; $self->update_norm(1) if $new});
has 'update_norm' => (is => 'rw', isa => 'Bool', default => 1,
trigger => sub{ my($self, $new) = @_; $self->update_bkg(1) if $new});
has 'update_bkg' => (is => 'rw', isa => 'Bool', default => 1,
trigger => sub{ my($self, $new) = @_; $self->update_fft(1) if $new;});
has 'update_fft' => (is => 'rw', isa => 'Bool', default => 1,
trigger => sub{ my($self, $new) = @_; $self->update_bft(1) if $new});
has 'update_bft' => (is => 'rw', isa => 'Bool', default => 1);
has 'nidp' => (is => 'rw', isa => 'LaxNum', default => 0);
## -------- background removal parameters
has 'bkg_algorithm' => (is => 'rw', isa => 'Str', default => 'autobk',
traits => [ qw(Quenchable) ],
);
has 'bkg_e0' => (is => 'rw', isa => 'LaxNum', default => 0,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1), $self->update_norm(1) });
has 'bkg_e0_fraction' => (is => 'rw', isa => PosNum, default => sub{ shift->co->default("bkg", "e0_fraction") || 0.5},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1); $self->update_norm(1) });
has 'bkg_eshift' => (is => 'rw', isa => 'LaxNum', default => 0,
alias => 'eshift',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_;
#$self->fetch_delta_eshift;
$self->update_bkg(1);
$self->update_norm(1);
$self->shift_reference if not $self->tying;
$self->tying(0); # prevent deep recursion
});
has 'bkg_delta_eshift'=> (is => 'rw', isa => 'LaxNum', default => 0, traits => [ qw(Quenchable) ],);
has 'bkg_kw' => (is => 'rw', isa => NonNeg, default => sub{ shift->co->default("bkg", "kw") || 1},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1) });
has 'bkg_rbkg' => (is => 'rw', isa => PosNum, default => sub{ shift->co->default("bkg", "rbkg") || 1},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1); $self->set_nknots; });
has 'bkg_dk' => (is => 'rw', isa => NonNeg, default => sub{ shift->co->default("bkg", "dk") || 1},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1) });
has 'bkg_pre1' => (is => 'rw', isa => 'LaxNum', default => sub{ shift->co->default("bkg", "pre1") || -150},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1); $self->update_norm(1) });
has 'bkg_pre2' => (is => 'rw', isa => 'LaxNum', default => sub{ shift->co->default("bkg", "pre2") || -30},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1); $self->update_norm(1) });
has 'bkg_nor1' => (is => 'rw', isa => 'LaxNum', default => sub{ shift->co->default("bkg", "nor1") || 150},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1); $self->update_norm(1) });
has 'bkg_nor2' => (is => 'rw', isa => 'LaxNum', default => sub{ shift->co->default("bkg", "nor2") || 400},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1); $self->update_norm(1) });
has 'bkg_spl1' => (is => 'rw', isa => 'LaxNum',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_;
$self->update_bkg(1);
$self->spline_range("spl1") if not $self->tying;
$self->tying(0);
},
default => sub{ shift->co->default("bkg", "spl1") || 0});
has 'bkg_spl2' => (is => 'rw', isa => 'LaxNum',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_;
$self->update_bkg(1);
$self->spline_range("spl2") if not $self->tying;
$self->tying(0);
},
default => sub{ shift->co->default("bkg", "spl2") || 0});
has 'bkg_spl1e' => (is => 'rw', isa => 'LaxNum',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_;
$self->update_bkg(1);
$self->spline_range("spl1e") if not $self->tying;
$self->tying(0);
},
default => 0);
has 'bkg_spl2e' => (is => 'rw', isa => 'LaxNum',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_;
$self->update_bkg(1);
$self->spline_range("spl2e") if not $self->tying;
$self->tying(0);
},
default => 0);
has 'bkg_kwindow' => (is => 'rw', isa => Window, default => sub{ shift->co->default("bkg", "kwindow") || 'hanning'},
traits => [ qw(Quenchable) ],
coerce => 1,
trigger => sub{ my($self, $new) = @_; $self->update_bkg(1) });
has $_ => (is => 'rw', isa => 'LaxNum', default => 0) foreach (qw(bkg_slope bkg_int bkg_fitted_step bkg_nc0 bkg_nc1 bkg_nc2 bkg_nc3 bkg_former_e0));
has $_ => (is => 'rw', isa => 'Bool', default => 0) foreach (qw(bkg_tie_e0 bkg_cl));
has 'bkg_step' => (is => 'rw', isa => 'LaxNum', default => 0,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_norm(1) });
has 'bkg_fixstep' => (is => 'rw', isa => 'Bool', default => 0,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_norm(1) });
has 'bkg_z' => (is => 'rw', isa => Element, default => 'H',
traits => [ qw(Quenchable) ],
);
has 'bkg_stan' => (is => 'rw', isa => 'Str', default => 'None',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1) });
has 'bkg_flatten' => (is => 'rw', isa => 'Bool', default => sub{ shift->co->default("bkg", "flatten")},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_norm(1) });
has 'bkg_funnorm' => (is => 'rw', isa => 'Bool', default => 0,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1), $self->update_norm(1) });
has 'bkg_nnorm' => (is => 'rw', isa => PosInt, default => sub{ shift->co->default("bkg", "nnorm") || 3},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1), $self->update_norm(1) });
has 'bkg_clamp1' => (is => 'rw', isa => Natural, default => sub{ shift->co->default("bkg", "clamp1") || 0},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1) });
has 'bkg_clamp2' => (is => 'rw', isa => Natural, default => sub{ shift->co->default("bkg", "clamp2") || 24},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1) });
has 'bkg_nclamp' => (is => 'rw', isa => PosInt, default => sub{ shift->co->default("bkg", "nclamp") || 5},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bkg(1) });
## -------- foreward Fourier transform parameters
has 'fft_edge' => (is => 'rw', isa => Edge, default => 'K', coerce => 1,
traits => [ qw(Quenchable) ],
);
has 'fft_kmin' => (is => 'rw', isa => 'LaxNum',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1); $self->_nidp},
default => sub{ shift->co->default("fft", "kmin") || 3});
has 'fft_kmax' => (is => 'rw', isa => 'LaxNum',
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1); $self->_nidp},
default => sub{ shift->co->default("fft", "kmax") || -2});
has 'fft_dk' => (is => 'rw', isa => NonNeg, default => sub{ shift->co->default("fft", "dk") || 2},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1)});
has 'fft_kwindow' => (is => 'rw', isa => Window, default => sub{ shift->co->default("fft", "kwindow") || 'hanning'},
coerce => 1,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1)});
has 'fft_pc' => (is => 'rw', isa => 'Any', default => sub{ shift->co->default("fft", "pc") || 0},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1)});
has 'fft_pctype' => (is => 'rw', isa => 'Str', default => "central", # "path"
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1)});
has 'fft_pcpath' => (is => 'rw', isa => 'Any', # isa => Empty.'|Demeter::Path',
default => q{},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self, $new) = @_; $self->update_fft(1); $self->fft_pcpathgroup($new->group) if $new;});
has 'fft_pcpathgroup' => (is => 'rw', isa => 'Str', default => q{},);
has 'rmax_out' => (is => 'rw', isa => PosNum, default => sub{ shift->co->default("fft", "rmax_out") || 10},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_fft(1)});
## -------- backward Fourier transform parameters
has 'bft_rwindow' => (is => 'rw', isa => Window, default => sub{ shift->co->default("bft", "rwindow") || 'hanning'},
coerce => 1,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bft(1)});
has 'bft_rmin' => (is => 'rw', isa => NonNeg,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bft(1); $self->_nidp},
default => sub{ shift->co->default("bft", "rmin") || 1});
has 'bft_rmax' => (is => 'rw', isa => PosNum,
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bft(1); $self->_nidp},
default => sub{ shift->co->default("bft", "rmax") || 3});
has 'bft_dr' => (is => 'rw', isa => NonNeg, default => sub{ shift->co->default("bft", "dr") || 0.2},
traits => [ qw(Quenchable) ],
trigger => sub{ my($self) = @_; $self->update_bft(1)});
## -------- fitting parameters
has 'fit_k1' => (is => 'rw', isa => 'Bool', default => sub{ shift->co->default("fit", "k1") || 1}, traits => [ qw(Quenchable) ],);
has 'fit_k2' => (is => 'rw', isa => 'Bool', default => sub{ shift->co->default("fit", "k2") || 1}, traits => [ qw(Quenchable) ],);
has 'fit_k3' => (is => 'rw', isa => 'Bool', default => sub{ shift->co->default("fit", "k3") || 1}, traits => [ qw(Quenchable) ],);
has 'fit_karb' => (is => 'rw', isa => 'Bool', default => sub{ shift->co->default("fit", "karb") || 0}, traits => [ qw(Quenchable) ],);
has 'fit_karb_value' => (is => 'rw', isa => NonNeg, default => sub{ shift->co->default("fit", "karb_value") || 0}, traits => [ qw(Quenchable) ],);
has 'fit_space' => (is => 'rw', isa => FitSpace, default => sub{ shift->co->default("fit", "space") || 'r'}, coerce => 1, traits => [ qw(Quenchable) ],);
has 'fit_epsilon' => (is => 'rw', isa => 'LaxNum', default => 0, traits => [ qw(Quenchable) ],);
has 'fit_cormin' => (is => 'rw', isa => NonNeg, default => sub{ shift->co->default("fit", "cormin") || 0.4}, traits => [ qw(Quenchable) ],);
has 'fit_include' => (is => 'rw', isa => 'Bool', default => 1);
has 'fit_data' => (is => 'rw', isa => Natural, default => 0);
has 'fit_plot_after_fit' => (is => 'rw', isa => 'Bool', default => 0);
has 'fit_do_bkg' => (is => 'rw', isa => 'Bool', default => 0, traits => [ qw(Quenchable) ],);
has 'fit_rfactor1' => (is => 'rw', isa => 'LaxNum', default => 0, );
has 'fit_rfactor2' => (is => 'rw', isa => 'LaxNum', default => 0, );
has 'fit_rfactor3' => (is => 'rw', isa => 'LaxNum', default => 0, );
has 'titles' => (is => 'rw', isa => 'ArrayRef', default => sub{ [] }, traits => [ qw(Quenchable) ],);
has 'fit_group' => (is => 'rw', isa => 'Str', default => q{}, );
## -------- plotting parameters
has 'y_offset' => (is => 'rw', isa => 'LaxNum', default => 0, traits => [ qw(Quenchable) ],);
has 'plot_multiplier' => (is => 'rw', isa => 'LaxNum', default => 1, traits => [ qw(Quenchable) ],);
#has 'bla_npixels' => (is => 'rw', isa => 'Int', default => 0,);
sub BUILD {
my ($self, @params) = @_;
$self->data($self); # I do not know of a way to set the data attribute to this instance using "has"....
$self->tag($self->group);
if (ref($self) =~ m{Data\z}) {
$self->mo->push_Data($self);
my $thiscv = $self->mo->datacount;
$self->cv($thiscv);
++$thiscv if ($self->group ne 'default___');
$self->mo->datacount($thiscv);
};
};
sub DEMOLISH {
my ($self) = @_;
## It seems as though this is getting called when I discard the
## group AND when perl is doing its final clean up. I guess I don't
## quite understand how perl & Moose shut down... Anyway, the
## following is essentially a check to see if this block of code has
## already been called for this Data object and avoid revivifying
## it. But I still get the chance to clean up the Larch group
## before leaving, so I can leave a tidy server alive and running.
return if not Demeter->mo;
return if not Demeter->mo->fetch('Data', $self->group);
if ($self->is_larch and ($self->group ne 'default___')) {
$self->dispense('process', 'erase', {items=>$self->group});
};
$self->alldone;
};
sub discard {
my ($self) = @_;
$self->dispense('process', 'erase', {items=>"\@group " . $self->group});
$self->DEMOLISH;
};
override alldone => sub {
my ($self) = @_;
if ($self->reference) {
my $ref = $self->reference;
$ref->reference(q{});
$self->reference(q{});
};
$self->remove;
return $self;
};
override all => sub {
my ($self) = @_;
my %all = $self->SUPER::all;
#foreach my $k (keys %all) {
# delete $all{$k} if $k =~ m {\Axdi};
#};
delete $all{fft_pcpath};
delete $all{is_mc};
delete $all{xdi};
delete $all{fit_group};
delete $all{bkg_funnorm} if not Demeter->co->default('athena', 'show_funnorm'); # preserve backwards compatability before 0.9.23
delete $all{is_z}; # do not save these to the project file ... must be explicitly used
delete $all{is_edge};
delete $all{is_edge_margin};
return %all;
};
override Clone => sub {
my ($self, @arguments) = @_;
$self->_update('background');
$self->_update('fft') if ($self->datatype =~ m{(?:xmu|chi)});
my $new = $self->SUPER::Clone();
my $standard = $self->get_mode('standard');
$new -> standard;
$self -> dispense("process", "clone");
if (ref($standard) =~ m{Data}) {
$standard->standard;
} else {
$new -> unset_standard;
};
$new -> dispense("process", "deriv");
$new -> update_data(0);
$new -> update_columns(0);
$new -> update_norm($self->datatype =~ m{(?:xmu|xanes)});
$new -> update_fft($self->datatype =~ m{(?:xmu|chi)});
my ($old_group, $new_group) = ($self->group, $new->group);
foreach my $att (qw(energy_string i0_string signal_string xmu_string)) {
my $newval = $self->$att;
$newval =~ s{$old_group}{$new_group}g;
$new->$att($newval);
};
## data from Athena
if ((ref($self) =~ m{Data}) and $self->from_athena) {
$new -> data($new);
$new -> provenance("cloned");
## mu(E) data from a file
} elsif (ref($self) =~ m{Data}) {
$new -> data($new);
$new -> provenance("cloned");
};
$new->set(@arguments);
my $newtag = $new->cv || $new->group;
$new->tag( $newtag );
return $new;
};
sub about {
my ($self) = @_;
$self->_update('bft');
my $string = $self->template("process", "about");
return $string;
};
sub _nidp {
my $self = shift;
$self->nidp( 2*($self->fft_kmax - $self->fft_kmin)*($self->bft_rmax - $self->bft_rmin)/$PI );
}
sub chi_noise {
my ($self) = @_;
#return $self if $self->fit_group;
$self->maxk($self->fft_kmax) if ($self->maxk < $self->fft_kmin);
$self->dispense("process", "chi_noise");
my $epsk = $self->fetch_scalar("epsilon_k");
$epsk = (looks_like_number($epsk)) ? $epsk : 1;
$epsk = ($epsk =~ m{nan|\#}i) ? 1 : $epsk; # unix returns '+/-NaN', windows returns '+/-1.#IOe000'
my $epsr = $self->fetch_scalar("epsilon_r");
$epsr = (looks_like_number($epsr)) ? $epsr : 1;
$epsr = ($epsk =~ m{nan|\#}i) ? 1 : $epsr;
$self->epsk( sprintf("%.3e", $epsk) );
$self->epsr( sprintf("%.3e", $epsr) );
$self->recommended_kmax( sprintf("%.3f", $self->fetch_scalar("kmax_suggest")) );
return $self;
};
## how Larch and Ifeffit report epsilon is very different, so it is
## hard to abstract this out in the manner of Get.pm. Instead, I am
## simply special-casing the problem of reporting epsilon in the fit
## log file
sub get_eps {
my ($self) = @_;
my ($epsk, $epsr) = (0,0);
my ($eps1, $eps2, $eps3) = (0,0,0);
if (Demeter->is_larch and $self->fit_group) {
my @eps = $self->fetch_array('dset_'.$self->group.'.epsilon_k');
$eps2 = shift @eps if $self->fit_k2;
$eps1 = shift @eps if $self->fit_k1;
$eps3 = shift @eps if $self->fit_k3;
my @parts = ();
push(@parts, sprintf("1 -> %.3e", $eps1)) if $self->fit_k1;
push(@parts, sprintf("2 -> %.3e", $eps2)) if $self->fit_k2;
push(@parts, sprintf("3 -> %.3e", $eps3)) if $self->fit_k3;
$epsk = join(', ', @parts);
@eps = $self->fetch_array('dset_'.$self->group.'.epsilon_r');
$eps2 = shift @eps if $self->fit_k2;
$eps1 = shift @eps if $self->fit_k1;
$eps3 = shift @eps if $self->fit_k3;
@parts = ();
push(@parts, sprintf("1 -> %.3e", $eps1)) if $self->fit_k1;
push(@parts, sprintf("2 -> %.3e", $eps2)) if $self->fit_k2;
push(@parts, sprintf("3 -> %.3e", $eps3)) if $self->fit_k3;
$epsr = join(', ', @parts);
} else {
$epsk = $self->epsk;
$epsr = $self->epsr;
};
return ($epsk, $epsr);
};
sub get_kweight {
my ($self) = @_;
return ($self->po->kweight >= 0) ? $self->po->kweight : $self->fit_karb_value;
};
sub _kw_string {
my ($self) = @_;
my @list = ();
push @list, "1" if $self->fit_k1;
push @list, "2" if $self->fit_k2;
push @list, "3" if $self->fit_k3;
push @list, $self->fit_karb_value if $self->fit_karb;
return join(",", @list);
};
sub nsuff {
my ($self) = @_;
my $suff = ($self->bkg_flatten) ? 'flat' : 'norm';
return $suff;
};
sub standard {
my ($self) = @_;
$self->mode->standard($self);
return $self;
};
sub unset_standard {
my ($self) = @_;
$self->mode->standard(q{});
return $self;
};
sub set_windows {
my ($self, $window) = @_;
$window = lc($window);
$window='kaiser' if ($self->is_larch and ($window eq 'kaiser-bessel'));
$window='kaiser-bessel' if ($self->is_ifeffit and ($window eq 'kaiser'));
return 0 if not is_Window($window);
$self->bkg_kwindow($window);
$self->fft_kwindow($window);
$self->bft_rwindow($window);
return $self;
};
## test for athena project file
sub determine_data_type {
my ($self) = @_;
my $file = $self->file;
return 0 if ($file eq $NULLFILE);
return 0 if is_Empty($file);
## figure out how to interpret these data -- need some error checking
if ((not $self->is_col) and ($self->datatype ne "xmu") and ($self->datatype ne "chi") ) {
$self->dispense('process', 'read_group', {file=>$file, group=>'deter___mine', type=>'raw'});
my @x;
if (Demeter->is_ifeffit) {
my $f = (split(" ", $self->fetch_string('column_label')))[0];
@x = $self->fetch_array("deter___mine.$f");
} else {
#my @f = Larch::get_larch_array("deter___mine.column_labels");
@x = Larch::get_larch_array("deter___mine.data[0,:]"); #.$f[0]);
};
$self->dispense('process', 'erase', {items=>"\@group deter___mine\n"});
if ($self->is_pixel) {
$self->datatype('xmu');
$self->is_kev(0);
$self->update_columns(0);
$self->update_norm(1);
} elsif ($x[0] > 100) { # seems to be energy data
$self->datatype('xmu');
$self->update_columns(0);
$self->update_norm(1);
} elsif (($x[0] > 3) and ($x[-1] < 35)) { # seems to be relative energy data
$self->datatype('xmu');
$self->is_kev(1);
$self->update_columns(0);
$self->update_norm(1);
} else { # it's chi(k) data
$self->datatype('chi');
$self->update_columns(0);
$self->update_norm(0);
$self->update_bkg(0);
};
};
return $self;
};
sub _update {
my ($self, $which) = @_;
#print join("|", $which, caller, $self->update_norm, $self->update_bkg, $self->update_fft), $/;
$which = lc($which);
WHICH: {
($which eq 'data') and do {
$self->read_data if ($self->update_data);
last WHICH;
};
($which eq 'normalize') and do {
$self->read_data if ($self->update_data);
$self->put_data if ($self->update_columns); # put_data is in Demeter::Data::Mu
last WHICH;
};
($self->display) and do { # bail if the display flag is set
return $self; # this effectively disables most Data object
}; # functionality while doing column selection.
($self->is_mc) and do { # bail if this is a Data::MultiChannel object
return $self; # this effectively disables most Data object
}; # functionality for D:MC.
($which eq 'background') and do {
$self->read_data if ($self->update_data);
$self->put_data if ($self->update_columns);
$self->normalize if ($self->update_norm and ($self->datatype =~ m{xmu|xanes}));
last WHICH;
};
($which eq 'fft') and do {
$self->read_data if ($self->update_data);
$self->put_data if ($self->update_columns);
$self->normalize if ($self->update_norm and ($self->datatype =~ m{(?:xmu|xanes)}));
$self->autobk if ($self->update_bkg and ($self->datatype =~ m{xmu}));
$self->fft_pcpath->_update('fft') if $self->fft_pcpath;
last WHICH;
};
($which eq 'bft') and do {
$self->read_data if ($self->update_data);
$self->put_data if ($self->update_columns);
$self->normalize if ($self->update_norm and ($self->datatype =~ m{xmu|xanes}));
$self->autobk if ($self->update_bkg and ($self->datatype =~ m{xmu}));
$self->fft if ($self->update_fft and ($self->datatype =~ m{xmu|chi}));
last WHICH;
};
($which eq 'all') and do {
$self->read_data if ($self->update_data);
$self->put_data if ($self->update_columns);
$self->normalize if ($self->update_norm and ($self->datatype =~ m{xmu|xanes}));
$self->autobk if ($self->update_bkg and ($self->datatype =~ m{xmu}));
$self->fft if ($self->update_fft and ($self->datatype =~ m{xmu|chi}));
$self->bft if ($self->update_bft and ($self->datatype =~ m{xmu|chi}));
last WHICH;
};
};
#$self->ifeffit_heap;
return $self;
};
sub read_data {
my ($self) = @_;
my $return = $self->readable($self->file);
$self->Croak($return) if $return;
my $type = (($self->is_col) and ($self->datatype ne 'chi')) ? q{}
: $self->datatype;
if ((not $self->is_col) and (not $type)) {
$self->determine_data_type;
$type = $self->datatype;
};
#print '>', $type, '<', $/;
my $string = $self->_read_data_command($type);
$self->dispose($string);
$self->update_data(0);
if ($self->is_col) {
$self->columns($self->fetch_string("column_label"));
};
$self->sort_data;
$self->put_data;
return $self if $self->is_mc; # bail if this is a Data::MultiChannel object
my $array = ($type eq 'xmu') ? 'energy'
: ($type eq 'chi') ? 'k'
: 'energy';
my @x = $self->get_array($array); # set things for about dialog
if (not @x) {
#carp($self->file." could not be read as data\n\n");
$self->unreadable(1);
return $self;
};
$self->npts($#x+1);
$self->xmin($x[0]);
$self->xmax($x[$#x]);
my $filename = fileparse($self->file, qr{\.dat}, qr{\.xmu}, qr{\.chi});
$self->name($filename) if not $self->name;
$self->identify_beamline($self->file) if not $self->xdi_will_be_cloned;
return $self;
};
## remove all arrays of this group that are not needed for further
## data processing
sub extraneous {
my ($self) = @_;
my $re = join("|", qw(energy xmu i0 ir signal der sec pre pre_edge
post_edge nbkg prex theta line flat nder
nsec bkg flat nbkg norm fbkg k chi));
my $items = join(", " ,map {$self->group.'.'.$_} grep {!m{$re}} split(" ", $self->columns));
#print $items, $/;
$self->dispense('process', 'erase', {items=>$items}) if ($items !~ m{\A\s*\z});
#$command .= $self->template("process", "post_autobk");
#if ($self->bkg_fixstep) { # or ($self->datatype eq 'xanes')) {
# $command .= $self->template("process", "flatten_fit");
#} else {
# $command .= $self->template("process", "flatten_set");
#};
##$self->dispose($command);
$self->update_norm(1);
}
sub explain_recordtype {
my ($self) = @_;
my $string = ($self->datatype eq 'xmu') ? 'mu(E)'
: ($self->datatype eq 'xanes') ? 'xanes(E)'
: ($self->datatype eq 'chi') ? 'chi(k)'
: ($self->datatype eq 'xmudat') ? 'Feff mu(E)'
: ($self->datatype eq 'background') ? 'background'
: ($self->datatype eq 'detector') ? 'detector'
: 'unknown';
$string = 'normalized ' . $string if $self->is_nor;
$string = 'merged ' . $string if $self->is_merge;
$self->recordtype($string);
$string = ($self->datatype eq 'xmu') ? 'any'
: ($self->datatype eq 'xanes') ? 'energy'
: ($self->datatype eq 'chi') ? 'k, R, or q'
: ($self->datatype eq 'xmudat') ? 'any'
: ($self->datatype eq 'background') ? 'any'
: ($self->datatype eq 'detector') ? 'energy'
: 'any';
$self->plotspaces($string);
return $self;
};
sub sort_data {
my ($self) = @_;
if ($self->is_larch) {
return $self;
};
# #Demeter->trace;
# $self->dispense('process', 'sort');
# return $self;
#};
my @x = ();
if ($self->is_col) {
## This block is a complicated bit. The idea is to store all
## the data in a list of lists. In this way, I can sort all the
## data in one swoop by sorting off the energy part of the list
## of lists. After sorting, I check the data for repeated
## points and remove them. Finally, I reload the data into
## ifeffit and carry on like normal data
## This gets a list of column labels
my @cols = split(" ", $self->columns);
my @lol;
## energy value is zeroth in each anon list
unshift @cols, q{};
my $ecol = $self->energy || '$1';
$ecol =~ s{^\$}{};
my @array = $self->get_array($cols[$ecol]);
#print $#array, $/, $/;
foreach (0 .. $#array) {push @{$lol[$_]}, $array[$_]};
foreach my $c (@cols) {
next unless $c;
## load other cols (including energy col) into anon. lists
my @this_array = $self->get_array($c);
foreach (0 .. $#this_array) {push @{$lol[$_]}, $this_array[$_]};
};
## sort the anon. lists by energy (i.e. zeroth element)
@lol = sort {$a->[0] <=> $b->[0]} @lol;
## now fish thru lol looking for repeated energy points
my $ii = 0;
my $eps = $EPSILON3;
$eps = $EPSILON6 if $self->is_kev;
while ($ii < $#lol) {
($lol[$ii+1]->[0] - $lol[$ii]->[0] > $eps) ? ++$ii : splice(@lol, $ii+1, 1);
#($lol[$ii+1]->[0] > $lol[$ii]->[0]) ? ++$ii : splice(@lol, $ii+1, 1);
};
## now feed columns back to ifeffit
my $group = $self->group;
$self->dispense('process', 'comment', {comment=>"replacing arrays for $group with sorted versions"});
$self->dispense('process', 'erase', {items=>"\@group $group"}) if (not $self->is_larch);
foreach my $c (1 .. $#cols) {
my @array;
foreach (@lol) {push @array, $_->[$c]};
$self->place_array("$group.$cols[$c]", \@array);
if ($self->is_larch) {
my $cc = $c-1;
$self->place_array("$group.data".'['.$cc.']', \@array);
};
};
# @array = $self->get_array($cols[$ecol]);
# print join(" ", @array), $/, $/, $/;
};
return $self;
};
sub _read_data_command {
my ($self, $type) = @_;
my $string = q[];
$self->raw_check;
if (($type eq 'xmu') and ($self->is_ifeffit)) { # for larch better to use "read" template
$string = $self->template("process", "read_xmu");
$string .= $self->template("process", "deriv");
$self->provenance("mu(E) file ".$self->file);
} elsif ($type eq 'chi') {
$string = $self->template("process", "read_chi");
$self->provenance("chi(k) file ".$self->file);
} elsif ($type eq 'feff.dat') {
$string = $self->template("process", "read_feffdat");
} else {
$string = $self->template("process", "read");
$self->provenance("column data file ".$self->file);
};
if ($self->is_larch) {
$string .= $self->template("process", "sort");
};
return $string;
};
sub raw_check {
my ($self) = @_;
open(my $F, $self->file);
while (<$F>) {
next if not m{\A[#*%;!]?\s*---+\s*\z};
my $cols = <$F>;
chomp $cols;
$self->read_as_raw(1) if length($cols) > 255;
last;
};
close $F;
return $self;
};
sub rfactor {
my ($self) = @_;
my (@x, @dr, @di, @fr, @fi, $xmin, $xmax);
my (@nn) = (0,0,0,0);
my (@dd) = (1,0,0,0);
if (lc($self->fit_space) eq 'k') {
($xmin,$xmax) = $self->get(qw(fft_kmin fft_kmax));
@x = $self -> get_array("k");
@dr = $self -> get_array("chi");
@fr = $self -> get_array("chi", "fit");
foreach my $i (0 .. $#x) {
next if ($x[$i] < $xmin);
last if ($x[$i] > $xmax);
foreach my $k (1,2,3) {
$nn[$k] += ($dr[$i]*$x[$i]**$k - $fr[$i]*$x[$i]**$k)**2;
$dd[$k] += ($dr[$i]*$x[$i]**$k )**2;
};
};
} elsif (lc($self->fit_space) eq 'r') {
($xmin,$xmax) = $self->get(qw(bft_rmin bft_rmax));
foreach my $k (1,2,3) {
$self->po->kweight($k);
$self->_update('bft');
$self->part_fft('fit');
@x = $self -> get_array("r");
@dr = $self -> get_array("chir_re");
@di = $self -> get_array("chir_im");
@fr = $self -> get_array("chir_re", "fit");
@fi = $self -> get_array("chir_im", "fit");
foreach my $i (0 .. $#x) {
next if ($x[$i] < $xmin);
last if ($x[$i] > $xmax);
$nn[$k] += ($dr[$i] - $fr[$i])**2 + ($di[$i] - $fi[$i])**2;
$dd[$k] += $dr[$i] **2 + $di[$i] **2;
};
};
} elsif (lc($self->fit_space) eq 'q') {
($xmin,$xmax) = $self->get(qw(fft_kmin fft_kmax));
foreach my $k (1,2,3) {
$self->po->kweight($k);
$self->_update('all');
$self->part_fft('fit');
$self->part_bft('fit');
@x = $self -> get_array("q");
@dr = $self -> get_array("chiq_re");
@di = $self -> get_array("chiq_im");
@fr = $self -> get_array("chiq_re", "fit");
@fi = $self -> get_array("chiq_im", "fit");
foreach my $i (0 .. $#x) {
next if ($x[$i] < $xmin);
last if ($x[$i] > $xmax);
$nn[$k] += ($dr[$i] - $fr[$i])**2 + ($di[$i] - $fi[$i])**2;
$dd[$k] += $dr[$i] **2 + $di[$i] **2;
};
};
};
$self->fit_rfactor1($nn[1]/$dd[1]) if $dd[1]>0;
$self->fit_rfactor2($nn[2]/$dd[2]) if $dd[2]>0;
$self->fit_rfactor3($nn[3]/$dd[3]) if $dd[3]>0;
return $self;
};
sub prep_peakfit {
my ($self, $xmin, $xmax) = @_;
$self->_update('background');
return ($self->bkg_e0+$xmin, $self->bkg_e0+$xmax);
};
## this appends the actual data to the base class serialization
override 'serialization' => sub {
my ($self) = @_;
my $string = $self->SUPER::serialization;
if ($self->datatype =~ m{(?:xmu|xanes)}) {
$string .= YAML::Tiny::Dump($self->ref_array("energy"));
$string .= YAML::Tiny::Dump($self->ref_array("xmu"));
if ($self->is_col) {
$string .= YAML::Tiny::Dump($self->ref_array("i0"));
}
} elsif ($self->datatype eq "chi") {
$string .= YAML::Tiny::Dump($self->ref_array("k"));
$string .= YAML::Tiny::Dump($self->ref_array("chi"));
};
return $string;
};
# ## standard deviation array?
override 'deserialize' => sub {
my ($self, $fname) = @_;
my @stuff;
eval {local $SIG{__DIE__} = sub {}; @stuff = YAML::Tiny::LoadFile($fname)};
## load the attributes
my %args = %{ $stuff[0] };
delete $args{plottable};
delete $args{pathtype};
delete $args{fit_pcpath}; # correct an early
delete $args{fit_do_pcpath}; # design mistake...
my @args = %args;
$self -> set(@args);
$self -> group($self->_get_group);
$self -> update_data(0);
$self -> update_columns(0);
$self -> update_norm(1);
$self -> from_yaml(1);
$self -> dispense('process','make_group');
my $path = $self -> mo -> fetch('Path', $self->fft_pcpathgroup);
$self -> fft_pcpath($path);
my @x = @{ $stuff[1] };
my @y = @{ $stuff[2] };
my @i0 = @{ $stuff[3] };
if ($self->datatype =~ m{(?:xmu|xanes)}) {
$self->place_array($self->group.".energy", \@x);
$self->place_array($self->group.".xmu", \@y);
if ($self->is_col) {
$self->place_array($self->group.".i0", \@i0);
};
} elsif ($self->datatype eq 'chi') {
$self->place_array($self->group.".k", \@x);
$self->place_array($self->group.".chi", \@y);
};
return $self;
};
alias thaw => 'deserialize';
__PACKAGE__->meta->make_immutable;
1;
=head1 NAME
Demeter::Data - Process and analyze EXAFS data with Ifeffit or Larch
=head1 VERSION
This documentation refers to Demeter version 0.9.26.
=head1 SYNOPSIS
use Demeter;
my $data = Demeter::Data -> new;
$data -> set(file => "example/cu/cu10k.chi",
name => 'My copper data',
fft_kmin => 3, fft_kmax => 14,
bft_rmin => 1, bft_rmax => 4.3,
fit_k1 => 1, fit_k3 => 1,
);
$data -> plot("r");
=head1 DESCRIPTION
This subclass of the L<Demeter> class is inteded to hold information
pertaining to data for use in data processing and analysis.
=head1 ATTRIBUTES
The following are the attributes of the Data object. Attempting to
access an attribute not on this list will throw an exception.
The type of argument expected in given in parentheses. i.e. number,
integer, string, and so on. The default value, if one exists, is
given in square brackets.
For a Data object to be included in a fit, it is necessary that it be
gathered into a Fit object. See L<Demeter::Fit> for details.
=head2 General Attributes
=over 4
=item C<group> (string) I<[random 5-letter string]>
This is the name associated with the data. It's primary use is as the
group name for the arrays associated with the data in Ifeffit or
Larch. That is, its arrays will be called I<group>.k, I<group>.chi,
and so on. It is best if this is a reasonably short word and it
B<must> follow the conventions of a valid group name in Ifeffit or
Larch. The default group is a random five-letter string generated
automatically when the object is created.
=item C<tag> (string) I<[same random 5-letter string as group]>
Use to disambiguate guess parameter names when doing variable name
substitution for local parameters.
=item C<file> (filename)
This is the file containing the chi(k) associated with this Data
object. It will be an empty string if the data comes from an Athena
project file or is generated by Demeter.
=item C<unreadable> (boolean)
This is set to a true value if any error is seen while trying to
import the data. This allows a GUI to bail out of processing the data
file before running into a problem that might cause a crash.
=item C<prjrecord> (project filename and record number)
This is the Athena project file from which the data associated with
this Data object. It will be an empty string if the data comes from a
normal file or is generated by Demeter. The format of this string is
the project file name and the record number separated by a comma:
print $data->prjrecord, $/;
==prints==>
whatever.prj, 5
This will be set automatically by the Data::Prj C<record> method.
Setting it by hand I<does not> trigger a reading of the record. So,
you should pretend that this is a read-only attribute.
=item C<provenance> (string)
This is a short string explaining where the data object came from,
e.g. from a column data file or an Athena project file.
=item C<name> (string)
This is a text string used to describe this object in a plot ot a user
interface. Like the C<group> attribute, this should be short, but it
can be a bit more verbose. It should be a single line, unlike the
C<title> attibute.
=item C<plotkey> (string)
This is a text string used as a temporary override to the name of Data
object for use in a plot. It should be reset to an empty string as
soon as the plot requiring the name override is finished.
=item C<forcekey> (string)
When this is true, it forces the plotting system to use the name of
the Data group as the legend key regardless of the type of plot. This
was needed to force an R123 plot to use the scaling information as the
key rather than having the key be the part plotted, which is what
normally happens for a single group R or q space plot.
=item C<cv> (number)
The characteristic value is a number associated with the data object.
The cv is used to generate guess parameteres from lguess parameters
and is used as the substitution value in math expressions containing
the string C<[cv]>. The default value is a number that is incremented
as Data objects are created.
=item C<datatype> (string)
This identifies the record type. It is one of
xmu chi xmudat xanes
Earlier versions of Demeter had attributes like C<is_xmu> and
C<is_chi>. Those are now obsolete and there use will return an error
about being unknown attributes.
=item C<is_col> (boolean)
This is true if the file indicated by the C<file> attribute contains
column data that needs to be converted into mu(E) data. See the
description of the C<read_data> method for how this gets set
automatically and when you may need to set it by hand.
=item C<is_col> (string)
This is an empty string by default. When a merge group is made, its
string value is set to themanner in which the merge was made, which is
one of C<e> for mu(E), C<n> for norm(E>, and C<k> for chi(k).
=item C<columns> (string)
This string contains Ifeffit's C<$column_label> or Larch's C<...>
string from importing the data file.
=item C<energy> (string)
This string uses gnuplot-like notation to indicate which column in the
data file contains the energy axis. As an example, the default is that the
first column contains the energy and this string is C<$1>.
=item C<numerator> (string)
This string uses gnuplot-like notation to indicate how to convert
columns from the data file into the numerator of the expression for
computing mu(E). For example, the default is that these are
transmission data and I0 is in the 2nd column and the default for
this string is C<$2>.
If these are fluorescence data measured with a multichannel analyzer
and the MCA channels are in columns 7 - 10, then this string would be
C<$7+$8+$9+$10>.
=item C<denominator> (string)
This string uses gnuplot-like notation to indicate how to convert
columns from the data file into the denominator of the expression for
computing mu(E). For example, the default is that these are
transmission data and transmission is in the 3nd column and the
default for this string is C<$3>.
=item C<ln> (boolean)
This is true for transmission data, i.e. if conversion from columns to
mu(E) requires that the natural log be taken. In fact, the natural
log of the absolute value of the ratio of the numerator and
denominator is computed to avoid numerical error in certain situations.
=item C<ln> (boolean)
This flag severely restricts data processing to just what is necessary
to make a plot of unnormalized mu(E). It is for use in a GUI's column
selection dialog so that swift plot updates can be made while columns
are being selected.
=item C<display> (boolean)
This is a flag used by a GUI while selecting columns. It severely
limits the amount of data processing done so that the display updates
quickly in the GUI. This should be set back to 0 B<as soon as
possible> so t hat subsequent data processing proceeds properly.
=back
=head2 Background Removal Attributes
=over 4
=item C<bkg_e0> (number)
The E0 value of mu(E) data. This is determined from the data when the
read_data method is called.
=item C<bkg_e0_fraction> (number) I<[0.5]>
This is a number between 0 and 1 used for the e0 algorithm which sets
e0 to a fraction of the edge step. See L<Demeter::Data::E0>.
=item C<bkg_eshift> (number) I<[0]>
An energy shift to apply to the data before doing any further processing.
=item C<bkg_kw> (number) I<[1]>
The k-weight to use during the background removal using the Autobk algorithm.
=item C<bkg_rbkg> (number) I<[1]>
The Rbkg value in the Autobk algorithm.
=item C<bkg_dk> (number) I<[0]>
The dk value to be used in the Fourier transform as part of the Autobk
algorithm.
=item C<bkg_pre1> (number) I<[-150]>
The lower end of the range of the pre-edge regression, relative to E0.
=item C<bkg_pre2> (number) I<[-30]>
The upper end of the range of the pre-edge regression, relative to E0.
=item C<bkg_nor1> (number) I<[100]>
The lower end of the range of the post-edge regression, relative to E0.
=item C<bkg_nor2> (number) I<[600]>
The upper end of the range of the post-edge regression, relative to E0.
=item C<bkg_spl1> (number) I<[0]>
The lower end in k of the spline range in the Autobk algorithm. The value of
bkg_spl1e is updated whenever this is updated.
=item C<bkg_spl2> (number) I<[15]>
The upper end in k of the spline range in the Autobk algorithm. The value of
bkg_spl2e is updated whenever this is updated.
=item C<bkg_spl1e> (number) I<[0]>
The lower end in energy of the spline range in the Autobk algorithm,
relative to E0. The value of bkg_spl1 is updated whenever this is
updated.
=item C<bkg_spl2e> (number) I<[857]>
The upper end in energy of the spline range in the Autobk algorithm,
relative to E0. The value of bkg_spl2 is updated whenever this is
updated.
=item C<bkg_kwindow> (list) I<[Hanning]>
This is the functional form of the Fourier transform window used in
the Autobk algorithm. It is one of
Kaiser-Bessel Hanning Welch Parzen Sine Gaussian
=item C<bkg_slope> (number)
The slope of the pre-edge line. This is set as part of the
C<normalize> method.
=item C<bkg_int> (number)
The intercept of the pre-edge line. This is set as part of the
C<normalize> method.
=item C<bkg_step> (number)
The edge step found by the C<normalize> method. This attribute will
be overwritten the next time the C<normalize> method is called unless
the C<bkg_fixstep> atribute is set true.
=item C<bkg_fitted_step> (number)
The value of edge step found by the C<normalize> method, regardless of
the setting of C<bkg_fixstep>. This is needed to correctly flatten
data.
=item C<bkg_fixstep> (boolean) I<[0]>
When true, the value of the c<bkg>_step will not be overwritten by the
c<normalize> method.
=item C<bkg_nc0> (number)
The constant parameter in the post-edge regression. This is set as part of
the c<normalize> method.
=item C<bkg_nc1> (number)
The linear parameter in the post-edge regression. This is set as part of
the C<normalize> method.
=item C<bkg_nc2> (number)
The cubic parameter in the post-edge regression. This is set as part of
the C<normalize> method.
=item C<bkg_nc3> (number)
The quartic parameter in the post-edge regression. This is set as part of
the C<normalize> method. (Larch only)
=item C<bkg_flatten> (boolean) I<[1]>
When true, a plot of normalized mu(E) data will be flattened.
=item C<bkg_funnorm> (boolean) I<[0]>
When true, a functional normalization is performed to approximately
remove the effect of quickly varying I0 signal on fluorescence EXAFS.
Note that has a bad impact on the display of mu(E). The
energy-dependent normalization is made by dividing (post(E)-pre(E))
from mu(E) right doing the background removal. Thus the background
function is computed from something different from mu(E). This turns
out to be hard to keep track of when using Demeter's plotting system.
Athena "solves" this by keeping track of what is being plotted. A
plot in k, R, or q uses the corrected mu(E). A plot in E is made by
temporarily turning off the energy-dependent normalization flag,
re-evaluating the background function, then turning the flag back on.
This is a bit of an efficiency hit. And the plot in E does not quite
correspond to the plot in k. Awkward!
=item C<bkg_nnorm> (integer) I<[3]>
This can be either 2 or 3 and specifies the order of the post-edge regression.
When this is 2, C<bkg_nc2> will be forced to 0 in the regression. I<not yet
implemented>
=item C<bkg_stan> (Data or Path object)
The background removal standard. This can be either a Data object or a Path
object. I<not yet implemented>
=item C<bkg_clamp1> (integer) I<[0]>
The value of the low-end spline clamp.
=item C<bkg_clamp2> (integer) I<[24]>
The value of the high-end spline clamp.
=item C<bkg_nclamp> (integer) I<[5]>
The number of data points to use in evaluating the clamp.
=item C<bkg_cl> (boolean) I<[0]>
When true, use Cromer-Liberman normalization rather than the Autobk algorithm.
I<not yet implemented>
=item C<bkg_z> (number)
The Z number of the absorber for these data. This is determined as part of
the normalize method but can also be set by hand. To deal with edge energy
confusions, certain K and L3 edges are prefered over nearby L2 and L3 edges
when this attribute is set automatically.
prefer over
----------------
Fe K Nd L1
Mn K Ce L1
Bi K Ir L1
Se K Tl L2
Pt L3 W L2
Se K Pb L2
Np L3 At L1
Cr K Ba L1
There is a configuration parameter to turn this behavor on and off.
=back
=head2 Forward Transform Attributes
Note that there is not an C<fft_kw> attribute. For all plotting and
data processing purposes, the Plot object's C<kweight> attribute is
used, while in fits the Fit object's k-weighting attributes are used.
=over 4
=item C<fft_edge> (edge symbol) I<[K]>
The absorption edge measured by the input data. This is used doing a
central-atom-only phase correction to the Fourier transform.
=item C<fft_kmin> (number) I<[2]>
The lower end of the k-range for the forward transform. C<fft_kmin> and
C<fft_kmax> will be sorted by Demeter.
=item C<fft_kmax> (number) I<[12]>
The upper end of the k-range for the forward transform. C<fft_kmin> and
C<fft_kmax> will be sorted by Demeter.
=item C<fft_dk> (number) I<[2]>
The width of the window sill used for the forward transform. The
meaning of this parameter depends on the functional form of the
window. See the Ifeffit/Larch document for a full discussion of the
functional forms.
=item C<fft_kwindow> (list) I<[Hanning]>
This is the functional form of the Fourier transform window used in
the forward transform. It is one of
Kaiser-Bessel Hanning Welch Parzen Sine Gaussian
=item C<fft_pc> (Path object) I<[0]>
This is set to the Path object to be used for a full phase correction to the
Fourier transform.
=item C<rmax_out> (number) I<[10]>
This tells Ifeffit/Larch how to size output arrays after doing a Fourier transform.
=back
=head2 Back Transform Attributes
=over 4
=item C<bft_rwindow> (number) I<[Hanning]>
This is the functional form of the Fourier transform window used in
the backward transform. It is one of
Kaiser-Bessel Hanning Welch Parzen Sine Gaussian
=item C<bft_rmin> (number) I<[1]>
The lower end of the R-range for the backward transform or the fitting range.
C<bft_rmin> and C<bft_rmax> will be sorted by Demeter.
=item C<bft_rmax> (number) I<[3]>
The upper end of the R-range for the backward transform or the fitting range.
C<bft_rmin> and C<bft_rmax> will be sorted by Demeter.
=item C<bft_dr> (number) I<[0.2]>
The width of the window sill used for the backward transform. The
meaning of this parameter depends on the functional form of the
window. See the Ifeffit/Larch document for a full discussion of the
functional forms.
=back
=head2 Fitting Attributes
Note that parameters with C<fft_> and C<bft_> analogs such as
C<fft_kmin> have been deprecated along with the C<process> mode.
=over 4
=item C<fitting> (boolean) I<[0]>
This is set to true when a Data object is used in a fit. It is used by
plotting methods to determine whether data parts (fit, background, residual)
should be considered for plotting.
=item C<fit_k1> (boolean) I<[1]>
If true, then k-weight of 1 will be used in the fit. Setting more
than one k-weighting parameter to true will result in a multiple
k-weight fit. By default, fits are done with kweight of 1, 2, and 3.
=item C<fit_k2> (boolean) I<[1]>
If true, then k-weight of 2 will be used in the fit. Setting more
than one k-weighting parameter to true will result in a multiple
k-weight fit. By default, fits are done with kweight of 1, 2, and 3.
=item C<fit_k3> (boolean) I<[1]>
If true, then k-weight of 3 will be used in the fit. Setting more
than one k-weighting parameter to true will result in a multiple
k-weight fit. By default, fits are done with kweight of 1, 2, and 3.
=item C<fit_karb> (boolean) I<[0]>
If true, then the user-supplied, arbitrary k-weight will be used in
the fit. Setting more than one k-weighting parameter to true will
result in a multiple k-weight fit. By default, fits are done with
kweight of 1, 2, and 3.
=item C<fit_karb_value> (number) I<[0]>
This is the value of the arbitrary k-weight which will be used in the
fit is C<fit_karb> is true.
=item C<fit_space> (list) I<[R]>
This is the space in which the fit will be evaluated. It is one of
C<k>, C<r>, or C<q>.
=item C<fit_epsilon> (number) I<[0]>
If this number is non-zero, it will be used as the measurement
uncertainty in k-space when the fit is evaluated. If it is zero, then
the default in Ifeffit or Larch will be used.
=item C<fit_cormin> (number) I<[0.4]>
This is the minimum value of correlation to be reported in the log
file after a fit.
=item C<fit_pcpath> (Path object)
This is the Path object to use for phase correction when these data
and it paths are plotted. It takes the reference to the Path object
as its value.
=item C<fit_include> (boolean) I<[1]>
When this is true, the data will be included in the next fit.
=item C<fit_plot_after_fit> (boolean) I<[0]>
This is a flag for use by a user interface to indicate that after a
fit is finished, this data set should be plotted.
=item C<fit_do_bkg> (boolean) I<[0]>
When true, the background function will be corefined for this data set
and the "bkg" part of the data will be created.
=item C<fit_titles> (multiline string)
These are title lines associated with this Data object. These lines
will be written to log files, output data files, etc.
=item C<fitsum> (list)
This attribute indicates whether the Fit objects C<fit> or C<ff2chi>
mehthod was most recently called. It is one of C<fit> or C<sum>.
It's purpose is to allow the fit part of the data object to be labeled
correctly in a plot.
=back
=head2 Plotting Attributes
Most aspects of how plots are made are handled by the attributes of
the Plot object. These Data attributes are specific to a particular
Data object and influence how that object is plotted.
=over 4
=item C<y_offset> (number) I<[0]>
The vertical displacement given to this data when plotted. This is
useful for making stacked plots.
=item C<plot_multiplier> (number) I<[1]>
An over-all scaling factor for this data when plotted. It is probably
a bad idea for this to be 0.
=back
=head1 METHODS
This subclass inherits from Demeter, so all of the methods of the
parent class are available.
See L<Demeter/Object_handling_methods> for a discussion of accessor
methods.
=head2 I/O methods
These methods handle the details of file I/O. See also the C<save>
method of the parent class.
=over 4
=item C<save>
This method returns the Ifeffit/Larch commands necessary to write
column data files based on the data object. See C<Demeter::Data::IO>
for details.
=item C<data_parameter_report>
This method returns a simple, textual summary of the attributes of the data
object related to background removal and data processing. It is used in log
files, output data files, and elsewhere. It may also be useful as a way of
interactively describing the data.
=item C<fit_parameter_report>
This method returns a simple, textual summary of the attributes of the
data object related to the fit. It is used in log files, output data
files, and elsewhere. It may also be useful as a way of interactively
describing the data. The two optional arguments control whether the
r-factor is computed as part of the report.
=item C<r_factor>
This returns an evaluation of the R-factor from a fit for a single
data set. This is different from the R-factor for a multiple data set
fit as reported by Ifeffit or Larch in that this number includes only
the misfit of the single data set.
$r = $data_object -> r_factor;
=item C<nidp>
This returns the number of independent points associated with this
data set, as determined from the values of the k- and R-range
parameters.
$n = $data_object -> nidp;
The Athena-like fft and bft ranges are used if the processing mode is
set to "fft". The Artemis-like fit ranges are used if the processing
mode is set to "fit".
=item C<plot>
Use this method to make plots of data. Demeter keeps track of changes
to parameters and which data processing steps need to be taken in
order to correctly make the plot. Consequently, it should never be
necessary to import data or perform a Fourier tansform by hand. The
practice with Demeter is to create a Data group, set some of its
attributes, and then make a plot.
$data_object -> plot($space)
The argument is one of C<E>, C<k>, C<R>, C<q>, or C<kq>. The details
of the plot are determine by the current state of the
L<Demeter::Plot> object.
=back
=head2 Convenience methods
=over 4
=item C<set_windows>
This is a shortcut to setting the functional form of all Fourier
transform windows used by the Data object. In one swoop, this method
sets C<bkg_kwindow>, C<fit_kwindow>, C<fit_rwindow>, C<fft_kwindow>,
and C<bft_rwindow> to the specified window type.
$data_object -> set_windows("Hanning");
The window type must be one of C<Kaiser-Bessel>, C<Hanning>,
C<Parzen>, C<Welch>, C<Sine>, or C<Gaussian>.
=item C<nsuff>
Returns either "norm" or "flat" as the proper suffix for the
normalized mu(E) array depending on the value of C<bkg_flatten>.
=item C<data>
This method returns the reference to the data object itself. This is
less silly than it seems. Having a C<data> method defined for both
Data and Path objects allows a loop over both kinds of objects and
provides a simple way to identify the correct Data object.
foreach my $obj (@data_objects, @paths_objects) {
my $d = $obj->data;
## do something with $d
};
=back
=head1 DATA FILES AND DATA PARTS
When data are imported, Demeter tries to figure out whether the data
are raw data, mu(E) or chi(k) data, if that has not been specified.
The heuristics are as follows:
=over 4
=item *
If the C<numerator> or C<denominator> attributes are set, this is data
is assumed to be column data that will be interpreted as raw data and
converted to mu(E) data.
=item *
The data will be read by Ifeffit or Larch. If the first data point is
greater than 100, it will be assumed that these data are mu(E) and
that the energy axis is absolute energy.
=item *
If the last data point is greater than 35, it will be assumed that
these data are mu(E) and that the energy axis is relative energy.
=item *
If none of the above are true, then the data must be chi(k) data.
=back
If your data will be misintepreted by these heuristics, then you
B<must> set the C<data_type> attribute by hand.
The Data object has several parts associated with it. Before a fit
(or summation) is done, there are two parts: the data itself and the
window. After the fit, there is a residual, a fit, and (if the
C<fit_do_bkg> attribute is true) a background. Attributes of the
L<Demeter::Plot> object are used to specify which Data parts
are shown in a plot.
=head1 DIAGNOSTICS
These messages are classified as follows (listed in increasing order
of desperation):
(W) A warning (optional).
(F) A fatal error (trappable).
=over 4
=item C<"$key" is not a valid Demeter::Data parameter>
(W) You have attempted to access an attribute that does not exist. Check
the spelling of the attribute at the point where you called the accessor.
=item C<Demeter::Data: "group" is not a valid group name>
(F) You have used a group name that does not follow Ifeffit's rules for group
names. The group name must start with a letter. After that only letters,
numbers, &, ?, _, and : are acceptable characters. The group name must be no
longer than 64 characters.
=item C<Demeter::Data: "$key" takes a number as an argument>
(F) You have attempted to set a numerical attribute with something
that cannot be interpretted as a number.
=item C<Demeter::Data: $k must be a number>
(F) You have attempted to set an attribute that requires a numerical
value to something that cannot be interpreted as a number.
=item C<Demeter::Data: $k must be a positive integer>
(F) You have attempted to set an attribute that requires a positive
integer value to something that cannot be interpreted as such.
=item C<Demeter::Data: $k must be a window function>
(F) You have set a Fourier transform window attribute to something not
recognized as a window function.
=item C<Demeter::Data: $r_hash->{$k} is not a readable data file>
(F) You have set the C<file> attribute to something that cannot be
found on disk.
=item C<Demeter::Data: $k must be one of (k R q)>
(F) You have set a fitting space that is not one C<k>, C<R>, or C<q>.
=item C<Demeter::Data: $k must be one of (K L1 L2 L3)>
(F) You have attempted to set the C<fft_edge> attribute to something
that is not recognized as an edge symbol.
=item C<No filename specified for save>
(F) You have called the save method without supplying a filename
for the output file.
=item C<Valid save types are: xmu norm chi r q fit bkgsub>
(F) You have called the save method with an unknown output file type.
=item C<cannot save mu(E) file from chi(k) data>
=item C<cannot save norm(E) file from chi(k) data>
(F) You have attempted to write out data in energy for data that were
imported as chi(k).
=item C<No filename specified for serialize>
(F) You have not supplied a filename for your data serialization.
=item C<No filename or YAML stream specified for deserialize>
(F) You have not supplied a filename from which to deserialization
data.
=back
=head1 SERIALIZATION AND DESERIALIZATION
The serialization format of a data object is as a YAML file. The YAML
serialization begins with a mapping of the Data object attributes. This is
followed by sequences representing the data. For mu(E) data, the sequences
are energy and xmu. If the data was column data, the xmu sequence is followed
by a sequence representing the i0 array. For chi(k) data, the mapping is
followed by sequences representing k and chi(k).
To serialize a Data object to a file:
$data -> serialize($filename);
To import the serialized data and create a Data object to hold it:
$data -> deserialize($filename);
As a convenience C<freeze> is a synonym for C<serialize> and C<thaw>
is a synonym for C<deserialize>.
Among the many attractive features of YAML as a serialization format is that
YAML is supported by lots of programming languages. So Demeter serialization
can be imported easily into other analysis software.
In principle, the Athena project file is also a serialization
format. The YAML serialization is intended for use as part of a
fitting project. An Athena project file is probably a more useful
user interaction format for data processing.
=head1 CONFIGURATION
See L<Demeter::Config> for a description of the configuration system.
Many attributes of a Data object can be configured via the
configuration system. See, among others, the C<bkg>, C<fft>, C<bft>,
and C<fit> configuration groups.
=head1 DEPENDENCIES
Demeter's dependencies are in the F<Build.PL> file.
=head1 BUGS AND LIMITATIONS
Several features have not yet been implemented.
=over 4
=item *
Should there only be two items in a collection of tied references?
Consider importing MED channels -- it would be reasonable for each
channel and the reference to be a reference collection.
=item *
Only some of the Athena-like data process methods (alignment, merging,
and so on) have been implemented at this time. None of the analysis
features of Athena (LCF, LR/PD, peak fitting) have been implemeneted.
=item *
Various background and normalization options: functional
normalization, normalization order, background removal standard,
Cromer-Liberman.
=item *
Tied reference channel
=item *
Standard deviation for merged data not written to serialization.
=back
Please report problems to the Ifeffit Mailing List
(L<http://cars9.uchicago.edu/mailman/listinfo/ifeffit/>)
Patches are welcome.
=head1 AUTHOR
Bruce Ravel, L<http://bruceravel.github.io/home>
L<http://bruceravel.github.io/demeter/>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2006-2019 Bruce Ravel (L<http://bruceravel.github.io/home>). All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlgpl>.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
=cut
|