A data model for 2D masks.
dq (numpy uint32 array) – The mask
dq_def (numpy table) – DQ flag definitions
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
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, value will be taken from the environmental PASS_INVALID_VALUES. Otherwise the default value is
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
validate_on_assignment (bool 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.
kwargs (dict) –
Additional keyword arguments passed to lower level functions. These arguments are generally file format-specific. Arguments of note are:
available built-in formats are (The) –
==== ===== ============= (=========) – Format Read Write Auto-identify
==== ===== ============= –
Yes Yes Yes (datamodel) –
==== ===== ============= –
The schema URI to validate the model against.
Returns the name “primary” array for this model, which controls the size of other arrays that are implicitly created.
The schema URI to validate the model against. If None, only basic validation of required metadata properties (filename, model_type) will occur.
Returns the name “primary” array for this model, which controls the size of other arrays that are implicitly created. This is intended to be overridden in the subclasses if the primary array’s name is not “data”.