mirar.processors.astromatic.scamp package

Subpackages

mirar.processors.astromatic.scamp.configs package

Submodules

mirar.processors.astromatic.scamp.scamp module

Module to run Scamp

class mirar.processors.astromatic.scamp.scamp.Scamp(ref_catalog_generator: Callable[[Header], BaseCatalog], scamp_config_path: str, temp_output_sub_dir: str = 'scamp', cache: bool = False, copy_scamp_header_to_image: bool = False, timeout: float = 60.0, make_checkplots: bool = False)[source]

Bases: BaseImageProcessor

Class for Scamp Processor

base_key = 'scamp'

check_prerequisites()[source]

Check to see if any prerequisite processors are missing

Returns:: None

description() → str[source]

Function to get description of the processor

Returns:: description

get_scamp_output_dir() → Path[source]

Function to get scamp output directory

Returns:: output directory

mirar.processors.astromatic.scamp.scamp.run_scamp(scamp_list_path: str | Path, scamp_config_path: str | Path, ast_ref_cat_path: str | Path, output_dir: str | Path, timeout_seconds: float = 60.0, make_checkplots: bool = False, checkplot_basename: str = 'scamp_checkplot', checkplot_dev: str = None)[source]

Function to run scamp. NOTE: By default, the scamp instance here is only designed to run for astrometry. This function thus enforces SOLVE_PHOTOM = N as otherwise Scamp behaves weirdly and can output FLXSCALE != 1 in the output header. This can cause incosistencies down the line, e.g. with Swarp.

Parameters:

scamp_list_path – Path to the list of images to run scamp on
scamp_config_path – Path to the scamp config file
ast_ref_cat_path – Path to the reference catalog
output_dir – Output directory
timeout_seconds – Timeout for scamp
make_checkplots – Whether to make checkplots
checkplot_basename – Basename for checkplots
checkplot_dev – What device to make checkplots

Returns:

None

mirar.processors.astromatic.scamp.scamp.write_scamp_header_to_image(image: Image)[source]: Function to write the scamp header to the image.