[ Identification | Description | Input parameters | Links ]

The KDSource Component

Distributional source, based on a MCPL-format particle list, on which the Kernel Density Estimation (KDE) method is applied.

Identification

Description

Distributional source, based on a MCPL-format particle list, on which
the Kernel Density Estimation (KDE) method is applied.

It allows sampling more particles than the number present in a virtual,
previously generated virtual source, without repeating samples, controlled via the nloop
input parameter.

To function, this component requires a KDSource installation v.2.0.2 or later, as
distributed on conda-forge and pypi and included with (conda-based) McStas 3.7.0 or later.

As inputs the component needs access to all of:

    

  1. The original MPCL file

  2. Outputs of a KDSource-analyzed / optimized KDE source:

      

    • An XML parameter-file containing the needed configuration

    • A "bandwidth" file (source_bws)

    


For information on performing KDSource analysis, please refer to the KDSource example
notebooks and the KDSource online documentation (links below).

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
filenamestrName of the XML parameters file containing KDSource definition.0
EminmeVLower energy bound. Particles found in the MCPL-file below the limit are skipped.0
EmaxmeVUpper energy bound. Particles found in the MCPL-file above the limit are skipped.FLT_MAX
nloopintNumber of times to loop through the file.1
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links

[ Identification | Description | Input parameters | Links ]

Generated on mcstas 3.7.1