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
|
## File: PDL::CCS::IO::FITS.pm
## Author: Bryan Jurish <moocow@cpan.org>
## Description: PDL::IO::FITS wrappers for PDL::CCS::Nd
package PDL::CCS::IO::FITS;
use PDL::CCS::Version;
use PDL::CCS::Nd;
use PDL;
use PDL::CCS::IO::Common qw(:intern); ##-- for e.g. _ccsio_write_header, _ccsio_read_header
use Carp qw(confess);
use strict;
our $VERSION = '1.24.1';
our @ISA = ('PDL::Exporter');
our @EXPORT_OK =
(
qw(ccs_wfits ccs_rfits),
);
our %EXPORT_TAGS =
(
Func => [@EXPORT_OK], ##-- respect PDL conventions (hopefully)
);
##======================================================================
## pod: headers
=pod
=head1 NAME
PDL::CCS::IO::FITS - PDL::IO::FITS wrappers for PDL::CCS::Nd
=head1 SYNOPSIS
use PDL;
use PDL::CCS::Nd;
use PDL::CCS::IO::FITS;
$ccs = PDL::CCS::Nd->newFromWhich($which,$nzvals);
ccs_wfits($ccs,$fname); # write a pair of FITS files
$ccs2 = ccs_readfits($fname); # read a pair of FITS files
=cut
##======================================================================
## I/O utilities
=pod
=head1 I/O Utilities
=cut
##---------------------------------------------------------------
## ccs_wfits
=pod
=head2 ccs_wfits
Write a pair of FITS files using L<PDL::IO::FITS::wfits()|PDL::IO::FITS/wfits>.
Piddles of type L<indx|PDL::Core/indx> will be implicitly converted
to L<long|PDL::Core/long>, since they are not currently supported by L<PDL::IO::FITS|PDL::IO::FITS> in PDL v2.014.
ccs_wfits($ccs,$fname)
ccs_wfits($ccs,$fname,\%opts)
Options %opts:
Header => $Header, ##-- default="$fname.hdr"
ixFile => $ixFile, ##-- default="$fname.ix.fits"
nzFile => $nzFile, ##-- default="$fname.nz.fits"
=cut
*PDL::ccs_wfits = *PDL::CCS::Nd::wfits = \&ccs_wfits;
sub ccs_wfits {
my ($ccs,$fname,$opts) = @_;
##-- get filenames
my $hFile = $opts->{Header} // "$fname.hdr";
my $ixFile = $opts->{ixFile} // "$fname.ix.fits";
my $nzFile = $opts->{nzFile} // "$fname.nz.fits";
##-- write header
_ccsio_write_header($ccs, $hFile)
or confess("ccs_wfits(): failed to write header-file $hFile: $!");
##-- write pdls
## + hack: treat 'indx' as 'long' until PDL::IO::FITS supports it (PDL v2.014 .. v2.016)
my $ix = $ccs->_whichND->type->ioname eq 'indx' ? $ccs->_whichND->long : $ccs->_whichND;
my $vals = $ccs->_vals->type->ioname eq 'indx' ? $ccs->_vals->long : $ccs->_vals;
PDL::wfits($ix, $ixFile)
or confess("ccs_wfits(): failed to write index-file $ixFile: $!");
PDL::wfits($vals, $nzFile)
or confess("ccs_wfits(): failed to write values-file $nzFile: $!");
return 1;
}
##---------------------------------------------------------------
## ccs_rfits
=pod
=head2 ccs_rfits
Read a pair of FITS files using L<PDL::IO::FITS::rfits()|PDL::IO::FITS/rfits()>.
$ccs = ccs_rfits($fname)
$ccs = ccs_rfits($fname,\%opts)
Options %opts:
Header => $Header, ##-- default="$fname.hdr"
ixFile => $ixFile, ##-- default="$fname.ix.fits"
nzFile => $nzFile, ##-- default="$fname.nz.fits"
sorted => $bool, ##-- is data on disk already sorted? (default=1)
=cut
*PDL::ccs_rfits = *PDL::CCS::Nd::rfits = \&ccs_rfits;
sub ccs_rfits {
shift if (UNIVERSAL::isa($_[0],'PDL') || UNIVERSAL::isa($_[0],'PDL::CCS::Nd'));
my ($fname,$opts) = @_;
##-- get filenames
my $hFile = $opts->{Header} // "$fname.hdr";
my $ixFile = $opts->{ixFile} // "$fname.ix.fits";
my $nzFile = $opts->{nzFile} // "$fname.nz.fits";
##-- read header
my $header = _ccsio_read_header($hFile)
or confess("ccs_rfits(): failed to read header-file $hFile: $!");
##-- read pdls
defined(my $ix = PDL->rfits($ixFile))
or confess("ccs_rfits(): failed to read index-file $ixFile: $!");
defined(my $nz = PDL->rfits($nzFile))
or confess("ccs_rfits(): failed to read values-file $nzFile: $!");
##-- construct and return
return PDL::CCS::Nd->newFromWhich($ix,$nz,
pdims=>$header->{pdims},
vdims=>$header->{vdims},
flags=>$header->{flags},
sorted=>($opts->{sorted}//1),
steal=>1);
}
1; ##-- be happy
##======================================================================
## POD: footer
=pod
=head1 ACKNOWLEDGEMENTS
Perl by Larry Wall.
PDL by Karl Glazebrook, Tuomas J. Lukka, Christian Soeller, and others.
=cut
##---------------------------------------------------------------------
=pod
=head1 AUTHOR
Bryan Jurish E<lt>moocow@cpan.orgE<gt>
=head2 Copyright Policy
Copyright (C) 2015-2024, Bryan Jurish. All rights reserved.
This package is free software, and entirely without warranty.
You may redistribute it and/or modify it under the same terms
as Perl itself.
=head1 SEE ALSO
L<perl>,
L<PDL>,
L<PDL::CCS::Nd>,
L<PDL::CCS::IO::FastRaw>,
L<PDL::CCS::IO::MatrixMarket>,
L<PDL::CCS::IO::LDAC>,
...
=cut
1; ##-- make perl happy
|
