Developer API

roman_datamodels.datamodels Package

Functions

open(init[, memmap])

Datamodel open/create function.

Classes

AssociationsModel([init])

Handle the case where one passes in an already instantiated version of the model.

DarkRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

DataModel([init])

Base class for all top level datamodels

DistortionRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

FlatRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

FpsModel([init])

Handle the case where one passes in an already instantiated version of the model.

GainRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

GuidewindowModel([init])

Handle the case where one passes in an already instantiated version of the model.

ImageModel([init])

Handle the case where one passes in an already instantiated version of the model.

InverselinearityRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

IpcRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

LinearityRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

MaskRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

MosaicModel([init])

Handle the case where one passes in an already instantiated version of the model.

MosaicSegmentationMapModel([init])

Handle the case where one passes in an already instantiated version of the model.

MosaicSourceCatalogModel([init])

Handle the case where one passes in an already instantiated version of the model.

MsosStackModel([init])

Handle the case where one passes in an already instantiated version of the model.

PixelareaRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

RampFitOutputModel([init])

Handle the case where one passes in an already instantiated version of the model.

RampModel([init])

Handle the case where one passes in an already instantiated version of the model.

ReadnoiseRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

RefpixRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

SaturationRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

ScienceRawModel([init])

Handle the case where one passes in an already instantiated version of the model.

SegmentationMapModel([init])

Handle the case where one passes in an already instantiated version of the model.

SourceCatalogModel([init])

Handle the case where one passes in an already instantiated version of the model.

SuperbiasRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

TvacModel([init])

Handle the case where one passes in an already instantiated version of the model.

WfiImgPhotomRefModel([init])

Handle the case where one passes in an already instantiated version of the model.

Class Inheritance Diagram

Inheritance diagram of roman_datamodels.datamodels._datamodels.AssociationsModel, roman_datamodels.datamodels._datamodels.DarkRefModel, roman_datamodels.datamodels._core.DataModel, roman_datamodels.datamodels._datamodels.DistortionRefModel, roman_datamodels.datamodels._datamodels.FlatRefModel, roman_datamodels.datamodels._datamodels.FpsModel, roman_datamodels.datamodels._datamodels.GainRefModel, roman_datamodels.datamodels._datamodels.GuidewindowModel, roman_datamodels.datamodels._datamodels.ImageModel, roman_datamodels.datamodels._datamodels.InverselinearityRefModel, roman_datamodels.datamodels._datamodels.IpcRefModel, roman_datamodels.datamodels._datamodels.LinearityRefModel, roman_datamodels.datamodels._datamodels.MaskRefModel, roman_datamodels.datamodels._datamodels.MosaicModel, roman_datamodels.datamodels._datamodels.MosaicSegmentationMapModel, roman_datamodels.datamodels._datamodels.MosaicSourceCatalogModel, roman_datamodels.datamodels._datamodels.MsosStackModel, roman_datamodels.datamodels._datamodels.PixelareaRefModel, roman_datamodels.datamodels._datamodels.RampFitOutputModel, roman_datamodels.datamodels._datamodels.RampModel, roman_datamodels.datamodels._datamodels.ReadnoiseRefModel, roman_datamodels.datamodels._datamodels.RefpixRefModel, roman_datamodels.datamodels._datamodels.SaturationRefModel, roman_datamodels.datamodels._datamodels.ScienceRawModel, roman_datamodels.datamodels._datamodels.SegmentationMapModel, roman_datamodels.datamodels._datamodels.SourceCatalogModel, roman_datamodels.datamodels._datamodels.SuperbiasRefModel, roman_datamodels.datamodels._datamodels.TvacModel, roman_datamodels.datamodels._datamodels.WfiImgPhotomRefModel

roman_datamodels.stnode Package

The STNode classes and supporting objects generated dynamically at import time

from RAD’s manifest.

Classes

Aperture([node, parent, name])

Aperture information

Associations([node, parent, name])

Association table

CalLogs([node])

Calibration log message

