smpy.map_kaiser_squires

smpy.map_kaiser_squires(data, coord_system='radec', pixel_scale=None, downsample_factor=None, smoothing=2.0, **kwargs)[source]

Perform Kaiser-Squires mass mapping.

This function provides direct access to the Kaiser-Squires method with sensible defaults for quick analysis.

Parameters:

  • data (str or pathlib.Path) – Path to input FITS file containing shear catalog.

  • coord_system (str, optional) – Coordinate system of input data. Options: ‘radec’, ‘pixel’.

  • pixel_scale (float, optional) – Pixel scale in arcminutes. Required for ‘radec’ coordinate system.

  • downsample_factor (int, optional) – Downsampling factor for pixel coordinates. Required for ‘pixel’ coordinate system.

  • smoothing (float, optional) – Gaussian smoothing scale in pixels.

  • **kwargs – Additional parameters passed to map_mass().

Returns:

result – Dictionary containing the computed mass maps.

Return type:

dict

Examples

>>> result = map_kaiser_squires(
...     data='catalog.fits',
...     coord_system='radec',
...     pixel_scale=0.168
... )