LSST Applications g02d81e74bb+86cf3d8bc9,g180d380827+7a4e862ed4,g2079a07aa2+86d27d4dc4,g2305ad1205+e1ca1c66fa,g29320951ab+012e1474a1,g295015adf3+341ea1ce94,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g33d1c0ed96+0e5473021a,g3a166c0a6a+0e5473021a,g3ddfee87b4+c429d67c83,g48712c4677+f88676dd22,g487adcacf7+27e1e21933,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+b41db86c35,g5a732f18d5+53520f316c,g64a986408d+86cf3d8bc9,g858d7b2824+86cf3d8bc9,g8a8a8dda67+585e252eca,g99cad8db69+84912a7fdc,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+a2b54eae19,gb0e22166c9+60f28cb32d,gba4ed39666+c2a2e4ac27,gbb8dafda3b+6681f309db,gc120e1dc64+f0fcc2f6d8,gc28159a63d+0e5473021a,gcf0d15dbbd+c429d67c83,gdaeeff99f8+f9a426f77a,ge6526c86ff+0433e6603d,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gff1a9f87cc+86cf3d8bc9,w.2024.17
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst.meas.base.tests.AlgorithmTestCase Class Reference

Public Member Functions

 makeSingleFrameMeasurementConfig (self, plugin=None, dependencies=())
 
 makeSingleFrameMeasurementTask (self, plugin=None, dependencies=(), config=None, schema=None, algMetadata=None)
 
 makeForcedMeasurementConfig (self, plugin=None, dependencies=())
 
 makeForcedMeasurementTask (self, plugin=None, dependencies=(), config=None, refSchema=None, algMetadata=None)
 

Detailed Description

Base class for tests of measurement tasks.

Definition at line 623 of file tests.py.

Member Function Documentation

◆ makeForcedMeasurementConfig()

lsst.meas.base.tests.AlgorithmTestCase.makeForcedMeasurementConfig ( self,
plugin = None,
dependencies = () ) 
Create an instance of `ForcedMeasurementTask.ConfigClass`.

In addition to the plugins specified in the plugin and dependencies
arguments, the `TransformedCentroid` and `TransformedShape` plugins
will be run and used as the centroid and shape slots; these simply
transform the reference catalog centroid and shape to the measurement
coordinate system.

Parameters
----------
plugin : `str`
    Name of measurement plugin to enable.
dependencies : iterable of `str`, optional
    Names of dependencies of the measurement plugin.

Returns
-------
config : `ForcedMeasurementTask.ConfigClass`
    The resulting task configuration.

Definition at line 699 of file tests.py.

699 def makeForcedMeasurementConfig(self, plugin=None, dependencies=()):
700 """Create an instance of `ForcedMeasurementTask.ConfigClass`.
701
702 In addition to the plugins specified in the plugin and dependencies
703 arguments, the `TransformedCentroid` and `TransformedShape` plugins
704 will be run and used as the centroid and shape slots; these simply
705 transform the reference catalog centroid and shape to the measurement
706 coordinate system.
707
708 Parameters
709 ----------
710 plugin : `str`
711 Name of measurement plugin to enable.
712 dependencies : iterable of `str`, optional
713 Names of dependencies of the measurement plugin.
714
715 Returns
716 -------
717 config : `ForcedMeasurementTask.ConfigClass`
718 The resulting task configuration.
719 """
720
721 config = ForcedMeasurementTask.ConfigClass()
722 config.slots.centroid = "base_TransformedCentroid"
723 config.slots.shape = "base_TransformedShape"
724 config.slots.modelFlux = None
725 config.slots.apFlux = None
726 config.slots.psfFlux = None
727 config.slots.gaussianFlux = None
728 config.plugins.names = (plugin,) + tuple(dependencies) + ("base_TransformedCentroid",
729 "base_TransformedShape")
730 return config
731

◆ makeForcedMeasurementTask()

