stdatamodels API

stdatamodels Package

Data models for JWST.

Classes

DataModel([init, schema, memmap, ...])

Base class of all of the data models.

Class Inheritance Diagram

stdatamodels.exceptions Module

Classes

ValidationWarning	Warning to raise if a model fails to validate through its schema.
NoTypeWarning	Warning to raise when opening a file that lacks a model type.

Class Inheritance Diagram

stdatamodels.dqflags Module

Interpret JWST data quality flags.

The flags are binary-packed structures representing information about a given element (a bit field): Each flag is assigned a bit position in a 32-bit mask. If a given bit is set, the flag assigned to that bit is interpreted as being set or active.

Functions

interpret_bit_flags(bit_flags[, flip_bits, ...])	Convert input bit flags to a single integer value (bit mask) or None.
dqflags_to_mnemonics(dqflags, mnemonic_map)	Interpret value as bit flags and return the mnemonics.

stdatamodels.asdf_in_fits Module

Functions

write(filename, tree[, hdulist])	Write ASDF data inside a FITS file.
open(filename_or_hdu, **kwargs)	Read ASDF data embedded in a fits file.

stdatamodels.jwst.datamodels Package

Datamodels for JWST pipeline.

Functions

open([init, guess, memmap])	Create a DataModel from a number of different types.
read_metadata(fname[, model_type, flatten])	Load a metadata tree from a file without loading the entire datamodel into memory.

Classes

