dq_to_boolean_mask¶

romancal.lib.psf.dq_to_boolean_mask(image_model_or_dq, ignore_flags=0, flag_map_name='ROMAN_DQ')[source]¶

Convert a DQ bitmask to a boolean mask. Useful for photutils methods.

Parameters:

image_model_or_dq (roman_datamodels.datamodels.ImageModel or numpy.ndarray) – ImageModel containing the DQ bitmask to convert to a boolean mask, or the DQ bitmask itself.
ignore_flags (int, str, list, None (default = 0)) – See docs for astropy.nddata.bitmask.extend_bit_flag_map
flag_map_name (str) – Name for the bitmask flag map in the astropy bitmask registry

Returns:

mask – Boolean mask

Return type:

numpy.ndarray