File: SelfAbsorption.pm

package info (click to toggle)
libdemeter-perl 0.9.27%2Bds6-9
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 74,028 kB
  • sloc: perl: 73,233; python: 2,196; makefile: 1,999; ansic: 1,368; lisp: 454; sh: 74
file content (326 lines) | stat: -rw-r--r-- 12,441 bytes parent folder | download
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
package Demeter::UI::Athena::SelfAbsorption;

use strict;
use warnings;

use Wx qw( :everything );
use base 'Wx::Panel';
use Wx::Event qw(EVT_BUTTON EVT_RADIOBOX EVT_TEXT_ENTER);
use Wx::Perl::TextValidator;

use Demeter::UI::Wx::SpecialCharacters qw(:all);

use Chemistry::Formula qw(parse_formula);
use Scalar::Util qw(looks_like_number);

use vars qw($label);
$label = "Self-absorption correction";	# used in the Choicebox and in status bar messages to identify this tool

my $tcsize = [60,-1];

sub new {
  my ($class, $parent, $app) = @_;
  my $this = $class->SUPER::new($parent, -1, wxDefaultPosition, wxDefaultSize, wxMAXIMIZE_BOX );

  my $box = Wx::BoxSizer->new( wxVERTICAL);
  $this->{sizer}  = $box;

  my $top = Wx::BoxSizer->new( wxHORIZONTAL );
  $box -> Add($top, 0, wxALIGN_CENTER_HORIZONTAL|wxTOP|wxBOTTOM, 10);

  $this->{algorithm} = Wx::RadioBox->new($this, -1, 'Algorithm', wxDefaultPosition, wxDefaultSize,
					 ["Fluo $MDASH $MU(E)", "Booth $MDASH $CHI(k)", "Troger $MDASH $CHI(k)", "Atoms $MDASH $CHI(k)"],
					 1, wxRA_SPECIFY_COLS);
  $top -> Add($this->{algorithm}, 0, wxLEFT|wxRIGHT, 5);
  $this->{algorithm}->SetSelection(0);
  EVT_RADIOBOX($this, $this->{algorithm}, sub{OnAlgorithm(@_, $app)});

  my $gbs = Wx::GridBagSizer->new( 5, 5 );
  $gbs->Add(Wx::StaticText->new($this, -1, 'Group'),        Wx::GBPosition->new(0,0));
  $gbs->Add(Wx::StaticText->new($this, -1, 'Element'),      Wx::GBPosition->new(1,0));
  $gbs->Add(Wx::StaticText->new($this, -1, 'Edge'),         Wx::GBPosition->new(1,2));
  $gbs->Add(Wx::StaticText->new($this, -1, 'Formula'),      Wx::GBPosition->new(2,0));
  $this->{in_label}        = Wx::StaticText->new($this, -1, 'Angle in');
  $this->{out_label}       = Wx::StaticText->new($this, -1, 'Angle out');
  $this->{thickness_label} = Wx::StaticText->new($this, -1, 'Thickness');
  $this->{density_label}   = Wx::StaticText->new($this, -1, 'Density');
  $gbs->Add($this->{in_label},        Wx::GBPosition->new(3,0));
  $gbs->Add($this->{out_label},       Wx::GBPosition->new(3,2));
  $gbs->Add($this->{thickness_label}, Wx::GBPosition->new(4,0));
  $gbs->Add($this->{density_label},   Wx::GBPosition->new(4,2));

  $this->{group}     = Wx::StaticText->new($this, -1, q{});
  $this->{element}   = Wx::StaticText->new($this, -1, q{});
  $this->{edge}      = Wx::StaticText->new($this, -1, q{});
  $this->{formula}   = Wx::TextCtrl->new($this, -1, q{},  wxDefaultPosition, [180, -1], wxTE_PROCESS_ENTER);
  $this->{in}        = Wx::SpinCtrl->new($this, -1, 45,   wxDefaultPosition, $tcsize, wxSP_ARROW_KEYS|wxTE_PROCESS_ENTER, 0, 90);
  $this->{out}       = Wx::SpinCtrl->new($this, -1, 45,   wxDefaultPosition, $tcsize, wxSP_ARROW_KEYS|wxTE_PROCESS_ENTER, 0, 90);
  $this->{thickness} = Wx::TextCtrl->new($this, -1, 1000, wxDefaultPosition, $tcsize, wxTE_PROCESS_ENTER);
  $this->{density}   = Wx::TextCtrl->new($this, -1, 1,    wxDefaultPosition, $tcsize, wxTE_PROCESS_ENTER);

  foreach my $x (qw(formula in out thickness density)) {
    EVT_TEXT_ENTER($this, $this->{$x}, sub{$this->plot($app->current_data)});
  };
  $this->{density} -> SetValidator( Wx::Perl::TextValidator->new( qr([0-9.]) ) );
  $this->{thickness} -> SetValidator( Wx::Perl::TextValidator->new( qr([0-9.]) ) );
  $this->{density_label}->Enable(0);
  $this->{density}->Enable(0);
  $this->{thickness_label}->Enable(0);
  $this->{thickness}->Enable(0);

  $gbs->Add($this->{group},     Wx::GBPosition->new(0,1));
  $gbs->Add($this->{element},   Wx::GBPosition->new(1,1));
  $gbs->Add($this->{edge},      Wx::GBPosition->new(1,3));
  $gbs->Add($this->{formula},   Wx::GBPosition->new(2,1), Wx::GBSpan->new(1,3));
  $gbs->Add($this->{in},        Wx::GBPosition->new(3,1));
  $gbs->Add($this->{out},       Wx::GBPosition->new(3,3));
  $gbs->Add($this->{thickness}, Wx::GBPosition->new(4,1));
  $gbs->Add($this->{density},   Wx::GBPosition->new(4,3));
  $top -> Add($gbs, 0, wxLEFT|wxRIGHT, 25);


  $this->{plot}  = Wx::Button->new($this, -1, 'Plot data and correction',         wxDefaultPosition, $tcsize);
  $this->{plotr} = Wx::Button->new($this, -1, 'Plot data and correction in R',    wxDefaultPosition, $tcsize);
  $this->{infoe} = Wx::Button->new($this, -1, 'Info depth in energy', wxDefaultPosition, $tcsize);
  $this->{info}  = Wx::Button->new($this, -1, 'Info depth in k',      wxDefaultPosition, $tcsize);
  $this->{make}  = Wx::Button->new($this, -1, 'Make corrected data group',        wxDefaultPosition, $tcsize);

  my $hbox = Wx::BoxSizer->new( wxHORIZONTAL);
  $box -> Add($hbox, 0, wxGROW|wxALL, 0);
  $hbox -> Add($this->{$_}, 1, wxGROW|wxALL, 2) foreach (qw(plot plotr));

  $hbox = Wx::BoxSizer->new( wxHORIZONTAL);
  $box -> Add($hbox, 0, wxGROW|wxALL, 0);
  $hbox -> Add($this->{$_}, 1, wxGROW|wxALL, 2) foreach (qw(infoe info));

  $box -> Add($this->{make}, 0, wxGROW|wxALL, 2);

  $this->{make}->Enable(0);
  $this->{plotr}->Enable(0);
  EVT_BUTTON($this, $this->{plot},    sub{$this->plot($app->current_data, 'k')});
  EVT_BUTTON($this, $this->{plotr},   sub{$this->plot($app->current_data, 'r')});
  EVT_BUTTON($this, $this->{infoe},   sub{$this->info($app->current_data, 'E')});
  EVT_BUTTON($this, $this->{info},    sub{$this->info($app->current_data, 'k')});
  EVT_BUTTON($this, $this->{make},    sub{$this->make($app)});

  my $textbox        = Wx::StaticBox->new($this, -1, 'Feedback', wxDefaultPosition, wxDefaultSize);
  my $textboxsizer   = Wx::StaticBoxSizer->new( $textbox, wxVERTICAL );
  $box              -> Add($textboxsizer, 1, wxBOTTOM|wxGROW, 5);
  $this->{feedback}  = Wx::TextCtrl->new($this, -1, q{}, wxDefaultPosition, wxDefaultSize,
					 wxTE_MULTILINE|wxTE_READONLY|wxTE_RICH2);
  $this->{feedback} -> SetFont( Wx::Font->new( 9, wxTELETYPE, wxNORMAL, wxNORMAL, 0, "" ) );
  $textboxsizer     -> Add($this->{feedback}, 1, wxGROW|wxALL, 5);

  $this->{document} = Wx::Button->new($this, -1, 'Document section: self absorption');
  $box -> Add($this->{document}, 0, wxGROW|wxALL, 2);
  EVT_BUTTON($this, $this->{document}, sub{  $app->document("process.sa")});

  $this->SetSizerAndFit($box);
  return $this;
};