JwstDataModel([init, schema, memmap, ...])	Base class for JWST data models.
ABVegaOffsetModel([init])	A data model containing offsets to convert from AB to Vega magnitudes.
AmiLgModel([init, schema, memmap, ...])	A data model for AMI LG analysis results.
AmiLgFitModel([init, schema, memmap, ...])	A data model for AMI LG analysis results.
AmiOIModel([init, schema, memmap, ...])	Class containing AMI interferometric observables.
NRMModel([init])	A data model for Non-Redundant Mask.
FgsImgApcorrModel([init])	A data model for FGS imaging apcorr reference files.
MirImgApcorrModel([init])	A data model for MIRI imaging apcorr reference files.
NrcImgApcorrModel([init])	A data model for NIRCam imaging apcorr reference files.
NisImgApcorrModel([init])	A data model for NIRISS imaging apcorr reference files.
MirLrsApcorrModel([init])	A data model for MIRI LRS apcorr reference files.
MirMrsApcorrModel([init])	A data model for MIRI MRS apcorr reference files.
NrcWfssApcorrModel([init])	A data model for NIRCam WFSS apcorr reference files.
NisWfssApcorrModel([init])	A data model for NIRISS WFSS apcorr reference files.
NrsMosApcorrModel([init])	A data model for NIRSpec MOS apcorr reference files.
NrsFsApcorrModel([init])	A data model for NIRSpec Fixed-Slit apcorr reference files.
NrsIfuApcorrModel([init])	A data model for NIRSpec IFU apcorr reference files.
AsnModel([init])	A data model for association tables.
BarshadowModel([init])	A data model for Bar Shadow correction information.
CameraModel([init, model, input_units, ...])	Stores the transforms from the NIRSpec camera to the GWA.
CollimatorModel([init, model, input_units, ...])	Stores the transform through the NIRSpec collimator.
CombinedSpecModel([init, schema, memmap, ...])	A data model for combined 1D spectra.
ContrastModel([init, schema, memmap, ...])	A data model for coronagraphic contrast curve files.
CubeModel([init])	A data model for 3D image cubes.
DarkModel([init])	A data model for dark reference files.
DarkMIRIModel([init])	A data model for dark MIRI reference files.
DarkNirspecModel([init])	A data model for NIRSpec dark reference files.
DisperserModel([init, angle, gwa_tiltx, ...])	A model for a NIRSPEC reference file of type "disperser".
DistortionModel([init, model, input_units, ...])	A model for a reference file of type "distortion".
DistortionMRSModel([init, x_model, y_model, ...])	A model for a reference file of type "distortion" for the MIRI MRS.
EmiModel([init])	A data model to correct MIRI images for EMI contamination.
Extract1dIFUModel([init])	A data model for IFU MIRI and NIRSpec extract 1d reference files.
FilteroffsetModel([init, filters, instrument])	A model for filter-dependent boresight offsets.
FlatModel([init])	A data model for 2D flat-field images.
NirspecFlatModel([init])	A data model for NIRSpec flat-field reference files.
NirspecQuadFlatModel([init])	A data model for NIRSpec flat-field files that differ by quadrant.
FOREModel([init, model, input_units, ...])	Stores the transform from the MSA plane to the Filter Wheel.
FPAModel([init, nrs1_model, nrs2_model])	A model for a NIRSPEC reference file of type "fpa".
FringeModel([init])	A data model for 2D fringe correction images.
FringeFreqModel([init])	A data model for 2D fringe correction images.
GainModel([init])	A data model for 2D gain.
GuiderRawModel([init])	A data model for Guide Star pipeline raw data files.
GuiderCalModel([init])	A data model for Guide Star pipeline calibrated files.
IFUCubeModel([init])	A data model for 3D IFU cubes.
NirspecIFUCubeParsModel([init])	A data model for Nirspec ifucubepars reference files.
MiriIFUCubeParsModel([init])	A data model for MIRI mrs ifucubepars reference files.
MirMrsPtCorrModel([init])	A data model for MIRI mrs IFU across-slice corrections file.
MirMrsXArtCorrModel([init])	A data model for MIRI MRS cross-artifact corrections file.
IFUFOREModel([init, model, input_units, ...])	A model for a NIRSPEC reference file of type "ifufore".
IFUImageModel([init])	A data model for 2D IFU images.
IFUPostModel([init, slice_models])	A model for a NIRSPEC reference file of type "ifupost".
IFUSlicerModel([init, model, data])	A model for a NIRSPEC reference file of type "ifuslicer".
ImageModel([init, schema, memmap, ...])	A data model for 2D images.
IPCModel([init])	A data model for IPC kernel checking information.
IRS2Model([init])	A data model for the IRS2 refpix reference file.
LastFrameModel([init])	A data model for Last frame correction reference files.
Level1bModel([init, schema, memmap, ...])	A data model for raw 4D ramps level-1b products.
LinearityModel([init])	A data model for linearity correction information.
MaskModel([init])	A data model for 2D masks.
MiriLRSSpecwcsModel([init, wavetable, ...])	A model for a reference file of type "specwcs" for MIRI LRS Slit.
MSAModel([init, models, data])	A model for a NIRSPEC reference file of type "msa".
MultiCombinedSpecModel([init])	A data model for multi-spec images.
MultiExposureModel([init])	A data model for multi-slit images derived from numerous exposures.
MultiSlitModel([init])	A data model for multi-slit images.
MultiSpecModel([init])	A data model for multi-spec tables.
MRSMultiSpecModel([init])	A data model for MIRI MRS multi-spec tables.
TSOMultiSpecModel([init])	A data model for TSO multi-integration, multi-spectra tables.
NIRCAMGrismModel([init, displ, dispx, ...])	A model for a reference file of type "specwcs" for NIRCAM WFSS.
NIRISSGrismModel([init, displ, dispx, ...])	A model for a reference file of type "specwcs" for NIRISS grisms.
OTEModel([init, model, input_units, ...])	Stores the transform from the Filter Wheel to the Optical Telescope Element.
OutlierIFUOutputModel([init, schema, ...])	A data model for the optional output from outlier_detection_ifu step.
PathlossModel([init])	A data model for pathloss correction information.
MirLrsPathlossModel([init])	A data model for MIRI LRS pathloss correction information.
PersistenceSatModel([init])	A data model for the persistence saturation value (full well).
PixelAreaModel([init])	A data model for the pixel area map.
NirspecSlitAreaModel([init])	A data model for the NIRSpec fixed-slit pixel area reference file.
NirspecMosAreaModel([init])	A data model for the NIRSpec MOS pixel area reference file.
NirspecIfuAreaModel([init])	A data model for the NIRSpec IFU pixel area reference file.
FgsImgPhotomModel([init])	A data model for FGS photom reference files.
MirImgPhotomModel([init])	A data model for MIRI imaging photom reference files.
MirLrsPhotomModel([init])	A data model for MIRI LRS photom reference files.
MirMrsPhotomModel([init])	A data model for MIRI MRS photom reference files.
NrcImgPhotomModel([init])	A data model for NIRCam imaging photom reference files.
NrcWfssPhotomModel([init])	A data model for NIRCam WFSS photom reference files.
NisImgPhotomModel([init])	A data model for NIRISS imaging photom reference files.
NisSossPhotomModel([init])	A data model for NIRISS SOSS photom reference files.
NisWfssPhotomModel([init])	A data model for NIRISS WFSS photom reference files.
NrsFsPhotomModel([init])	A data model for NIRSpec Fixed-Slit photom reference files.
NrsMosPhotomModel([init])	A data model for NIRSpec MOS and IFU photom reference files.
PastasossModel([init])	A data model to hold NIRISS SOSS wavelength grids.
PsfMaskModel([init])	A data model for coronagraphic 2D PSF mask reference files.
QuadModel([init])	A data model for 4D image arrays.
RampModel([init])	A data model for 4D ramps.
RampFitOutputModel([init, schema, memmap, ...])	A data model for the optional output of the ramp fitting step.
ReadnoiseModel([init])	A data model for 2D readnoise.
ReferenceFileModel([init])	A data model for reference tables.
ReferenceCubeModel([init])	A data model for 3D reference images.
ReferenceImageModel([init])	A data model for 2D reference images.
ReferenceQuadModel([init])	A data model for 4D reference images.
RegionsModel([init, regions])	A model for a reference file of type "regions".
ResetModel([init])	A data model for reset correction reference files.
ResolutionModel([init])	A data model for Spectral Resolution parameters reference tables.
MiriResolutionModel([init])	A data model for MIRI Resolution reference files.
RSCDModel([init])	A data model for the RSCD reference file.
SaturationModel([init])	A data model for saturation checking information.
SIRSKernelModel([init])	A data model for the NIR Optimized Convolution Kernel Fourier Coefficients.
SlitDataModel([init])	A data model for 2D slit images.
SlitModel([init])	A data model for 2D images.
SpecModel([init, schema, memmap, ...])	A data model for 1D spectra.
MRSSpecModel([init, schema, memmap, ...])	A data model for MIRI MRS 1D spectra with residual fringe corrections.
TSOSpecModel([init, schema, memmap, ...])	A data model for TSO 1D spectra with multiple integrations.
SegmentationMapModel([init, schema, memmap, ...])	A data model for 2D segmentation maps.
SossBkgModel([init])	A data model of 2D background reference templates for NIRISS SOSS data.
SossExtractModel([init, schema, memmap, ...])	A data model to hold NIRISS SOSS extraction model arrays.
SossWaveGridModel([init, schema, memmap, ...])	A data model to hold NIRISS SOSS wavelength grids.
SpecKernelModel([init])	A data model for 2D spectral kernels.
SpecProfileModel([init])	A data model for NIRISS SOSS spectral profile reference files.
SpecProfileSingleModel([init])	A data model for NIRISS SOSS spectral profile data.
SpecTraceModel([init])	A data model for NIRISS SOSS spectral trace reference files.
SpecTraceSingleModel([init])	A data model for NIRISS SOSS spectral trace data.
SpecPsfModel([init])	A data model for spectral PSF reference data.
SpecwcsModel([init, model, input_units, ...])	A model for a reference file of type "specwcs".
StrayLightModel([init])	A data model for 2D straylight mask.
SuperBiasModel([init])	A data model for 2D super-bias images.
ThroughputModel([init])	A data model for filter throughput.
TrapDensityModel([init])	A data model for the trap density of a detector, for persistence.
TrapParsModel([init])	A data model for trap capture and decay parameters.
TrapsFilledModel([init, schema, memmap, ...])	A data model for the number of traps filled for a detector, for persistence.
TsoPhotModel([init, radii])	A model for a reference file of type "tsophot".
WavelengthrangeModel([init, ...])	A model for a reference file of type "wavelengthrange".
WaveCorrModel([init, apertures])	Wavelength zero-point correction for the position of a point source in a NIRSpec slit.
WaveMapModel([init])	A data model for NIRISS SOSS wavelength map reference files.
WaveMapSingleModel([init])	A data model for NIRISS SOSS wavelength map data.
WfssBkgModel([init])	A data model for 2D WFSS master background reference files.
WFSSCombinedSpecModel([init, schema, ...])	A data model for NIRCam and NIRISS WFSS exposure-averaged 1D spectra.
WFSSMultiCombinedSpecModel([init, schema, ...])	A data model for NIRCam and NIRISS WFSS exposure-averaged 1D spectra.
WFSSMultiSpecModel([init])	A data model for a collection of spectra from multiple exposures and/or spectral orders.
WFSSSpecModel([init, schema, memmap, ...])	A data model for NIRCam and NIRISS WFSS 1D spectra.

Class Inheritance Diagram

stdatamodels.jwst.transforms Package

Custom Astropy modeling transforms for JWST.