feather_simple_cube

uvcombine.feather_simple_cube(cube_hi, cube_lo, allow_spectral_resample=True, allow_huge_operations=False, use_memmap=True, use_dask=False, use_save_to_tmp_dir=False, force_spatial_rechunk=True, channels_per_chunk='auto', allow_lo_reproj=True, **kwargs)

Parameters:

cube_hi‘~spectral_cube.SpectralCube’ or str

The high-resolution spectral-cube or name of FITS file.

cube_lo‘~spectral_cube.SpectralCube’ or str

The low-resolution spectral-cube or name of FITS file.

allow_spectral_resamplebool

If True, will run spectral_interpolate to match the spectral axes of the data. Note that spectral smoothing may need to be first applied when downsampling along the spectral axis; this should be applied to the input data prior to feathering. If False, a ValueError is raised when the spectral axes of the cubes differ.

allow_huge_operationsbool

Sets allow_huge_operations. If True, no memory related errors will be raise prior to computing. If False, an error will be raise if the cube size is too large (currently set to ~1 GB in spectral-cube).

use_memmapbool

Enable saving the feathered cube to a memory-mapped array to avoid having the whole output cube in memory.

use_daskbool

Enable feathering using dask operations. See the spectral-cube documentation for more information on using dask with spectral-cube.

use_save_to_tmp_dirbool

With use_dask enabled, when True will save intermediate operations to a temporary zarr file. This forces dask to perform each computation and can be useful for operations that are optimized with different rechunking schemes.

force_spatial_rechunkbool

With use_dask enabled, True forces rechunking both cubes to ensure the chunk sizes match and have contiguous spatial chunks (i.e., chunk only along the spectral axis).

channels_per_chunkstr or int

With use_dask enabled, allows setting the number of channels in each chunk. The default is ‘auto’, allowing dask to choose the optimal chunk size. -1 will force the entire cube into a single chunk and may cause memory issues.

allow_lo_reprojbool

With use_dask enabled, cube_lo will be reprojected to match cube_hi. This step can otherwise be performed prior to feathering but is needed to force alignment of the chunks in both cubes.

kwargsPassed to feather_simple.

Returns:

feathcube‘~spectral_cube.SpectralCube’

The combined feathered spectral cube.