pint.models.parameter.pairParameter
- class pint.models.parameter.pairParameter(name=None, index=None, value=None, long_double=False, units=None, description=None, uncertainty=None, frozen=True, continuous=False, aliases=[], **kwargs)[source]
Bases:
floatParameter
Parameter type for parameters that need two input floats.
One example are WAVE parameters.
- Parameters:
name (str) – The name of the parameter.
value (astropy Time, str, float in mjd, str in mjd.) – The input parameter MJD value.
description (str, optional) – A short description of what this parameter means.
uncertainty (number) – Current uncertainty of the value.
frozen (bool, optional) – A flag specifying whether “fitters” should adjust the value of this parameter or leave it fixed.
continuous (bool, optional, default True) – A flag specifying whether phase derivatives with respect to this parameter exist.
aliases (str, optional) – List of aliases for the current parameter
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.
as_ufloat
([units])Return the parameter as a
uncertainties.ufloat
from_parfile_line
(line)Read mask parameter line (e.g.
from_ufloat
(value[, units])Set the parameter from the value of a
uncertainties.ufloat
Return a help line containing parameter name, description and units.
name_matches
(name)Whether or not the parameter name matches the provided name
new_param
(index)Create a new but same style mask parameter.
prior_pdf
([value, logpdf])Return the prior probability density.
set
(value)Deprecated - just assign to .value.
str_quantity
(quan)Return quantity as a string.
value_as_latex
()Attributes
Whether the parameter has long double precision.
prior distribution for this parameter.
Value including units (if appropriate).
repeatable
Parameter uncertainty value with units.
Return a pure value from .uncertainty.
If True, the parameter can automatically scale some values upon assignment.
Units associated with this parameter.
Return the pure value of a parameter.
- from_parfile_line(line)[source]
Read mask parameter line (e.g. JUMP).
Notes
- The accepted format:
NAME value_a value_b
- as_parfile_line(format='pint')[source]
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:
Notes
Format differences between tempo, tempo2, and pint at [1]
- property value
Return the pure value of a parameter.
This value will associate with parameter default value, which is .units attribute.
- add_alias(alias)
Add a name to the list of aliases for this parameter.
- as_ufloat(units=None)
Return the parameter as a
uncertainties.ufloat
Will cast to the specified units, or the default If the uncertainty is not set will be returned as 0
- Parameters:
units (astropy.units.core.Unit, optional) – Units to cast the value
- Return type:
uncertainties.ufloat
Notes
Currently
ufloat
does not support double precision values, so some precision may be lost.
- from_ufloat(value, units=None)
Set the parameter from the value of a
uncertainties.ufloat
Will cast to the specified units, or the default If the uncertainty is 0 it will be set to
None
- Parameters:
value (uncertainties.ufloat) –
units (astropy.units.core.Unit, optional) – Units to cast the value
- help_line()
Return a help line containing parameter name, description and units.
- property long_double
Whether the parameter has long double precision.
- 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.
- 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 unit_scale
If True, the parameter can automatically scale some values upon assignment.
- property units
Units associated with this parameter.
Should be a
astropy.units.Unit
object, or None if never set.