FitsTiler

class toasty.fits_tiler.FitsTiler(coll, out_dir=None, tiling_method=TilingMethod.AUTO_DETECT, add_place_for_toast=True)[source]

Bases: object

A class to manage the tiling of a FITS file collection.

Parameters:
collImageCollection

A collection of one or more input FITS files

out_diroptional str, default None

The output directory for the tiled FITS data. If None, a sensible default next to the first input file will be chosen.

tiling_methodoptional TilingMethod

Whether the tiling process will be auto-detected or manually chosen. Defaults to auto detection based on the angular size of the imageset.

Attributes Summary

builder

A Builder describing the output dataset.

coll

The input ImageCollection.

tiling_method

Whether the tiling process will be auto-detected or manually chosen.

out_dir

The output directory.

Methods Summary

tile([cli_progress, parallel, override])

Process the collection into a tile pyramid, using either a common tangential projection, TOAST, or HiPS.

Attributes Documentation

builder = None

A Builder describing the output dataset.

This attribute is None upon creation of a class instance. It will be filled in after a successful invocation of the tile() method.

coll = None

The input ImageCollection.

tiling_method = 5

Whether the tiling process will be auto-detected or manually chosen.

out_dir = None

The output directory.

This can be set upon creation or left as None. If the latter, this attribute will be filled in after a successful invocation of the tile() method.

Methods Documentation

tile(cli_progress=False, parallel=None, override=False, **kwargs)[source]

Process the collection into a tile pyramid, using either a common tangential projection, TOAST, or HiPS.

Parameters:
cli_progressoptional boolean, defaults to False

If true, progress messages will be printed as the FITS files are being processed.

parallelinteger or None (the default)

The level of parallelization to use. If unspecified, defaults to using all CPUs. If the OS does not support fork-based multiprocessing, parallel processing is not possible and serial processing will be forced. Pass 1 to force serial processing.

overrideoptional boolean, defaults to False

By default, if the output directory already exists, the tiling process is skipped. If this argument is true, an existing output directory will be deleted if it exists.

kwargs

Settings for the tiling process. For example, blankval.

Returns:
Self.

Notes

After this function returns, the attributes out_dir and builder of self will be fully initialized.