multiresolution_optical_signature¶
- multiresolution_optical_signature … end_multiresolution_optical_signature¶
As with other platform components, multiresolution_optical_signature may be used outside of platform or platform_type commands to define new types, or inside those commands to instantiate an object on an instance of a platform or platform_type. Usage is as follows:
Define a new multiresolution_optical_signature type (occurs outside a platform or platform_type command)
multiresolution_optical_signature <derived> WSF_MULTIRESOLUTION_OPTICAL_SIGNATURE fidelity <real-value> [add | edit] model <string-value> fidelity_range <real-value> <real-value> [default] optical_signature [<optical_signature-type>] ... optical_signature ... end_optical_signature end_model [add | edit] model <string-value> ... Any number of models may be specified ... end_model common ... optical_signature ... end_common end_multiresolution_optical_signature
Instantiate a multiresolution_optical_signature object on a new platform_type:
platform_type ... multiresolution_optical_signature <type> ... multiresolution_optical_signature commands ... end_multiresolution_optical_signature end_platform_type
Instantiate a (not previously existing) multiresolution_optical_signature object on a platform instance:
platform ... add multiresolution_optical_signature <type> ... multiresolution_optical_signature commands ... end_multiresolution_optical_signature end_platform
Modify an existing multiresolution_optical_signature object on a platform instance:
platform ... edit multiresolution_optical_signature <type> ... multiresolution_optical_signature commands ... end_multiresolution_optical_signature end_platform
Overview¶
multiresolution_optical_signature defines a container for holding one or more optical_signature objects on a platform and deferring the choice of which optical_signature to use on the platform until run-time. The choice of optical_signature is made using a fidelity parameter associated with the component. Each optical_signature model defined in the container is assigned a fidelity_range over which it is valid, and the matching optical_signature is set on the platform during initialization.
The fidelity_range inputs are used to categorize models into bins that are selected by the fidelity parameter. A typical use would be to set up a multiresolution_optical_signature on a platform_type without specifying the fidelity, deferring that choice to the actual platform definition.
Note
In the future the fidelity choice is intended to be made available at alternate locations in a scenario file, which will improve the utility of this component.
Types¶
Commands¶
- fidelity <real-value>¶
Defines the fidelity value of the component, which determines which optical_signature to use at run-time. Must be between 0 and 1 inclusive. This value maps directly to the fidelity_range defined in the model commands. In other words, if two models are defined with the first having fidelity_range 0 to 0.5 and the second having 0.5 to 1, any fidelity between 0 and 0.5 (but exclusive of 0.5) will select the first model.
Default: 1.0
- model <string-value> … end_model¶
Defines or edits a contained optical_signature model with the name given by the string. Implicit adding (or editing if the named model exists) is supported along with explicit adding and editing with the
add
andedit
commands.Note
At least one model block must be specified.
- fidelity_range <real-value> <real-value>¶
Defines the range of fidelity values over which this model should be used. Must be between 0 and 1 inclusive, in increasing order and must not overlap with another model’s fidelity_range on this component.
Default: 0.0 1.0
- default¶
If specified, this model will be used as the default choice if no fidelity match is made.
- optical_signature <optical_signature-type> … end_optical_signature¶
Defines the optical_signature model’s type and parameters specific to this model instantiation. The optical_signature is required when first defining a new model, and must not be specified when editing an existing model.
- common … end_common¶
Defines common parameters to forward to all currently specified optical_signature models. These parameters must be valid for all currently defined optical_signature models.