LSSTApplications
16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
LSSTDataManagementBasePackage
|
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 105 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 56 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 34 of file comparison.py.