Simulated CMB Dipole Timestreams#

class toast.ops.SimDipole(*, API=0, boresight='boresight_radec', cmb=<Quantity 2.72548 K>, coord='E', det_data='signal', det_data_units=Unit("K"), enabled=True, freq=<Quantity 0. Hz>, kernel_implementation=ImplementationType.DEFAULT, mode='total', name=None, solar_gal_lat=<Quantity 48.26 deg>, solar_gal_lon=<Quantity 263.99 deg>, solar_speed=<Quantity 369. km / s>, subtract=False, velocity='velocity', view=None, **kwargs)[source]#

Operator which generates dipole signal for detectors.

This uses the detector pointing, the telescope velocity vectors, and the solar system motion with respect to the CMB rest frame to compute the observed CMB dipole signal. The dipole timestream is either added (default) or subtracted from the specified detector data.

The telescope velocity and detector quaternions are assumed to be in the same coordinate system.

The “mode” trait determines what components of the telescope motion are included in the observed dipole. Valid options are ‘solar’ for just the solar system motion, ‘orbital’ for just the motion of the telescope with respect to the solarsystem barycenter, and ‘total’ which is the sum of both (and the default).

Note

The following traits can be set at construction or afterwards

Variables

  • API (int) – Internal interface version for this operator (default = 0)

  • boresight (str) – Observation shared key for boresight (default = boresight_radec)

  • cmb (Quantity) – CMB monopole value (default = 2.72548000000000e+00)

  • coord (str) – Valid options are ‘C’ (Equatorial), ‘E’ (Ecliptic), and ‘G’ (Galactic) (default = E)

  • det_data (str) – Observation detdata key for accumulating dipole timestreams (default = signal)

  • det_data_units (Unit) – Output units if creating detector data (default = K)

  • enabled (bool) – If True, this class instance is marked as enabled (default = True)

  • freq (Quantity) – Optional observing frequency (default = 0.00000000000000e+00)

  • kernel_implementation (enum) – Which kernel implementation to use (DEFAULT, COMPILED, NUMPY, JAX). (default = 0)

  • mode (str) – Valid options are solar, orbital, and total (default = total)

  • name (str) – The ‘name’ of this class instance (default = None)

  • solar_gal_lat (Quantity) – Galactic latitude of direction of solarsystem motion (default = 4.82600000000000e+01)

  • solar_gal_lon (Quantity) – Galactic longitude of direction of solarsystem motion (default = 2.63990000000000e+02)

  • solar_speed (Quantity) – Amplitude of the solarsystem barycenter velocity with respect to the CMB (default = 3.69000000000000e+02)

  • subtract (bool) – If True, subtract the dipole timestream instead of accumulating (default = False)

  • velocity (str) – Observation shared key for velocity (default = velocity)

  • view (str) – Use this view of the data in all observations (default = None)

API#

Internal interface version for this operator

det_data#

Observation detdata key for accumulating dipole timestreams

det_data_units#

Output units if creating detector data

view#

Use this view of the data in all observations

boresight#

Observation shared key for boresight

velocity#

Observation shared key for velocity

subtract#

If True, subtract the dipole timestream instead of accumulating

mode#

Valid options are solar, orbital, and total

coord#

Valid options are ‘C’ (Equatorial), ‘E’ (Ecliptic), and ‘G’ (Galactic)

solar_speed#

Amplitude of the solarsystem barycenter velocity with respect to the CMB

solar_gal_lat#

Galactic latitude of direction of solarsystem motion

solar_gal_lon#

Galactic longitude of direction of solarsystem motion

cmb#

CMB monopole value

freq#

Optional observing frequency

Simulated Atmosphere Timestreams#

