MultiSlitModel¶
-
class
jwst.datamodels.
MultiSlitModel
(init=None, **kwargs)[source]¶ Bases:
jwst.datamodels.JwstDataModel
A data model for multi-slit images.
This model has a special member
slits
that can be used to deal with an entire slit at a time. It behaves like a list:>>> from .slit import SlitModel >>> multislit_model = MultiSlitModel() >>> multislit_model.slits.append(SlitModel()) >>> multislit_model[0] <SlitModel>
If
init
is a file name or anImageModel
or aSlitModel``instance, an empty ``SlitModel
will be created and assigned to attributeslits[0]
, and thedata
,dq
,err
,var_rnoise
, andvar_poisson
attributes from the input file or model will be copied to the first element ofslits
.- Parameters
slits.items.data (numpy float32 array) – The science data
slits.items.dq (numpy uint32 array) – Data quality array
slits.items.err (numpy float32 array) – Error array
slits.items.var_poisson (numpy float32 array) – variance due to poisson noise
slits.items.var_rnoise (numpy float32 array) – variance due to read noise
slits.items.wavelength (numpy float32 array) – Wavelength array, corrected for zero-point
slits.items.barshadow (numpy float32 array) – Bar shadow correction
slits.items.flatfield_point (numpy float32 array) – flatfield array for point source
slits.items.flatfield_uniform (numpy float32 array) – flatfield array for uniform source
slits.items.pathloss_point (numpy float32 array) – pathloss array for point source
slits.items.pathloss_uniform (numpy float32 array) – pathloss array for uniform source
slits.items.photom_point (numpy float32 array) – photom array for point source
slits.items.photom_uniform (numpy float32 array) – photom array for uniform source
slits.items.area (numpy float32 array) – Pixel area map array
init (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.
Attributes Documentation
-
schema_url
= 'http://stsci.edu/schemas/jwst_datamodel/multislit.schema'¶ The schema URI to validate the model against. If None, only basic validation of required metadata properties (filename, model_type) will occur.