ellipse2d-1.0.0

Two dimensional ellipse model.

Description

Two dimensional ellipse.

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 ellipse.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- x_0
  object Required
  x position of the center of the ellipse.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- y_0
  object Required
  y position of the center of the ellipse.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- a
  object Required
  The length of the semimajor axis.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- b
  object Required
  The length of the seminor axis.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number
- theta
  object Required
  The rotation angle in radians of the semimajor axis. The rotation angle increase counterclockwise from the positive x axis.
  This node must validate against any of the following:
  
  ../unit/quantity-1.1.0
  
  number

Examples ¶

A 2D ellipse centered at (x, y) = (0.5, 1.5), with a semimajor axis of 2.0, semiminor axis of 4.0, oriented at 0.2 radians counterclockwise from the positive x-axis.:

!transform/ellipse2d-1.0.0
  a: 2.0
  amplitude: 10.0
  b: 4.0
  bounding_box:
  - [-2.4403509950278934, 5.440350995027893]
  - [-1.6150966966034175, 2.6150966966034175]
  theta: 0.2
  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/ellipse2d-1.0.0"
title: >
  Two dimensional ellipse model.

description: >
  Two dimensional ellipse.

examples:
  -
    - A 2D ellipse centered at (x, y) = (0.5, 1.5), with a semimajor axis of 2.0, semiminor axis of 4.0, oriented at 0.2 radians counterclockwise from the positive x-axis.
    - |
      !transform/ellipse2d-1.0.0
        a: 2.0
        amplitude: 10.0
        b: 4.0
        bounding_box:
        - [-2.4403509950278934, 5.440350995027893]
        - [-1.6150966966034175, 2.6150966966034175]
        theta: 0.2
        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 ellipse.
      x_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: x position of the center of the ellipse.
      y_0:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: y position of the center of the ellipse.
      a:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: The length of the semimajor axis.
      b:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: The length of the seminor axis.
      theta:
        anyOf:
          - $ref: "../unit/quantity-1.1.0"
          - type: number
        description: The rotation angle in radians of the semimajor axis. The rotation angle increase counterclockwise from the positive x axis.

    required: ['amplitude', 'x_0', 'y_0', 'a', 'b', 'theta']
...