A SwitchMap is a Mapping which represents a set of alternate Mappings, each of which is used to transform positions within a particular region of the input or output coordinate system of the SwitchMap.
A SwitchMap can encapsulate any number of Mappings, but they must all have the same number
of inputs (Nin attribute value) and the same number of outputs (Nout attribute value).
The SwitchMap itself inherits these same values for its Nin and Nout attributes. Each of
these Mappings represents a
" through the switch, and are referred to as
Mappings below. Each route Mapping transforms positions between the input and output
coordinate space of the entire SwitchMap, but only one Mapping will be used to transform any
given position. The selection of the appropriate route Mapping to use with any given input
position is made by another Mapping, called the
" Mapping. Each SwitchMap
encapsulates two selector Mappings in addition to its route Mappings; one for use with
’ s forward transformation (called the
" forward selector Mapping
" ), and
one for use with the SwitchMap
’ s inverse transformation (called the
" inverse selector
" ). The forward selector Mapping must have the same number of inputs as the
route Mappings, but should have only one output. Likewise, the inverse selector Mapping
must have the same number of outputs as the route Mappings, but should have only one
When the SwitchMap is used to transform a position in the forward direction (from input to output), each supplied input position is first transformed by the forward transformation of the forward selector Mapping. This produces a single output value for each input position referred to as the selector value. The nearest integer to the selector value is found, and is used to index the array of route Mappings (the first supplied route Mapping has index 1, the second route Mapping has index 2, etc). If the nearest integer to the selector value is less than 1 or greater than the number of route Mappings, then the SwitchMap output position is set to a value of AST__BAD on every axis. Otherwise, the forward transformation of the selected route Mapping is used to transform the supplied input position to produce the SwitchMap output position.
When the SwitchMap is used to transform a position in the inverse direction (from
" ), each supplied
" position is first transformed by the inverse transformation of the
inverse selector Mapping. This produces a selector value for each
" position. Again, the
nearest integer to the selector value is found, and is used to index the array of route Mappings. If this
selector index value is within the bounds of the array of route Mappings, then the inverse
transformation of the selected route Mapping is used to transform the supplied
" position to
produce the SwitchMap
" position. If the selector index value is outside the bounds of the array
of route Mappings, then the SwitchMap
" position is set to a value of AST__BAD on every
In practice, appropriate selector Mappings should be chosen to associate a different route Mapping with each region of coordinate space. Note that the SelectorMap class of Mapping is particularly appropriate for this purpose.
If a compound Mapping contains a SwitchMap in series with its own inverse, the combination of the two adjacent SwitchMaps will be replaced by a UnitMap when the compound Mapping is simplified using AST_SIMPLIFY.
Note that the component Mappings supplied are not copied by AST_SWITCHMAP (the new SwitchMap simply retains a reference to them). They may continue to be used for other purposes, but should not be deleted. If a SwitchMap containing a copy of its component Mappings is required, then a copy of the SwitchMap should be made using AST_COPY.
A null Object pointer (AST__NULL) will be returned if this function is invoked with STATUS set to an error value, or if it should fail for any reason.