def output_to_fits(self, file_path, overwrite=False):
"""
Write the 2D Mask to a .fits file.
Before outputting a NumPy array, the array may be flipped upside-down using np.flipud depending on the project
config files. This is for Astronomy projects so that structures appear the same orientation as `.fits` files
loaded in DS9.
Parameters
----------
file_path : str
The full path of the file that is output, including the file name and `.fits` extension.
overwrite : bool
If `True` and a file already exists with the input file_path the .fits file is overwritten. If `False`, an
error is raised.
Returns
-------
None
Examples
--------
mask = Mask2D(mask=np.full(shape=(5,5), fill_value=False))
mask.output_to_fits(file_path='/path/to/file/filename.fits', overwrite=True)
"""
array_2d_util.numpy_array_2d_to_fits(array_2d=self.astype("float"),
file_path=file_path,
overwrite=overwrite)
def output_to_fits(self, file_path, overwrite=False):
"""
Output the grid to a .fits file.
Parameters
----------
file_path : str
The path the file is output to, including the filename and the ``.fits`` extension,
e.g. '/path/to/filename.fits'
overwrite : bool
If a file already exists at the path, if overwrite=True it is overwritten else an error is raised."""
array_2d_util.numpy_array_2d_to_fits(array_2d=self.native,
file_path=file_path,
overwrite=overwrite)
def output_to_fits(self, file_path, overwrite=False):
"""
Output the visibilities to a .fits file.
The complex values are converted to a 2D NumPy float array of shape [total_visiblities, 2] before being
written to `.fits` format via the `in_array` property.
Parameters
----------
file_path : str
The path the file is output to, including the filename and the ``.fits`` extension,
e.g. '/path/to/filename.fits'
overwrite : bool
If a file already exists at the path, if overwrite=True it is overwritten else an error is raised.
"""
array_2d_util.numpy_array_2d_to_fits(array_2d=self.in_array,
file_path=file_path,
overwrite=overwrite)
def output_to_fits(
self,
visibilities_path=None,
noise_map_path=None,
uv_wavelengths_path=None,
overwrite=False,
):
if visibilities_path is not None:
self.visibilities.output_to_fits(
file_path=visibilities_path, overwrite=overwrite
)
if self.noise_map is not None and noise_map_path is not None:
self.noise_map.output_to_fits(file_path=noise_map_path, overwrite=overwrite)
if self.uv_wavelengths is not None and uv_wavelengths_path is not None:
array_2d_util.numpy_array_2d_to_fits(
array_2d=self.uv_wavelengths,
file_path=uv_wavelengths_path,
overwrite=overwrite,
)
