pint.models.parameter.strParameter

class pint.models.parameter.strParameter(name=None, value=None, description=None, aliases=None, **kwargs)

Bases: Parameter

String-valued parameter.

strParameter is not fittable.

Parameters:

• name (str) – The name of the parameter.

• value (str) – The input parameter string value.

• description (str, optional) – A short description of what this parameter means.

• aliases (list, optional) – An optional list of strings specifying alternate names that can also be accepted for this parameter.

Example

>>> from parameter import strParameter
>>> test = strParameter(name='test1', value='This is a test',)
>>> print(test)
test1 This is a test

Methods

add_alias(alias)	Add a name to the list of aliases for this parameter.
as_latex()
as_parfile_line([format])	Return a parfile line giving the current state of the parameter.
from_parfile_line(line)	Parse a parfile line into the current state of the parameter.
help_line()	Return a help line containing parameter name, description and units.
name_matches(name)	Whether or not the parameter name matches the provided name
prior_pdf([value, logpdf])	Return the prior probability density.
set(value)	Deprecated - just assign to .value.
str_quantity(quan)	Format the argument in an appropriate way as a string.
value_as_latex()

Attributes

prior	prior distribution for this parameter.
quantity	Value including units (if appropriate).
repeatable
uncertainty	Parameter uncertainty value with units.
uncertainty_value	Return a pure value from .uncertainty.
units	Units associated with this parameter.
value	Return the value (without units) of a parameter.

add_alias(alias)

Add a name to the list of aliases for this parameter.

as_parfile_line(format='pint')

Return a parfile line giving the current state of the parameter.

Parameters:

format (str, optional) – Parfile output format. PINT outputs in ‘tempo’, ‘tempo2’ and ‘pint’ formats. The default format is pint.

Return type:

str

Notes

Format differences between tempo, tempo2, and pint at [1]

[1]

https://github.com/nanograv/PINT/wiki/PINT-vs.-TEMPO%282%29-par-file-changes

from_parfile_line(line)

Parse a parfile line into the current state of the parameter.

Returns True if line was successfully parsed, False otherwise.

Note

The accepted formats:

• NAME value

• NAME value fit_flag

• NAME value fit_flag uncertainty

• NAME value uncertainty

help_line()

Return a help line containing parameter name, description and units.

name_matches(name)

Whether or not the parameter name matches the provided name

property prior

prior distribution for this parameter.

This should be a Prior object describing the prior distribution of the quantity, for use in Bayesian fitting.

prior_pdf(value=None, logpdf=False)

Return the prior probability density.

Evaluated at the current value of the parameter, or at a proposed value.

Parameters:

• value (array-like or float, optional) – Where to evaluate the priors; should be a unitless number. If not provided the prior is evaluated at self.value.

• logpdf (bool) – If True, return the logarithm of the PDF instead of the PDF; this can help with densities too small to represent in floating-point.

property quantity

Value including units (if appropriate).

set(value)

Deprecated - just assign to .value.

str_quantity(quan)

Format the argument in an appropriate way as a string.

property uncertainty

Parameter uncertainty value with units.

property uncertainty_value

Return a pure value from .uncertainty.

This will be interpreted as having units self.units.

property units

Units associated with this parameter.

Should be a astropy.units.Unit object, or None if never set.

property value

Return the value (without units) of a parameter.

This value is assumed to be in units of self.units. Upon setting, a a Quantity can be provided, which will be converted to self.units.