LSST Applications
21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
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.