lsst.meas.base.tests.AlgorithmTestCase.makeForcedMeasurementTask ( self,
plugin = None,
dependencies = (),
config = None,
refSchema = None,
algMetadata = None ) 
Create a configured instance of `ForcedMeasurementTask`.

Parameters
----------
plugin : `str`, optional
    Name of measurement plugin to enable. If `None`, a configuration
    must be supplied as the ``config`` parameter. If both are
    specified, ``config`` takes precedence.
dependencies : iterable of `str`, optional
    Names of dependencies of the specified measurement plugin.
config : `SingleFrameMeasurementTask.ConfigClass`, optional
    Configuration for the task. If `None`, a measurement plugin must
    be supplied as the ``plugin`` paramter. If both are specified,
    ``config`` takes precedence.
refSchema : `lsst.afw.table.Schema`, optional
    Reference table schema. If `None`, a default schema is
    generated.
algMetadata : `lsst.daf.base.PropertyList`, optional
    Measurement algorithm metadata. If `None`, a default container
    will be generated.

Returns
-------
task : `ForcedMeasurementTask`
    A configured instance of the measurement task.

Definition at line 732 of file tests.py.

733 algMetadata=None):
734 """Create a configured instance of `ForcedMeasurementTask`.
735
736 Parameters
737 ----------
738 plugin : `str`, optional
739 Name of measurement plugin to enable. If `None`, a configuration
740 must be supplied as the ``config`` parameter. If both are
741 specified, ``config`` takes precedence.
742 dependencies : iterable of `str`, optional
743 Names of dependencies of the specified measurement plugin.
744 config : `SingleFrameMeasurementTask.ConfigClass`, optional
745 Configuration for the task. If `None`, a measurement plugin must
746 be supplied as the ``plugin`` paramter. If both are specified,
747 ``config`` takes precedence.
748 refSchema : `lsst.afw.table.Schema`, optional
749 Reference table schema. If `None`, a default schema is
750 generated.
751 algMetadata : `lsst.daf.base.PropertyList`, optional
752 Measurement algorithm metadata. If `None`, a default container
753 will be generated.
754
755 Returns
756 -------
757 task : `ForcedMeasurementTask`
758 A configured instance of the measurement task.
759 """
760 if config is None:
761 if plugin is None:
762 raise ValueError("Either plugin or config argument must not be None")
763 config = self.makeForcedMeasurementConfig(plugin=plugin, dependencies=dependencies)
764 if refSchema is None:
765 refSchema = TestDataset.makeMinimalSchema()
766 if algMetadata is None:
767 algMetadata = lsst.daf.base.PropertyList()
768 return ForcedMeasurementTask(refSchema=refSchema, algMetadata=algMetadata, config=config)
769
770
lsst::daf::base::PropertyList
Class for storing ordered metadata with comments.
Definition PropertyList.h:68

◆ makeSingleFrameMeasurementConfig()

lsst.meas.base.tests.AlgorithmTestCase.makeSingleFrameMeasurementConfig ( self,
plugin = None,
dependencies = () ) 
Create an instance of `SingleFrameMeasurementTask.ConfigClass`.

Only the specified plugin and its dependencies will be run; the
Centroid, Shape, and ModelFlux slots will be set to the truth fields
generated by the `TestDataset` class.

Parameters
----------
plugin : `str`
    Name of measurement plugin to enable.
dependencies : iterable of `str`, optional
    Names of dependencies of the measurement plugin.

Returns
-------
config : `SingleFrameMeasurementTask.ConfigClass`
    The resulting task configuration.

Definition at line 626 of file tests.py.

