stdatamodels API

stdatamodels Package

Classes

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

Base class of all of the data models.

Class Inheritance Diagram

Inheritance diagram of stdatamodels.model_base.DataModel

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

Functions

open([init, guess, memmap])

Creates a DataModel from a number of different types

Classes

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

Parameters:

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, ...])

TODO

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, ...])

A model for a reference file of type "camera".

CollimatorModel([init, model, input_units, ...])

A model for a reference file of type "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.

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.

DrizParsModel([init])

A data model for drizzle parameters reference tables.

EmiModel([init])

A data model to correct MIRI images for EMI contamination.

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

A data model for the extract_1d reference image array.

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, ...])

A model for a reference file of type "fore".

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.

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

A data model for the optional output of the ramp fitting step for the GLS algorithm.

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, schema, memmap, ...])

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.

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.

MultiExtract1dImageModel([init])

A data model for extract_1d reference images.

MultiSlitModel([init])

A data model for multi-slit images.

MultiSpecModel([init])

A data model for multi-spec images.

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, ...])

A model for a reference file of type "ote".

OutlierParsModel([init])

A data model for outlier detection parameters reference tables.

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.

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.

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.

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

A data model for 2D segmentation maps

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.

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])

Parameters:

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.

Class Inheritance Diagram

Inheritance diagram of stdatamodels.jwst.datamodels.model_base.JwstDataModel, stdatamodels.jwst.datamodels.abvega_offset.ABVegaOffsetModel, stdatamodels.jwst.datamodels.amilg.AmiLgModel, stdatamodels.jwst.datamodels.amilgfitmodel.AmiLgFitModel, stdatamodels.jwst.datamodels.amioi.AmiOIModel, stdatamodels.jwst.datamodels.nrm.NRMModel, stdatamodels.jwst.datamodels.apcorr.FgsImgApcorrModel, stdatamodels.jwst.datamodels.apcorr.MirImgApcorrModel, stdatamodels.jwst.datamodels.apcorr.NrcImgApcorrModel, stdatamodels.jwst.datamodels.apcorr.NisImgApcorrModel, stdatamodels.jwst.datamodels.apcorr.MirLrsApcorrModel, stdatamodels.jwst.datamodels.apcorr.MirMrsApcorrModel, stdatamodels.jwst.datamodels.apcorr.NrcWfssApcorrModel, stdatamodels.jwst.datamodels.apcorr.NisWfssApcorrModel, stdatamodels.jwst.datamodels.apcorr.NrsMosApcorrModel, stdatamodels.jwst.datamodels.apcorr.NrsFsApcorrModel, stdatamodels.jwst.datamodels.apcorr.NrsIfuApcorrModel, stdatamodels.jwst.datamodels.asn.AsnModel, stdatamodels.jwst.datamodels.barshadow.BarshadowModel, stdatamodels.jwst.datamodels.wcs_ref_models.CameraModel, stdatamodels.jwst.datamodels.wcs_ref_models.CollimatorModel, stdatamodels.jwst.datamodels.combinedspec.CombinedSpecModel, stdatamodels.jwst.datamodels.contrast.ContrastModel, stdatamodels.jwst.datamodels.cube.CubeModel, stdatamodels.jwst.datamodels.dark.DarkModel, stdatamodels.jwst.datamodels.darkMIRI.DarkMIRIModel, stdatamodels.jwst.datamodels.wcs_ref_models.DisperserModel, stdatamodels.jwst.datamodels.wcs_ref_models.DistortionModel, stdatamodels.jwst.datamodels.wcs_ref_models.DistortionMRSModel, stdatamodels.jwst.datamodels.drizpars.DrizParsModel, stdatamodels.jwst.datamodels.emi.EmiModel, stdatamodels.jwst.datamodels.extract1dimage.Extract1dImageModel, stdatamodels.jwst.datamodels.extract1d_spec.Extract1dIFUModel, stdatamodels.jwst.datamodels.wcs_ref_models.FilteroffsetModel, stdatamodels.jwst.datamodels.flat.FlatModel, stdatamodels.jwst.datamodels.nirspec_flat.NirspecFlatModel, stdatamodels.jwst.datamodels.nirspec_flat.NirspecQuadFlatModel, stdatamodels.jwst.datamodels.wcs_ref_models.FOREModel, stdatamodels.jwst.datamodels.wcs_ref_models.FPAModel, stdatamodels.jwst.datamodels.fringe.FringeModel, stdatamodels.jwst.datamodels.fringefreq.FringeFreqModel, stdatamodels.jwst.datamodels.gain.GainModel, stdatamodels.jwst.datamodels.gls_rampfit.GLS_RampFitModel, stdatamodels.jwst.datamodels.guider.GuiderRawModel, stdatamodels.jwst.datamodels.guider.GuiderCalModel, stdatamodels.jwst.datamodels.ifucube.IFUCubeModel, stdatamodels.jwst.datamodels.ifucubepars.NirspecIFUCubeParsModel, stdatamodels.jwst.datamodels.ifucubepars.MiriIFUCubeParsModel, stdatamodels.jwst.datamodels.mrsptcorr.MirMrsPtCorrModel, stdatamodels.jwst.datamodels.mrsxartcorr.MirMrsXArtCorrModel, stdatamodels.jwst.datamodels.wcs_ref_models.IFUFOREModel, stdatamodels.jwst.datamodels.ifuimage.IFUImageModel, stdatamodels.jwst.datamodels.wcs_ref_models.IFUPostModel, stdatamodels.jwst.datamodels.wcs_ref_models.IFUSlicerModel, stdatamodels.jwst.datamodels.image.ImageModel, stdatamodels.jwst.datamodels.ipc.IPCModel, stdatamodels.jwst.datamodels.irs2.IRS2Model, stdatamodels.jwst.datamodels.lastframe.LastFrameModel, stdatamodels.jwst.datamodels.level1b.Level1bModel, stdatamodels.jwst.datamodels.linearity.LinearityModel, stdatamodels.jwst.datamodels.mask.MaskModel, stdatamodels.jwst.datamodels.wcs_ref_models.MSAModel, stdatamodels.jwst.datamodels.multicombinedspec.MultiCombinedSpecModel, stdatamodels.jwst.datamodels.multiexposure.MultiExposureModel, stdatamodels.jwst.datamodels.multiextract1d.MultiExtract1dImageModel, stdatamodels.jwst.datamodels.multislit.MultiSlitModel, stdatamodels.jwst.datamodels.multispec.MultiSpecModel, stdatamodels.jwst.datamodels.wcs_ref_models.NIRCAMGrismModel, stdatamodels.jwst.datamodels.wcs_ref_models.NIRISSGrismModel, stdatamodels.jwst.datamodels.wcs_ref_models.OTEModel, stdatamodels.jwst.datamodels.outlierpars.OutlierParsModel, stdatamodels.jwst.datamodels.outlierifuoutput.OutlierIFUOutputModel, stdatamodels.jwst.datamodels.pathloss.PathlossModel, stdatamodels.jwst.datamodels.pathloss.MirLrsPathlossModel, stdatamodels.jwst.datamodels.persat.PersistenceSatModel, stdatamodels.jwst.datamodels.pixelarea.PixelAreaModel, stdatamodels.jwst.datamodels.pixelarea.NirspecSlitAreaModel, stdatamodels.jwst.datamodels.pixelarea.NirspecMosAreaModel, stdatamodels.jwst.datamodels.pixelarea.NirspecIfuAreaModel, stdatamodels.jwst.datamodels.photom.FgsImgPhotomModel, stdatamodels.jwst.datamodels.photom.MirImgPhotomModel, stdatamodels.jwst.datamodels.photom.MirLrsPhotomModel, stdatamodels.jwst.datamodels.photom.MirMrsPhotomModel, stdatamodels.jwst.datamodels.photom.NrcImgPhotomModel, stdatamodels.jwst.datamodels.photom.NrcWfssPhotomModel, stdatamodels.jwst.datamodels.photom.NisImgPhotomModel, stdatamodels.jwst.datamodels.photom.NisSossPhotomModel, stdatamodels.jwst.datamodels.photom.NisWfssPhotomModel, stdatamodels.jwst.datamodels.photom.NrsFsPhotomModel, stdatamodels.jwst.datamodels.photom.NrsMosPhotomModel, stdatamodels.jwst.datamodels.psfmask.PsfMaskModel, stdatamodels.jwst.datamodels.quad.QuadModel, stdatamodels.jwst.datamodels.ramp.RampModel, stdatamodels.jwst.datamodels.rampfitoutput.RampFitOutputModel, stdatamodels.jwst.datamodels.readnoise.ReadnoiseModel, stdatamodels.jwst.datamodels.reference.ReferenceFileModel, stdatamodels.jwst.datamodels.reference.ReferenceCubeModel, stdatamodels.jwst.datamodels.reference.ReferenceImageModel, stdatamodels.jwst.datamodels.reference.ReferenceQuadModel, stdatamodels.jwst.datamodels.wcs_ref_models.RegionsModel, stdatamodels.jwst.datamodels.reset.ResetModel, stdatamodels.jwst.datamodels.resolution.ResolutionModel, stdatamodels.jwst.datamodels.resolution.MiriResolutionModel, stdatamodels.jwst.datamodels.rscd.RSCDModel, stdatamodels.jwst.datamodels.saturation.SaturationModel, stdatamodels.jwst.datamodels.slit.SlitDataModel, stdatamodels.jwst.datamodels.slit.SlitModel, stdatamodels.jwst.datamodels.spec.SpecModel, stdatamodels.jwst.datamodels.segmap.SegmentationMapModel, stdatamodels.jwst.datamodels.sossextractmodel.SossExtractModel, stdatamodels.jwst.datamodels.sosswavegrid.SossWaveGridModel, stdatamodels.jwst.datamodels.speckernel.SpecKernelModel, stdatamodels.jwst.datamodels.specprofile.SpecProfileModel, stdatamodels.jwst.datamodels.specprofile.SpecProfileSingleModel, stdatamodels.jwst.datamodels.spectrace.SpecTraceModel, stdatamodels.jwst.datamodels.spectrace.SpecTraceSingleModel, stdatamodels.jwst.datamodels.wcs_ref_models.SpecwcsModel, stdatamodels.jwst.datamodels.straylight.StrayLightModel, stdatamodels.jwst.datamodels.superbias.SuperBiasModel, stdatamodels.jwst.datamodels.throughput.ThroughputModel, stdatamodels.jwst.datamodels.trapdensity.TrapDensityModel, stdatamodels.jwst.datamodels.trappars.TrapParsModel, stdatamodels.jwst.datamodels.trapsfilled.TrapsFilledModel, stdatamodels.jwst.datamodels.tsophot.TsoPhotModel, stdatamodels.jwst.datamodels.wcs_ref_models.WavelengthrangeModel, stdatamodels.jwst.datamodels.wcs_ref_models.WaveCorrModel, stdatamodels.jwst.datamodels.wavemap.WaveMapModel, stdatamodels.jwst.datamodels.wavemap.WaveMapSingleModel, stdatamodels.jwst.datamodels.wfssbkg.WfssBkgModel

stdatamodels.jwst.transforms Package