File: X23A2MultiChannel.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 (188 lines) | stat: -rw-r--r-- 4,905 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
package Demeter::Plugins::X23A2MultiChannel;  # -*- cperl -*-

use File::Basename;

use Moose;
extends 'Demeter::Plugins::FileType';
use Demeter::Data::MultiChannel;

has '+is_binary'   => (default => 0);
has '+description' => (default => 'the NSLS X23A2 multi-channel detector');
has '+version'     => (default => 0.1);
has '+output'      => (default => 'project');
has '+metadata_ini' => (default => File::Spec->catfile(File::Basename::dirname($INC{'Demeter.pm'}), 'Demeter', 'share', 'xdi', 'xdac.x23a2.ini'));

has 'n1'           => (is => 'rw', isa => 'Str',  default => '$2');
has 'n2'           => (is => 'rw', isa => 'Str',  default => '$3');
has 'n3'           => (is => 'rw', isa => 'Str',  default => '$4');
has 'n4'           => (is => 'rw', isa => 'Str',  default => '$5');

has 'd1'           => (is => 'rw', isa => 'Str',  default => '$6');
has 'd2'           => (is => 'rw', isa => 'Str',  default => '$7');
has 'd3'           => (is => 'rw', isa => 'Str',  default => '$8');
has 'd4'           => (is => 'rw', isa => 'Str',  default => '$9');

has 'ch1'          => (is => 'rw', isa => 'Str',  default => 'channel 1');
has 'ch2'          => (is => 'rw', isa => 'Str',  default => 'channel 2');
has 'ch3'          => (is => 'rw', isa => 'Str',  default => 'channel 3');
has 'ch4'          => (is => 'rw', isa => 'Str',  default => 'channel 4');

has 'reference'    => (is => 'rw', isa => 'Str',  default => 'reference');
has 'do_reference' => (is => 'rw', isa => 'Bool', default => 0);

has '+time_consuming'  => (default => 1);
has '+working_message' => (default => 'Converting multicolumn data file to an Athena project file');


sub is {
  my ($self) = @_;
  open (my $D, $self->file) or $self->Croak("could not open " . $self->file . " as data (X23A2 multi-channel)\n");
  my $is_xdac = (<$D> =~ m{\A\s*XDAC});
  while (<$D>) {
    last if (m{\A\s*-----});
  };
  my $is_mc = (<$D> =~ m{I01?\s+I02\s+I03\s+I04\s+It1\s+It2\s+It3\s+It4});
  close $D;
  #print join("|",$is_xdac, $is_mc), $/;
  return ($is_xdac and $is_mc);
};

sub fix {
  my ($self) = @_;

  my $file = $self->file;
  my $prj  = File::Spec->catfile($self->stash_folder, basename($self->file));

  my $mc = Demeter::Data::MultiChannel->new(file => $file, energy => '$1',);
  my @data = ($mc->make_data(numerator   => $self->n1,
			     denominator => $self->d1,
			     ln          => 1,
			     name        => $self->ch1,
			    ),
	      $mc->make_data(numerator   => $self->n2,
			     denominator => $self->d2,
			     ln          => 1,
			     name        => $self->ch2,
			    ),
	      $mc->make_data(numerator   => $self->n3,
			     denominator => $self->d3,
			     ln          => 1,
			     name        => $self->ch3,
			    ),
	      $mc->make_data(numerator   => $self->n4,
			     denominator => $self->d4,
			     ln          => 1,
			     name        => $self->ch4,
			    ),
	     );

  if ($self->do_reference) {
    $data[4] = $mc->make_data(numerator   => '$9',
			      denominator => '$10',
			      ln          => 1,
			      name        => $self->reference,
			     );
  };

  $data[0]->dispense('process', 'erase', {items=>"\@group ".$mc->group});
  foreach my $d (@data) {
    my ($elem, $edge) = $d->find_edge($d->e0('ifeffit'));
    $d->bkg_z($elem);
    $d->fft_edge($edge);
  };
  $data[0]->write_athena($prj, @data);
  $_ -> DEMOLISH foreach (@data, $mc);

  $self->fixed($prj);
  return $prj;
};

sub suggest {
  ();
};

after 'add_metadata' => sub {
  my ($self, @data) = @_;
  return if not Demeter->xdi_exists;
  foreach my $d (@data) {
    Demeter::Plugins::Beamlines::XDAC->is($d, $self->file);
    $d->xdi->set_item('Detector', 'i0', '4-channel ionization chamber');
    $d->xdi->set_item('Detector', 'it', '4-channel ionization chamber');
  };
};


__PACKAGE__->meta->make_immutable;
1;

=head1 NAME

Demeter::Plugin::X23A2MultiChannel - filetype plugin for X23A2 multi-channel data files

=head1 VERSION

This documentation refers to Demeter version 0.9.26.

=head1 SYNOPSIS

This plugin converts data from X23A2 multi-channel ion chambers to an
Athena project file.

=head1 METHODS

=over 4

=item C<is>

The multichannel file is recognized by "XDAC" in the first header line and

  I0   I02  I03  I04  It1  It2  It3  It4

in that order as column headers.

=item C<fix>

The column data file is converted into an Athena project file using
the L<Demeter::Data::MultiChannel> object.

=back

=head1 BUGS AND SHORTCOMINGS

=over 4

=item *

Need to prompt for label columns

=item *

Tie all four channels

=item *

Prompt whether to import reference, whether to use all 4 It channels
in the numerator, tie reference to all four groups

=item *

Need a persistance file for label columns and reference

=back

=head1 REVISIONS

=over 4

=item 0.1

Initial version

=back

=head1 AUTHOR

  Bruce Ravel, L<http://bruceravel.github.io/home>
  http://bruceravel.github.io/demeter

=cut