disk2d-1.0.0

Two dimensional disk model.

Description

Two dimensional radially symmetric disk.

Outline

Schema Definitions

This node must validate against all of the following:

  • This type is an object with the following properties:

    • amplitude

      objectRequired

      Value of the disk function.

      This node must validate against any of the following:

    • x_0

      objectRequired

      x position of the center of the disk.

      This node must validate against any of the following:

    • y_0

      objectRequired

      y position of the center of the disk.

      This node must validate against any of the following:

    • R_0

      objectRequired

      Radius of the disk.

      This node must validate against any of the following:

Examples

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

!transform/disk2d-1.0.0
  R_0: 5.0
  amplitude: 10.0
  bounding_box:
  - [-3.5, 6.5]
  - [-4.5, 5.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/disk2d-1.0.0"
title: >
  Two dimensional disk model.

description: >
  Two dimensional radially symmetric disk.

examples:
  -
    - A 2D disk centered at (x, y) = (0.5, 1.5), of radius 5.0 and amplitude 10.0.
    - |
      !transform/disk2d-1.0.0
        R_0: 5.0
        amplitude: 10.0
        bounding_box:
        - [-3.5, 6.5]
        - [-4.5, 5.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 position of the center of the disk.
      y_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: y position of the center of the disk.
      R_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: Radius of the disk.

    required: ['amplitude', 'x_0', 'y_0', 'R_0']
...