McXtrace logo

McXtrace - An X-ray ray-trace simulation package

Synchrotron SOLEIL DTU Physics

McXtrace

About McXtrace
 Publications
 Project Partners
 Project People
 Goal

Download
 Components

Mailing list

Search

Documentation
 Manual
 Commands
 Wiki (GitHub)
 Tutorial

Links

Report bugs (GitHub)

Code-repository (GitHub)


McXtrace: SasView_hollow_rectangular_prism

[ Identification | Description | Input parameters | Links ]

The SasView_hollow_rectangular_prism Component

SasView hollow_rectangular_prism model component as sample description.

Identification

  • Author: Jose Robledo
  • Origin: FZJ / DTU / ESS DMSC
  • Date:

Description

SasView_hollow_rectangular_prism component, generated from hollow_rectangular_prism.c in sasmodels.

Example:
SasView_hollow_rectangular_prism(sld, sld_solvent, length_a, b2a_ratio, c2a_ratio, thickness,
model_scale=1.0, model_abs=0.0, xwidth=0.01, yheight=0.01, zdepth=0.005, R=0,
int target_index=1, target_x=0, target_y=0, target_z=1,
focus_xw=0.5, focus_yh=0.5, focus_aw=0, focus_ah=0, focus_r=0,
pd_length_a=0.0, pd_thickness=0.0)

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
sld1e-6/Ang^2([-inf, inf]) Parallelepiped scattering length density.6.3
sld_solvent1e-6/Ang^2([-inf, inf]) Solvent scattering length density.1
length_aAng([0, inf]) Shortest, external, size of the parallelepiped.35
b2a_ratioAng([0, inf]) Ratio sides b/a.1
c2a_ratioAng([0, inf]) Ratio sides c/a.1
thicknessAng([0, inf]) Thickness of parallelepiped. Optional parameters:1
model_scale Global scale factor for scattering kernel. For systems without inter-particle interference, the form factors can be related to the scattering intensity by the particle volume fraction.1.0
model_abs Absorption cross section density at 2200 m/s.0.0
xwidthm([-inf, inf]) Horiz. dimension of sample, as a width.0.01
yheightm([-inf, inf]) vert . dimension of sample, as a height for cylinder/box0.01
zdepthm([-inf, inf]) depth of sample0.005
RmOuter radius of sample in (x,z) plane for cylinder/sphere.0
target_xmrelative focus target position.0
target_ymrelative focus target position.0
target_zmrelative focus target position.1
target_index Relative index of component to focus at, e.g. next is +1.1
focus_xwmhoriz. dimension of a rectangular area.0.5
focus_yhm, vert. dimension of a rectangular area.0.5
focus_awdeg, horiz. angular dimension of a rectangular area.0
focus_ahdeg, vert. angular dimension of a rectangular area.0
focus_rmcase of circular focusing, focusing radius.0
pd_length_a(0,inf) defined as (dx/x), where x is de mean value and dx the standard devition of the variable.0.0
pd_thickness(0,inf) defined as (dx/x), where x is de mean value and dx the standard devition of the variable0.0
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links

  • Source code for SasView_hollow_rectangular_prism.comp.

[ Identification | Description | Examples | Input parameters | Links ]

Generated on mcxtrace 3.10.2


Last Modified: Monday, 02-Nov-2026 21:43:06 CET
Search website mailinglist archive GitHub repos