class toast.ops.SimAtmosphere(*, API=0, add_loading=True, cache_dir=None, cache_only=False, component=123456, debug_plots=False, debug_snapshots=False, debug_spectrum=False, debug_tod=False, det_data='signal', det_data_units=Unit("K"), det_flag_mask=1, det_flags='flags', detector_pointing, detector_weights, enabled=True, fade_time=<Quantity 60. s>, field_of_view=None, gain=1e-05, kernel_implementation=ImplementationType.DEFAULT, lmax_center=<Quantity 10. m>, lmax_sigma=<Quantity 10. m>, lmin_center=<Quantity 0.01 m>, lmin_sigma=<Quantity 0.001 m>, n_bandpass_freqs=100, name=None, nelem_sim_max=10000, overwrite_cache=False, polarization_fraction=0, realization=0, sample_rate=None, shared_flag_mask=1, shared_flags='flags', times='times', turnaround_interval='turnaround', view=None, wind_dist=<Quantity 3000. m>, xstep=<Quantity 100. m>, ystep=<Quantity 100. m>, z0_center=<Quantity 2000. m>, z0_sigma=<Quantity 0. m>, zatm=<Quantity 40000. m>, zmax=<Quantity 2000. m>, zstep=<Quantity 100. m>, **kwargs)[source]#

Operator which generates atmosphere timestreams for detectors.

All processes collectively generate the atmospheric realization. Then each process passes through its local data and observes the atmosphere.

Note

The following traits can be set at construction or afterwards

Variables

  • API (int) – Internal interface version for this operator (default = 0)

  • add_loading (bool) – Add elevation-dependent loading. (default = True)

  • cache_dir (str) – Directory to use for loading / saving atmosphere realizations (default = None)

  • cache_only (bool) – If True, only cache the atmosphere, do not observe it. (default = False)

  • component (int) – The component index to use for this atmosphere simulation (default = 123456)

  • debug_plots (bool) – If True, make plots of the debug snapshots (default = False)

  • debug_snapshots (bool) – If True, dump snapshots of the atmosphere slabs to pickle files (default = False)

  • debug_spectrum (bool) – If True, dump out Kolmogorov debug files (default = False)

  • debug_tod (bool) – If True, dump TOD to pickle files (default = False)

  • det_data (str) – Observation detdata key for accumulating atmosphere timestreams (default = signal)

  • det_data_units (Unit) – Output units if creating detector data (default = K)

  • det_flag_mask (int) – Bit mask value for optional detector flagging (default = 1)

  • det_flags (str) – Observation detdata key for flags to use (default = flags)

  • detector_pointing (toast.ops.operator.Operator) – Operator that translates boresight Az/El pointing into detector frame (default = traitlets.Undefined)

  • detector_weights (toast.ops.operator.Operator) – Operator that translates boresight Az/El pointing into detector weights (default = traitlets.Undefined)

  • enabled (bool) – If True, this class instance is marked as enabled (default = True)

  • fade_time (Quantity) – Fade in/out time to avoid a step at wind break. (default = 6.00000000000000e+01)

  • field_of_view (Quantity) – Override the focalplane field of view (default = None)

  • gain (float) – Scaling applied to the simulated TOD (default = 1.00000000000000e-05)

  • kernel_implementation (enum) – Which kernel implementation to use (DEFAULT, COMPILED, NUMPY, JAX). (default = 0)

  • lmax_center (Quantity) – Kolmogorov turbulence injection scale center (default = 1.00000000000000e+01)

  • lmax_sigma (Quantity) – Kolmogorov turbulence injection scale sigma (default = 1.00000000000000e+01)

  • lmin_center (Quantity) – Kolmogorov turbulence dissipation scale center (default = 1.00000000000000e-02)

  • lmin_sigma (Quantity) – Kolmogorov turbulence dissipation scale sigma (default = 1.00000000000000e-03)

  • n_bandpass_freqs (int) – The number of sampling frequencies used when convolving the bandpass with atmosphere absorption and loading (default = 100)

  • name (str) – The ‘name’ of this class instance (default = None)

  • nelem_sim_max (int) – Controls the size of the simulation slices (default = 10000)

  • overwrite_cache (bool) – If True, redo and overwrite any cached atmospheric realizations. (default = False)

  • polarization_fraction (float) – Polarization fraction (only Q polarization). (default = 0)

  • realization (int) – If simulating multiple realizations, the realization index (default = 0)

  • sample_rate (Quantity) – Rate at which to sample atmospheric TOD before interpolation. Default is no interpolation. (default = None)

  • shared_flag_mask (int) – Bit mask value for optional flagging (default = 1)

  • shared_flags (str) – Observation shared key for telescope flags to use (default = flags)

  • times (str) – Observation shared key for timestamps (default = times)

  • turnaround_interval (str) – Interval name for turnarounds (default = turnaround)

  • view (str) – Use this view of the data in all observations (default = None)

  • wind_dist (Quantity) – Maximum wind drift before discarding the volume and creating a new one (default = 3.00000000000000e+03)

  • xstep (Quantity) – Size of volume elements in X direction (default = 1.00000000000000e+02)

  • ystep (Quantity) – Size of volume elements in Y direction (default = 1.00000000000000e+02)

  • z0_center (Quantity) – Central value of the water vapor distribution (default = 2.00000000000000e+03)

  • z0_sigma (Quantity) – Sigma of the water vapor distribution (default = 0.00000000000000e+00)

  • zatm (Quantity) – Atmosphere extent for temperature profile (default = 4.00000000000000e+04)

  • zmax (Quantity) – Atmosphere extent for water vapor integration (default = 2.00000000000000e+03)

  • zstep (Quantity) – Size of volume elements in Z direction (default = 1.00000000000000e+02)

