<commit_before>%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/wcs/frame-0.1.0"
title: >
  The base class of all coordinate frames.
description: >
  These objects are designed to be nested in arbitrary ways to build up
  transformation pipelines out of a number of low-level pieces.

  Most of these coordinate frames are defined in [IERS
  conventions](http://www.iers.org/IERS/EN/Publications/TechnicalNotes/tn36.html).

type: object
properties:
  name:
    description: |
      A user-friendly name for the frame.
    type: string

  axes_order:
    description: |
      The order of the axes.
    type: array
    items:
      type: integer

  axes_names:
    description: |
      The name of each axis in this frame.
    type: array
    items:
      anyOf:
        - type: string
        - type: 'null'

  reference_frame:
    description: |
      The reference frame.  Some reference frames require additional
      properties, listed next to each reference frame type below.

      The reference frames types are:

      - `ICRS`

      - `FK5`: `equinox`.

      - `FK4`: `equinox` and optionally `obstime`.

      - `FK4_noeterms`: `equinox` and optionally `obstime`.

      - `galactic`

      - `galactocentric`: `galcen_distance`, `galcen_ra`,
        `galcen_dec`, `z_sun` and `roll`.

      - `GCRS`: `obstime`, `obsgeoloc`, and `obsgeovel`.

      - `CIRS`: `obstime`.

      - `ITRS`: `obstime`.

      - `precessed_geocentric`: `obstime`, `obsgeoloc`, and
        `obsgeovel`.

    enum: [ICRS, FK5, FK4, FK4_noeterms, galactic, galactocentric,
           GCRS, CIRS, ITRS, precessed_geocentric]
    default: ICRS

  equinox:
    description: |
      The equinox of the reference frame.  Required when
      `reference_frame` one of:

        `FK5`, `FK4`, `FK4_noeterms`

    $ref: ../time/time-0.1.0

  obstime:
    description: |
      The observation time of the reference frame, used to determine
      the location of the Earth.  Required when `reference_frame` is
      one of:

        `FK4`, `FK4_noeterms`, `GCRS`, `CIRS`, `ITRS`

      If not provided, it defaults to the same value as `equinox`.
    $ref: ../time/time-0.1.0

  galcen_distance:
    description: |
      The distance from the Sun to the Galactic center.  Required when
      `reference_frame` is `galactocentric`.
    type: array
    items:
      - type: number
      - $ref: ../unit/unit-0.1.0
        default: pc

  galcen_ra:
    description: |
      The Right Ascension (RA) of the Galactic center in the ICRS
      frame.  Required when `reference_frame` is `galactocentric`.
    type: array
    items:
      - type: number
      - $ref: ../unit/unit-0.1.0
        default: degree

  galcen_dec:
    description: |
      The Declination (DEC) of the Galactic center in the ICRS frame.
      Required when `reference_frame` is `galactocentric`.
    type: array
    items:
      - type: number
      - $ref: ../unit/unit-0.1.0
        default: degree

  z_sun:
    description: |
      The distance from the sun to the galactic midplane.  Required
      when `reference_frame` is `galactocentric`.  Required when
      `reference_frame` is `galactocentric`.
    type: array
    items:
      - type: number
      - $ref: ../unit/unit-0.1.0
        default: pc

  roll:
    description: |
      The angle to rotate about the final x-axis, relative to the
      orientation for `galactic`.  Required when `reference_frame` is
      `galactocentric`.
    type: array
    items:
      - type: number
      - $ref: ../unit/unit-0.1.0
        default: degree

  obsgeoloc:
    description: |
      3-vector giving the position of the observer relative to the
      center-of-mass of the Earth, oriented the same as
      BCRS/ICRS. Defaults to `[0, 0, 0]`, meaning "true" GCRS.  Used
      when `reference_frame` is `GCRS` or `precessed_geocentric`.
    type: array
    items:
      - type: array
        items:
          type: number
        minItems: 3
        maxItems: 3
      - $ref: ../unit/unit-0.1.0
        default: m
    default:
      - [0, 0, 0]

  obsgeovel:
    description: |
      3-vector giving the velocity of the observer relative to the
      center-of-mass of the Earth, oriented the same as
      BCRS/ICRS. Defaults to `[0, 0, 0]`, meaning "true" GCRS.  Used
      when `reference_frame` is `GCRS` or `precessed_geocentric`.
    type: array
    items:
      - type: array
        items:
          type: number
        minItems: 3
        maxItems: 3
      - $ref: ../unit/unit-0.1.0
        default: m/s
    default:
      - [0, 0, 0]

  unit:
    description: |
      Units for each axis.
    type: array
    items:
      $ref: ../unit/unit-0.1.0

required: [name]
additionalProperties: true<commit_msg>Change layout.  Add an example.<commit_after>%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/wcs/frame-0.1.0"
title: |
  The base class of all coordinate frames.

description: |
  These objects are designed to be nested in arbitrary ways to build up
  transformation pipelines out of a number of low-level pieces.

  Most of these coordinate frames are defined in [IERS
  conventions](http://www.iers.org/IERS/EN/Publications/TechnicalNotes/tn36.html).

examples:
  -
    - |
        A celestial frame in the FK4 reference frame.
    - |
        !wcs/celestial_frame-0.1.0
          axes_names: [ra, dec]
          name: CelestialFrame
          reference_frame:
            type: FK4
            equinox: !time/time-0.1.0 '2010-01-01 00:00:00.000'
            obstime: !time/time-0.1.0 '2015-01-01 00:00:00.000'
          unit: [!unit/unit-0.1.0 deg, !unit/unit-0.1.0 deg]

type: object
properties:
  name:
    description: |
      A user-friendly name for the frame.
    type: string

  axes_order:
    description: |
      The order of the axes.
    type: array
    items:
      type: integer

  axes_names:
    description: |
      The name of each axis in this frame.
    type: array
    items:
      anyOf:
        - type: string
        - type: 'null'

  reference_frame:
    description: |
      The reference frame.
    type: object
    properties:
      type:
        description: |
          The reference frame type.  Some reference frame types
          require additional properties, listed next to each reference
          frame type below.

          The reference frames types are:

          - `ICRS`

          - `FK5`: `equinox`.

          - `FK4`: `equinox` and optionally `obstime`.

          - `FK4_noeterms`: `equinox` and optionally `obstime`.

          - `galactic`

          - `galactocentric`: `galcen_distance`, `galcen_ra`,
            `galcen_dec`, `z_sun` and `roll`.

          - `GCRS`: `obstime`, `obsgeoloc`, and `obsgeovel`.

          - `CIRS`: `obstime`.

          - `ITRS`: `obstime`.

          - `precessed_geocentric`: `obstime`, `obsgeoloc`, and
            `obsgeovel`.

        enum: [ICRS, FK5, FK4, FK4_noeterms, galactic, galactocentric,
               GCRS, CIRS, ITRS, precessed_geocentric]
        default: ICRS

      equinox:
        description: |
          The equinox of the reference frame.  Required when
          `reference_frame` one of:

            `FK5`, `FK4`, `FK4_noeterms`

        $ref: ../time/time-0.1.0

      obstime:
        description: |
          The observation time of the reference frame, used to determine
          the location of the Earth.  Required when `reference_frame` is
          one of:

            `FK4`, `FK4_noeterms`, `GCRS`, `CIRS`, `ITRS`

          If not provided, it defaults to the same value as `equinox`.
        $ref: ../time/time-0.1.0

      galcen_distance:
        description: |
          The distance from the Sun to the Galactic center.  Required when
          `reference_frame` is `galactocentric`.
        type: array
        items:
          - type: number
          - $ref: ../unit/unit-0.1.0
            default: pc

      galcen_ra:
        description: |
          The Right Ascension (RA) of the Galactic center in the ICRS
          frame.  Required when `reference_frame` is `galactocentric`.
        type: array
        items:
          - type: number
          - $ref: ../unit/unit-0.1.0
            default: deg

      galcen_dec:
        description: |
          The Declination (DEC) of the Galactic center in the ICRS frame.
          Required when `reference_frame` is `galactocentric`.
        type: array
        items:
          - type: number
          - $ref: ../unit/unit-0.1.0
            default: deg

      z_sun:
        description: |
          The distance from the sun to the galactic midplane.  Required
          when `reference_frame` is `galactocentric`.  Required when
          `reference_frame` is `galactocentric`.
        type: array
        items:
          - type: number
          - $ref: ../unit/unit-0.1.0
            default: pc

      roll:
        description: |
          The angle to rotate about the final x-axis, relative to the
          orientation for `galactic`.  Required when `reference_frame` is
          `galactocentric`.
        type: array
        items:
          - type: number
          - $ref: ../unit/unit-0.1.0
            default: deg

      obsgeoloc:
        description: |
          3-vector giving the position of the observer relative to the
          center-of-mass of the Earth, oriented the same as
          BCRS/ICRS. Defaults to `[0, 0, 0]`, meaning "true" GCRS.  Used
          when `reference_frame` is `GCRS` or `precessed_geocentric`.
        type: array
        items:
          - type: array
            items:
              type: number
            minItems: 3
            maxItems: 3
          - $ref: ../unit/unit-0.1.0
            default: m
        default:
          - [0, 0, 0]

      obsgeovel:
        description: |
          3-vector giving the velocity of the observer relative to the
          center-of-mass of the Earth, oriented the same as
          BCRS/ICRS. Defaults to `[0, 0, 0]`, meaning "true" GCRS.  Used
          when `reference_frame` is `GCRS` or `precessed_geocentric`.
        type: array
        items:
          - type: array
            items:
              type: number
            minItems: 3
            maxItems: 3
          - $ref: ../unit/unit-0.1.0
            default: m/s
        default:
          - [0, 0, 0]

    required: [type]

  unit:
    description: |
      Units for each axis.
    type: array
    items:
      $ref: ../unit/unit-0.1.0

required: [name]
additionalProperties: true
{'fraction_non_alphanumeric': 0.10291335603480893, 'fraction_numerical': 0.017688233068482783, 'mean_word_length': 1.8521715673050985, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2391162', 'n_tokens_mistral': 3531, 'n_tokens_neox': 3287, 'n_words': 1022}