lsst.pex.config.comparison Namespace Reference

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)

Function Documentation

compareConfigs()

def lsst.pex.config.comparison.compareConfigs	(		name,
			c1,
			c2,
			shortcut = True,
			rtol = 1E-8,
			atol = 1E-8,
			output = None
	)

Helper function for Config.compare; used to compare two Configs for equality.

If the Configs contain RegistryFields or ConfigChoiceFields, unselected Configs
will not be compared.

@param[in] name       Name to use when reporting differences
@param[in] c1         LHS config to compare
@param[in] c2         RHS config to compare
@param[in] shortcut   If True, return as soon as an inequality is found.
@param[in] rtol       Relative tolerance for floating point comparisons.
@param[in] atol       Absolute tolerance for floating point comparisons.
@param[in] output     If not None, a callable that takes a string, used (possibly repeatedly)
                      to report inequalities.

Floating point comparisons are performed by numpy.allclose; refer to that for details.

Definition at line 67 of file comparison.py.

compareScalars()

def lsst.pex.config.comparison.compareScalars	(		name,
			v1,
			v2,
			output,
			rtol = 1E-8,
			atol = 1E-8,
			dtype = None
	)

Helper function for Config.compare; used to compare two scalar values for equality.

@param[in] name       Name to use when reporting differences
@param[in] dtype      Data type for comparison; may be None if it's definitely not floating-point.
@param[in] v1         LHS value to compare
@param[in] v2         RHS value to compare
@param[in] output     If not None, a callable that takes a string, used (possibly repeatedly)
                      to report inequalities.
@param[in] rtol       Relative tolerance for floating point comparisons.
@param[in] atol       Absolute tolerance for floating point comparisons.
@param[in] dtype      Data type for comparison; may be None if it's definitely not floating-point.

Floating point comparisons are performed by numpy.allclose; refer to that for details.

Definition at line 41 of file comparison.py.

getComparisonName()

def lsst.pex.config.comparison.getComparisonName	(		name1,
			name2
	)

Definition at line 35 of file comparison.py.