API#

Internal interface version for this operator

times#

Observation shared key for timestamps

det_data#

Observation detdata key for accumulating atmosphere timestreams

det_data_units#

Output units if creating detector data

view#

Use this view of the data in all observations

detector_pointing#

Operator that translates boresight Az/El pointing into detector frame

detector_weights#

Operator that translates boresight Az/El pointing into detector weights

polarization_fraction#

Polarization fraction (only Q polarization).

shared_flags#

Observation shared key for telescope flags to use

shared_flag_mask#

Bit mask value for optional flagging

det_flags#

Observation detdata key for flags to use

det_flag_mask#

Bit mask value for optional detector flagging

turnaround_interval#

Interval name for turnarounds

realization#

If simulating multiple realizations, the realization index

component#

The component index to use for this atmosphere simulation

lmin_center#

Kolmogorov turbulence dissipation scale center

lmin_sigma#

Kolmogorov turbulence dissipation scale sigma

lmax_center#

Kolmogorov turbulence injection scale center

lmax_sigma#

Kolmogorov turbulence injection scale sigma

gain#

Scaling applied to the simulated TOD

zatm#

Atmosphere extent for temperature profile

zmax#

Atmosphere extent for water vapor integration

xstep#

Size of volume elements in X direction

ystep#

Size of volume elements in Y direction

zstep#

Size of volume elements in Z direction

z0_center#

Central value of the water vapor distribution

z0_sigma#

Sigma of the water vapor distribution

wind_dist#

Maximum wind drift before discarding the volume and creating a new one

fade_time#

Fade in/out time to avoid a step at wind break.

sample_rate#

Rate at which to sample atmospheric TOD before interpolation. Default is no interpolation.

nelem_sim_max#

Controls the size of the simulation slices

n_bandpass_freqs#

The number of sampling frequencies used when convolving the bandpass with atmosphere absorption and loading

cache_dir#

Directory to use for loading / saving atmosphere realizations

overwrite_cache#

If True, redo and overwrite any cached atmospheric realizations.

cache_only#

If True, only cache the atmosphere, do not observe it.

debug_spectrum#

If True, dump out Kolmogorov debug files

debug_tod#

If True, dump TOD to pickle files

debug_snapshots#

If True, dump snapshots of the atmosphere slabs to pickle files

debug_plots#

If True, make plots of the debug snapshots

add_loading#

Add elevation-dependent loading.

field_of_view#

Override the focalplane field of view