CalibrationSoftwareVersion

Calibration software version number

Coordinates([node, parent, name])

Coordinate frame information

DNode([node, parent, name])

Base class describing all "object" (dict-like) data nodes for STNode classes.

DarkRef([node, parent, name])

Dark reference schema

DistortionRef([node, parent, name])

Distortion reference schema

Ephemeris([node, parent, name])

Ephemeris information

Exposure([node, parent, name])

Exposure information

FileDate(val[, val2, format, scale, ...])

Date this file was created (UTC)

Filename

Name of the file

FlatRef([node, parent, name])

Flat field information

Fps([node, parent, name])

FPS test data

FpsCalStep([node, parent, name])

FPS Level 2 Calibration Step status information

FpsCalibrationSoftwareVersion

FPS Calibration software version number

FpsExposure([node, parent, name])

FPS Exposure information

FpsFileDate(val[, val2, format, scale, ...])

FPS Date this file was created (UTC)

FpsFilename

FPS Name of the file

FpsGroundtest([node, parent, name])

FPS Ground test description.

FpsGuidestar([node, parent, name])

FPS Guidestar information

FpsModelType

FPS Type of data model

FpsOrigin

FPS Organization responsible for creating file

FpsPrdSoftwareVersion

FPS S&OC PRD version number used in data processing

FpsRefFile([node, parent, name])

FPS Calibration reference file names.

FpsSdfSoftwareVersion

FPS SDF software version number

FpsStatistics([node, parent, name])

FPS Summary Statistics

FpsTelescope

FPS Telescope used to acquire the data

FpsWfiMode([node, parent, name])

FPS Roman WFI Instrument

GainRef([node, parent, name])

Gain reference schema

Guidestar([node, parent, name])

Guidestar information

Guidewindow([node, parent, name])

Guide window schema

IndividualImageMeta([node, parent, name])

Combined level 2 metadata

InverselinearityRef([node, parent, name])

Inverse linearity correction reference schema

IpcRef([node, parent, name])

IPC kernel reference schema

L2CalStep([node, parent, name])

Level 2 Calibration Step status information

L3CalStep([node, parent, name])

Level 3 Calibration Step status information

LNode([node])

Base class describing all "array" (list-like) data nodes for STNode classes.

LinearityRef([node, parent, name])

Linearity correction reference schema

MaskRef([node, parent, name])

DQ Mask reference schema

ModelType

Type of data model

MosaicAssociations([node, parent, name])

Mosaic associations metadata keywords

MosaicBasic([node, parent, name])

Basic mosaic metadata keywords

MosaicSegmentationMap([node, parent, name])

Segmentation map computed by the Source Catalog Step

MosaicSourceCatalog([node, parent, name])

Photometry and astrometry computed by the Source Catalog Step

MosaicWcsinfo([node, parent, name])

Mosaic WCS parameters

MsosStack([node, parent, name])

Level 3 schema for SSC's MSOS stack products

Observation([node, parent, name])

Observation information

Origin

Organization responsible for creating file

OutlierDetection([node, parent, name])

Outlier Detection information

Photometry([node, parent, name])

Photometry information

PixelareaRef([node, parent, name])

Pixel area reference schema

Pointing([node, parent, name])

Spacecraft Pointing information

PrdSoftwareVersion

S&OC PRD version number used in data processing

Program([node, parent, name])

Program information

Ramp([node, parent, name])

Ramp schema

RampFitOutput([node, parent, name])

Ramp fit output schema

ReadnoiseRef([node, parent, name])

Read noise reference schema

RefFile([node, parent, name])

Calibration reference file names.

RefpixRef([node, parent, name])

Reference pixel correction reference schema

Resample([node, parent, name])

Resample information

SaturationRef([node, parent, name])

Saturation reference schema

SdfSoftwareVersion

SDF software version number

SegmentationMap([node, parent, name])

Segmentation map computed by the Source Catalog Step

SourceCatalog([node, parent, name])

