Developer API

roman_datamodels.datamodels Package

Functions

open(init[, memmap])

Datamodel open/create function.

Classes

AbvegaoffsetRefModel([init])	Handle the case where one passes in an already instantiated version of the model.
ApcorrRefModel([init])	Handle the case where one passes in an already instantiated version of the model.
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.
EpsfRefModel([init])	Handle the case where one passes in an already instantiated version of the model.
FilenameMismatchWarning	Warning when the filename in the meta attribute does not match the filename of the file being opened.
FlatRefModel([init])	Handle the case where one passes in an already instantiated version of the model.
ForcedImageSourceCatalogModel([init])	Handle the case where one passes in an already instantiated version of the model.
ForcedMosaicSourceCatalogModel([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.
ImageSourceCatalogModel([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.
L1DetectorGuidewindowModel([init])	Handle the case where one passes in an already instantiated version of the model.
L1FaceGuidewindowModel([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.
MATableRefModel([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.
MultibandSourceCatalogModel([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.
SkycellsRefModel([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.
WfiWcsModel([init])	Handle the case where one passes in an already instantiated version of the model.

Class Inheritance Diagram

roman_datamodels.stnode Package

The STNode classes and supporting objects generated dynamically at import time

from RAD’s manifest.

Classes

AbvegaoffsetRef([node, parent, name])	AB Vega Offset reference schema
ApcorrRef([node, parent, name])	Aperture correction reference schema
Associations([node, parent, name])	Association table
CalLogs([node])	Calibration log message
CalibrationSoftwareName	Name of the calibration software package used in processing this file.
CalibrationSoftwareNameMixin()
CalibrationSoftwareVersion	The version number of the calibration software used in processing this file.
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
EpsfRef([node, parent, name])	ePSF reference schema
Exposure([node, parent, name])	Exposure information
FileDate(val[, val2, format, scale, ...])	The date and time this file was created.
FileDateMixin()
Filename	The auto-generated name of this file.
FlatRef([node, parent, name])	Flat field information
ForcedImageSourceCatalog([node, parent, name])	Photometry and astrometry computed by the Source Catalog Step
ForcedImageSourceCatalogMixin()
ForcedMosaicSourceCatalog([node, parent, name])	Photometry and astrometry computed by the Source Catalog Step
ForcedMosaicSourceCatalogMixin()
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)
FpsFileDateMixin()
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
ImageSourceCatalog([node, parent, name])	Photometry and astrometry computed by the Source Catalog Step
ImageSourceCatalogMixin()
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
L1DetectorGuidewindow([node, parent, name])	Level 1 Detector Guide Star Window Information schema
L1FaceGuidewindow([node, parent, name])	Level 1 FACE Guide Star Window Information schema
L2CalStep([node, parent, name])	Level 2 Calibration Step status information
L2CalStepMixin()
L3CalStep([node, parent, name])	Level 3 Calibration Step status information
L3CalStepMixin()
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
MatableRef([node, parent, name])	Multiple Accumulation Table Reference File Schema
ModelType	The type of data model contained within this file.
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
MosaicSourceCatalogMixin()
MosaicWcsinfo([node, parent, name])	Mosaic WCS parameters
MsosStack([node, parent, name])	Level 3 schema for SSC's MSOS stack products
MultibandSegmentationMap([node, parent, name])	Segmentation map computed by the Multiband Catalog Step
MultibandSourceCatalog([node, parent, name])	Photometry and astrometry computed by the Multiband Catalog Step
MultibandSourceCatalogMixin()
Observation([node, parent, name])	Observation information
Origin	The name of the institution of organization responsible for creating this file.
OriginMixin()
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
PrdVersion	The version number of the Science Operations Center (SOC) Project Reference Database (PRD) used in generating this file.
PrdVersionMixin()
ProductType	A descriptor for the type of data contained within the file.
Program([node, parent, name])	Program information
Ramp([node, parent, name])	Ramp schema
RampFitOutput([node, parent, name])	Ramp fit output schema
Rcs([node, parent, name])	Relative Calibration System Information
ReadnoiseRef([node, parent, name])	Read noise reference schema
RefFile([node, parent, name])	Calibration reference file names.
RefFileMixin()
RefpixRef([node, parent, name])	Reference pixel correction reference schema
Resample([node, parent, name])	Resample information
SaturationRef([node, parent, name])	Saturation reference schema
SdfSoftwareVersion	The version number of the Science Operations Center (SOC) Science Data Formatting (SDF) software used in generating this file.
SdfSoftwareVersionMixin()
SegmentationMap([node, parent, name])	Segmentation map computed by the Source Catalog Step
SkyBackground([node, parent, name])	Sky Background Information
SkycellsRef([node, parent, name])	This file contains definitions for all the skycells that cover the entire celestial sphere
SourceCatalog([node, parent, name])	Source catalog for TweakReg
Statistics([node, parent, name])	Basic Statistical Information
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.
Telescope	The name of the telescope used to acquire the data.
TelescopeMixin()
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)
TvacFileDateMixin()
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
WfiImgPhotomRefMixin()
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
WfiWcs([node, parent, name])	Roman Wide Field Instrument (WFI) Level 2 (L2) WCS and modified WCS applicable for Science Raw (L1).

Class Inheritance Diagram

roman_datamodels.table_definitions Module

roman_datamodels.validate Module

Functions that support validation of model changes

Classes

ValidationWarning

Class Inheritance Diagram