mirar.references package

Module for generating reference images

Subpackages

• mirar.references.wfcam package
  • Subpackages
    • mirar.references.wfcam.files package
  • Submodules
  • mirar.references.wfcam.utils module
    • combine_headers()
    • find_wfcam_surveys()
    • get_query_coordinates_from_header()
    • get_wfcam_basename()
    • get_wfcam_file_identifiers_from_url()
    • make_wfcam_image_from_hdulist()
    • open_compressed_wfcam_fits()
    • save_wfcam_as_compressed_fits()
  • mirar.references.wfcam.wfcam_query module
    • BaseWFCAMQuery
      • BaseWFCAMQuery.run_query()
    • NotinWFCAMError
    • WFAUQuery
      • WFAUQuery.get_query_class()
      • WFAUQuery.get_query_crds()
      • WFAUQuery.get_surveys_query_class()
      • WFAUQuery.run_query()
      • WFAUQuery.run_wfau_query()
    • WFAUQueryDBError
    • WFAURefError
    • WFCAMRefNotFoundError
    • check_multiframe_exists_locally()
    • check_query_exists_locally()
    • download_wfcam_archive_images()
    • get_locally_existing_overlap_images()
  • mirar.references.wfcam.wfcam_stack module
    • WFCAMStackedRef
      • WFCAMStackedRef.abbreviation
      • WFCAMStackedRef.get_component_images()
    • default_filter_wfau_images()

Submodules

mirar.references.base_reference_generator module

Module with base class for reference image generation

class mirar.references.base_reference_generator.BaseReferenceGenerator(filter_name: str, write_image: bool = True, write_image_sub_dir: str = 'references', write_to_db: bool = False, db_table: Type[BaseDB] = None, duplicate_protocol: str = 'replace', q3c_bool: bool = True)

Bases: object

Base Reference Image Generator. Subclasses should implement get_reference, which returns a reference image HDU, and a reference weight image HDU. Classes using this generator should call get_reference_image to get the reference image as an Image object. Users can optionally choose to save the reference images to a file and/or database.

property abbreviation

Abbreviation for image naming

static get_output_path(output_dir: str | Path, base_name: str) → Path

Get output path

Parameters:

• output_dir – output dir

• base_name – Name

Returns:

output path

get_reference_image(image: Image) → Image

Get reference image corresponding to an image

Parameters:

image – Image

Returns:

reference image

class mirar.references.base_reference_generator.BaseStackReferenceGenerator(filter_name: str, image_resampler_generator: Callable[[...], Swarp], write_stacked_image: bool = True, write_stack_sub_dir: str = 'references/stack', write_stack_to_db: bool = False, stacks_db_table: Type[BaseDB] = None, duplicate_protocol: str = 'replace', q3c_bool: bool = False, stack_image_annotator: Callable[[Image, Image], Image] = None, references_base_subdir_name: str = 'references', photcal_stack: bool = False, sextractor_generator: Callable[[...], Sextractor] = None, phot_calibrator_generator: Callable[[...], PhotCalibrator] = None)

Bases: BaseReferenceGenerator

Base processor where multiple images need to be stacked together

get_component_images(image: Image) → ImageBatch

Get component reference images that will be stacked together. :param image: image :return: ImageBatch of component reference images to be used for stacking

exception mirar.references.base_reference_generator.ReferenceGenerationError

Bases: ProcessorError

Error for reference generation

mirar.references.errors module

Module containing errors for reference images

exception mirar.references.errors.ReferenceImageError

Bases: ProcessorError

Error with reference image

mirar.references.local module

Module for getting reference images stored locally

class mirar.references.local.RefFromPath(path: str, filter_name: str, write_image: bool = False, write_to_db: bool = False, db_table: Type[BaseDB] = None, duplicate_protocol: str = 'replace', q3c_bool: bool = True, weight_path: str = None)

Bases: BaseReferenceGenerator

Get locally saved ref from path

abbreviation = 'local'

mirar.references.ps1 module

Module for PS1 reference image generator

class mirar.references.ps1.PS1Ref(filter_name: str, write_image: bool = True, write_image_sub_dir: str = 'references', write_to_db: bool = False, db_table: Type[BaseDB] = None, duplicate_protocol: str = 'replace', q3c_bool: bool = True)

Bases: BaseReferenceGenerator

PS1 Ref generator

abbreviation = 'ps1_ref_lookup'

getimages(ra_deg: float, dec_deg: float, filters='grizy') → Table

Query ps1filenames.py service to get a list of images

ra, dec = position in degrees size = image size in pixels (0.25 arcsec/pixel) filters = string with filters to include Returns a table with the results

geturl(ra_deg: float, dec_deg: float, size: int = 240, output_size=None, filters='grizy', file_format='fits', color=False)

Get URL for images in the table

ra, dec = position in degrees size = extracted image size in pixels (0.25 arcsec/pixel) output_size = output (display) image size in pixels (default = size).

output_size has no effect for fits format images.

filters = string with filters to include format = data format (options are “jpg”, “png” or “fits”) color = if True, creates a color image (only for jpg or png format).

Default is return a list of URLs for single-filter grayscale images.

Returns a string with the URL

mirar.references.sdss module

Module for generating reference images from SDSS

class mirar.references.sdss.SDSSRef(filter_name: str, write_image: bool = True, write_image_sub_dir: str = 'references', write_to_db: bool = False, db_table: Type[BaseDB] = None, duplicate_protocol: str = 'replace', q3c_bool: bool = True)

Bases: BaseReferenceGenerator

SDSS ref generator

abbreviation = 'sdss_ref_lookup'

mirar.references.wirc module

Module for generating reference images with WIRC data

class mirar.references.wirc.WIRCRef(filter_name: str, object_name: str, images_directory_path: str)

Bases: BaseReferenceGenerator

WIRC reference generator

abbreviation = 'wirc_file_lookup'