## deprecated?
sub pull_values {
  my ($this, $data) = @_;
  1;
};

## this subroutine fills the controls when an item is selected from the Group list
sub push_values {
  my ($this, $data) = @_;
  $this->{group}  ->SetLabel($data->name);
  $this->{element}->SetLabel(ucfirst($data->bkg_z));
  $this->{edge}   ->SetLabel(ucfirst($data->fft_edge));
  $this->{make}   ->Enable(0);
  1;
};

## this subroutine sets the enabled/frozen state of the controls
sub mode {
  my ($this, $data, $enabled, $frozen) = @_;
  1;
};

sub OnAlgorithm {
  my ($this, $event, $app) = @_;
  if ($this->{algorithm}->GetSelection == 1) {
    $this->{$_}->Enable(1) foreach (qw(thickness thickness_label density density_label));
  } else {
    $this->{$_}->Enable(0) foreach (qw(thickness thickness_label density density_label));
  };
  if ($this->{algorithm}->GetSelection == 0) {
    $this->{plotr}->Enable(0);
  } else {
    $this->{plotr}->Enable(1);
  };
  if ($this->{algorithm}->GetSelection == 3) {
    $this->{$_}->Enable(0) foreach (qw(in in_label out out_label));
  } else {
    $this->{$_}->Enable(1) foreach (qw(in in_label out out_label));
  };
};

