LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
Functions | |
def | getComparisonName (name1, name2) |
def | compareScalars (name, v1, v2, output, rtol=1E-8, atol=1E-8, dtype=None) |
def | compareConfigs (name, c1, c2, shortcut=True, rtol=1E-8, atol=1E-8, output=None) |
def lsst.pex.config.comparison.compareConfigs | ( | name, | |
c1, | |||
c2, | |||
shortcut = True , |
|||
rtol = 1E-8 , |
|||
atol = 1E-8 , |
|||
output = None |
|||
) |
Compare two `lsst.pex.config.Config` instances for equality. This function is a helper for `lsst.pex.config.Config.compare`. Parameters ---------- name : `str` Name to use when reporting differences, typically created by `getComparisonName`. v1 : `lsst.pex.config.Config` Left-hand side config to compare. v2 : `lsst.pex.config.Config` Right-hand side config to compare. shortcut : `bool`, optional If `True`, return as soon as an inequality is found. Default is `True`. rtol : `float`, optional Relative tolerance for floating point comparisons. atol : `float`, optional Absolute tolerance for floating point comparisons. output : callable, optional A callable that takes a string, used (possibly repeatedly) to report inequalities. For example: `print`. Returns ------- areEqual : `bool` `True` when the two `lsst.pex.config.Config` instances are equal. `False` if there is an inequality. See also -------- lsst.pex.config.compareScalars Notes ----- Floating point comparisons are performed by `numpy.allclose`. If ``c1`` or ``c2`` contain `~lsst.pex.config.RegistryField` or `~lsst.pex.config.ConfigChoiceField` instances, *unselected* `~lsst.pex.config.Config` instances will not be compared.
Definition at line 111 of file comparison.py.
def lsst.pex.config.comparison.compareScalars | ( | name, | |
v1, | |||
v2, | |||
output, | |||
rtol = 1E-8 , |
|||
atol = 1E-8 , |
|||
dtype = None |
|||
) |
Compare two scalar values for equality. This function is a helper for `lsst.pex.config.Config.compare`. Parameters ---------- name : `str` Name to use when reporting differences, typically created by `getComparisonName`. v1 : object Left-hand side value to compare. v2 : object Right-hand side value to compare. output : callable or `None` A callable that takes a string, used (possibly repeatedly) to report inequalities (for example, `print`). Set to `None` to disable output. rtol : `float`, optional Relative tolerance for floating point comparisons. atol : `float`, optional Absolute tolerance for floating point comparisons. dtype : class, optional Data type of values for comparison. May be `None` if values are not floating-point. Returns ------- areEqual : `bool` `True` if the values are equal, `False` if they are not. See also -------- lsst.pex.config.compareConfigs Notes ----- Floating point comparisons are performed by `numpy.allclose`.
Definition at line 62 of file comparison.py.
def lsst.pex.config.comparison.getComparisonName | ( | name1, | |
name2 | |||
) |
Create a comparison name that is used for printed output of comparisons. Parameters ---------- name1 : `str` Name of the first configuration. name2 : `str` Name of the second configuration. Returns ------- name : `str` When ``name1`` and ``name2`` are equal, the returned name is simply one of the names. When they are different the returned name is formatted as ``"{name1} / {name2}"``.
Definition at line 40 of file comparison.py.