angle-1.0.0

Represents an Angle.

Description

This object represents a subtype of Quantity which has units equivalent to radians or degrees.

Outline

• Schema Definitions
• Examples
• Original Schema

Schema Definitions

This type is an object with the following properties:

• value

  object

  Required

  A vector of one or more values

  This node must validate against any of the following:

  • number

  • http://stsci.edu/schemas/asdf/core/ndarray-1.0.0

• unit

  http://stsci.edu/schemas/asdf/unit/unit-1.0.0

  Required

  The unit corresponding to the values

Examples

An Angle object in Degrees:

!<tag:astropy.org:astropy/coordinates/angle-1.0.0>
  unit: !unit/unit-1.0.0 deg
  value: 10.0

Original Schema

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://astropy.org/schemas/astropy/coordinates/angle-1.0.0"

title: |
  Represents an Angle.

# TODO: Is there any restriction on the range of values?  The next
# version of the schema should make this explicit.
description:
  This object represents a subtype of Quantity which has units equivalent to
  radians or degrees.

examples:
  -
    - An Angle object in Degrees
    - |
        !<tag:astropy.org:astropy/coordinates/angle-1.0.0>
          unit: !unit/unit-1.0.0 deg
          value: 10.0

type: object
properties:
  value:
    description: |
      A vector of one or more values
    anyOf:
      - type: number
      - $ref: "http://stsci.edu/schemas/asdf/core/ndarray-1.0.0"
  unit:
    description: |
      The unit corresponding to the values
    $ref: "http://stsci.edu/schemas/asdf/unit/unit-1.0.0"
required: [value, unit]
...