ring2d-1.0.0

Two dimensional radially symmetric ring model.

Description

Two dimensional radially symmetric ring.

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
  Value of the disk function.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- x_0
  object Required
  x center position of the disk.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- y_0
  object Required
  y center position of the disk.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- r_in
  object Required
  Inner radius of the ring.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- width
  object Required
  Width of the ring.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number

Examples ¶

A 2D disk centered at (x, y) = (0.5, 1.5), with an inner radius of 5.0, outer radius of 7.5 and amplitude 10.0.:

!transform/ring2d-1.0.0
  amplitude: 10.0
  bounding_box:
  - [-6.0, 9.0]
  - [-7.0, 8.0]
  r_in: 5.0
  width: 2.5
  x_0: 0.5
  y_0: 1.5

Original Schema ¶

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/transform/ring2d-1.0.0"
title: >
  Two dimensional radially symmetric ring model.

description: >
  Two dimensional radially symmetric ring.

examples:
  -
    - A 2D disk centered at (x, y) = (0.5, 1.5), with an inner radius of 5.0, outer radius of 7.5 and amplitude 10.0.
    - |
      !transform/ring2d-1.0.0
        amplitude: 10.0
        bounding_box:
        - [-6.0, 9.0]
        - [-7.0, 8.0]
        r_in: 5.0
        width: 2.5
        x_0: 0.5
        y_0: 1.5

allOf:
  - $ref: "transform-1.2.0"
  - type: object
    properties:
      amplitude:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Value of the disk function.
      x_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: x center position of the disk.
      y_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: y center position of the disk.
      r_in:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Inner radius of the ring.
      width:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Width of the ring.

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