domain-1.0.0

Defines the domain of an input axis. (deprecated since 1.1.0)

Description

Describes the range of acceptable input values to a particular axis of a transform.

Outline

Schema Definitions

This type is an object with the following properties:

  • lower

    number

    The lower value of the domain. If not provided, the domain has no lower limit.

    Default value: -inf

  • upper

    number

    The upper value of the domain. If not provided, the domain has no upper limit.

    Default value: inf

  • includes_lower

    boolean

    If true, the domain includes lower.

    Default value:

    False

  • includes_upper

    boolean

    If true, the domain includes upper.

    Default value:

    False

Examples

The domain [0, 1).:

!transform/domain-1.0.0
  lower: 0
  upper: 1
  includes_lower: true

Original Schema 

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/transform/domain-1.0.0"
title: >
  Defines the domain of an input axis. (deprecated since 1.1.0)

description: >
  Describes the range of acceptable input values to a particular
  axis of a transform.

examples:
  -
    - The domain `[0, 1)`.
    - |
      !transform/domain-1.0.0
        lower: 0
        upper: 1
        includes_lower: true

properties:
  lower:
    description: >
      The lower value of the domain.  If not provided, the
      domain has no lower limit.
    type: number
    default: -.inf

  upper:
    description: >
      The upper value of the domain.  If not provided, the
      domain has no upper limit.
    type: number
    default: .inf

  includes_lower:
    description: If `true`, the domain includes `lower`.
    type: boolean
    default: false

  includes_upper:
    description: If `true`, the domain includes `upper`.
    type: boolean
    default: false
...