tkrietan プログラム仕様

Rietan結晶構造解析に関する機能を提供するモジュール。

このモジュールは、Rietanプログラムに関連する様々な機能を提供します。主な機能は、原子散乱因子(ASF)のパラメータの読み込みと計算、 Rietanプログラムの実行、およびRietan関連の入力ファイル(.ins)の生成です。また、結晶学的な情報（空間群、格子定数、原子座標など）を処理し、 Rietanが利用できる形式に変換する機能も含まれます。

関連リンク: tkrietan.py Technical Documentation

class tklib.tkcrystal.tkrietan.tkRietan(**args)

ベースクラス: tkCrystalObject

Rietan結晶構造解析に関する機能を提供するクラス。

tkCrystalObject を継承し、原子散乱因子や空間群の処理、 Rietan関連ファイルの読み書き、プログラム実行機能などを拡張します。

HydrogenAtomicScatteringFactor(s)

水素原子の原子散乱因子を計算する。

与えられた s 値（sin(θ)/λ）に対する水素原子の原子散乱因子を計算します。

パラメータ:: s (float) -- sin(θ)/λ の値。
戻り値:: 計算された水素原子の原子散乱因子。
戻り値の型:: float

ReadASFParameters(AtomName, dbpath='d:/git/tkProg\\tkapp\\XRD\\RIETAN-FP\\RIETAN_VENUS\\asfdc', XraySource='Cu', StopByError=1)

原子散乱因子(ASF)のパラメータをデータベースから読み込む。

ASFDCPath または指定されたデータベースファイルから、指定された原子のASFパラメータを検索し、辞書形式で返します。X線源の種類によって異なる異常分散因子を選択します。

パラメータ:

AtomName (str) -- 検索対象の原子名。
dbpath (str) -- (optional) データベースファイルのパス。デフォルトは ASFDCPath。
XraySource (str) -- (optional) X線源の種類 ('Cu', 'Cr', 'Fe', 'Co', 'Mo', 'Ag', 'Kb')。デフォルトは 'Cu'。
StopByError (int) -- (optional) エラー発生時にプログラムを終了するかどうか。1 の場合は終了、0 の場合は続行。デフォルトは 1。

戻り値:

読み込まれたASFパラメータを含む辞書。エラーが発生した場合は0。

戻り値の型:

dict or int

asf(s, StopByError=1)

原子散乱因子(ASF)を計算する。

ReadASFParameters で読み込まれたパラメータを使用して、与えられた s 値（sin(θ)/λ）に対するASFを計算します。異常分散因子が存在する場合は複素数として返します。

パラメータ:

s (float) -- sin(θ)/λ の値 (単位: nm⁻¹)。
StopByError (int) -- (optional) エラー発生時にプログラムを終了するかどうか。1 の場合は終了、0 の場合は続行。デフォルトは 1。

戻り値:

計算された原子散乱因子。異常分散因子が存在する場合は複素数、そうでない場合は実数。

戻り値の型:

complex or float

asfElectron(s, StopByError=1)

電子散乱因子を計算する。

ReadASFParameters で読み込まれた原子の情報を基に、与えられた s 値（sin(θ)/λ）に対する電子散乱因子を計算します。

パラメータ:

s (float) -- sin(θ)/λ の値 (単位: nm⁻¹)。
StopByError (int) -- (optional) エラー発生時にプログラムを終了するかどうか。1 の場合は終了、0 の場合は続行。デフォルトは 1。

戻り値:

計算された電子散乱因子。

戻り値の型:

float