CubeMosaic¶

class mpdaf.obj.CubeMosaic(files, output_wcs)[source]¶

Bases: mpdaf.obj.CubeList

Manages a list of cubes and handles the combination to make a mosaic.

To run the combination, all the cubes must be on the same WCS grid. The values from the CRPIX keywords will be used as offsets to put each cube inside the combined cube. The shape and WCS grid of the output cube is determined using from a FITS file specified with the output_wcs argument (same principle as the MUSE pipeline).

This class inherits from mpdaf.obj.CubeList, but not all the combination commands are available: currently only CubeMosaic.pycombine is implemented.

Parameters:

files : list of str

List of cubes FITS filenames.

output_wcs : str

Path to a cube FITS file, this cube is used to define the output cube: shape, WCS and unit are needed, it must have the same WCS grid as the input cubes.

Attributes

files	(list of str) List of cubes FITS filenames.
nfiles	(int) Number of files.
shape	(array of 3 integers) Lengths of data in Z and Y and X (python notation (nz,ny,nx)).
wcs	(`mpdaf.obj.WCS`) World coordinates.
wave	(`mpdaf.obj.WaveCoord`) Wavelength coordinates
unit	(str) Possible data unit type. None by default.

Attributes Summary

checkers

Methods Summary

`check_compatibility`()	Checks if all cubes are compatible.
`check_dim`()	Checks if all cubes have same dimensions.
`check_wcs`()	Checks if all cubes use the same projection.
`combine`()	This method is not implemented for CubeMosaic.
`info`([verbose])
`median`()	This method is not implemented for CubeMosaic.
`pycombine`([nmax, nclip, var, nstop, nl, header])
`pymedian`()	This method is not implemented for CubeMosaic.
`save_combined_cube`(data[, var, method, ...])

Attributes Documentation

checkers = ('check_dim', 'check_wcs')¶

Methods Documentation

check_compatibility()¶: Checks if all cubes are compatible.

check_dim()[source]¶: Checks if all cubes have same dimensions.

check_wcs()[source]¶: Checks if all cubes use the same projection.

combine()[source]¶: This method is not implemented for CubeMosaic.

info(verbose=False)[source]¶

median()[source]¶: This method is not implemented for CubeMosaic.

pycombine(nmax=2, nclip=5.0, var='propagate', nstop=2, nl=None, header=None)[source]¶

pymedian()[source]¶: This method is not implemented for CubeMosaic.

save_combined_cube(data, var=None, method='', keywords=None, expnb=None, unit=None, header=None)¶