label_mapper-1.0.0: Represents a mapping from a coordinate value to a label.

Type: transform-1.1.0 and object.

Represents a mapping from a coordinate value to a label.

A label mapper instance maps inputs to a label. It is used together with [regions_selector](ref:http://stsci.edu/schemas/gwcs/regions_selector-1.0.0). The [label_mapper](ref:http://stsci.edu/schemas/gwcs/label_mapper-1.0.0) returns the label corresponding to given inputs. The [regions_selector](ref:http://stsci.edu/schemas/gwcs/regions_selector-1.0.0) returns the transform corresponding to this label. This maps inputs (e.g. pixels on a detector) to transforms uniquely.

All of:

0

Type: transform-1.1.0.

1

Type: object.

Properties:

mapper

Type: ndarray-1.0.0 or transform-1.1.0 or object. Required.

A mapping of inputs to labels. In the general case this is a astropy.modeling.core.Model.

It could be a numpy array with the shape of the detector/observation. Pixel values are of type integer or string and represent region labels. Pixels which are not within any region have value no_label.

It could be a dictionary which maps tuples to labels or floating point numbers to labels.

Any of:

—

Type: ndarray-1.0.0.

—

Type: transform-1.1.0.

—

Type: object.

Properties:

labels

Type: array of ( number or array of ( number ) ).

Items:

Type: number or array of ( number ).

Any of:

—

Type: number.

—

Type: array of ( number ).

Items:

Type: number.

models

Type: array of ( transform-1.1.0 ).

Items:

Type: transform-1.1.0.

inputs

Type: array of ( string ).

Names of inputs.

Items:

Type: string.

inputs_mapping

Type: transform-1.1.0.

[mapping](ref:http://stsci.edu/schemas/asdf/transform/remap-axes-1.1.0)

atol

Type: number.

absolute tolerance to compare keys in mapper.

no_label

Type: number or string.

Fill in value for missing output.

Any of:

—

Type: number.

—

Type: string.

Examples:

Map array indices are to labels.:

!<tag:stsci.edu:gwcs/label_mapper-1.0.0>
  mapper: !core/ndarray-1.0.0
    data:
    - [1, 0, 2]
    - [1, 0, 2]
    - [1, 0, 2]
    datatype: int64
    shape: [3, 3]
    no_label: 0

Map numbers dictionary to transforms which return labels.:

!<tag:stsci.edu:gwcs/label_mapper-1.0.0>
  atol: 1.0e-08
  inputs: [x, y]
  inputs_mapping: !transform/remap_axes-1.1.0
      mapping: [0]
      n_inputs: 2
  mapper: !!omap
    - !!omap
      labels: [-1.67833272, -1.9580548, -1.118888]
    - !!omap
      models:
      - !transform/shift-1.1.0 {offset: 6.0}
      - !transform/shift-1.1.0 {offset: 2.0}
      - !transform/shift-1.1.0 {offset: 4.0}
  no_label: 0

Map a number within a range of numbers to transforms which return labels.:

!<tag:stsci.edu:gwcs/label_mapper-1.0.0>
  mapper: !!omap
  - !!omap
    labels:
    - [3.2, 4.1]
    - [2.67, 2.98]
    - [1.95, 2.3]
  - !!omap
    models:
    - !transform/shift-1.1.0 {offset: 6.0}
    - !transform/shift-1.1.0 {offset: 2.0}
    - !transform/shift-1.1.0 {offset: 4.0}
  inputs: [x, y]
  inputs_mapping: !transform/remap_axes-1.1.0
    mapping: [0]
    n_inputs: 2