shapepipe.modules.random_cat_package.random_cat
shapepipe.modules.random_cat_package.random_cat¶
RANDOM CATALOGUE.
This module contains a class to create a random catalogue, and to compute the tile area accounting for overlapping and masked regions.
- Author
Martin Kilbinger <martin.kilbinger@cea.fr>
- class RandomCat(input_image_path, input_mask_path, output_dir, file_number_string, output_file_pattern, n_rand, density, w_log, healpix_options)[source]¶
Bases:
object
Random Catalogue.
This class creates a random catalogue given a mask FITS file.
- Parameters
input_image_path (str) – Path to input image file
input_mask_path (str) – Path to input mask file
output_dir (str) – Output directory
file_number_pattern (str) – ShapePipe image ID string
output_file_pattern (str) – Output file pattern (base name) for random catalogue
n_rand (float) – Number of random objects on output
density (bool) –
n_rand
is interpreted per square degrees ifTrue
w_log (logging.Logger) – Logging instance
healpix_options (dict) – Parameters for HEALPix output mask file
- save_as_healpix(mask, header)[source]¶
Save As Healpix.
Save mask as healpix FITS file.
- Parameters
mask (numpy.ndarray) – 2D pixel mask image
header (class Header) – Image header with WCS information