reproject_to_hips

reproject.hips.reproject_to_hips(input_data, *, coord_system_out, reproject_function, output_directory, level=None, level_depth=None, hdu_in=0, tile_size=512, tile_depth=16, progress_bar=None, threads=False, properties=None, generate_moc=True, allsky=True, **kwargs)

Reproject data from a standard projection to a set of Hierarchical Progressive Surveys (HiPS) tiles.

Parameters:

input_dataobject

The input data to reproject. This can be:

• The name of a FITS file as a str or a pathlib.Path object

• An HDUList object

• An image HDU object such as a PrimaryHDU, ImageHDU, or CompImageHDU instance

• A tuple where the first element is a ndarray and the second element is either a BaseLowLevelWCS, BaseHighLevelWCS, or a Header object

• An NDData object from which the .data and .wcs attributes will be used as the input data.

• The name of a PNG or JPEG file with AVM metadata

coord_system_out{‘equatorial’, ‘galactic’, ‘ecliptic’ }

The target coordinate system for the HEALPIX projection

reproject_functioncallable

The function to use for the reprojection.

output_directorystr

The name of the output directory - if this already exists, an error will be raised.

levelint, optional

The number of levels of tiles for celestial coordinates.

level_depthint, optional

The number of levels of tiles for the third (e.g. spectral) dimension.

hdu_inint or str, optional

If input_data is a FITS file or an HDUList instance, specifies the HDU to use.

tile_sizeint or tuple, optional

The size of each individual tile (defaults to 512) for celestial dimensions.

tile_depthint or tuple, optional

The depth of each individual tile (defaults to 16) for the third (e.g. spectral) dimension when present.

progress_barcallable, optional

If specified, use this as a progress_bar to track loop iterations over data sets.

threadsbool or int

If False, no multi-threading is used. If an integer, this number of threads will be used, and if True, the number of threads will be chosen automatically.

propertiesdict, optional

Dictionary of properties that should be output to the properties file inside the HiPS dataset. At list of properties and their meanings can be found in the HiPS 1.0 description.

generate_mocbool, optional

Whether to write a Moc.fits coverage file at the root of the HiPS dataset (a spatial MOC for 2-d data and a space-frequency MOC for 3-d data), as recommended by the HiPS standard. Defaults to True.

allskybool, optional

Whether to write Allsky preview files for the low orders (0 to 3) of a 2-d image HiPS, as described by the HiPS standard. Ignored for 3-d data. Defaults to True.

**kwargs

Keyword arguments to be passed to the reprojection function.

Returns:

None

This function does not return a value.