COLines

class pysm3.COLines(nside, has_polarization=True, lines=['10', '21', '32'], include_high_galactic_latitude_clouds=False, polarization_fraction=0.001, theta_high_galactic_latitude_deg=20.0, random_seed=1234567, verbose=False, run_mcmole3d=False, map_dist=None)[source] [edit on github]

Bases: Model

Class defining attributes for CO line emission. CO templates are extracted from Type 1 CO Planck maps. See further details in: https://www.aanda.org/articles/aa/abs/2014/11/aa21553-13/aa21553-13.html

Parameters:
nsideint

HEALPix NSIDE of the output maps

has_polarizationbool

whether or not to simulate also polarization maps

lineslist of strings

CO rotational transitions to consider. Accepted values : 10, 21, 32

polarization_fraction: float

polarisation fraction for polarised CO emission.

include_high_galactic_latitude_clouds: bool

If True it includes a simulation from MCMole3D to include high Galactic Latitude clouds. (See more details at http://giuspugl.github.io/mcmole/index.html)

run_mcmole3d: bool

If True it simulates HGL cluds by running MCMole3D, otherwise it coadds a map of HGL emission.

random_seed: int

set random seed for mcmole3d simulations.

theta_high_galactic_latitude_degfloat

Angle in degree to identify High Galactic Latitude clouds (i.e. clouds whose latitude b is |b|> theta_high_galactic_latitude_deg).

map_distmpi4py communicator

Read inputs across a MPI communicator, see pysm.read_map

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.

simulate_high_galactic_latitude_CO(line)

Coadd High Galactic Latitude CO emission, simulated with MCMole3D.

simulate_polarized_emission(I_map)

Add polarized emission by means of: * an overall constant polarization fraction, * a depolarization map to mimick the line of sight depolarization effect at low Galactic latitudes * a polarization angle map coming from a dust template (we exploit the observed correlation between polarized dust and molecular emission in star forming regions).

Methods Documentation

get_emission(freqs: Unit('GHz'), weights=None)[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.

simulate_high_galactic_latitude_CO(line)[source] [edit on github]

Coadd High Galactic Latitude CO emission, simulated with MCMole3D.

simulate_polarized_emission(I_map)[source] [edit on github]

Add polarized emission by means of: * an overall constant polarization fraction, * a depolarization map to mimick the line of sight depolarization effect at low Galactic latitudes * a polarization angle map coming from a dust template (we exploit the observed correlation between polarized dust and molecular emission in star forming regions).