masking_algorithm_generalized

rubin_sim.maf.maf_contrib.masking_algorithm_generalized(my_bundles, plot_handler, data_label, nside=128, find_value='unmasked', relation='=', new_value='masked', pixel_radius=6, return_border_indices=False, print_intermediate_info=False, plot_intermediate_plots=True, print_final_info=True, plot_final_plots=True, sky_map_color_min=None, sky_map_color_max=None)

Assign new_value to all pixels in a skymap within pixel_radius of pixels with value <, >, or = find_value.

Parameters:

my_bundlesdict {rubin_sim.maf.MetricBundles}

a dictionary for metricBundles.

plot_handlerrubin_sim.maf.plots.plotHandler.PlotHandler

data_labelstr

description of the data, i.e. ‘numGal’

nsideint

HEALpix resolution parameter. Default: 128

find_valuestr

if related to mask, must be either ‘masked’ or ‘unmasked’. otherwise, must be a number. Default: ‘unmasked’

relationstr

must be ‘>’,’=’,’<’. Default: ‘=’

new_valuestr

if related to mask, must be either ‘masked’ or ‘unmasked’; otherwise, must be a number. Default: ‘masked’

pixel_radiusint

number of pixels to consider around a given pixel. Default: 6

return_border_indicesbool

set to True to return the array of indices of the pixels whose values/mask are changed. Default: False

print_intermediate_infobool

set to False if do not want to print intermediate info. Default: True

plot_intermediate_plotsbool

set to False if do not want to plot intermediate plots. Default: True

print_final_infobool

set to False if do not want to print final info, i.e. total pixels changed. Default: True

plot_final_plotsbool

set to False if do not want to plot the final plots. Default: True

sky_map_color_minfloat

color_min label value for skymap plot_dict label. Default: None

sky_map_color_maxfloat

color_max label value for skymap plot_dict label. Default: None