morphfits.products ================== .. py:module:: morphfits.products .. autoapi-nested-parse:: Create J-HIVE MorphFITS GalWrap products for GALFIT usage. Attributes ---------- .. autoapisummary:: morphfits.products.logger morphfits.products.KRON_FACTOR morphfits.products.MINIMUM_IMAGE_SIZE morphfits.products.BUNIT morphfits.products.AB_ZEROPOINT Functions --------- .. autoapisummary:: morphfits.products.generate_stamps morphfits.products.generate_sigmas morphfits.products.generate_psfs morphfits.products.generate_masks morphfits.products.generate_products Module Contents --------------- .. py:data:: logger Logger object for this module. .. py:data:: KRON_FACTOR :value: 3 Factor by which to multiply Kron radius to determine image size for each object. .. py:data:: MINIMUM_IMAGE_SIZE :value: 32 Minimum square stamp pixel dimensions. .. py:data:: BUNIT :value: 1e-08 Numerical value of flux unit per pixel, 10nJy. .. py:data:: AB_ZEROPOINT :value: 3631 Monochromatic AB magnitude zeropoint, in Jy. .. py:function:: generate_stamps(input_root: pathlib.Path, product_root: pathlib.Path, field: str, image_version: str, catalog_version: str, filter: str, objects: list[str], pixscale: tuple[float, float], regenerate: bool = False, display_progress: bool = False) -> tuple[list[int], list[astropy.coordinates.SkyCoord], list[int]] Generate stamps (science frame cutouts) for all objects in a FICL. :param input_root: Path to root GalWrap input directory. :type input_root: Path :param product_root: Path to root GalWrap products directory. :type product_root: Path :param field: Field of observation. :type field: str :param image_version: Version of image processing used on observation. :type image_version: str :param catalog_version: Version of cataloguing used for field. :type catalog_version: str :param filter: Filter used for observation. :type filter: str :param objects: List of object IDs in catalog to stamp from observation. :type objects: list[str] :param pixscale: Pixel scale along x and y axes, in arcseconds per pixel. :type pixscale: tuple[float, float] :param regenerate: Regenerate existing stamps, by default False. :type regenerate: bool, optional :param display_progress: Display progress on terminal screen via tqdm, by default False. :type display_progress: bool, optional :returns: List of object IDs, positions, and image sizes for successful stamps. :rtype: tuple[list[int], list[SkyCoord], list[int]] .. py:function:: generate_sigmas(input_root: pathlib.Path, product_root: pathlib.Path, field: str, image_version: str, catalog_version: str, filter: str, objects: list[int], positions: list[astropy.coordinates.SkyCoord], image_sizes: list[int], regenerate: bool = False, display_progress: bool = False) Generate sigma maps for all objects in a FICL. :param input_root: Path to root GalWrap input directory. :type input_root: Path :param product_root: Path to root GalWrap products directory. :type product_root: Path :param field: Field of observation. :type field: str :param image_version: Version of image processing used on observation. :type image_version: str :param catalog_version: Version of cataloguing used for field. :type catalog_version: str :param filter: Filter used for observation. :type filter: str :param objects: List of object IDs in catalog for which to generate sigma maps. :type objects: list[str] :param positions: List of positions of objects in the sky, from catalog. :type positions: list[SkyCoord] :param image_sizes: List of image sizes corresponding to each object's stamp. :type image_sizes: list[int] :param regenerate: Regenerate existing sigma maps, by default False. :type regenerate: bool, optional :param display_progress: Display progress on terminal screen via tqdm, by default False. :type display_progress: bool, optional .. seealso:: :obj:`This` .. py:function:: generate_psfs(input_root: pathlib.Path, product_root: pathlib.Path, field: str, image_version: str, catalog_version: str, filter: str, objects: list[int], image_sizes: list[int], pixscale: tuple[float, float], regenerate: bool = False, display_progress: bool = False) Generate PSF crops for all frames in a filter. :param input_root: Path to root GalWrap input directory. :type input_root: Path :param product_root: Path to root GalWrap products directory. :type product_root: Path :param field: Field of observation. :type field: str :param image_version: Version of image processing used on observation. :type image_version: str :param catalog_version: Version of cataloguing used for field. :type catalog_version: str :param filter: Filter used for observation. :type filter: str :param objects: List of object IDs in catalog for which to generate masks. :type objects: list[str] :param image_sizes: List of image sizes corresponding to each object's stamp. :type image_sizes: list[int] :param pixscale: Pixel scale along x and y axes, in arcseconds per pixel. :type pixscale: tuple[float, float] :param regenerate: Regenerate existing crops, by default False. :type regenerate: bool, optional :param display_progress: Display progress on terminal screen via tqdm, by default False. :type display_progress: bool, optional .. py:function:: generate_masks(input_root: pathlib.Path, product_root: pathlib.Path, field: str, image_version: str, catalog_version: str, filter: str, objects: list[int], positions: list[astropy.coordinates.SkyCoord], image_sizes: list[int], regenerate: bool = False, display_progress: bool = False) Generate masks for all objects in a FICL. :param input_root: Path to root GalWrap input directory. :type input_root: Path :param product_root: Path to root GalWrap products directory. :type product_root: Path :param field: Field of observation. :type field: str :param image_version: Version of image processing used on observation. :type image_version: str :param catalog_version: Version of cataloguing used for field. :type catalog_version: str :param filter: Filter used for observation. :type filter: str :param objects: List of object IDs in catalog for which to generate masks. :type objects: list[str] :param positions: List of positions of objects in the sky, from catalog. :type positions: list[SkyCoord] :param image_sizes: List of image sizes corresponding to each object's stamp. :type image_sizes: list[int] :param regenerate: Regenerate existing masks, by default False. :type regenerate: bool, optional :param display_progress: Display progress on terminal screen via tqdm, by default False. :type display_progress: bool, optional .. py:function:: generate_products(morphfits_config: morphfits.config.MorphFITSConfig, regenerate_products: bool = False, regenerate_stamps: bool = False, regenerate_sigmas: bool = False, regenerate_psfs: bool = False, regenerate_masks: bool = False, keep_feedfiles: bool = False, display_progress: bool = False) Generate all products for a given configuration. :param morphfits_config: Configuration object for this MorphFITS run. :type morphfits_config: MorphFITSConfig :param regenerate_products: Regenerate all products, by default False. :type regenerate_products: bool, optional :param regenerate_stamps: Regenerate stamps, by default False. :type regenerate_stamps: bool, optional :param regenerate_sigmas: Regenerate sigma maps, by default False. :type regenerate_sigmas: bool, optional :param regenerate_psfs: Regenerate PSF crops, by default False. :type regenerate_psfs: bool, optional :param regenerate_masks: Regenerate masks, by default False. :type regenerate_masks: bool, optional :param keep_feedfiles: Reuse existing feedfiles, by default False. :type keep_feedfiles: bool, optional :param display_progress: Display progress on terminal screen via tqdm, by default False. :type display_progress: bool, optional