sub plot {
  my ($this, $data, $sp) = @_;
  my $busy = Wx::BusyCursor->new();
  my @algs = (qw(fluo booth troger atoms));
  my $algorithm = $algs[$this->{algorithm}->GetSelection];
  my $space = ($algorithm eq 'fluo') ? 'E' : 'k';
  $space = 'R' if lc($sp) eq 'r';
  my $formula   = $this->{formula}   -> GetValue;
  my $in        = $this->{in}        -> GetValue;
  my $out       = $this->{out}       -> GetValue;
  my $thickness = $this->{thickness} -> GetValue;
  my $density   = $this->{density}   -> GetValue;
  if (not looks_like_number($thickness)) {
    $::app->{main}->status("Not doing self absorption correction -- your value for thickness is not a number!", 'error|nobuffer');
    return;
  };
  if (not looks_like_number($density)) {
    $::app->{main}->status("Not doing self absorption correction -- your value for density is not a number!", 'error|nobuffer');
    return;
  };

  if ($formula =~ m{\A\s*\z}) {
    $this->{feedback}->SetValue("You did not provide a formula.");
    $::app->{main}->status("You did not provide a formula.", 'error');
    return;
  };
  my %count = ();
  my $ok = parse_formula($formula, \%count);
  if (not $ok) {
    $this->{feedback}->SetValue($count{error});
    $::app->{main}->status("The formula \"$formula\" could not be parsed.", 'error');
    return;
  };
  if (not exists($count{ucfirst($data->bkg_z)})) {
    $this->{feedback}->SetValue("Your formula does not contain the absorber.");
    $::app->{main}->status("Your formula does not contain the absorber.", 'error');
    return;
  };

  $::app->{main}->{PlotE}->pull_single_values;
  $data->po->set(e_mu=>1, e_markers=>1, e_bkg=>0, e_pre=>0, e_post=>0, e_norm=>1, e_der=>0, e_sec=>0, e_i0=>0, e_signal=>0) if $space eq 'E';
  $data->po->start_plot;
  $data->plot($space);

  my $text = q{};
  ($this->{sadata}, $text) = $data->sa($algorithm, formula=>$formula, in=>$in, out=>$out,
				       thickness=>$thickness, density=>$density);
  $this->{feedback}->Clear;
  $this->{feedback}->SetValue($text);
  $this->{sadata}->plot($space);

  $this->{make}->Enable(1);
  $::app->{main}->status("Plotted data using " . ucfirst($algorithm) . " algorithm.");
  $::app->heap_check(0);

  undef $busy;
};

