trapezoid1d-1.0.0

One dimensional trapezoid model.

Description

One dimensional trapezoid.

Outline

Schema Definitions
Examples
Original Schema

Schema Definitions ¶

This node must validate against all of the following:

This type is an object with the following properties:
- amplitude
  object Required
  Amplitude of the trapezoid.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- x_0
  object Required
  Center position of the trapezoid.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- width
  object Required
  Width of the constant part of the trapezoid.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- slope
  object Required
  Slope of the tails of the trapezoid.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number

Examples ¶

A 1D trapezoid centered at x=0.5, of width 5.0, slope of tails 1.0, and amplitude 10.0:

!transform/trapezoid1d-1.0.0
  amplitude: 10.0
  bounding_box: [-12.0, 13.0]
  slope: 1.0
  width: 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/trapezoid1d-1.0.0"
title: >
  One dimensional trapezoid model.

description: >
  One dimensional trapezoid.

examples:
  -
    - A 1D trapezoid centered at x=0.5, of width 5.0, slope of tails 1.0, and amplitude 10.0
    - |
      !transform/trapezoid1d-1.0.0
        amplitude: 10.0
        bounding_box: [-12.0, 13.0]
        slope: 1.0
        width: 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: Amplitude of the trapezoid.
      x_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Center position of the trapezoid.
      width:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Width of the constant part of the trapezoid.
      slope:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Slope of the tails of the trapezoid.

    required: ['amplitude', 'x_0', 'width', 'slope']
...