IDEAL

The IDEAL instrument is synthetic and supports a variety of energy-independent 1-D broadening models. It is mainly intended for testing and experimentation.

Sampling issues

It isn’t always straightforward to represent an “ideal” broadening kernel on a coarse grid. Depending on the position and scale, key points of the shape might not align to the grid.

Boxcar

The boxcar (rectangular) broadening kernel has a theoretical height of 1 / width but this assumes perfectly steep sides. As the sampled kernel is always effectively trapezoid, they are renormalized to produce the correct area for the actual trapezoid.

Triangular and trapezoid

The triangular and trapezoid functions have the correct shape and area when aligned to grid points. If the width parameter(s) are not commensurate with the grid, it is possible to obtain inaccurate shape and scaling.

To help manage this, the get_peak() method precomputes a zero-centered kernel and rounds the peak positions to the nearest point, giving a consistent shape.

Versions

IDEAL (default)

IDEAL

For details on the parameters associated with the IDEAL version, please see the IDEAL data.

boxcar

This is the recommended boxcar model - it is an alias for the boxcar_v1 model, which is the model actually containing the data.

Important

boxcar refers to the best version of this model - using a specific version may run the risk using a model with known bugs or other issues and is not advisable unless replicating the results of a given version of the model.

boxcar_v1

This section contains the data for the IDEAL instrument associated with the boxcar_v1 model. For more information about how the model works and its implementation, please see resins.models.ideal.GenericBoxcar1DModel. For more information on the model parameters, please see boxcar_v1 model data.

Configurations: NONE

triangle

This is the recommended triangle model - it is an alias for the triangle_v1 model, which is the model actually containing the data.

Important

triangle refers to the best version of this model - using a specific version may run the risk using a model with known bugs or other issues and is not advisable unless replicating the results of a given version of the model.

triangle_v1

This section contains the data for the IDEAL instrument associated with the triangle_v1 model. For more information about how the model works and its implementation, please see resins.models.ideal.GenericTriangle1DModel. For more information on the model parameters, please see triangle_v1 model data.

Configurations: NONE

trapezoid

This is the recommended trapezoid model - it is an alias for the trapezoid_v1 model, which is the model actually containing the data.

Important

trapezoid refers to the best version of this model - using a specific version may run the risk using a model with known bugs or other issues and is not advisable unless replicating the results of a given version of the model.

trapezoid_v1

This section contains the data for the IDEAL instrument associated with the trapezoid_v1 model. For more information about how the model works and its implementation, please see resins.models.ideal.GenericTrapezoid1DModel. For more information on the model parameters, please see trapezoid_v1 model data.

Configurations: NONE

gaussian

This is the recommended gaussian model - it is an alias for the gaussian_v1 model, which is the model actually containing the data.

Important

gaussian refers to the best version of this model - using a specific version may run the risk using a model with known bugs or other issues and is not advisable unless replicating the results of a given version of the model.

gaussian_v1

This section contains the data for the IDEAL instrument associated with the gaussian_v1 model. For more information about how the model works and its implementation, please see resins.models.ideal.GenericGaussian1DModel. For more information on the model parameters, please see gaussian_v1 model data.

Configurations: NONE

lorentzian

This is the recommended lorentzian model - it is an alias for the lorentzian_v1 model, which is the model actually containing the data.

Important

lorentzian refers to the best version of this model - using a specific version may run the risk using a model with known bugs or other issues and is not advisable unless replicating the results of a given version of the model.

lorentzian_v1

This section contains the data for the IDEAL instrument associated with the lorentzian_v1 model. For more information about how the model works and its implementation, please see resins.models.ideal.GenericLorentzian1DModel. For more information on the model parameters, please see lorentzian_v1 model data.

Configurations: NONE

Data

name: "IDEAL"
default_version: "IDEAL"
version:
    IDEAL:
        default_model: "gaussian"
        models:
            boxcar: "boxcar_v1"
            boxcar_v1:
                function: "boxcar"
                citation: ['']
                parameters:
                    defaults:
                    restrictions:
                configurations: {}
            triangle: "triangle_v1"
            triangle_v1:
                function: "triangle"
                citation: ['']
                parameters:
                    defaults:
                    restrictions:
                configurations: {}
            trapezoid: "trapezoid_v1"
            trapezoid_v1:
                function: "trapezoid"
                citation: ['']
                parameters:
                    defaults:
                    restrictions:
                configurations: {}
            gaussian: "gaussian_v1"
            gaussian_v1:
                function: "gaussian"
                citation: ['']
                parameters:
                    defaults:
                    restrictions:
                configurations: {}
            lorentzian: "lorentzian_v1"
            lorentzian_v1:
                function: "lorentzian"
                citation: ['']
                parameters:
                    defaults:
                    restrictions:
                configurations: {}