SimpleSZ

class pysm3.SimpleSZ(nside, template_name, sz_type, max_nside, map_dist=None)[source] [edit on github]

Bases: Model

Simple, frequency-independent SZ model using a single template map.

This component uses a precomputed SZ template map that is independent of observing frequency. The same sky template is used at all frequencies and is retrieved via template_name.

Parameters:
nsideint

HEALPix NSIDE of the output maps.

template_namestr

Name or key identifying the SZ template map to download/load via pysm3.models.utils.RemoteData. The template is expected to be a single-frequency SZ map in units of uK_CMB.

sz_typestr

Type of SZ effect to model, either "kinetic" or "thermal".

max_nsideint

Maximum HEALPix NSIDE at which the input template map is available.

map_distobject, optional

HEALPix map distribution helper or MPI communicator-like object used by the base Model class to handle distributed maps.

Parameters:
mpi_comm: object

MPI communicator object (optional, default=None).

nside: int

Resolution parameter at which this model is to be calculated.

available_nside: list[int]

Which Nsides the template maps are available at

max_nside: int

Keeps track of the the maximum Nside this model is available at by default 512 like PySM 2 models

smoothing_lmaxint

\(\ell_{max}\) for the smoothing step, by default \(2*N_{side}\)

Methods Summary

get_emission(freqs[, weights])

This function evaluates the component model at a either a single frequency, an array of frequencies, or over a bandpass.

Methods Documentation

get_emission(freqs: Annotated[Quantity, Unit('GHz')], weights=None) Annotated[Quantity, Unit('uK_RJ')][source] [edit on github]

This function evaluates the component model at a either a single frequency, an array of frequencies, or over a bandpass.

Parameters:
freqs: scalar or array astropy.units.Quantity

Frequency at which the model should be evaluated, in a frequency which can be converted to GHz using astropy.units. If an array of frequencies is provided, integrate using trapz with a equal weighting, i.e. simulate a top-hat bandpass.

weights: np.array, optional

Array of weights describing the frequency response of the instrument, i.e. the bandpass. Weights are normalized and applied in Jy/sr.

Returns:
outputastropy.units.Quantity

Simulated map at the given frequency or integrated over the given bandpass. The shape of the output is (3,npix) for polarized components, (1,npix) for temperature-only components. Output is in uK_RJ.