WavelengthrangeModel¶
-
class
jwst.datamodels.
WavelengthrangeModel
(init=None, wrange_selector=None, wrange=None, order=None, extract_orders=None, wunits=None, **kwargs)[source]¶ Bases:
jwst.datamodels.ReferenceFileModel
A model for a reference file of type “wavelengthrange”.
The model is used by MIRI, NIRSPEC, NIRCAM, and NIRISS.
- Parameters
wrange (list) – Contains a list of [order, filter, min wave, max wave]
order (list) – A list of orders that are available and described in the file
extract_orders (list) – A list of filters and the orders that should be extracted by default
wunits (
units
) – The units for the wavelength datainit (str, tuple,
HDUList
, ndarray, dict, None) –None : Create a default data model with no shape.
tuple : Shape of the data array. Initialize with empty data array with shape specified by the.
file path: Initialize from the given file (FITS or ASDF)
readable file object: Initialize from the given file object
HDUList
: Initialize from the givenHDUList
.A numpy array: Used to initialize the data array
dict: The object model tree for the data model
schema (dict, str (optional)) – Tree of objects representing a JSON schema, or string naming a schema. The schema to use to understand the elements on the model. If not provided, the schema associated with this class will be used.
memmap (bool) – Turn memmap of FITS file on or off. (default: False). Ignored for ASDF files.
pass_invalid_values (bool or None) – If
True
, values that do not validate the schema will be added to the metadata. IfFalse
, they will be set toNone
. IfNone
, value will be taken from the environmental PASS_INVALID_VALUES. Otherwise the default value isFalse
.strict_validation (bool or None) – If
True
, schema validation errors will generate an exception. IfFalse
, they will generate a warning. IfNone
, value will be taken from the environmental STRICT_VALIDATION. Otherwise, the default value isFalse
.validate_on_assignment (bool or None) – Defaults to ‘None’. If
None
, value will be taken from the environmental VALIDATE_ON_ASSIGNMENT, defaulting to ‘True’ if no environment variable is set. If ‘True’, attribute assignments are validated at the time of assignment. Validation errors generate warnings and values will be set toNone
. If ‘False’, schema validation occurs only once at the time of write. Validation errors generate warnings.ignore_missing_extensions (bool) – When
False
, raise warnings when a file is read that contains metadata about extensions that are not available. Defaults toTrue
.kwargs (dict) –
Additional keyword arguments passed to lower level functions. These arguments are generally file format-specific. Arguments of note are:
available built-in formats are (The) –
==== ===== ============= (=========) – Format Read Write Auto-identify
==== ===== ============= –
Yes Yes Yes (datamodel) –
==== ===== ============= –
Attributes Summary
The schema URI to validate the model against.
Methods Summary
get_wfss_wavelength_range
(filter, orders)Retrieve the wavelength range for a WFSS observation.
on_save
([path])Hook invoked by the base class before writing a model to a file (FITS or ASDF).
to_fits
()Write a data model to a FITS file.
validate
()Convenience function to be run when files are created.
Attributes Documentation
-
reftype
= 'wavelengthrange'¶
-
schema_url
= 'http://stsci.edu/schemas/jwst_datamodel/wavelengthrange.schema'¶ The schema URI to validate the model against. If None, only basic validation of required metadata properties (filename, model_type) will occur.
Methods Documentation
-
get_wfss_wavelength_range
(filter, orders)[source]¶ Retrieve the wavelength range for a WFSS observation.
-
on_save
(path=None)[source]¶ Hook invoked by the base class before writing a model to a file (FITS or ASDF).