626 def makeSingleFrameMeasurementConfig(self, plugin=None, dependencies=()):
627 """Create an instance of `SingleFrameMeasurementTask.ConfigClass`.
628
629 Only the specified plugin and its dependencies will be run; the
630 Centroid, Shape, and ModelFlux slots will be set to the truth fields
631 generated by the `TestDataset` class.
632
633 Parameters
634 ----------
635 plugin : `str`
636 Name of measurement plugin to enable.
637 dependencies : iterable of `str`, optional
638 Names of dependencies of the measurement plugin.
639
640 Returns
641 -------
642 config : `SingleFrameMeasurementTask.ConfigClass`
643 The resulting task configuration.
644 """
645 config = SingleFrameMeasurementTask.ConfigClass()
646 with warnings.catch_warnings():
647 warnings.filterwarnings("ignore", message="ignoreSlotPluginChecks", category=FutureWarning)
648 config = SingleFrameMeasurementTask.ConfigClass(ignoreSlotPluginChecks=True)
649 config.slots.centroid = "truth"
650 config.slots.shape = "truth"
651 config.slots.modelFlux = None
652 config.slots.apFlux = None
653 config.slots.psfFlux = None
654 config.slots.gaussianFlux = None
655 config.slots.calibFlux = None
656 config.plugins.names = (plugin,) + tuple(dependencies)
657 return config
658

◆ makeSingleFrameMeasurementTask()

lsst.meas.base.tests.AlgorithmTestCase.makeSingleFrameMeasurementTask ( self,
plugin = None,
dependencies = (),
config = None,
schema = None,
algMetadata = None ) 
Create a configured instance of `SingleFrameMeasurementTask`.

Parameters
----------
plugin : `str`, optional
    Name of measurement plugin to enable. If `None`, a configuration
    must be supplied as the ``config`` parameter. If both are
    specified, ``config`` takes precedence.
dependencies : iterable of `str`, optional
    Names of dependencies of the specified measurement plugin.
config : `SingleFrameMeasurementTask.ConfigClass`, optional
    Configuration for the task. If `None`, a measurement plugin must
    be supplied as the ``plugin`` paramter. If both are specified,
    ``config`` takes precedence.
schema : `lsst.afw.table.Schema`, optional
    Measurement table schema. If `None`, a default schema is
    generated.
algMetadata : `lsst.daf.base.PropertyList`, optional
    Measurement algorithm metadata. If `None`, a default container
    will be generated.

Returns
-------
task : `SingleFrameMeasurementTask`
    A configured instance of the measurement task.

Definition at line 659 of file tests.py.

660 algMetadata=None):
661 """Create a configured instance of `SingleFrameMeasurementTask`.
662
663 Parameters
664 ----------
665 plugin : `str`, optional
666 Name of measurement plugin to enable. If `None`, a configuration
667 must be supplied as the ``config`` parameter. If both are
668 specified, ``config`` takes precedence.
669 dependencies : iterable of `str`, optional
670 Names of dependencies of the specified measurement plugin.
671 config : `SingleFrameMeasurementTask.ConfigClass`, optional
672 Configuration for the task. If `None`, a measurement plugin must
673 be supplied as the ``plugin`` paramter. If both are specified,
674 ``config`` takes precedence.
675 schema : `lsst.afw.table.Schema`, optional
676 Measurement table schema. If `None`, a default schema is
677 generated.
678 algMetadata : `lsst.daf.base.PropertyList`, optional
679 Measurement algorithm metadata. If `None`, a default container
680 will be generated.
681
682 Returns
683 -------
684 task : `SingleFrameMeasurementTask`
685 A configured instance of the measurement task.
686 """
687 if config is None:
688 if plugin is None:
689 raise ValueError("Either plugin or config argument must not be None")
690 config = self.makeSingleFrameMeasurementConfig(plugin=plugin, dependencies=dependencies)
691 if schema is None:
692 schema = TestDataset.makeMinimalSchema()
693 # Clear all aliases so only those defined by config are set.
694 schema.setAliasMap(None)
695 if algMetadata is None:
696 algMetadata = lsst.daf.base.PropertyList()
697 return SingleFrameMeasurementTask(schema=schema, algMetadata=algMetadata, config=config)
698
The documentation for this class was generated from the following file:
Generated on Fri Apr 26 2024 08:52:39 for LSST Applications by doxygen 1.10.0