Inheritance diagram for lsst.meas.base.tests.TransformTestCase:
Public Member Functions | |
| setUp (self) | |
| tearDown (self) | |
| testTransform (self, baseNames=None) | |
| testRegistration (self) | |
Public Attributes | |
| calexp | |
| inputCat | |
| outputCat | |
Static Public Attributes | |
| str | name = "MeasurementTransformTest" |
| controlClass = None | |
| algorithmClass = None | |
| transformClass = None | |
| tuple | flagNames = ("flag",) |
| tuple | singleFramePlugins = () |
| tuple | forcedPlugins = () |
Protected Member Functions | |
| _populateCatalog (self, baseNames) | |
| _checkOutput (self, baseNames) | |
| _runTransform (self, doExtend=True) | |
| _checkRegisteredTransform (self, registry, name) | |
Protected Attributes | |
| _runTransform | |
Detailed Description
Base class for testing measurement transformations. Notes ----- We test both that the transform itself operates successfully (fluxes are converted to magnitudes, flags are propagated properly) and that the transform is registered as the default for the appropriate measurement algorithms. In the simple case of one-measurement-per-transformation, the developer need not directly write any tests themselves: simply customizing the class variables is all that is required. More complex measurements (e.g. multiple aperture fluxes) require extra effort.
Member Function Documentation
◆ _checkOutput()
|
protected |
Definition at line 833 of file tests.py.
833 def _checkOutput(self, baseNames):
834 for inSrc, outSrc in zip(self.inputCat, self.outputCat):
835 for baseName in baseNames:
836 self._compareFieldsInRecords(inSrc, outSrc, baseName)
837 for flagName in self.flagNames:
838 keyName = outSrc.schema.join(baseName, flagName)
839 if keyName in inSrc.schema:
840 self.assertEqual(outSrc.get(keyName), inSrc.get(keyName))
841 else:
842 self.assertFalse(keyName in outSrc.schema)
843
◆ _checkRegisteredTransform()
|
protected |
Definition at line 882 of file tests.py.
882 def _checkRegisteredTransform(self, registry, name):
883 # If this is a Python-based transform, we can compare directly; if
884 # it's wrapped C++, we need to compare the wrapped class.
885 self.assertEqual(registry[name].PluginClass.getTransformClass(), self.transformClass)
886
◆ _populateCatalog()
|
protected |
Definition at line 823 of file tests.py.
823 def _populateCatalog(self, baseNames):
824 records = []
825 for flagValue in (True, False):
826 records.append(self.inputCat.addNew())
827 for baseName in baseNames:
828 for flagName in self.flagNames:
829 if records[-1].schema.join(baseName, flagName) in records[-1].schema:
830 records[-1].set(records[-1].schema.join(baseName, flagName), flagValue)
831 self._setFieldsInRecords(records, baseName)
832
◆ _runTransform()
|
protected |
◆ setUp()
| lsst.meas.base.tests.TransformTestCase.setUp | ( | self | ) |
◆ tearDown()
| lsst.meas.base.tests.TransformTestCase.tearDown | ( | self | ) |
◆ testRegistration()
| lsst.meas.base.tests.TransformTestCase.testRegistration | ( | self | ) |
Test that the transformation is appropriately registered.
Definition at line 887 of file tests.py.
887 def testRegistration(self):
888 """Test that the transformation is appropriately registered.
889 """
890 for pluginName in self.singleFramePlugins:
891 self._checkRegisteredTransform(lsst.meas.base.SingleFramePlugin.registry, pluginName)
892 for pluginName in self.forcedPlugins:
893 self._checkRegisteredTransform(lsst.meas.base.ForcedPlugin.registry, pluginName)
894
895
◆ testTransform()
| lsst.meas.base.tests.TransformTestCase.testTransform | ( | self, | |
| baseNames = None ) |
Test the transformation on a catalog containing random data.
Parameters
----------
baseNames : iterable of `str`
Iterable of the initial parts of measurement field names.
Notes
-----
We check that:
- An appropriate exception is raised on an attempt to transform
between catalogs with different numbers of rows;
- Otherwise, all appropriate conversions are properly appled and that
flags have been propagated.
The ``baseNames`` argument requires some explanation. This should be
an iterable of the leading parts of the field names for each
measurement; that is, everything that appears before ``_instFlux``,
``_flag``, etc. In the simple case of a single measurement per plugin,
this is simply equal to ``self.name`` (thus measurements are stored as
``self.name + "_instFlux"``, etc). More generally, the developer may
specify whatever iterable they require. For example, to handle
multiple apertures, we could have ``(self.name + "_0", self.name +
"_1", ...)``.
Definition at line 849 of file tests.py.
849 def testTransform(self, baseNames=None):
850 """Test the transformation on a catalog containing random data.
851
852 Parameters
853 ----------
854 baseNames : iterable of `str`
855 Iterable of the initial parts of measurement field names.
856
857 Notes
858 -----
859 We check that:
860
861 - An appropriate exception is raised on an attempt to transform
862 between catalogs with different numbers of rows;
863 - Otherwise, all appropriate conversions are properly appled and that
864 flags have been propagated.
865
866 The ``baseNames`` argument requires some explanation. This should be
867 an iterable of the leading parts of the field names for each
868 measurement; that is, everything that appears before ``_instFlux``,
869 ``_flag``, etc. In the simple case of a single measurement per plugin,
870 this is simply equal to ``self.name`` (thus measurements are stored as
871 ``self.name + "_instFlux"``, etc). More generally, the developer may
872 specify whatever iterable they require. For example, to handle
873 multiple apertures, we could have ``(self.name + "_0", self.name +
874 "_1", ...)``.
875 """
876 baseNames = baseNames or [self.name]
877 self._populateCatalog(baseNames)
879 self._runTransform()
880 self._checkOutput(baseNames)
881
Reports attempts to exceed implementation-defined length limits for some classes.
Definition Runtime.h:76
Member Data Documentation
◆ _runTransform
|
protected |
◆ algorithmClass
|
static |
◆ calexp
◆ controlClass
|
static |
◆ flagNames
|
static |
◆ forcedPlugins
|
static |
◆ inputCat
◆ name
|
static |
◆ outputCat
◆ singleFramePlugins
|
static |
◆ transformClass
|
static |
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g212a7c68fe+4b38ad7149/python/lsst/meas/base/tests.py
