pint.models.dispersion_model.DispersionJump

class pint.models.dispersion_model.DispersionJump[source]

Bases: Dispersion

This class provides the constant offsets to the DM values.

Parameters supported:

Name / Aliases	Description	Kind
DMJUMP {flag} {value}	DM value offset.	pc / cm3

Notes

This DM jump is only for modeling the DM values, and will not apply to the dispersion time delay.

Methods

`add_param`(param[, deriv_func, setup])	Add a parameter to the Component.
`d_delay_d_dmjump`(toas, param_name[, acc_delay])	Derivative of the delay w.r.t DM jumps.
`d_delay_d_dmparam`(toas, param_name[, acc_delay])	Derivative of delay wrt to DM parameter.
`d_dm_d_dmjump`(toas, jump_param)	Derivative of the DM values w.r.t DM jumps.
`dispersion_slope_value`(toas)
`dispersion_time_delay`(DM, freq)	Return the dispersion time delay for a set of frequency.
`dispersion_type_delay`(toas)
`dm_value`(toas)	Compute modeled DM value at given TOAs.
`get_params_of_type`(param_type)	Get all the parameters in timing model for one specific type.
`get_prefix_mapping_component`(prefix)	Get the index mapping for the prefix parameters.
`is_in_parfile`(para_dict)	Check if this subclass included in parfile.
`jump_dm`(toas)	Return the DM jump for each DM section collected by DMJUMP parameters.
`match_param_aliases`(alias)	Return the parameter corresponding to this alias.
`param_help`()	Print help lines for all available parameters in model.
`print_par`([format])	param format: Parfile output format. PINT outputs the 'tempo', 'tempo2' and 'pint'
`register_deriv_funcs`(func, param)	Register the derivative function in to the deriv_func dictionaries.
`register_dm_deriv_funcs`(func, param)	Register the derivative function in to the deriv_func dictionaries.
`remove_param`(param)	Remove a parameter from the Component.
`set_special_params`(spcl_params)
`setup`()	Finalize construction loaded values.
`validate`()	Validate loaded values.
`validate_toas`(toas)	Check that this model component has TOAs where needed.

Attributes

`aliases_map`	Return all the aliases and map to the PINT parameter name.
`category`
`component_types`
`free_params_component`	Return the free parameters in the component.
`param_prefixs`
`register`

setup()[source]: Finalize construction loaded values.

validate()[source]: Validate loaded values.

jump_dm(toas)[source]

Return the DM jump for each DM section collected by DMJUMP parameters.

The delay value is determined by DMJUMP parameter value in the unit of pc / cm ** 3.

d_dm_d_dmjump(toas, jump_param)[source]: Derivative of the DM values w.r.t DM jumps.

d_delay_d_dmjump(toas, param_name, acc_delay=None)[source]

Derivative of the delay w.r.t DM jumps.

Since DMJUMPs do not affect the delay, this should be zero.

add_param(param, deriv_func=None, setup=False)

Add a parameter to the Component.

The parameter is stored in an attribute on the Component object. Its name is also recorded in a list, self.params.

Parameters:

param (pint.models.Parameter) – The parameter to be added.
deriv_func (function) – Derivative function for parameter.

property aliases_map

Return all the aliases and map to the PINT parameter name.

This property returns a dictionary from the current in timing model parameters’ aliase to the pint defined parameter names. For the aliases of a prefixed parameter, the aliase with an existing prefix index maps to the PINT defined parameter name with the same index. Behind the scenes, the indexed parameter adds the indexed aliase to its aliase list.

d_delay_d_dmparam(toas, param_name, acc_delay=None)

Derivative of delay wrt to DM parameter.

Parameters:

toas (pint.TOAs object.) – Input toas.
param_name (str) – Derivative parameter name
acc_delay (astropy.quantity or numpy.ndarray) – Accumulated delay values. This parameter is to keep the unified API, but not used in this function.

dispersion_time_delay(DM, freq)

Return the dispersion time delay for a set of frequency.

This equation if cited from Duncan Lorimer, Michael Kramer, Handbook of Pulsar Astronomy, Second edition, Page 86, Equation [4.7] Here we assume the reference frequency is at infinity and the EM wave frequency is much larger than plasma frequency.

dm_value(toas)

Compute modeled DM value at given TOAs.

Parameters:

toas (TOAs object or TOA table(TOAs.table)) –

If given a TOAs object, it will use the whole TOA table in the: TOAs object.

Return type:

DM values at given TOAs in the unit of DM.

property free_params_component

Return the free parameters in the component.

This function collects the non-frozen parameters.

Return type:: A list of free parameters.

get_params_of_type(param_type): Get all the parameters in timing model for one specific type.

get_prefix_mapping_component(prefix)

Get the index mapping for the prefix parameters.

Parameters:: prefix (str) – Name of prefix.
Returns:: A dictionary with prefix parameter real index as key and parameter name as value.
Return type:: dict

is_in_parfile(para_dict)

Check if this subclass included in parfile.

Parameters:: para_dict (dictionary) – A dictionary contain all the parameters with values in string from one parfile
Returns:: Whether the subclass is included in the parfile.
Return type:: bool

match_param_aliases(alias)

Return the parameter corresponding to this alias.

Parameters:: alias (str) – Alias name.

Note

This function only searches the parameter aliases within the current component. If one wants to search the aliases in the scope of TimingModel, please use TimingModel.match_param_aliase().

param_help(): Print help lines for all available parameters in model.

print_par(format='pint')

Parameters:: format (str, optional) – Parfile output format. PINT outputs the ‘tempo’, ‘tempo2’ and ‘pint’ format. The defaul format is pint. Actual formatting done elsewhere.
Returns:: str
Return type:: formatted line for par file

register_deriv_funcs(func, param)

Register the derivative function in to the deriv_func dictionaries.

Parameters:

func (callable) – Calculates the derivative
param (str) – Name of parameter the derivative is with respect to

register_dm_deriv_funcs(func, param)

Register the derivative function in to the deriv_func dictionaries.

Parameters:

func (callable) – Calculates the derivative
param (str) – Name of parameter the derivative is with respect to

remove_param(param)

Remove a parameter from the Component.

Parameters:: param (str or pint.models.Parameter) – The parameter to remove.

validate_toas(toas): Check that this model component has TOAs where needed.