Si — powder neutron TOF — Jorgensen profile¶
Verifies the Jorgensen back-to-back exponential profile for a silicon time-of-flight powder pattern.
Refinement: the overall scale only; all other parameters are taken from the FullProf reference.
In [2]:
Copied!
import easydiffraction as edi
from easydiffraction import ExperimentFactory
from easydiffraction import StructureFactory
from easydiffraction.analysis import verification as verify
import easydiffraction as edi
from easydiffraction import ExperimentFactory
from easydiffraction import StructureFactory
from easydiffraction.analysis import verification as verify
Build the project¶
In [3]:
Copied!
project = edi.Project()
project = edi.Project()
Define the structure¶
In [4]:
Copied!
structure = StructureFactory.from_scratch(name='si')
structure.space_group.name_h_m = 'F d -3 m' # FullProf Space group symbol
structure.space_group.coord_system_code = '2'
structure.cell.length_a = 5.432382 # FullProf a
structure.atom_sites.create(
id='Si', # FullProf Atom
type_symbol='Si', # FullProf Typ
fract_x=0.125, # FullProf X
fract_y=0.125, # FullProf Y
fract_z=0.125, # FullProf Z
adp_type='Biso', # FullProf Biso
adp_iso=0.54095, # FullProf Biso
)
project.structures.add(structure)
structure = StructureFactory.from_scratch(name='si')
structure.space_group.name_h_m = 'F d -3 m' # FullProf Space group symbol
structure.space_group.coord_system_code = '2'
structure.cell.length_a = 5.432382 # FullProf a
structure.atom_sites.create(
id='Si', # FullProf Atom
type_symbol='Si', # FullProf Typ
fract_x=0.125, # FullProf X
fract_y=0.125, # FullProf Y
fract_z=0.125, # FullProf Z
adp_type='Biso', # FullProf Biso
adp_iso=0.54095, # FullProf Biso
)
project.structures.add(structure)
Load the FullProf reference¶
In [5]:
Copied!
FULLPROF_PROJECT_DIR = 'pd-neut-tof_si_jorgensen'
FULLPROF_PRF_FILE = 'arg_si.prf'
FULLPROF_SUM_FILE = 'arg_si.sum'
FULLPROF_BAC_FILE = 'arg_si.bac'
FULLPROF_LABEL = verify.fullprof_label(FULLPROF_PROJECT_DIR, FULLPROF_SUM_FILE)
FULLPROF_ZERO = -8.56733 # FullProf Zero
FULLPROF_SCALE = 0.6620058 # FullProf Scale
FULLPROF_TWOTHETA_BANK = 144.845 # FullProf 2ThetaBank
FULLPROF_DTT1 = 7476.91016 # FullProf Dtt1
FULLPROF_DTT2 = -1.54 # FullProf Dtt2
FULLPROF_SIGMA_0 = 5.0790 # FullProf Sigma-0
FULLPROF_SIGMA_1 = 29.6492 # FullProf Sigma-1
FULLPROF_SIGMA_2 = 0.0 # FullProf Sigma-2
FULLPROF_ALPHA_0 = 0.0 # FullProf alph0
FULLPROF_ALPHA_1 = 0.235422 # FullProf alph1
FULLPROF_BETA_0 = 0.038020 # FullProf beta0
FULLPROF_BETA_1 = 0.010902 # FullProf beta1
FULLPROF_WDT = 30.0 # FullProf Wdt
x, calc_fullprof = verify.load_fullprof_calc_profile(
FULLPROF_PROJECT_DIR,
FULLPROF_PRF_FILE,
FULLPROF_BAC_FILE,
FULLPROF_ZERO,
)
FULLPROF_PROJECT_DIR = 'pd-neut-tof_si_jorgensen'
FULLPROF_PRF_FILE = 'arg_si.prf'
FULLPROF_SUM_FILE = 'arg_si.sum'
FULLPROF_BAC_FILE = 'arg_si.bac'
FULLPROF_LABEL = verify.fullprof_label(FULLPROF_PROJECT_DIR, FULLPROF_SUM_FILE)
FULLPROF_ZERO = -8.56733 # FullProf Zero
FULLPROF_SCALE = 0.6620058 # FullProf Scale
FULLPROF_TWOTHETA_BANK = 144.845 # FullProf 2ThetaBank
FULLPROF_DTT1 = 7476.91016 # FullProf Dtt1
FULLPROF_DTT2 = -1.54 # FullProf Dtt2
FULLPROF_SIGMA_0 = 5.0790 # FullProf Sigma-0
FULLPROF_SIGMA_1 = 29.6492 # FullProf Sigma-1
FULLPROF_SIGMA_2 = 0.0 # FullProf Sigma-2
FULLPROF_ALPHA_0 = 0.0 # FullProf alph0
FULLPROF_ALPHA_1 = 0.235422 # FullProf alph1
FULLPROF_BETA_0 = 0.038020 # FullProf beta0
FULLPROF_BETA_1 = 0.010902 # FullProf beta1
FULLPROF_WDT = 30.0 # FullProf Wdt
x, calc_fullprof = verify.load_fullprof_calc_profile(
FULLPROF_PROJECT_DIR,
FULLPROF_PRF_FILE,
FULLPROF_BAC_FILE,
FULLPROF_ZERO,
)
Create the experiment¶
In [6]:
Copied!
experiment = ExperimentFactory.from_scratch(
name='si',
sample_form='powder',
beam_mode='time-of-flight',
radiation_probe='neutron',
scattering_type='bragg',
)
verify.set_reference_as_measured(experiment, x, calc_fullprof)
experiment.linked_structures.create(structure_id='si', scale=FULLPROF_SCALE)
experiment.instrument.setup_twotheta_bank = FULLPROF_TWOTHETA_BANK
experiment.instrument.calib_d_to_tof_offset = FULLPROF_ZERO
experiment.instrument.calib_d_to_tof_linear = FULLPROF_DTT1
experiment.instrument.calib_d_to_tof_quadratic = FULLPROF_DTT2
experiment.peak.type = 'jorgensen'
experiment.peak.broad_gauss_sigma_0 = FULLPROF_SIGMA_0
experiment.peak.broad_gauss_sigma_1 = FULLPROF_SIGMA_1
experiment.peak.broad_gauss_sigma_2 = FULLPROF_SIGMA_2
experiment.peak.rise_alpha_0 = FULLPROF_ALPHA_0
experiment.peak.rise_alpha_1 = FULLPROF_ALPHA_1
experiment.peak.decay_beta_0 = FULLPROF_BETA_0
experiment.peak.decay_beta_1 = FULLPROF_BETA_1
experiment.excluded_regions.create(id='1', start=0, end=5000)
experiment.excluded_regions.create(id='2', start=10000, end=100000)
experiment.peak.cutoff_fwhm = FULLPROF_WDT
project.experiments.add(experiment)
experiment = ExperimentFactory.from_scratch(
name='si',
sample_form='powder',
beam_mode='time-of-flight',
radiation_probe='neutron',
scattering_type='bragg',
)
verify.set_reference_as_measured(experiment, x, calc_fullprof)
experiment.linked_structures.create(structure_id='si', scale=FULLPROF_SCALE)
experiment.instrument.setup_twotheta_bank = FULLPROF_TWOTHETA_BANK
experiment.instrument.calib_d_to_tof_offset = FULLPROF_ZERO
experiment.instrument.calib_d_to_tof_linear = FULLPROF_DTT1
experiment.instrument.calib_d_to_tof_quadratic = FULLPROF_DTT2
experiment.peak.type = 'jorgensen'
experiment.peak.broad_gauss_sigma_0 = FULLPROF_SIGMA_0
experiment.peak.broad_gauss_sigma_1 = FULLPROF_SIGMA_1
experiment.peak.broad_gauss_sigma_2 = FULLPROF_SIGMA_2
experiment.peak.rise_alpha_0 = FULLPROF_ALPHA_0
experiment.peak.rise_alpha_1 = FULLPROF_ALPHA_1
experiment.peak.decay_beta_0 = FULLPROF_BETA_0
experiment.peak.decay_beta_1 = FULLPROF_BETA_1
experiment.excluded_regions.create(id='1', start=0, end=5000)
experiment.excluded_regions.create(id='2', start=10000, end=100000)
experiment.peak.cutoff_fwhm = FULLPROF_WDT
project.experiments.add(experiment)
Peak profile type for experiment 'si' changed to
jorgensen
edi-cryspy VS FullProf¶
In [7]:
Copied!
experiment.calculator.type = 'cryspy'
experiment.linked_structures['si'].scale = FULLPROF_SCALE
project.analysis.calculate()
calc_ed_cryspy = experiment.data.intensity_calc
LABEL_ED_CRYSPY = verify.engine_label('cryspy')
project.display.pattern_comparison(
'si',
reference=calc_fullprof,
candidate=calc_ed_cryspy,
reference_label=FULLPROF_LABEL,
candidate_label=LABEL_ED_CRYSPY,
)
experiment.calculator.type = 'cryspy'
experiment.linked_structures['si'].scale = FULLPROF_SCALE
project.analysis.calculate()
calc_ed_cryspy = experiment.data.intensity_calc
LABEL_ED_CRYSPY = verify.engine_label('cryspy')
project.display.pattern_comparison(
'si',
reference=calc_fullprof,
candidate=calc_ed_cryspy,
reference_label=FULLPROF_LABEL,
candidate_label=LABEL_ED_CRYSPY,
)
Calculator for experiment 'si' already set to
cryspy
Loading plot…
Fit edi-cryspy to FullProf¶
In [8]:
Copied!
experiment.linked_structures['si'].scale.free = True
project.analysis.fit()
project.display.fit.results()
project.analysis.calculate()
calc_ed_cryspy_refined = experiment.data.intensity_calc
LABEL_ED_CRYSPY_REFINED = verify.engine_label('cryspy', note='refined')
project.display.pattern_comparison(
'si',
reference=calc_fullprof,
candidate=calc_ed_cryspy_refined,
reference_label=FULLPROF_LABEL,
candidate_label=LABEL_ED_CRYSPY_REFINED,
)
experiment.linked_structures['si'].scale.free = True
project.analysis.fit()
project.display.fit.results()
project.analysis.calculate()
calc_ed_cryspy_refined = experiment.data.intensity_calc
LABEL_ED_CRYSPY_REFINED = verify.engine_label('cryspy', note='refined')
project.display.pattern_comparison(
'si',
reference=calc_fullprof,
candidate=calc_ed_cryspy_refined,
reference_label=FULLPROF_LABEL,
candidate_label=LABEL_ED_CRYSPY_REFINED,
)
Standard fitting
📋 Using experiment 🔬 'si' for 'single' fitting
🚀 Starting fit process with 'lmfit (leastsq)'...
📈 Goodness-of-fit progress:
| iteration | time (s) | χ² | change / status | |
|---|---|---|---|---|
| 1 | 1 | 0.03 | 111197.17 | |
| 2 | 5 | 0.15 | 89081.42 | 19.9% ↓ |
| 3 | 7 | 0.22 | 52198.81 | 41.4% ↓ |
| 4 | 9 | 0.28 | 7829.18 | 85.0% ↓ |
| 5 | 11 | 0.35 | 0.45 | 100.0% ↓ |
| 6 | 14 | 0.48 | 0.45 |
🏆 Best goodness-of-fit (reduced χ²) is 0.45 at iteration 13
✅ Fitting complete.
⚙️ Settings used:
| Name | Value | Description | |
|---|---|---|---|
| 1 | max_iterations | 1000 | Maximum solver iterations. |
📋 Least-squares fit results:
| Metric | Value | |
|---|---|---|
| 1 | 🧪 Minimizer | lmfit (leastsq) |
| 2 | ✅ Overall status | success |
| 3 | ⏱️ Fitting time (seconds) | 0.48 |
| 4 | 🔁 Iterations | 11 |
| 5 | 📏 Goodness-of-fit (reduced χ²) | 0.45 |
| 6 | 📏 R-factor (Rf, %) | 0.45 |
| 7 | 📏 R-factor squared (Rf², %) | 0.20 |
| 8 | 📏 Weighted R-factor (wR, %) | 0.20 |
📈 Refined parameters:
| datablock | category | entry | parameter | units | start | value | s.u. | change | |
|---|---|---|---|---|---|---|---|---|---|
| 1 | si | linked_structure | si | scale | 0.6620 | 631.4339 | 0.0402 | 95281.93 % ↑ |
• start = parameter value before refinement
• value = refined value from least-squares minimization
• s.u. = standard uncertainty (one sigma), from the covariance matrix
• change = relative change from start, in %; ↑ = increase, ↓ = decrease
• value = refined value from least-squares minimization
• s.u. = standard uncertainty (one sigma), from the covariance matrix
• change = relative change from start, in %; ↑ = increase, ↓ = decrease
Loading plot…
In [9]:
Copied!
experiment.linked_structures['si'].scale
experiment.linked_structures['si'].scale
Out[9]:
<si.linked_structure.si.scale = 631.4339069442333 ± 0.04016720195770356 (free=True)>
Agreement check¶
In [10]:
Copied!
verify.assert_patterns_agree(
[
(
f'{LABEL_ED_CRYSPY_REFINED} vs {FULLPROF_LABEL}',
verify.restrict_to_included(experiment, calc_fullprof),
calc_ed_cryspy_refined,
),
],
)
verify.assert_patterns_agree(
[
(
f'{LABEL_ED_CRYSPY_REFINED} vs {FULLPROF_LABEL}',
verify.restrict_to_included(experiment, calc_fullprof),
calc_ed_cryspy_refined,
),
],
)
| Comparison | Metric | Expected | Actual | OK | |
|---|---|---|---|---|---|
| 1 | edi 0.19.0 (cryspy 0.12.1, refined) vs FullProf 8.40 | Profile diff (%) | < 2.5 | 0.20 | ✅ |
| 2 | Max deviation (%) | < 6 | 0.10 | ✅ | |
| 3 | Area ratio | 0.99 to 1.01 | 1.0018 | ✅ | |
| 4 | Shape correlation | > 0.999 | 1.0000 | ✅ |
Out[10]:
True