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
|
package Demeter::Data::MultiChannel;
use Moose;
extends 'Demeter::Data';
has '+is_mc' => (default => 1);
has '+is_col' => (default => 1);
has '+name' => (default => 'multichannel data',);
sub BUILD {
my ($self, @params) = @_;
$self->mo->push_MultiChannel($self);
};
## make this a null op
override 'put_data' => sub {
my ($self) = @_;
# my $string = $self->_read_data_command('raw');
# $self->dispose($string);
$self->update_data(0);
};
sub make_data {
my ($self, @args) = @_;
my %args = @args;
$self->_update('data');
## get columns from ifeffit
my @cols = split(" ", $self->columns);
unshift @cols, q{};
my $energy_string = $self->energy;
my ($xmu_string, $i0_string, $signal_string) = (q{}, q{}, q{});
if ($args{ln}) {
$xmu_string = "ln(abs( ("
. $args{numerator}
. ") / ("
. $args{denominator}
. ") ))";
$i0_string = $args{numerator};
$signal_string = $args{denominator};
} else {
$xmu_string = "(" . $args{numerator} . ") / (" . $args{denominator} . ")";
$i0_string = $args{denominator};
$signal_string = $args{numerator};
};
delete $args{$_} foreach (qw(ln energy numerator denominator));
## what about chi(k) MC data?
my $this = Demeter::Data->new(energy=>$energy_string, file=>$self->file, columns=>$self->columns);
$this -> dispense('process','make_group');
## resolve column tokens
my $group = $self->group;
$i0_string =~ s{\$(\d+)}{$group.$cols[$1]}g;
$signal_string =~ s{\$(\d+)}{$group.$cols[$1]}g;
$xmu_string =~ s{\$(\d+)}{$group.$cols[$1]}g;
$energy_string =~ s{\$(\d+)}{$group.$cols[$1]}g;
## this next bit removes the energy shift from the new group's
## energy column. this was implemented in support of data files for
## multichannel ion chambers. See the 10BMMultiChannel plugin for
## an example.
if (exists $args{bkg_eshift}) {
$energy_string .= "+" . $args{bkg_eshift};
delete $args{bkg_eshift};
};
$this->i0_string($i0_string);
$this->signal_string($signal_string);
$this->xmu_string($xmu_string);
$this->energy_string($energy_string);
my $command = $this->template("process", "columns");
$command .= $this->template("process", "deriv");
$this->dispose($command);
$this->i0_scale($self->fetch_scalar('__i0_scale'));
$this->signal_scale($self->fetch_scalar('__signal_scale'));
$this->update_data(0);
$this->update_columns(0);
$this->update_norm(1);
$this->provenance(sprintf("multichannel data file %s", $self->file));
$this->initialize_e0;
$args{datatype} ||= 'xmu';
$this->set(%args);
$this->resolve_defaults;
return $this;
};
override 'discard' => sub {
my ($self) = @_;
$self->dispense('process', 'erase', {items=>"\@group " . $self->group});
$self->alldone;
$self->DEMOLISH;
};
__PACKAGE__->meta->make_immutable;
1;
=head1 NAME
Demeter::Data::MultiChannel - Efficiantly read multiple data channels from a single file
=head1 VERSION
This documentation refers to Demeter version 0.9.26.
=head1 DESCRIPTION
This object provides a way to read multiple channels of data from a
single column data file that uses the data processing backend
(Ifeffit/Larch) as efficiently as possible.
my $mc = Demeter::Data::MultiChannel->new(file => $file,
energy => '$1');
my $data1 = $mc->make_data(numerator => '$3',
denominator => '$2',
ln => 0,
name => 'MED Channel 1');
my $data2 = $mc->make_data(numerator => '$4',
denominator => '$2',
ln => 0,
name => 'MED Channel 2');
$_->plot('E') foreach ($data1, $data2);
## later on...
$mc -> discard;
The data file containing multiple channels of data is imported by the
Data::MultiChannel object. Normal Data objects are created using the
C<make_data> method. The advantage of this over simply re-importing
the data file for each Data object is that backend arrays for the raw
data columns are only created once, greatly reducing the amount of
array wrangling that the backend must perform.
This method was written for the mutichannel ioniziation chambers
discussed in (give reference). This class would also be useful for
generating fuorescence data groups from each individual channel of an
energy dispersive detector.
This object inherits from L<Demeter::Data> although most data
processing capabilities of the Data object are disabled in a simple
way. Many of the array handling methods described in
L<Demeter::Data::Arrays> are useful when dealing with
Data::MultiChannel objects.
=head1 METHODS
=over 4
=item C<make_data>
This returns a Data object. When a Data::MultiChannel object is
created, you B<must> specify the C<file> and C<energy> attributes,
both of which are inherited from the Data object. The C<energy>
attribute is required so that the raw data arrays can be properly
sorted. The energy array is then pushed onto all Data objects make
using C<make_data>.
The C<make_data> certainly requires that the C<numerator>,
C<denominator>, and C<ln> attributes are set so that mu(E) data can be
generated from the columns of the data file. All other Data
attributes specified in the C<make_data> method call will be passed
along to the data object.
=item C<discard>
This method destroys the Data::MultiChannel object and also removes
all its associated arrays from the backend. It is hard to make all
that happen automatically B<and> at the proper time, so it is a good
idea to explicitly do this when you are finished with a
Data::MultiChannel object.
=back
=head1 CONFIGURATION
There are no configuration options for this class.
See L<Demeter::Config> for a description of Demeter's
configuration system.
=head1 DEPENDENCIES
Demeter's dependencies are in the F<Build.PL> file.
=head1 BUGS AND LIMITATIONS
=over 4
=item *
Test and profile....
=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
|
