smpy.mapping_methods.base.MassMapper

class smpy.mapping_methods.base.MassMapper(config)

Abstract base class for mass mapping methods.

This class defines the interface that all mass mapping implementations must follow. Subclasses must implement the abstract methods to provide specific mass mapping algorithms.

Parameters:

config (dict) – Configuration dictionary with nested structure containing general settings, method-specific parameters, and plotting options.

__init__(config)

Initialize mass mapper with configuration.

Parameters:

config (dict) – Configuration dictionary with nested structure containing ‘general’, ‘methods’, and ‘plotting’ sections.

Methods

__init__(config)	Initialize mass mapper with configuration.
create_maps(g1_grid, g2_grid)	Create mass maps from shear grids.
run(g1_grid, g2_grid, scaled_boundaries, ...)	Run complete mass mapping pipeline.

Attributes

name	Name of the mapping method.

__init__(config)

Initialize mass mapper with configuration.

Parameters:

config (dict) – Configuration dictionary with nested structure containing ‘general’, ‘methods’, and ‘plotting’ sections.

abstract create_maps(g1_grid, g2_grid)

Create mass maps from shear grids.

This method must be implemented by subclasses to perform the actual mass mapping computation from input shear grids.

Parameters:

• g1_grid (numpy.ndarray) – First shear component grid.

• g2_grid (numpy.ndarray) – Second shear component grid.

Returns:

• map_e (numpy.ndarray) – E-mode mass map.

• map_b (numpy.ndarray) – B-mode mass map.

run(g1_grid, g2_grid, scaled_boundaries, true_boundaries, counts_overlay=None)

Run complete mass mapping pipeline.

Execute the mass mapping algorithm and handle output generation including plotting and file saving based on configuration.

Parameters:

• g1_grid (numpy.ndarray) – First shear component grid.

• g2_grid (numpy.ndarray) – Second shear component grid.

• scaled_boundaries (dict) – Scaled coordinate boundaries for plotting.

• true_boundaries (dict) – True coordinate boundaries for WCS information.

Returns:

maps – Dictionary containing ‘E’ and ‘B’ mode mass maps.

Return type:

dict

abstract property name

Name of the mapping method.

Returns:

method_name – String identifier for the mass mapping method.

Return type:

str