ReferenceFileModel

class jwst.datamodels.ReferenceFileModel(init=None, **kwargs)

Bases: JwstDataModel

A data model for reference tables.

Initialize a data model.

Parameters:
initstr, tuple, ~astropy.io.fits.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

  • ~astropy.io.fits.HDUList : Initialize from the given ~astropy.io.fits.HDUList.

  • A numpy array: Used to initialize the data array

  • dict: The object model tree for the data model

schemadict, 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.

memmapbool

Turn memmap of FITS/ASDF file on or off.

pass_invalid_valuesbool 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_validationbool 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.

validate_on_assignmentbool or None

Defaults to ‘None’. If None, value will be taken from the environmental VALIDATE_ON_ASSIGNMENT, defaulting to ‘True’ if no environment variable is set. If ‘True’, attribute assignments are validated at the time of assignment. Validation errors generate warnings and values will be set to None. If ‘False’, schema validation occurs only once at the time of write. Validation errors generate warnings.

validate_arraysbool

If True, arrays will be validated against ndim, max_ndim, and datatype validators in the schemas.

ignore_missing_extensionsbool

When False, raise warnings when a file is read that contains metadata about extensions that are not available. Defaults to True.

**kwargs

Additional keyword arguments passed to lower level functions. These arguments are generally file format-specific.

Attributes Summary

schema_url

The schema URI to validate the model against.

Methods Summary

print_err(message)

Raise error or warn, depending on strict_validation attribute.

save(path[, dir_path])

Save the model, handling 'dq' and 'dq_def' separately if they exist.

validate()

Check that required reference file keywords are set.

Attributes Documentation

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

The schema URI to validate the model against. If None, only basic validation of required metadata properties (filename, model_type) will occur.

Methods Documentation

print_err(message)

Raise error or warn, depending on strict_validation attribute.

Parameters:
messagestr

The message to print

save(path, dir_path=None, *args, **kwargs)

Save the model, handling ‘dq’ and ‘dq_def’ separately if they exist.

Parameters:
pathstr

The path to the file

dir_pathstr

The path to the directory containing the file

*args, **kwargs

Any additional arguments to pass to the save method of JwstDataModel

Returns:
output_pathstr

The path to the saved file

validate()

Check that required reference file keywords are set.