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
|
package PDL::IO::HDF5::Dataset;
use Carp;
use strict;
use Config;
# Global mapping variables
our ($H5T_STRING, $H5T_REFERENCE, %PDLtoHDF5internalTypeMapping, %HDF5toPDLfileMapping, %PDLtoHDF5fileMapping);
=head1 NAME
PDL::IO::HDF5::Dataset - PDL::IO::HDF5 Helper Object representing HDF5 datasets.
=head1 DESCRIPTION
This is a helper-object used by PDL::IO::HDF5 to interface with HDF5 format's dataset objects.
Information on the HDF5 Format can be found
at the HDF Group's web site at http://www.hdfgroup.org .
=head1 SYNOPSIS
See L<PDL::IO::HDF5>
=head1 MEMBER DATA
=over 1
=item ID
ID number given to the dataset by the HDF5 library
=item name
Name of the dataset.
=item parent
Ref to parent object (group) that owns this dateset.
=item fileObj
Ref to the L<PDL::IO::HDF5> object that owns this object.
=back
=head1 METHODS
####---------------------------------------------------------
=head2 new
=for ref
PDL::IO::HDF5::Dataset Constructor - creates new object
B<Usage:>
=for usage
This object will usually be created using the calling format detailed in the L<SYNOPSIS>. The
following syntax is used by the L<PDL::IO::HDF5> object to build the object.
$a = new PDL::IO::HDF5:Dataset( name => $name, parent => $parent,
fileObj => $fileObj);
Args:
$name Name of the dataset
$parent Parent Object that owns this dataset
$fileObj PDL::HDF object that owns this dateset.
=cut
sub new{
my $type = shift;
my %parms = @_;
my $self = {};
my @DataMembers = qw( name parent fileObj);
my %DataMembers;
@DataMembers{ @DataMembers } = @DataMembers; # hash for quick lookup
# check for proper supplied names:
my $varName;
foreach $varName(keys %parms){
unless( defined($DataMembers{$varName})){
carp("Error Calling ".__PACKAGE__." Constuctor\n \'$varName\' not a valid data member\n");
return undef;
}
unless( defined($parms{$varName})){
carp("Error Calling ".__PACKAGE__." Constuctor\n \'$varName\' not supplied\n");
return undef;
}
$self->{$varName} = $parms{$varName};
}
my $parent = $self->{parent};
my $groupID = $parent->IDget;
my $groupName = $parent->nameGet;
my $name = $self->{name};
my $datasetID;
#####
# Turn Error Reporting off for the following, so H5 lib doesn't complain
# if the group isn't found.
PDL::IO::HDF5::H5errorOff();
my $rc = PDL::IO::HDF5::H5Gget_objinfo($groupID, $name,1,0);
PDL::IO::HDF5::H5errorOn();
# See if the dataset exists:
if( $rc >= 0){
#DataSet Exists open it:
$datasetID = PDL::IO::HDF5::H5Dopen($groupID, $name);
if($datasetID < 0 ){
carp "Error Calling ".__PACKAGE__." Constuctor: Can't open existing dataset '$name'\n";
return undef;
}
}
else{ # dataset didn't exist, set datasetID = 0
## (Have to put off opening the dataset
### until it is written to (Must know dims, etc to create)
$datasetID = 0;
}
$self->{ID} = $datasetID;
bless $self, $type;
return $self;
}
=head2 DESTROY
=for ref
PDL::IO::HDF5::Dataset Destructor - Closes the dataset object
B<Usage:>
=for usage
No Usage. Automatically called
=cut
sub DESTROY {
my $self = shift;
my $datasetID = $self->{ID};
# print "In DataSet DEstroy\n";
if( $datasetID && (PDL::IO::HDF5::H5Dclose($self->{ID}) < 0 )){
warn("Error closing HDF5 Dataset '".$self->{name}."' in file:group: '".$self->{filename}.":".$self->{group}."'\n");
}
}
=head2 set
=for ref
Write data to the HDF5 dataset
B<Usage:>
=for usage
$dataset->set($pdl, unlimited => 1); # Write the array data in the dataset
Options:
unlimited If present, the dataset is created with unlimited dimensions.
=cut
#############################################################################
# Mapping of PDL types to HDF5 types for writing to a dataset
#
# Mapping of PDL types to what HDF5 calls them while we are dealing with them
# outside of the HDF5 file.
%PDLtoHDF5internalTypeMapping = (
$PDL::Types::PDL_B => PDL::IO::HDF5::H5T_NATIVE_CHAR(),
$PDL::Types::PDL_S => PDL::IO::HDF5::H5T_NATIVE_SHORT(),
$PDL::Types::PDL_L => PDL::IO::HDF5::H5T_NATIVE_INT(),
$PDL::Types::PDL_LL => PDL::IO::HDF5::H5T_NATIVE_LLONG(),
$PDL::Types::PDL_F => PDL::IO::HDF5::H5T_NATIVE_FLOAT(),
$PDL::Types::PDL_D => PDL::IO::HDF5::H5T_NATIVE_DOUBLE(),
);
# Mapping of PDL types to what types they are written to in the HDF5 file.
# For 64 Bit machines, we might need to modify this with some smarts to determine
# what is appropriate
my %PDLtoHDF5fileMapping;
if ( $Config{byteorder} =~ m/4321$/ ) {
# Big endian.
%PDLtoHDF5fileMapping = (
$PDL::Types::PDL_B => PDL::IO::HDF5::H5T_STD_I8BE(),
$PDL::Types::PDL_S => PDL::IO::HDF5::H5T_STD_I16BE(),
$PDL::Types::PDL_L => PDL::IO::HDF5::H5T_STD_I32BE(),
$PDL::Types::PDL_LL => PDL::IO::HDF5::H5T_STD_I64BE(),
$PDL::Types::PDL_F => PDL::IO::HDF5::H5T_IEEE_F32BE(),
$PDL::Types::PDL_D => PDL::IO::HDF5::H5T_IEEE_F64BE(),
);
} else {
# Little endian.
%PDLtoHDF5fileMapping = (
$PDL::Types::PDL_B => PDL::IO::HDF5::H5T_STD_I8LE(),
$PDL::Types::PDL_S => PDL::IO::HDF5::H5T_STD_I16LE(),
$PDL::Types::PDL_L => PDL::IO::HDF5::H5T_STD_I32LE(),
$PDL::Types::PDL_LL => PDL::IO::HDF5::H5T_STD_I64LE(),
$PDL::Types::PDL_F => PDL::IO::HDF5::H5T_IEEE_F32LE(),
$PDL::Types::PDL_D => PDL::IO::HDF5::H5T_IEEE_F64LE(),
);
}
sub set{
my $self = shift;
my $pdl = shift;
my %options = @_
if ( scalar(@_) >= 1 );
my $parent = $self->{parent};
my $groupID = $parent->IDget;
my $datasetID = $self->{ID};
my $name = $self->{name};
my $internalhdf5_type; # hdf5 type that describes the way data is stored in memory
my $hdf5Filetype; # hdf5 type that describes the way data will be stored in the file.
my @dims; # hdf5 equivalent dims for the supplied PDL
my $type = $pdl->get_datatype; # get PDL datatype
if( $pdl->isa('PDL::Char') ){ # Special Case for PDL::Char Objects (fixed length strings)
@dims = $pdl->dims;
my $length = shift @dims; # String length is the first dim of the PDL for PDL::Char
# Create Null-Terminated String Type
$internalhdf5_type = PDL::IO::HDF5::H5Tcopy(PDL::IO::HDF5::H5T_C_S1());
PDL::IO::HDF5::H5Tset_size($internalhdf5_type, $length ); # make legth of type eaual to strings
$hdf5Filetype = $internalhdf5_type; # memory and file storage will be the same type
@dims = reverse(@dims); # HDF5 stores columns/rows in reverse order than pdl
}
else{ # Other PDL Types
unless( defined($PDLtoHDF5internalTypeMapping{$type}) ){
carp "Error Calling ".__PACKAGE__."::set: Can't map PDL type to HDF5 datatype\n";
return undef;
}
$internalhdf5_type = $PDLtoHDF5internalTypeMapping{$type};
unless( defined($PDLtoHDF5fileMapping{$type}) ){
carp "Error Calling ".__PACKAGE__."::set: Can't map PDL type to HDF5 datatype\n";
return undef;
}
$hdf5Filetype = $PDLtoHDF5fileMapping{$type};
@dims = reverse($pdl->dims); # HDF5 stores columns/rows in reverse order than pdl
}
my $dims = PDL::IO::HDF5::packList(@dims);
my $udims = $dims;
if ( exists($options{'unlimited'}) ) {
my $udim = pack ("L*", (PDL::IO::HDF5::H5S_UNLIMITED()));
my $rank = scalar(@dims)*2;
$udims = $udim x $rank;
}
my $dataspaceID = PDL::IO::HDF5::H5Screate_simple(scalar(@dims), $dims , $udims);
if( $dataspaceID < 0 ){
carp("Can't Open Dataspace in ".__PACKAGE__.":set\n");
return undef;
}
if( $datasetID == 0){ # Dataset not created yet
my $propertiesID;
if ( exists($options{'unlimited'}) ) {
$propertiesID = PDL::IO::HDF5::H5Pcreate(PDL::IO::HDF5::H5P_DATASET_CREATE());
if( $propertiesID < 0 ){
carp("Can't Open Properties in ".__PACKAGE__.":set\n");
return undef;
}
if ( PDL::IO::HDF5::H5Pset_chunk($propertiesID,scalar(@dims),$dims) < 0 ) {
carp("Error setting chunk size in ".__PACKAGE__.":set\n");
return undef;
}
# /* Create the dataset. */
$datasetID = PDL::IO::HDF5::H5Dcreate($groupID, $name, $hdf5Filetype, $dataspaceID,
$propertiesID);
} else {
# /* Create the dataset. */
$datasetID = PDL::IO::HDF5::H5Dcreate($groupID, $name, $hdf5Filetype, $dataspaceID,
PDL::IO::HDF5::H5P_DEFAULT());
}
if( $datasetID < 0){
carp("Can't Create Dataspace in ".__PACKAGE__.":set\n");
return undef;
}
$self->{ID} = $datasetID;
if ( exists($options{'unlimited'}) ) {
if ( PDL::IO::HDF5::H5Pclose($propertiesID) < 0 ) {
carp("Error closing properties in ".__PACKAGE__.":set\n");
return undef;
}
}
}
# Write the actual data:
my $data = ${$pdl->get_dataref};
if( PDL::IO::HDF5::H5Dextend($datasetID,$dims) < 0 ){
carp("Error extending dataset in ".__PACKAGE__.":set\n");
return undef;
}
if( PDL::IO::HDF5::H5Dwrite($datasetID, $internalhdf5_type, PDL::IO::HDF5::H5S_ALL(), PDL::IO::HDF5::H5S_ALL(), PDL::IO::HDF5::H5P_DEFAULT(),
$data) < 0 ){
carp("Error Writing to dataset in ".__PACKAGE__.":set\n");
return undef;
}
# /* Terminate access to the data space. */
carp("Can't close Dataspace in ".__PACKAGE__.":set\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return 1;
}
=head2 get
=for ref
Get data from a HDF5 dataset to a PDL
B<Usage:>
=for usage
$pdl = $dataset->get; # Read the Array from the HDF5 dataset, create a PDL from it
# and put in $pdl
# Assuming $dataset is three dimensional
# with dimensions (20,100,90)
The I<get> method can also be used to obtain particular slices or hyperslabs
of the dataset array. For example, if $dataset is three dimensional with dimensions
(20,100,90) then we could do:
$start=pdl([0,0,0]); # We begin the slice at the very beginning
$end=pdl([19,0,0]); # We take the first vector of the array,
$stride=pdl([2,1,1]); # taking only every two values of the vector
$pdl = $dataset->get($start,$end,[$stride]); # Read a slice or
# hyperslab from the HDF5 dataset.
# $start, $end and optionally $stride
# should be PDL vectors with length the
# number of dimensions of the dataset.
# $start gives the starting coordinates
# in the array.
# $end gives the ending coordinate
# in the array
# $stride gives the steps taken from one
# coordinate to the next of the slice
The mapping of HDF5 datatypes in the file to PDL datatypes in memory will be according
to the following table.
HDF5 File Type PDL Type
------------------------ -----------------
PDL::IO::HDF5::H5T_C_S1() => PDL::Char Object (Special Case for Char Strings)
PDL::IO::HDF5::H5T_STD_I8BE() => $PDL::Types::PDL_B
PDL::IO::HDF5::H5T_STD_I8LE() => $PDL::Types::PDL_B,
PDL::IO::HDF5::H5T_STD_U8BE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_U8LE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_I16BE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_I16LE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_U16BE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_U16LE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_I32BE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_I32LE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_U32LE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_STD_U32BE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_STD_I64LE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_STD_I64BE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_IEEE_F32BE()=> $PDL::Types::PDL_F,
PDL::IO::HDF5::H5T_IEEE_F32LE()=> $PDL::Types::PDL_F,
PDL::IO::HDF5::H5T_IEEE_F64BE()=> $PDL::Types::PDL_D,
PDL::IO::HDF5::H5T_IEEE_F64LE()=> $PDL::Types::PDL_D
For HDF5 File types not in this table, this method will attempt to
map it to the default PDL type PDL_D.
If the dataset being read is a scalar reference, the referenced dataset region will be read instead.
B<Note:>
Character arrays are returned as the special L<PDL::Char> fixed-length string type. For fixed-length
HDF5 string arrays, this is a direct mapping to the PDL::Char datatype. For HDF5 variable-length string
arrays, the data is converted to a fixed-length character array, with a string size equal to the maximum
size of all the strings in the array.
=cut
#############################################################################
# Mapping of HDF5 file types to PDL types
# For 64 Bit machines, we might need to modify this with some smarts to determine
# what is appropriate
%HDF5toPDLfileMapping = (
PDL::IO::HDF5::H5T_STD_I8BE() => $PDL::Types::PDL_B,
PDL::IO::HDF5::H5T_STD_I8LE() => $PDL::Types::PDL_B,
PDL::IO::HDF5::H5T_STD_U8BE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_U8LE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_I16BE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_I16LE() => $PDL::Types::PDL_S,
PDL::IO::HDF5::H5T_STD_U16BE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_U16LE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_I32BE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_I32LE() => $PDL::Types::PDL_L,
PDL::IO::HDF5::H5T_STD_U32LE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_STD_U32BE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_STD_I64LE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_STD_I64BE() => $PDL::Types::PDL_LL,
PDL::IO::HDF5::H5T_IEEE_F32BE() => $PDL::Types::PDL_F,
PDL::IO::HDF5::H5T_IEEE_F32LE() => $PDL::Types::PDL_F,
PDL::IO::HDF5::H5T_IEEE_F64BE() => $PDL::Types::PDL_D,
PDL::IO::HDF5::H5T_IEEE_F64LE() => $PDL::Types::PDL_D
);
$H5T_STRING = PDL::IO::HDF5::H5T_STRING (); #HDF5 string type
$H5T_REFERENCE = PDL::IO::HDF5::H5T_REFERENCE(); #HDF5 reference type
sub get{
my $self = shift;
my $start = shift;
my $end = shift;
my $stride = shift;
my $pdl;
my $rc; # H5 library call return code
my $parent = $self->{parent};
my $groupID = $parent->IDget;
my $datasetID = $self->{ID};
my $name = $self->{name};
my $stringSize; # String size, if we are retrieving a string type
my $PDLtype; # PDL type that the data will be mapped to
my $internalhdf5_type; # Type that represents how HDF5 will store the data in memory (after retreiving from
# the file)
my $ReturnType = 'PDL'; # Default object returned is PDL. If strings are store, then this will
# return PDL::Char
my $isReference = 0; # Indicates if dataset is a reference
my $datasetReference; # Data set reference
my $referencedDatasetID; # ID of referenced dataset
# Get the HDF5 file datatype;
my $HDF5type = PDL::IO::HDF5::H5Dget_type($datasetID );
unless( $HDF5type >= 0 ){
carp "Error Calling ".__PACKAGE__."::get: Can't get HDF5 Dataset type.\n";
return undef;
}
# Check for string type:
my $varLenString = 0; # Flag = 1 if reading variable-length string array
if( PDL::IO::HDF5::H5Tget_class($HDF5type ) == $H5T_STRING ){ # String type
# Check for variable length string"
if( ! PDL::IO::HDF5::H5Tis_variable_str($HDF5type ) ){
# Not a variable length string
$stringSize = PDL::IO::HDF5::H5Tget_size($HDF5type);
unless( $stringSize >= 0 ){
carp "Error Calling ".__PACKAGE__."::get: Can't get HDF5 String Datatype Size.\n";
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
return undef;
}
$internalhdf5_type = $HDF5type; # internal storage the same as the file storage.
}
else{
# Variable-length String, set flag
$varLenString = 1;
# Create variable-length type for reading from the file
$internalhdf5_type = PDL::IO::HDF5::H5Tcopy(PDL::IO::HDF5::H5T_C_S1() );
PDL::IO::HDF5::H5Tset_size( $internalhdf5_type, PDL::IO::HDF5::H5T_VARIABLE() );
}
$PDLtype = $PDL::Types::PDL_B;
$ReturnType = 'PDL::Char'; # For strings, we return a PDL::Char
}
elsif ( PDL::IO::HDF5::H5Tget_class($HDF5type) == $H5T_REFERENCE ) { # Reference type
# Flag that dataset is a reference
$isReference = 1;
# Check that the reference dataset is a single element
my $dataspaceID = PDL::IO::HDF5::H5Dget_space($datasetID);
my $Ndims = PDL::IO::HDF5::H5Sget_simple_extent_ndims($dataspaceID);
if( $Ndims != 0 ){
carp("Can't handle non-scalar references ".__PACKAGE__.":get\n");
carp("Can't close Dataspace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
# Read the reference
my $howBig = PDL::IO::HDF5::H5Tget_size(PDL::IO::HDF5::H5T_STD_REF_DSETREG());
$datasetReference = ' ' x $howBig;
$rc = PDL::IO::HDF5::H5Dread($datasetID, PDL::IO::HDF5::H5T_STD_REF_DSETREG(), PDL::IO::HDF5::H5S_ALL(),
PDL::IO::HDF5::H5S_ALL(),
PDL::IO::HDF5::H5P_DEFAULT(),
$datasetReference);
# Dereference the reference
$referencedDatasetID = PDL::IO::HDF5::H5Rdereference($datasetID,PDL::IO::HDF5::H5R_DATASET_REGION(),$datasetReference);
# Get the data type of the dereferenced object
$HDF5type = PDL::IO::HDF5::H5Dget_type($referencedDatasetID);
# Map the HDF5 file datatype to a PDL datatype
$PDLtype = $PDL::Types::PDL_D; # Default type is double
my $defaultType;
foreach $defaultType( keys %HDF5toPDLfileMapping){
if( PDL::IO::HDF5::H5Tequal($defaultType,$HDF5type) > 0){
$PDLtype = $HDF5toPDLfileMapping{$defaultType};
last;
}
}
# Get the HDF5 internal datatype that corresponds to the PDL type
unless( defined($PDLtoHDF5internalTypeMapping{$PDLtype}) ){
carp "Error Calling ".__PACKAGE__."::set: Can't map PDL type to HDF5 datatype\n";
return undef;
}
$internalhdf5_type = $PDLtoHDF5internalTypeMapping{$PDLtype};
}
else{ # Normal Numeric Type
# Map the HDF5 file datatype to a PDL datatype
$PDLtype = $PDL::Types::PDL_D; # Default type is double
my $defaultType;
foreach $defaultType( keys %HDF5toPDLfileMapping){
if( PDL::IO::HDF5::H5Tequal($defaultType,$HDF5type) > 0){
$PDLtype = $HDF5toPDLfileMapping{$defaultType};
last;
}
}
# Get the HDF5 internal datatype that corresponds to the PDL type
unless( defined($PDLtoHDF5internalTypeMapping{$PDLtype}) ){
carp "Error Calling ".__PACKAGE__."::set: Can't map PDL type to HDF5 datatype\n";
return undef;
}
$internalhdf5_type = $PDLtoHDF5internalTypeMapping{$PDLtype};
}
my $dataspaceID;
if ( $isReference == 1 ) {
# Get the dataspace from the reference
$dataspaceID = PDL::IO::HDF5::H5Rget_region($datasetID,PDL::IO::HDF5::H5R_DATASET_REGION(),$datasetReference);
# Now reset the dataset ID to that of the referenced dataset for all further use
$datasetID = $referencedDatasetID;
} else {
# Get the dataspace from the dataset itself
$dataspaceID = PDL::IO::HDF5::H5Dget_space($datasetID);
}
if( $dataspaceID < 0 ){
carp("Can't Open Dataspace in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
return undef;
}
# Get the number of dims:
my $Ndims = PDL::IO::HDF5::H5Sget_simple_extent_ndims($dataspaceID);
if( $Ndims < 0 ){
carp("Can't Get Number of Dims in Dataspace in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
my @dims = ( 0..($Ndims-1));
my ($mem_space,$file_space);
if ( $isReference == 1) {
my @startAt = ( 0..($Ndims-1));
my @endAt = ( 0..($Ndims-1));
my $startAt = PDL::IO::HDF5::packList(@startAt);
my $endAt = PDL::IO::HDF5::packList(@endAt);
my $rc = PDL::IO::HDF5::H5Sget_select_bounds($dataspaceID, $startAt, $endAt );
if( $rc < 0 ){
carp("Error getting number of dims in dataspace in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
@startAt = PDL::IO::HDF5::unpackList($startAt);
@endAt = PDL::IO::HDF5::unpackList($endAt);
for(my $i=0;$i<=$#dims;++$i) {
$dims[$i] = $endAt[$i]-$startAt[$i]+1;
}
if (not defined $start) {
$start = PDL->zeros($Ndims);
$end = PDL->zeros($Ndims);
$start .= PDL->pdl(@startAt);
$end .= PDL->pdl(@endAt);
} else {
$start += PDL->pdl(@startAt);
$end += PDL->pdl(@startAt);
}
}
if (not defined $start) {
# Initialize Dims structure:
my $dims = PDL::IO::HDF5::packList(@dims);
my $dims2 = PDL::IO::HDF5::packList(@dims);
my $rc = PDL::IO::HDF5::H5Sget_simple_extent_dims($dataspaceID, $dims, $dims2 );
if( $rc != $Ndims){
carp("Error getting number of dims in dataspace in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
@dims = PDL::IO::HDF5::unpackList($dims); # get the dim sizes from the binary structure
} else {
if ( ($start->getndims != 1) || ($start->getdim(0) != $Ndims) ){
carp("Wrong dimensions in start PDL in ".__PACKAGE__."\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
my $start2 = PDL::IO::HDF5::packList(reverse($start->list));
if (not defined $end) {
carp("No end supplied in ".__PACKAGE__."\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
if ( ($end->getndims != 1) || ($end->getdim(0) != $Ndims) ) {
carp("Wrong dimensions in end PDL in ".__PACKAGE__."\n") ;
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
my $length2;
if (defined $stride) {
if ( ($stride->getndims != 1) ||
($stride->getdim(0) != $Ndims) ) {
carp("Wrong dimensions in stride in ".__PACKAGE__."\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
@dims=reverse((($end-$start+1)/$stride)->list);
$length2 = PDL::IO::HDF5::packList(@dims);
} else {
@dims=reverse(($end-$start+1)->list);
$length2 = PDL::IO::HDF5::packList(@dims);
$stride=PDL::Core::ones($Ndims);
}
my $mem_dims = PDL::IO::HDF5::packList(@dims);
my $stride2 = PDL::IO::HDF5::packList(reverse($stride->list));
my $block=PDL::Core::ones($Ndims);
my $block2 = PDL::IO::HDF5::packList(reverse($block->list));
# Slice the data
$file_space = PDL::IO::HDF5::H5Dget_space($datasetID);
$rc=PDL::IO::HDF5::H5Sselect_hyperslab($file_space, 0,
$start2, $stride2, $length2, $block2);
if( $rc < 0 ){
carp("Error slicing data from file in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
$mem_space = PDL::IO::HDF5::H5Screate_simple($Ndims, $mem_dims,
$mem_dims);
}
# Create initial PDL null array with the proper datatype
$pdl = $ReturnType->null;
$pdl->set_datatype($PDLtype);
my @pdldims; # dims of the PDL
my $datatypeSize; # Size of one element of data stored
if( defined( $stringSize )){ # Fixed-Length String types
@pdldims = ($stringSize,reverse(@dims)); # HDF5 stores columns/rows in reverse order than pdl,
# 1st PDL dim is the string length (for PDL::Char)
$datatypeSize = PDL::howbig($pdl->get_datatype);
}
elsif( $varLenString ){ # Variable-length String
# (Variable length string arrays will be converted to fixed-length strings later)
@pdldims = (reverse(@dims)); # HDF5 stores columns/rows in reverse order than pdl
# Variable length strings are stored as arrays of string pointers, so get that size
# This will by 4 bytes on 32-bit machines, and 8 bytes on 64-bit machines.
$datatypeSize = PDL::IO::HDF5::bufPtrSize();
}
else{ # Normal Numeric types
# (Variable length string arrays will be converted to fixed-length strings later)
@pdldims = (reverse(@dims)); # HDF5 stores columns/rows in reverse order than pdl
$datatypeSize = PDL::howbig($pdl->get_datatype);
}
$pdl->setdims(\@pdldims);
my $nelems = 1;
foreach (@pdldims){ $nelems *= $_; }; # calculate the number of elements
my $datasize = $nelems * $datatypeSize;
# Create empty space for the data
# Incrementally, to get around problem on win32
my $howBig = $datatypeSize;
my $data = ' ' x $howBig;
foreach my $dim(@pdldims){
$data = $data x $dim;
}
# Read the data:
if (not defined $start) {
$rc = PDL::IO::HDF5::H5Dread($datasetID, $internalhdf5_type, PDL::IO::HDF5::H5S_ALL(), PDL::IO::HDF5::H5S_ALL(),
PDL::IO::HDF5::H5P_DEFAULT(),
$data);
} else {
$rc = PDL::IO::HDF5::H5Dread($datasetID, $internalhdf5_type,
$mem_space, $file_space,
PDL::IO::HDF5::H5P_DEFAULT(),
$data);
}
if( $rc < 0 ){
carp("Error reading data from file in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
if( $varLenString ){
# Convert variable-length string to fixed-length string, to be compatible with the PDL::Char type
my $maxsize = PDL::IO::HDF5::findMaxVarLenSize($data, $nelems);
# Create empty space for the fixed-length data
# Incrementally, to get around problem on win32
my $howBig = $maxsize + 1; # Adding one to include the null string terminator
my $fixeddata = ' ' x $howBig;
foreach my $dim(@pdldims){
$fixeddata = $fixeddata x $dim;
}
PDL::IO::HDF5::copyVarLenToFixed($data, $fixeddata, $nelems, $maxsize);
# Reclaim data from HDF5 system (HDF5 allocates memory when it reads variable-length strings)
$rc = PDL::IO::HDF5::H5Dvlen_reclaim ($internalhdf5_type, $dataspaceID, PDL::IO::HDF5::H5P_DEFAULT(), $data);
if( $rc < 0 ){
carp("Error reclaiming memeory while reading data from file in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
# Adjust for fixed-length PDL creation
$data = $fixeddata;
unshift @pdldims, ($maxsize+1);
}
# Setup the PDL with the proper dimensions and data
$pdl->setdims(\@pdldims);
# Update the PDL data with the data read from the file
${$pdl->get_dataref()} = $data;
$pdl->upd_data();
# /* Terminate access to the data space. */
carp("Can't close Dataspace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
# /* Terminate access to the data type. */
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
return $pdl;
}
=head2 dims
=for ref
Get the dims for a HDF5 dataset. For example, a 3 x 4 array would return a perl array
(3,4);
B<Usage:>
=for usage
@pdl = $dataset->dims; # Get an array of dims.
=cut
sub dims{
my $self = shift;
my $parent = $self->{parent};
my $groupID = $parent->IDget;
my $datasetID = $self->{ID};
my $name = $self->{name};
my $dataspaceID = PDL::IO::HDF5::H5Dget_space($datasetID);
if( $dataspaceID < 0 ){
carp("Can't Open Dataspace in ".__PACKAGE__.":get\n");
return undef;
}
# Get the number of dims:
my $Ndims = PDL::IO::HDF5::H5Sget_simple_extent_ndims($dataspaceID);
if( $Ndims < 0 ){
carp("Can't Get Number of Dims in Dataspace in ".__PACKAGE__.":get\n");
return undef;
}
# Initialize Dims structure:
my @dims = ( 0..($Ndims-1));
my $dims = PDL::IO::HDF5::packList(@dims);
my $dims2 = PDL::IO::HDF5::packList(@dims);
my $rc = PDL::IO::HDF5::H5Sget_simple_extent_dims($dataspaceID, $dims, $dims2 );
if( $rc != $Ndims){
carp("Error getting number of dims in dataspace in ".__PACKAGE__.":get\n");
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
@dims = PDL::IO::HDF5::unpackList($dims); # get the dim sizes from the binary structure
return reverse @dims; # return dims in the order that PDL will store them
}
=head2 attrSet
=for ref
Set the value of an attribute(s)
Attribute types supported are null-terminated strings and PDL matrices
B<Usage:>
=for usage
$dataset->attrSet( 'attr1' => 'attr1Value',
'attr2' => 'attr2 value',
'attr3' => $pdl,
.
.
.
);
Returns undef on failure, 1 on success.
=cut
sub attrSet {
my $self = shift;
my %attrs = @_; # get atribute hash
my $datasetID = $self->{ID};
unless( $datasetID){ # Error checking
carp("Can't Set Attribute for empty dataset. Try writing some data to it first:\n");
carp(" in file:group: '".$self->{filename}.":".$self->{group}."'\n");
return undef;
}
my($key,$value);
my $typeID; # id used for attribute
my $dataspaceID; # id used for the attribute dataspace
my $attrID;
foreach $key( sort keys %attrs){
$value = $attrs{$key};
if (ref($value) =~ /^PDL/) {
my $internalhdf5_type; # hdf5 type that describes the way data is stored in memory
my @dims; # hdf5 equivalent dims for the supplied PDL
my $type = $value->get_datatype; # get PDL datatype
if( $value->isa('PDL::Char') ){ # Special Case for PDL::Char Objects (fixed length strings)
@dims = $value->dims;
my $length = shift @dims; # String length is the first dim of the PDL for PDL::Char
# Create Null-Terminated String Type
$internalhdf5_type = PDL::IO::HDF5::H5Tcopy(PDL::IO::HDF5::H5T_C_S1());
PDL::IO::HDF5::H5Tset_size($internalhdf5_type, $length ); # make legth of type eaual to strings
$typeID = $internalhdf5_type; # memory and file storage will be the same type
@dims = reverse(@dims); # HDF5 stores columns/rows in reverse order than pdl
} else { # Other PDL Types
unless( defined($PDLtoHDF5internalTypeMapping{$type}) ){
carp "Error Calling ".__PACKAGE__."::set: Can't map PDL type to HDF5 datatype\n";
return undef;
}
$internalhdf5_type = $PDLtoHDF5internalTypeMapping{$type};
$typeID = PDL::IO::HDF5::H5Tcopy($internalhdf5_type);
@dims = reverse($value->dims); # HDF5 stores columns/rows in reverse order than pdl
}
my $dims = PDL::IO::HDF5::packList(@dims);
$value = ${$value->get_dataref};
$dataspaceID = PDL::IO::HDF5::H5Screate_simple(scalar(@dims), $dims , $dims);
if( $dataspaceID < 0 ){
carp("Can't Open Dataspace in ".__PACKAGE__.":set\n");
return undef;
}
} else {
# Create Null-Terminated String Type
$typeID = PDL::IO::HDF5::H5Tcopy(PDL::IO::HDF5::H5T_C_S1());
PDL::IO::HDF5::H5Tset_size($typeID, length($value) || 1 ); # make legth of type eaual to length of $value or 1 if zero
$dataspaceID = PDL::IO::HDF5::H5Screate_simple(0, 0, 0);
}
#Note: If a attr already exists, then it will be deleted an re-written
# Delete the attribute first
PDL::IO::HDF5::H5errorOff(); # keep h5 lib from complaining
PDL::IO::HDF5::H5Adelete($datasetID, $key);
PDL::IO::HDF5::H5errorOn();
$attrID = PDL::IO::HDF5::H5Acreate($datasetID, $key, $typeID, $dataspaceID, PDL::IO::HDF5::H5P_DEFAULT());
if($attrID < 0 ){
carp "Error in ".__PACKAGE__." attrSet; Can't create attribute '$key'\n";
PDL::IO::HDF5::H5Sclose($dataspaceID);
PDL::IO::HDF5::H5Tclose($typeID); # Cleanup
return undef;
}
# Write the attribute data.
if( PDL::IO::HDF5::H5Awrite($attrID, $typeID, $value) < 0){
carp "Error in ".__PACKAGE__." attrSet; Can't write attribute '$key'\n";
PDL::IO::HDF5::H5Aclose($attrID);
PDL::IO::HDF5::H5Sclose($dataspaceID);
PDL::IO::HDF5::H5Tclose($typeID); # Cleanup
return undef;
}
# Cleanup
PDL::IO::HDF5::H5Aclose($attrID);
PDL::IO::HDF5::H5Sclose($dataspaceID);
PDL::IO::HDF5::H5Tclose($typeID);
}
# Clear-out the attribute index, it is no longer valid with the updates
# we just made.
$self->{fileObj}->clearAttrIndex;
return 1;
}
=head2 attrDel
=for ref
Delete attribute(s)
B<Usage:>
=for usage
$dataset->attrDel( 'attr1',
'attr2',
.
.
.
);
Returns undef on failure, 1 on success.
=cut
sub attrDel {
my $self = shift;
my @attrs = @_; # get atribute names
my $datasetID = $self->{ID};
my $attr;
my $rc; #Return code returned by H5Adelete
foreach $attr( @attrs ){
# Note: We don't consider errors here as cause for aborting, we just
# complain using carp
if( PDL::IO::HDF5::H5Adelete($datasetID, $attr) < 0){
carp "Error in ".__PACKAGE__." attrDel; Error Deleting attribute '$attr'\n";
}
}
# Clear-out the attribute index, it is no longer valid with the updates
# we just made.
$self->{fileObj}->clearAttrIndex;
return 1;
}
=head2 attrs
=for ref
Get a list of all attribute names associated with a dataset
B<Usage:>
=for usage
@attrs = $dataset->attrs;
=cut
sub attrs {
my $self = shift;
my $datasetID = $self->{ID};
my $defaultMaxSize = 256; # default max size of a attribute name
my $noAttr = PDL::IO::HDF5::H5Aget_num_attrs($datasetID); # get the number of attributes
my $attrIndex = 0; # attribute Index
my @attrNames = ();
my $attributeID;
my $attrNameSize; # size of the attribute name
my $attrName; # attribute name
# Go thru each attribute and get the name
for( $attrIndex = 0; $attrIndex < $noAttr; $attrIndex++){
$attributeID = PDL::IO::HDF5::H5Aopen_idx($datasetID, $attrIndex );
if( $attributeID < 0){
carp "Error in ".__PACKAGE__." attrs; Error Opening attribute number $attrIndex\n";
next;
}
#init attrname to 256 length string (Maybe this not necessary with
# the typemap)
$attrName = ' ' x 256;
# Get the name
$attrNameSize = PDL::IO::HDF5::H5Aget_name($attributeID, 256, $attrName );
# If the name is greater than 256, try again with the proper size:
if( $attrNameSize > 256 ){
$attrName = ' ' x $attrNameSize;
$attrNameSize = PDL::IO::HDF5::H5Aget_name($attributeID, $attrNameSize, $attrName );
}
push @attrNames, $attrName;
# Close the attr:
PDL::IO::HDF5::H5Aclose($attributeID);
}
return @attrNames;
}
=head2 attrGet
=for ref
Get the value of an attribute(s)
Currently the attribute types supported are null-terminated strings
and PDLs.
B<Usage:>
=for usage
my @attrs = $dataset->attrGet( 'attr1', 'attr2');
=cut
sub attrGet {
my $self = shift;
my @attrs = @_; # get atribute array
my $datasetID = $self->{ID};
my($attrName,$attrValue);
my @attrValues; #return array
my $typeID; # id used for attribute
my $dataspaceID; # id used for the attribute dataspace
my $attrID;
my $stringSize;
my $Ndims;
foreach $attrName( @attrs){
undef($stringSize);
$attrValue = undef;
# Open the Attribute
$attrID = PDL::IO::HDF5::H5Aopen_name($datasetID, $attrName );
unless( $attrID >= 0){
carp "Error Calling ".__PACKAGE__."::attrget: Can't open HDF5 Attribute name '$attrName'.\n";
next;
}
# Open the data-space
$dataspaceID = PDL::IO::HDF5::H5Aget_space($attrID);
if( $dataspaceID < 0 ){
carp("Can't Open Dataspace for Attribute name '$attrName' in ".__PACKAGE__."::attrget\n");
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
# Check to see if the dataspace is simple
if( PDL::IO::HDF5::H5Sis_simple($dataspaceID) < 0 ){
carp("Warning: Non-Simple Dataspace for Attribute name '$attrName' ".__PACKAGE__."::attrget\n");
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
# Get the number of dims:
$Ndims = PDL::IO::HDF5::H5Sget_simple_extent_ndims($dataspaceID);
unless( $Ndims >= 0){
if( $Ndims < 0 ){
carp("Warning: Can't Get Number of Dims in Attribute name '$attrName' Dataspace in ".__PACKAGE__.":get\n");
}
#if( $Ndims > 0 ){
# carp("Warning: Non-Scalar Dataspace for Attribute name '$attrName' Dataspace in ".__PACKAGE__.":get\n");
#}
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
my $HDF5type;
if ($Ndims == 0) {
# If it is a scalar we do this
# Get the HDF5 dataset datatype;
$HDF5type = PDL::IO::HDF5::H5Aget_type($attrID );
unless( $HDF5type >= 0 ){
carp "Error Calling ".__PACKAGE__."::attrGet: Can't get HDF5 Dataset type in Attribute name '$attrName'.\n";
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
# Get the size so we can allocate space for it
my $size = PDL::IO::HDF5::H5Tget_size($HDF5type);
unless( $size){
carp "Error Calling ".__PACKAGE__."::attrGet: Can't get HDF5 Dataset type size in Attribute name '$attrName'.\n";
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
#init attr value to the length of the type
my $data = ' ' x ($size);
my $PDLtype;
my $ReturnType;
my $internalhdf5_type;
if( PDL::IO::HDF5::H5Tget_class($HDF5type ) == PDL::IO::HDF5::H5T_STRING() ){ # String type
$PDLtype = $PDL::Types::PDL_B;
$internalhdf5_type = $HDF5type; # internal storage the same as the file storage.
$ReturnType = 'PDL::Char'; # For strings, we return a PDL::Char
$stringSize = PDL::IO::HDF5::H5Tget_size($HDF5type);
unless( $stringSize >= 0 ){
carp "Error Calling ".__PACKAGE__."::attrGet: Can't get HDF5 String Datatype Size.\n";
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
return undef;
}
}
else{ # Normal Numeric Type
# Map the HDF5 file datatype to a PDL datatype
$PDLtype = $PDL::Types::PDL_D; # Default type is double
$ReturnType = 'PDL';
my $defaultType;
foreach $defaultType( keys %HDF5toPDLfileMapping){
if( PDL::IO::HDF5::H5Tequal($defaultType,$HDF5type) > 0){
$PDLtype = $HDF5toPDLfileMapping{$defaultType};
last;
}
}
# Get the HDF5 internal datatype that corresponds to the PDL type
unless( defined($PDLtoHDF5internalTypeMapping{$PDLtype}) ){
carp "Error Calling ".__PACKAGE__."::attrGet: Can't map PDL type to HDF5 datatype\n";
return undef;
}
$internalhdf5_type = $PDLtoHDF5internalTypeMapping{$PDLtype};
}
if( PDL::IO::HDF5::H5Aread($attrID, $internalhdf5_type, $data) < 0 ){
carp "Error Calling ".__PACKAGE__."::attrGet: Can't read Attribute Value for Attribute name '$attrName'.\n";
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
$attrValue = $ReturnType->null;
$attrValue->set_datatype($PDLtype);
my @pdldims;
if( defined( $stringSize )){ # String types
@pdldims = ( $stringSize );
} else {
@pdldims = ( 1 );
}
$attrValue->setdims(\@pdldims);
# Update the PDL data with the data read from the file
${$attrValue->get_dataref()} = $data;
$attrValue->upd_data();
# End of scalar option
} else {
# This is a PDL
# Get the HDF5 dataset datatype;
$HDF5type = PDL::IO::HDF5::H5Aget_type($attrID );
unless( $HDF5type >= 0 ){
carp "Error Calling ".__PACKAGE__."::attrGet: Can't get HDF5 Dataset type in Attribute name '$attrName'.\n";
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
next;
}
#*********************************************************
my $stringSize;
my $PDLtype;
my $internalhdf5_type;
my $typeID;
my $ReturnType = 'PDL'; # Default object returned is PDL. If strings are store, then this will
# return PDL::Char
# Check for string type:
my $varLenString = 0; # Flag = 1 if reading variable-length string array
if( PDL::IO::HDF5::H5Tget_class($HDF5type ) == $H5T_STRING ){ # String type
# Check for variable length string"
if( ! PDL::IO::HDF5::H5Tis_variable_str($HDF5type ) ){
# Not a variable length string
$stringSize = PDL::IO::HDF5::H5Tget_size($HDF5type);
unless( $stringSize >= 0 ){
carp "Error Calling ".__PACKAGE__."::get: Can't get HDF5 String Datatype Size.\n";
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
return undef;
}
$internalhdf5_type = $HDF5type; # internal storage the same as the file storage.
}
else{
# Variable-length String, set flag
$varLenString = 1;
# Create variable-length type for reading from the file
$internalhdf5_type = PDL::IO::HDF5::H5Tcopy(PDL::IO::HDF5::H5T_C_S1() );
PDL::IO::HDF5::H5Tset_size( $internalhdf5_type, PDL::IO::HDF5::H5T_VARIABLE() );
}
$PDLtype = $PDL::Types::PDL_B;
$internalhdf5_type = $HDF5type; # internal storage the same as the file storage.
$typeID=$HDF5type;
$ReturnType = 'PDL::Char'; # For strings, we return a PDL::Char
}
else{ # Normal Numeric Type
# Map the HDF5 file datatype to a PDL datatype
$PDLtype = $PDL::Types::PDL_D; # Default type is double
my $defaultType;
foreach $defaultType( keys %HDF5toPDLfileMapping){
if( PDL::IO::HDF5::H5Tequal($defaultType,$HDF5type) > 0){
$PDLtype = $HDF5toPDLfileMapping{$defaultType};
last;
}
}
# Get the HDF5 internal datatype that corresponds to the PDL type
unless( defined($PDLtoHDF5internalTypeMapping{$PDLtype}) ){
carp "Error Calling ".__PACKAGE__."::set: Can't map PDL type to HDF5 datatype\n";
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
return undef;
}
$internalhdf5_type = $PDLtoHDF5internalTypeMapping{$PDLtype};
#$internalhdf5_type = $HDF5type; # internal storage the same as the file storage.
#$typeID = PDL::IO::HDF5::H5Tcopy($internalhdf5_type);
$typeID = $internalhdf5_type;
} # End of String or Numeric type
# Initialize Dims structure:
my @dims = ( 0..($Ndims-1));
my $dims = PDL::IO::HDF5::packList(@dims);
my $dims2 = PDL::IO::HDF5::packList(@dims);
my $rc = PDL::IO::HDF5::H5Sget_simple_extent_dims($dataspaceID, $dims, $dims2 );
if( $rc != $Ndims){
carp("Error getting number of dims in dataspace in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
return undef;
}
@dims = PDL::IO::HDF5::unpackList($dims); # get the dim sizes from the binary structure
# Create initial PDL null array with the proper datatype
$attrValue = $ReturnType->null;
$attrValue->set_datatype($PDLtype);
my @pdldims; # dims of the PDL
my $datatypeSize; # Size of one element of data stored
if( defined( $stringSize )){ # Fixed-Length String types
@pdldims = ($stringSize,reverse(@dims)); # HDF5 stores columns/rows in reverse order than pdl,
# 1st PDL dim is the string length (for PDL::Char)
$datatypeSize = PDL::howbig($attrValue->get_datatype);
}
elsif( $varLenString ){ # Variable-length String
# (Variable length string arrays will be converted to fixed-length strings later)
@pdldims = (reverse(@dims)); # HDF5 stores columns/rows in reverse order than pdl
# Variable length strings are stored as arrays of string pointers, so get that size
# This will by 4 bytes on 32-bit machines, and 8 bytes on 64-bit machines.
$datatypeSize = PDL::IO::HDF5::bufPtrSize();
}
else{ # Normal Numeric types
@pdldims = (reverse(@dims)); # HDF5 stores columns/rows in reverse order than pdl,
$datatypeSize = PDL::howbig($attrValue->get_datatype);
}
$attrValue->setdims(\@pdldims);
my $nelems = 1;
foreach (@pdldims){ $nelems *= $_; }; # calculate the number of elements
my $datasize = $nelems * $datatypeSize;
# Create empty space for the data
# Incrementally, to get around problem on win32
my $howBig = $datatypeSize;
my $data = ' ' x $howBig;
foreach my $dim(@pdldims){
$data = $data x $dim;
}
# Read the data:
$rc = PDL::IO::HDF5::H5Aread($attrID,$internalhdf5_type,$data);
if( $rc < 0 ){
carp("Error reading data from file in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
return undef;
}
if( $varLenString ){
# Convert variable-length string to fixed-length string, to be compatible with the PDL::Char type
my $maxsize = PDL::IO::HDF5::findMaxVarLenSize($data, $nelems);
# Create empty space for the fixed-length data
# Incrementally, to get around problem on win32
my $howBig = $maxsize + 1; # Adding one to include the null string terminator
my $fixeddata = ' ' x $howBig;
foreach my $dim(@pdldims){
$fixeddata = $fixeddata x $dim;
}
PDL::IO::HDF5::copyVarLenToFixed($data, $fixeddata, $nelems, $maxsize);
# Reclaim data from HDF5 system (HDF5 allocates memory when it reads variable-length strings)
$rc = PDL::IO::HDF5::H5Dvlen_reclaim ($internalhdf5_type, $dataspaceID, PDL::IO::HDF5::H5P_DEFAULT(), $data);
if( $rc < 0 ){
carp("Error reclaiming memeory while reading data from file in ".__PACKAGE__.":get\n");
carp("Can't close Datatype in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":get\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
return undef;
}
# Adjust for fixed-length PDL creation
$data = $fixeddata;
unshift @pdldims, ($maxsize+1);
}
# Setup the PDL with the proper dimensions and data
$attrValue->setdims(\@pdldims);
${$attrValue->get_dataref()} = $data;
$attrValue->upd_data();
#************************************************
} # End of PDL option
# Cleanup
carp("Can't close Datatype in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Tclose($HDF5type) < 0);
carp("Can't close DataSpace in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Sclose($dataspaceID) < 0);
carp("Can't close Attribute in ".__PACKAGE__.":attrGet\n") if( PDL::IO::HDF5::H5Aclose($attrID) < 0);
}
continue{
if ( $Ndims == 0 ) {
if (defined($stringSize)) {
push @attrValues, $attrValue->atstr(0);
} else {
push @attrValues, $attrValue->index(0);
}
} else {
push @attrValues, $attrValue;
}
}
return @attrValues;
}
=head2 IDget
=for ref
Returns the HDF5 library ID for this object
B<Usage:>
=for usage
my $ID = $dataSetObj->IDget;
=cut
sub IDget{
my $self = shift;
return $self->{ID};
}
=head2 nameGet
=for ref
Returns the HDF5 Dataset Name for this object.
B<Usage:>
=for usage
my $name = $datasetObj->nameGet;
=cut
sub nameGet{
my $self = shift;
return $self->{name};
}
1;
|