Skip to content

Commit 2039898

Browse files
committed
added questions.md + some perl wrapper development
1 parent 3c6571d commit 2039898

File tree

4 files changed

+80
-24
lines changed

4 files changed

+80
-24
lines changed

perl/Makefile.PL

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ WriteMakefile(
2222
NAME => 'Xray::XDI',
2323
VERSION_FROM => 'lib/Xray/XDI.pm', # finds $VERSION
2424
PREREQ_PM => {
25-
Inline => 0.5,
26-
Inline::C => 0.62,
27-
Moose => 2.06,
28-
'MooseX::NonMoose' => 0.22,
29-
'MooseX::Aliases' => 0.10,
30-
'MooseX::Clone' => 0.05,
25+
Inline => 0.5,
26+
Inline::C => 0.62,
27+
Moose => 2.06,
28+
MooseX::NonMoose => 0.22,
29+
MooseX::Aliases => 0.10,
30+
MooseX::Clone => 0.05,
3131
},
3232
($] >= 5.005 ? ## Add these new keywords supported since 5.005
3333
(ABSTRACT_FROM => 'lib/Xray/XDI.pm', # retrieve abstract from module

perl/lib/Xray/XDIFile.pm

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,19 @@ Newx should have this comment block explaining it:
7676
Allocate memory with Newx if it's available - if it's an older
7777
perl that doesn't have Newx then we resort to using New.
7878
79-
8079
Regarding INT2PTR, see
8180
Lhttp://www.mail-archive.com/inline%40perl.org/msg02689.html>. The
8281
use of PTR2IV in new was the result of trial and error, rather than
8382
deep understanding.
8483
85-
8684
=over 4
8785
8886
=item *
8987
88+
No way to push values from perl into the stuct
89+
90+
=item *
91+
9092
Error handling is primitive
9193
9294
=item *

specification/dictionary.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -332,15 +332,6 @@ versions of this dictionary.
332332
* _Units_: none
333333
* _Format_: free-format string
334334

335-
#### Outstanding issues
336-
337-
This is one of the areas for which James advocated the use of tables
338-
in order to capture a full complement of information about the
339-
detectors. For example, an ion chamber might be identified by by any
340-
or all of length, gas content, voltage, gap, gas pressure, dark
341-
current offset, and details (shaping time, amplification, etc.) about
342-
the signal chain behind the detector.
343-
344335

345336
## Defined items in the Sample namespace
346337

@@ -554,13 +545,6 @@ voltage on a themocouple might be labeled as
554545

555546
# Column.N: thermocouple millivolts
556547

557-
#### Outstanding issues
558-
559-
Is a file non-compliant if the `Column` fileds are missing? Is it
560-
non-compliant if the number of `Column` fields is different from the
561-
number of columns? Is it non-compliant if the `Column` field values
562-
are different from the words in the column label line at the end of
563-
the header?
564548

565549

566550
## Extension fields

specification/questions.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
Questions on the XAS Data Interchange Format Draft Specification, version 1.0
2+
=============================================================================
3+
4+
XDI Working Group
5+
-----------------
6+
7+
* Matthew NEWVILLE (University of Chicago Center for Advanced Radiation Sources, APS)
8+
* Bruce RAVEL (NIST) [bravel AT bnl DOT gov](mailto:[email protected])
9+
* V. Armando SOLÉ (ESRF)
10+
* Gerd WELLENREUTHER (DESY)
11+
* [mailing list - http://millenia.cars.aps.anl.gov/mailman/listinfo/xasformat](http://millenia.cars.aps.anl.gov/mailman/listinfo/xasformat)
12+
* [GitHub organization - https://github.com/XraySpectroscopy](https://github.com/XraySpectroscopy)
13+
14+
# Introduction
15+
16+
This document contains questions about the XAS Data Interchange Format
17+
(XDI), version 1.0, a simple file format for a single X-ray Absorption
18+
Spectroscopy (XAS) measurement. These are questions that should be
19+
resolved prior to the announcement if the 1.0 release.
20+
21+
This document is an effort of an *ad hoc* working group
22+
reporting to the
23+
[International X-ray Absorption Society (IXAS)](http://www.ixasportal.net/)
24+
and the
25+
[XAFS Commission of International Union of Crystallography (IUCr-XC)](http://www.iucr.org/resources/commissions/xafs).
26+
The charge of this working group is to propose standards for the
27+
storage and dissemination of XAS and related data.
28+
29+
30+
# Questions
31+
32+
## Regarding the dictionary definition of the Detector namespace
33+
34+
Items in this namespace are an area for which James advocated the use
35+
of tables in order to capture a full complement of information about
36+
the detectors. For example, an ion chamber might be identified by by
37+
any or all of length, gas content, voltage, gap, gas pressure, dark
38+
current offset, and details (shaping time, amplification, etc.) about
39+
the signal chain behind the detector.
40+
41+
42+
## Regarding the dictionary definition of the Column namespace
43+
44+
Is a file non-compliant if the `Column` fileds are missing? Is it
45+
non-compliant if the number of `Column` fields is different from the
46+
number of columns? Is it non-compliant if the `Column` field values
47+
are different from the words in the column label line at the end of
48+
the header?
49+
50+
## Regarding XDI files containing data as chi(k), chi(R), or Filtered[chi(k)]
51+
52+
The table of array labels in the dictionary has entries for chi(k) and
53+
chi(R). It seems the `k` and `r` columns should have units. For `k`,
54+
this is presumably inverse Angstroms. For `r`, Angstroms, picometers,
55+
or nanometers (with Angstroms preferred).
56+
57+
Some questions:
58+
59+
1. Should Angstrom be spelled with or without diacritic marks over the
60+
"A" and "o"?
61+
62+
2. And should "inverse Angstrom" be two words with a space between, or
63+
a single word (either concatinated or with an underscore)?
64+
65+
Regarding 1, I suggest recognizing `[ÅåAa]ngstr[öo]m`
66+
67+
Regarding 2, The explanation of values with units in the dictionary,
68+
as written, is ambiguous as to whether the string explaning the units
69+
is a single word or may be multiple words. I propose "inverse
70+
Angstrom" with the multiple spelling of Angstrom suggested above.

0 commit comments

Comments
 (0)