pint.simulation.make_fake_toas_uniform

pint.simulation.make_fake_toas_uniform(startMJD: float | ~astropy.units.quantity.Quantity | ~astropy.time.core.Time, endMJD: float | ~astropy.units.quantity.Quantity | ~astropy.time.core.Time, ntoas: int, model: ~pint.models.timing_model.TimingModel, fuzz: ~astropy.units.quantity.Quantity = 0, freq: ~astropy.units.quantity.Quantity = <Quantity 1400. MHz>, obs: str = 'GBT', error: ~astropy.units.quantity.Quantity = <Quantity 1. us>, add_noise: bool = False, add_correlated_noise: bool = False, wideband: bool = False, wideband_dm_error: ~astropy.units.quantity.Quantity = <Quantity 0.0001 dmu>, name: str = 'fake', include_bipm: bool = False, include_gps: bool = True, multi_freqs_in_epoch: bool = False, flags: dict | None = None, subtract_mean: bool = True) → TOAs[source]

Simulate uniformly spaced TOAs.

Parameters:

  • startMJD (float or astropy.units.Quantity or astropy.time.Time) – starting MJD for fake toas

  • endMJD (float or astropy.units.Quantity or astropy.time.Time) – ending MJD for fake toas

  • ntoas (int) – number of fake toas to create between startMJD and endMJD

  • model (pint.models.timing_model.TimingModel) – current model

  • fuzz (astropy.units.Quantity, optional) – Standard deviation of ‘fuzz’ distribution to be applied to TOAs

  • freq (astropy.units.Quantity, optional) – Frequency (or array of frequencies) for the fake TOAs, default is 1400 MHz

  • obs (str, optional) – observatory for fake toas, default GBT

  • error (astropy.units.Quantity) – uncertainty to attach to each TOA

  • add_noise (bool, optional) – Add noise to the TOAs (otherwise error just populates the column)

  • add_correlated_noise (bool, optional) – Add correlated noise to the TOAs if it’s present in the timing mode.

  • wideband (bool, optional) – Whether to include wideband DM information with each TOA; default is not to include any wideband DM information. If True, the DM associated with each TOA will be computed using the model, and the -ppdm and -ppdme flags will be set.

  • dm_error (astropy.units.Quantity) – uncertainty to attach to each DM measurement

  • name (str, optional) – Name for the TOAs (goes into the flags)

  • include_bipm (bool, optional) – Whether or not to disable UTC-> TT BIPM clock correction (see pint.observatory.topo_obs.TopoObs)

  • include_gps (bool, optional) – Whether or not to disable UTC(GPS)->UTC clock correction (see pint.observatory.topo_obs.TopoObs)

  • multi_freqs_in_epoch (bool, optional) – Whether to generate multiple frequency TOAs for the same epoch.

  • flags (None or dict) – Dictionary of flags to be added to all simulated TOAs.

  • subtract_mean (bool, optional) – Controls whether mean will be subtracted from the residuals when making fake TOAs

Returns:

TOAs – object with evenly spaced toas spanning given start and end MJD with ntoas toas, with optional errors

Return type:

pint.toa.TOAs

Notes

  1. add_noise respects any EFAC or EQUAD present in the model

  2. When wideband is set, wideband DM measurement noise will be included only if add_noise is set. Otherwise, the -pp_dme flags will be set without adding the measurement noise to the simulated DM values.

  3. The simulated DM measurement noise respects DMEFAC and DMEQUAD values in the model.

  4. If multi_freqs_in_epoch is True, each epoch will contain TOAs for all frequencies given in the freq argument. Otherwise, each epoch will have only one TOA, and the frequencies are distributed amongst TOAs in an alternating manner. In either case, the total number of TOAs will be ntoas.

  5. Currently supports simulating only one observatory.

See also

make_fake_toas()