Photometry and astrometry computed by the Source Catalog Step

SourceDetection([node, parent, name])

Source catalog for TweakReg

SuperbiasRef([node, parent, name])

Super-bias reference schema

TaggedListNode([node])

Base class for all tagged list defined by RAD

TaggedListNodeConverter()

Converter for all subclasses of TaggedListNode.

TaggedObjectNode([node, parent, name])

Base class for all tagged objects defined by RAD

TaggedObjectNodeConverter()

Converter for all subclasses of TaggedObjectNode.

TaggedScalarNode()

Base class for all tagged scalars defined by RAD

TaggedScalarNodeConverter()

Converter for all subclasses of TaggedScalarNode.

Target([node, parent, name])

Target information

Telescope

Telescope used to acquire the data

Tvac([node, parent, name])

TVAC test data

TvacCalStep([node, parent, name])

TVAC Level 2 Calibration Step status information

TvacCalibrationSoftwareVersion

TVAC Calibration software version number

TvacExposure([node, parent, name])

TVAC Exposure information

TvacFileDate(val[, val2, format, scale, ...])

TVAC Date this file was created (UTC)

TvacFilename

TVAC Name of the file

TvacGroundtest([node, parent, name])

TVAC Ground test description.

TvacGuidestar([node, parent, name])

TVAC Guidestar information

TvacModelType

TVAC Type of data model

TvacOrigin

TVAC Organization responsible for creating file

TvacPrdSoftwareVersion

TVAC S&OC PRD version number used in data processing

TvacRefFile([node, parent, name])

TVAC Calibration reference file names.

TvacSdfSoftwareVersion

TVAC SDF software version number

TvacStatistics([node, parent, name])

TVAC Summary Statistics

TvacTelescope

TVAC Telescope used to acquire the data

TvacWfiMode([node, parent, name])

TVAC Roman WFI Instrument

VelocityAberration([node, parent, name])

Velocity aberration information

Visit([node, parent, name])

Visit information

Wcsinfo([node, parent, name])

Wcsinfo information

WfiImage([node, parent, name])

Wfi level 2 image information

WfiImgPhotomRef([node, parent, name])

WFI imaging photometric flux conversion data model

WfiMode([node, parent, name])

Roman WFI Instrument

WfiModeMixin()

Extensions to the WfiMode class.

WfiMosaic([node, parent, name])

Wfi level 3 mosaic information

WfiScienceRaw([node, parent, name])

Basic Roman Raw Science

Class Inheritance Diagram

