pint.models.noise_model.ScaleDmError

class pint.models.noise_model.ScaleDmError[source]

Bases: WhiteNoiseComponent

Correction for estimated wideband DM measurement uncertainty.

Parameters supported:

Name / Aliases	Description	Kind
DMEFAC {flag} {value}	A multiplication factor on the measured DM uncertainties,	number
DMEQUAD {flag} {value}	An error term added in quadrature to the scaled (by EFAC) TOA uncertainty.	pc / cm3

Note

Ref: NANOGrav 12.5 yrs wideband data

Methods

`add_param`(param[, deriv_func, setup])	Add a parameter to the Component.
`dm_sigma_scaled_cov_matrix`(toas)
`get_params_of_type`(param_type)	Get all the parameters in timing model for one specific Parameter subtype.
`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.
`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.
`scale_dm_sigma`(toas)	Scale the DM uncertainty.
`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.
`introduces_correlated_errors`
`introduces_dm_errors`
`param_prefixs`
`register`

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

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

scale_dm_sigma(toas: TOAs) → Quantity[source]

Scale the DM uncertainty.

Parameters:: toas (pint.toa.TOAs object) – Input DM error object. We assume DM error is stored in the TOA objects.

add_param(param: Parameter, deriv_func: Callable | None = None, setup: bool = 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: Dict[str, str]

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: List[str]

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: str) → List[str]: Get all the parameters in timing model for one specific Parameter subtype.

get_prefix_mapping_component(prefix: str) → Dict[int, str]

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: Dict) → bool

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: str) → str

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() → str: Print help lines for all available parameters in model.

print_par(format: Literal['tempo', 'tempo2', 'pint'] = 'pint') → str

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: Callable, param: str) → None

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: str | Parameter) → None

Remove a parameter from the Component.

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

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