lorentz1d-1.0.0

One dimensional Lorentzian model.

Description

One dimensional Lorentzian model.

Outline

Schema Definitions

This node must validate against all of the following:

  • This type is an object with the following properties:

    • amplitude

      objectRequired

      Peak value.

      This node must validate against any of the following:

    • x_0

      objectRequired

      Position of the peak.

      This node must validate against any of the following:

    • fwhm

      objectRequired

      Full width at half maximum.

      This node must validate against any of the following:

Examples

\[f(x) = \frac{10.0 *5.0^{2}}{5.0^{2} + \left(x - 0.5\right)^{2}}\]
!transform/lorentz1d-1.0.0
  amplitude: 10.0
  bounding_box: [-124.5, 125.5]
  fwhm: 5.0
  x_0: 0.5

Original Schema

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/transform/lorentz1d-1.0.0"
title: >
  One dimensional Lorentzian model.

description: >
  One dimensional Lorentzian model.

examples:
  -
    - $$f(x) = \frac{10.0 *5.0^{2}}{5.0^{2} + \left(x - 0.5\right)^{2}}$$
    - |
      !transform/lorentz1d-1.0.0
        amplitude: 10.0
        bounding_box: [-124.5, 125.5]
        fwhm: 5.0
        x_0: 0.5

allOf:
  - $ref: "transform-1.2.0"
  - type: object
    properties:
      amplitude:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Peak value.
      x_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Position of the peak.
      fwhm:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Full width at half maximum.

    required: ['amplitude', 'x_0', 'fwhm']
...