.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Xray::Scattering::WaasKirf 3pm" .TH Xray::Scattering::WaasKirf 3pm "2015-07-28" "perl v5.20.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Xray::Scattering::WassKirf \- Perl interface to the Waaskirf\-Kirfel tables .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use Xray::Scattering; \& Xray::Scattering\->load(\*(AqWaasKirf\*(Aq); \& $fnot = Xray::Scattering\->get_f($symb, $d); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a functional interface to the Waasmaier-Kirfel tables of coefficients for calculating the Thomson (kinematical) scattering factors of the elements and common valence states. The coefficients are stored externally in the waaskirf.db database file. The coefficients are for an Aikman expansion, which is of this form: .PP .Vb 3 \& 5 \& f0 = sum [ ai*exp(\-bi*s^2) ] + c \& i=1 .Ve .PP Thus there are 11 coefficients for each of the 211 tabulated element/valence symbols. .PP \&\f(CW\*(C`s\*(C'\fR is \f(CW\*(C`sin(theta)/lambda\*(C'\fR. \f(CW\*(C`(lambda*s)/2pi\*(C'\fR is the momentum transfer. \&\f(CW\*(C`s\*(C'\fR is simply related to the crystal d\-spacing by \f(CW\*(C`s=1/2d\*(C'\fR. .PP The reference for these tables is \*(L"New Analytical Scattering Factor Functions for Free Atoms and Ions for Free Atoms and Ions\*(R", D. Waasmaier & A. Kirfel, Acta Cryst. (1995) A51, pp. 416\-413. [doi:10.1107/S0108767394013292] These data, computed for neutral atoms and ions, are valid for the full range of sin(theta)/lambda from 0.0 to 6.0 A\-1. .PP The actual data used in the W\-K Aikman expansion can be found in a few places on the web. Here is where I obtained the file used with this module: http://ftp.esrf.fr/pub/scisoft/xop/DabaxFiles/f0_WaasKirf.dat .SH "METHODS" .IX Header "METHODS" .ie n .IP """get_f""" 4 .el .IP "\f(CWget_f\fR" 4 .IX Item "get_f" This function calculates the Thomson scattering for a given symbol and d\-spacing. The Thomson scattering depends only on the momentum transfer. The d\-spacing of the scattering planes is a closely related quantity and is easily calculated from the crystal structure, see Xtal.pm. .Sp .Vb 2 \& $symb = "Ce3+"; \& $fnot = Xray::Scattering\->get_f($symb, $d); .Ve .Sp If the symbol cannot be found in the table, \f(CW\*(C`get_f\*(C'\fR returns 0. It also returns 0 when \f(CW$symbol\fR consists of whitespace or is \*(L"null\*(R" or \&\*(L"nu\*(R". If \f(CW$symbol\fR is a number or the name of an element, then it assumes you want the Thomson scattering for the neutral element. The absolute value of \f(CW$d_spacing\fR is used by this function. .Sp If you ask for a valence state that is not in the table but for an element whose 0+ state is in the table, this method returns the scattering factor for the 0 valent atom. .ie n .IP """get_coefficients""" 4 .el .IP "\f(CWget_coefficients\fR" 4 .IX Item "get_coefficients" This returns the 11 element list containing the coefficients for the given symbol. .Sp .Vb 1 \& @coefs = Xray::Scattering\->get_coefficients($symb) .Ve .Sp This returns a1,b1,a2,b2,a3,b3,a4,b4,c. .Sp If you ask for a valence state that is not in the table but for an element whose 0+ state is in the table, this method returns the coefficients for the 0 valent atom. .ie n .IP """has""" 4 .el .IP "\f(CWhas\fR" 4 .IX Item "has" This is a test of whether a given symbol is tabulated in the Waasmaier-Kirfel table. It returns the symbol itself if found in the table or 0 if it is not in the table. .Sp .Vb 2 \& $symb = "Ce3+"; \& $is_tabulated = Xray::Scattering\->has($symb); .Ve .SH "ELEMENTS AND VALENCE STATES" .IX Header "ELEMENTS AND VALENCE STATES" The following is a list of symbols for the tabulated elements and valence states. The final two are ways of refering to an empty site (i.e. a null or blank atom). .PP .Vb 10 \& H H1\- He Li Li1+ Be Be2+ B C \& Cval N O O1\- O2\- F F1\- Ne Na \& Na1+ Mg Mg2+ Al Al3+ Si Siva Si4+ P \& S Cl Cl1\- Ar K K1+ Ca Ca2+ Sc \& Sc3+ Ti Ti2+ Ti3+ Ti4+ V V2+ V3+ V5+ \& Cr Cr2+ Cr3+ Mn Mn2+ Mn3+ Mn4+ Fe Fe2+ \& Fe3+ Co Co2+ Co3+ Ni Ni2+ Ni3+ Cu Cu1+ \& Cu2+ Zn Zn2+ Ga Ga3+ Ge Ge4+ As Se \& Br Br1\- Kr Rb Rb1+ Sr Sr2+ Y Zr \& Zr4+ Nb Nb3+ Nb5+ Mo Mo3+ Mo5+ Mo6+ Tc \& Ru Ru3+ Ru4+ Rh Rh3+ Rh4+ Pd Pd2+ Pd4+ \& Ag Ag1+ Ag2+ Cd Cd2+ In In3+ Sn Sn2+ \& Sn4+ Sb Sb3+ Sb5+ Te I I1\- Xe Cs \& Cs1+ Ba Ba2+ La La3+ Ce Ce3+ Ce4+ Pr \& Pr3+ Pr4+ Nd Nd3+ Pm Pm3+ Sm Sm3+ Eu \& Eu2+ Eu3+ Gd Gd3+ Tb Tb3+ Dy Dy3+ Ho \& Ho3+ Er Er3+ Tm Tm3+ Yb Yb2+ Yb3+ Lu \& Lu3+ Hf Hf4+ Ta Ta5+ W W6+ Re Os \& Os4+ Ir Ir3+ Ir4+ Pt Pt2+ Pt4+ Au Au1+ \& Au3+ Hg Hg1+ Hg2+ Tl Tl1+ Tl3+ Pb Pb2+ \& Pb4+ Bi Bi3+ Bi5+ Po At Rn Fr Ra \& Ra2+ Ac Ac3+ Th Th4+ Pa U U3+ U4+ \& U6+ Np Np3+ Np4+ Np6+ Pu Pu3+ Pu4+ Pu6+ \& Am Cm Bk Cf \*(Aq \*(Aq Nu .Ve .SH "AUTHOR" .IX Header "AUTHOR" .Vb 2 \& Bruce Ravel, bravel AT bnl DOT gov \& http://cars9.uchicago.edu/~ravel/software/exafs/ .Ve