RegionsModel

class jwst.datamodels.RegionsModel(init=None, regions=None, **kwargs)[source]

Bases: jwst.datamodels.ReferenceFileModel

A model for a reference file of type “regions”.

Parameters
  • 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 given HDUList.

    • 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. If False, they will be set to None. If None, value will be taken from the environmental PASS_INVALID_VALUES. Otherwise the default value is False.

  • strict_validation (bool or None) – If True, schema validation errors will generate an exception. If False, they will generate a warning. If None, value will be taken from the environmental STRICT_VALIDATION. Otherwise, the default value is False.

  • ignore_missing_extensions (bool) – When False, raise warnings when a file is read that contains metadata about extensions that are not available. Defaults to True.

  • kwargs (dict) – Additional arguments passed to lower level functions.

  • available built-in formats are (The) –

  • ==== ===== ============= (=========) – Format Read Write Auto-identify

  • ==== ===== =============

  • Yes Yes Yes (datamodel) –

  • ==== ===== =============

Attributes Summary

reftype

schema_url

Methods Summary

on_save([path])

This is a hook that is called just before saving the file.

populate_meta()

to_fits()

Write a data model to a FITS file.

validate()

Convenience function to be run when files are created.

Attributes Documentation

reftype = 'regions'
schema_url = 'http://stsci.edu/schemas/jwst_datamodel/regions.schema'

Methods Documentation

on_save(path=None)[source]

This is a hook that is called just before saving the file. It can be used, for example, to update values in the metadata that are based on the content of the data.

Override it in the subclass to make it do something, but don’t forget to “chain up” to the base class, since it does things there, too.

Parameters

path (str) – The path to the file that we’re about to save to.

populate_meta()[source]
to_fits()[source]

Write a data model to a FITS file.

Parameters
  • init (file path or file object) –

  • kwargs (args,) – Any additional arguments are passed along to astropy.io.fits.writeto.

validate()[source]

Convenience function to be run when files are created. Checks that required reference file keywords are set.