pint.models.glitch.Glitch

class pint.models.glitch.Glitch[source]

Bases: PhaseComponent

Pulsar spin-down glitches.

Parameters supported:

Name / Aliases	Description	Kind
GLPH_{number}	Phase change for glitch 1	number
GLEP_{number}	Epoch of glitch 1	d
GLF0_{number}	(‘Permanent frequency change for glitch 1’,)	Hz
GLF1_{number}	(‘Permanent frequency-derivative change for glitch 1’,)	Hz / s
GLF2_{number}	(‘Permanent second frequency-derivative change for glitch 1’,)	Hz / s2
GLF0D_{number}	Decaying frequency change for glitch 1	Hz
GLTD_{number}	Decay time constant for glitch 1	d

Methods

`add_param`(param[, deriv_func, setup])	Add a parameter to the Component.
`d_phase_d_GLEP`(toas, param, delay)	Calculate the derivative wrt GLEP
`d_phase_d_GLF0`(toas, param, delay)	Calculate the derivative wrt GLF0
`d_phase_d_GLF0D`(toas, param, delay)	Calculate the derivative wrt GLF0D
`d_phase_d_GLF1`(toas, param, delay)	Calculate the derivative wrt GLF1
`d_phase_d_GLF2`(toas, param, delay)	Calculate the derivative wrt GLF1
`d_phase_d_GLPH`(toas, param, delay)	Calculate the derivative wrt GLPH
`d_phase_d_GLTD`(toas, param, delay)	Calculate the derivative wrt GLTD
`deriv_prep`(toas, param, delay)	Get the things we need for any of the derivative calcs
`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.
`glitch_phase`(toas, delay)	Glitch phase function.
`is_in_parfile`(para_dict)	Check if this subclass included in parfile.
`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.
`remove_param`(param)	Remove a parameter from the Component.
`set_special_params`(spcl_params)
`setup`()	Finalize construction loaded values.
`validate`()	Validate parameters input.
`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 parameters input.

print_par(format='pint')[source]

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

glitch_phase(toas, delay)[source]: Glitch phase function. delay is the time delay from the TOA to time of pulse emission at the pulsar, in seconds. returns an array of phases in long double

deriv_prep(toas, param, delay)[source]: Get the things we need for any of the derivative calcs

d_phase_d_GLPH(toas, param, delay)[source]: Calculate the derivative wrt GLPH

d_phase_d_GLF0(toas, param, delay)[source]: Calculate the derivative wrt GLF0

d_phase_d_GLF1(toas, param, delay)[source]: Calculate the derivative wrt GLF1

d_phase_d_GLF2(toas, param, delay)[source]: Calculate the derivative wrt GLF1

d_phase_d_GLF0D(toas, param, delay)[source]: Calculate the derivative wrt GLF0D

d_phase_d_GLTD(toas, param, delay)[source]: Calculate the derivative wrt GLTD

d_phase_d_GLEP(toas, param, delay)[source]: Calculate the derivative wrt GLEP

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.

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.

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

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.