Inheritance diagram of roman_datamodels.stnode.Aperture, roman_datamodels.stnode.Associations, roman_datamodels.stnode.CalLogs, roman_datamodels.stnode.CalibrationSoftwareVersion, roman_datamodels.stnode.Coordinates, roman_datamodels.stnode._node.DNode, roman_datamodels.stnode.DarkRef, roman_datamodels.stnode.DistortionRef, roman_datamodels.stnode.Ephemeris, roman_datamodels.stnode.Exposure, roman_datamodels.stnode.FileDate, roman_datamodels.stnode.Filename, roman_datamodels.stnode.FlatRef, roman_datamodels.stnode.Fps, roman_datamodels.stnode.FpsCalStep, roman_datamodels.stnode.FpsCalibrationSoftwareVersion, roman_datamodels.stnode.FpsExposure, roman_datamodels.stnode.FpsFileDate, roman_datamodels.stnode.FpsFilename, roman_datamodels.stnode.FpsGroundtest, roman_datamodels.stnode.FpsGuidestar, roman_datamodels.stnode.FpsModelType, roman_datamodels.stnode.FpsOrigin, roman_datamodels.stnode.FpsPrdSoftwareVersion, roman_datamodels.stnode.FpsRefFile, roman_datamodels.stnode.FpsSdfSoftwareVersion, roman_datamodels.stnode.FpsStatistics, roman_datamodels.stnode.FpsTelescope, roman_datamodels.stnode.FpsWfiMode, roman_datamodels.stnode.GainRef, roman_datamodels.stnode.Guidestar, roman_datamodels.stnode.Guidewindow, roman_datamodels.stnode.IndividualImageMeta, roman_datamodels.stnode.InverselinearityRef, roman_datamodels.stnode.IpcRef, roman_datamodels.stnode.L2CalStep, roman_datamodels.stnode.L3CalStep, roman_datamodels.stnode._node.LNode, roman_datamodels.stnode.LinearityRef, roman_datamodels.stnode.MaskRef, roman_datamodels.stnode.ModelType, roman_datamodels.stnode.MosaicAssociations, roman_datamodels.stnode.MosaicBasic, roman_datamodels.stnode.MosaicSegmentationMap, roman_datamodels.stnode.MosaicSourceCatalog, roman_datamodels.stnode.MosaicWcsinfo, roman_datamodels.stnode.MsosStack, roman_datamodels.stnode.Observation, roman_datamodels.stnode.Origin, roman_datamodels.stnode.OutlierDetection, roman_datamodels.stnode.Photometry, roman_datamodels.stnode.PixelareaRef, roman_datamodels.stnode.Pointing, roman_datamodels.stnode.PrdSoftwareVersion, roman_datamodels.stnode.Program, roman_datamodels.stnode.Ramp, roman_datamodels.stnode.RampFitOutput, roman_datamodels.stnode.ReadnoiseRef, roman_datamodels.stnode.RefFile, roman_datamodels.stnode.RefpixRef, roman_datamodels.stnode.Resample, roman_datamodels.stnode.SaturationRef, roman_datamodels.stnode.SdfSoftwareVersion, roman_datamodels.stnode.SegmentationMap, roman_datamodels.stnode.SourceCatalog, roman_datamodels.stnode.SourceDetection, roman_datamodels.stnode.SuperbiasRef, roman_datamodels.stnode._tagged.TaggedListNode, roman_datamodels.stnode._converters.TaggedListNodeConverter, roman_datamodels.stnode._tagged.TaggedObjectNode, roman_datamodels.stnode._converters.TaggedObjectNodeConverter, roman_datamodels.stnode._tagged.TaggedScalarNode, roman_datamodels.stnode._converters.TaggedScalarNodeConverter, roman_datamodels.stnode.Target, roman_datamodels.stnode.Telescope, roman_datamodels.stnode.Tvac, roman_datamodels.stnode.TvacCalStep, roman_datamodels.stnode.TvacCalibrationSoftwareVersion, roman_datamodels.stnode.TvacExposure, roman_datamodels.stnode.TvacFileDate, roman_datamodels.stnode.TvacFilename, roman_datamodels.stnode.TvacGroundtest, roman_datamodels.stnode.TvacGuidestar, roman_datamodels.stnode.TvacModelType, roman_datamodels.stnode.TvacOrigin, roman_datamodels.stnode.TvacPrdSoftwareVersion, roman_datamodels.stnode.TvacRefFile, roman_datamodels.stnode.TvacSdfSoftwareVersion, roman_datamodels.stnode.TvacStatistics, roman_datamodels.stnode.TvacTelescope, roman_datamodels.stnode.TvacWfiMode, roman_datamodels.stnode.VelocityAberration, roman_datamodels.stnode.Visit, roman_datamodels.stnode.Wcsinfo, roman_datamodels.stnode.WfiImage, roman_datamodels.stnode.WfiImgPhotomRef, roman_datamodels.stnode.WfiMode, roman_datamodels.stnode._mixins.WfiModeMixin, roman_datamodels.stnode.WfiMosaic, roman_datamodels.stnode.WfiScienceRaw

roman_datamodels.table_definitions Module

roman_datamodels.validate Module

Functions that support validation of model changes

Functions

value_change(value, pass_invalid_values, ...)

Validate a change in value against a schema.

Classes

ValidationWarning

Class Inheritance Diagram

Inheritance diagram of roman_datamodels.validate.ValidationWarning