transform-1.0.0

A generic type used to mark where other transforms are accepted.

Description

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

Outline

Schema Definitions

This type is an object with the following properties:

  • name

    string

    A user-friendly name for the transform, to give it extra meaning.

    No length restriction

  • domain

    array

    The domain (range of valid inputs) to the transform. Each entry in the list corresponds to an input dimension.

    No length restriction

    Items in the array are restricted to the following types:

  • inverse

    transform-1.0.0

    Explicitly sets the inverse transform of this transform.

    If the transform has a direct analytic inverse, this property is usually not necessary, as the ASDF-reading tool can provide it automatically.

Original Schema 

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/transform/transform-1.0.0"
title: >
  A generic type used to mark where other transforms are accepted.

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

type: object
properties:
  name:
    description: |
      A user-friendly name for the transform, to give it extra
      meaning.
    type: string

  domain:
    description: |
      The domain (range of valid inputs) to the transform.
      Each entry in the list corresponds to an input dimension.
    type: array
    items:
      $ref: "domain-1.0.0"

  inverse:
    description: |
      Explicitly sets the inverse transform of this transform.

      If the transform has a direct analytic inverse, this
      property is usually not necessary, as the ASDF-reading tool
      can provide it automatically.

    $ref: "transform-1.0.0"
additionalProperties: true
...