11.3. ファイル読み込みプラグイン

11.3.1. Extending ATHENA to read new file types

bend ATHENA uses IFEFFIT's read\_data() function or LARCH's read_ascii() function to import data. This means that ATHENA's notion of what is an acceptable data format is completely identical to IFEFFIT's (or LARCH's) notion. The contrapositive is also true – if IFEFFIT (or LARCH) can read a data file, so can ATHENA.

実際に,これはとてもうまくいっています.IFEFFIT は世界の多くの XAS ビームラインで生成されるデータファイルを読み込むことができます.よって,また,ATHENA でも読み込むことができるということです.残念なことに,IFEFFIT や ATHENA で読み込むことができない形式を使っているビームラインもたくさんあります.そういったビームラインのデータを扱うためには,2つの方法が考えられます.

  1. それらのデータを直接を扱うのを諦め,IFEFFIT が扱うことができる形式に変換する.
  2. 新しいデータ形式に気づく度に ATHENA にそのファイルが読めるようなコードを足していく

いずれもユーザーフレンドリーとは言えません.ATHENA はその代わりに,内部のコードを変更することなしに,新しいデータ形式を直接扱えるように拡張するためのプラグイン機構を持っています.

このページでは ATHENA のユーザが自分のファイル形式のためのプラグインを書くことができるようにプラグイン機構について説明します.

11.3.2. プラグイン動作の概観

簡単に言うと,perl モジュールとは特別な場所に置かれた特別な perl のコードを含む短いファイルのことです.ATHENA はそのファイルに含まれたコードを使って,データファイル形式を認識して,IFEFFIT で適切に読み込むことができるように前処理を行います.

もう少し技術的にいうと,プラグインとはあなたのコンピュータのパスの通っている場所に置かれた単なる perl モジュールです.このファイルは ATHENA が起動した際に読み込まれ,データ読み込みの際に利用できるようなります.

プラグインが有効化されていると,Open file 機能で ATHENA にファイルが読み込まれる度にプラグインの機能が呼び出されます.その際,プラグインの持つメソッドのうちの1つを使って,読み込もうとしているファイルがそのプラグインによって変換されるべきものなのか確認します.もし,そのファイルが変換対象であれば,プラグインにある他のメソッドが元のデータファイルを IFEFFIT が読むことができる形式に変換します.この変換は元のデータファイルに変更を加えることなく行われます.

変換がうまくいくと,ATHENA の列選択ダイアログが表示され,いつもと同じようにデータを読み込むことができます.うまく書かれたプラグインは,理想的にはデータを ATHENA に読み込むときにユーザからは全く見えないプロセスとなります.

11.3.3. プラグインの例

ここには,DEMETER に含まれ,うまく動作するプラグインの完全な例について説明します.ATHENA はこのプラグインを使って NSLS のビームライン X10C のファイルを読み込むことができます.ご覧のように,プラグインは非常に短いものです.このページの続きではこの例について詳しく説明します.

package Demeter::Plugins::X10C;

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

has '+is_binary'    => (default => 0);
has '+description'  => (default => "NSLS beamline X10C");
has '+version'      => (default => 0.1);
has '+metadata_ini' => (default =>
                        File::Spec->catfile(File::Basename::dirname($INC{'Demeter.pm'}),
                                            'Demeter', 'share', 'xdi', 'x10c.ini'));

sub is {
  my ($self) = @_;
  open D, $self->file or $self->Croak("could not open " . $self->file . " as data (X10C)\n");
  my $first = <D>;
  close D, return 0 unless (uc($first) =~ /^EXAFS/);
  my $lines = 0;
  while (<D>) {
    close D, return 1 if (uc($first) =~ /^\s+DATA START/);
    ++$lines;
  };
  close D;
};


sub fix {
  my ($self) = @_;
  my $new = File::Spec->catfile($self->stash_folder, $self->filename);
  ($new = File::Spec->catfile($self->stash_folder, "toss")) if (length($new) > 127);
  open D, $self->file or die "could not open " , $self->file . " as data (fix in X10C)\n";
  open N, ">".$new or die "could not write to $new (fix in X10C)\n";
  my $header = 1;
  my $null = chr(0).'+';
  while (<D>) {
    $_ =~ s/$null//g;             # clean up nulls
    print N "# " . $_ if $header; # comment headers
    ($header = 0), next if (uc($_) =~ /^\s+DATA START/);
    next if ($header);
    $_ =~ s/([eE][-+]\d{1,2})-/$1 -/g; # clean up 5th column
    print N $_;
  };