ConvertCatalogCoordinatesConfig

class lsst.meas.astrom.ConvertCatalogCoordinatesConfig(*args, **kw)

Bases: Config

Configuration for the MatchProbabilistic matcher.

Attributes Summary

column_ref_coord1	The reference table column for the first spatial coordinate (usually x or ra).
column_ref_coord2	The reference table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord1.
column_target_coord1	The target table column for the first spatial coordinate (usually x or ra).Units must match column_ref_coord1.
column_target_coord2	The target table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord2.
coords_ref_factor	Multiplicative factor for reference catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_ref_coord[12].
coords_ref_to_convert	Dict mapping sky coordinate columns to be converted to pixel columns.
coords_spherical	Whether column_*_coord[12] are spherical coordinates (ra/dec) or not (pixel x/y).
coords_target_factor	Multiplicative factor for target catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_target_coord[12].
mag_zeropoint_ref	Magnitude zeropoint for reference catalog.
return_converted_coords	Whether to return converted coordinates for matching or only write them.

Methods Summary

format_catalogs(catalog_ref, catalog_target)

Format matched catalogs that may require coordinate conversions.

Attributes Documentation

column_ref_coord1

The reference table column for the first spatial coordinate (usually x or ra). (str, default 'ra')

column_ref_coord2

The reference table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord1. (str, default 'dec')

column_target_coord1

The target table column for the first spatial coordinate (usually x or ra).Units must match column_ref_coord1. (str, default 'coord_ra')

column_target_coord2

The target table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord2. (str, default 'coord_dec')

coords_ref_factor

Multiplicative factor for reference catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_ref_coord[12]. Otherwise, it must convert the coordinate to the same units as the target coordinates. (float, default 1.0)

coords_ref_to_convert

Dict mapping sky coordinate columns to be converted to pixel columns. (Dict, default None)

coords_spherical

Whether column_*_coord[12] are spherical coordinates (ra/dec) or not (pixel x/y). (bool, default True)

coords_target_factor

Multiplicative factor for target catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_target_coord[12]. Otherwise, it must convert the coordinate to the same units as the reference coordinates. (float, default 1.0)

mag_zeropoint_ref

Magnitude zeropoint for reference catalog. (float, default 31.4)

return_converted_coords

Whether to return converted coordinates for matching or only write them. (float, default True)

Methods Documentation

format_catalogs(catalog_ref: Table, catalog_target: Table, select_ref: array = None, select_target: array = None, radec_to_xy_func: Callable = None, **kwargs)

Format matched catalogs that may require coordinate conversions.

Parameters

catalog_refastropy.table.Table

A reference catalog for comparison to catalog_target.

catalog_targetastropy.table.Table

A target catalog with measurements for comparison to catalog_ref.

select_refnumpy.ndarray, (Nref,)

A boolean array of len catalog_ref, True for valid match candidates.

select_targetnumpy.ndarray, (Ntarget,)

A boolean array of len catalog_target, True for valid match candidates.

radec_to_xy_functyping.Callable

Function taking equal-length ra, dec arrays and returning an ndarray of - x: current parameter (float). - extra_args: additional arguments (dict).

kwargs

Additional keyword arguments to pass to radec_to_xy_func.

Returns

compcat_ref, compcat_targetComparableCatalog

Comparable catalogs corresponding to the input reference and target.