box1d-1.0.0¶

One dimensional box model.

Description

One dimensional box.

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.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- x_0
  object Required
  Position of the center of the box model.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- width
  object Required
  Width of box.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number

Examples ¶

A 1D box of width 4.0, amplitude 10.0, centered at x=1.5.:

!transform/box1d-1.0.0
  amplitude: 10.0
  bounding_box: [-0.5, 3.5]
  width: 4.0
  x_0: 1.5

Original Schema ¶

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

description: >
  One dimensional box.

examples:
  -
    - A 1D box of width 4.0, amplitude 10.0, centered at x=1.5.
    - |
      !transform/box1d-1.0.0
        amplitude: 10.0
        bounding_box: [-0.5, 3.5]
        width: 4.0
        x_0: 1.5

allOf:
  - $ref: "transform-1.2.0"
  - type: object
    properties:
      amplitude:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Amplitude.
      x_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Position of the center of the box model.
      width:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Width of box.

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