sub make {
  my ($this, $app) = @_;

  my $index = $app->current_index;
  $this->{sadata}->source('Self absorption correction of '.$app->current_data->name);
  $this->{sadata}->update_fft(1);
  if ($index == $app->{main}->{list}->GetCount-1) {
    $app->{main}->{list}->AddData($this->{sadata}->name, $this->{sadata});
  } else {
    $app->{main}->{list}->InsertData($this->{sadata}->name, $index+1, $this->{sadata});
  };
  $app->{main}->status("Made self-absorption corrected group from " . $app->current_data->name);
  $app->modified(1);
  $app->heap_check(0);
};

sub info {
  my ($this, $data, $space) = @_;
  my $formula   = $this->{formula}   -> GetValue;
  my $in        = $this->{in}        -> GetValue;
  my $out       = $this->{out}       -> GetValue;
  if ($formula =~ m{\A\s*\z}) {
    $this->{feedback}->SetValue("You did not provide a formula.");
    $::app->{main}->status("You did not provide a formula.", 'error');
    return;
  };
  my %count = ();
  my $ok = parse_formula($formula, \%count);
  if (not $ok) {
    $this->{feedback}->SetValue($count{error});
    $::app->{main}->status("The formula \"$formula\" could not be parsed.", 'error');
    return;
  };
  if (not exists($count{ucfirst($data->bkg_z)})) {
    $this->{feedback}->SetValue("Your formula does not contain the absorber.");
    $::app->{main}->status("Your formula does not contain the absorber.", 'error');
    return;
  };

  $::app->{main}->{PlotK}->pull_single_values;

  $data->po->start_plot;
  my ($x, $y) = $data->info_depth($formula, $in, $out, $space);
  my $tempfile = $data->po->tempfile;
  open my $T, '>'.$tempfile;
  foreach my $i (0 .. $#{$x}) {
    print $T $x->[$i], "  ", $y->[$i], 0, $/;
  };
  close $T;

  if (lc($space) eq 'e') {
    $data -> chart('plot', 'plot_info_depth_e', {file  => $tempfile});
  } else {
    $data -> chart('plot', 'plot_info_depth',   {file  => $tempfile});
  };
};


1;


=head1 NAME

Demeter::UI::Athena::SelfAbsorption - A self-absorption correction tool for Athena

=head1 VERSION

This documentation refers to Demeter version 0.9.26.

=head1 SYNOPSIS

This module provides a tool for computing self absorption corrections using
L<Data::Demeter::SelfAbsorption>.

=head1 CONFIGURATION


=head1 DEPENDENCIES

Demeter's dependencies are in the F<Build.PL> file.

=head1 BUGS AND LIMITATIONS

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