LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
Public Member Functions | List of all members
lsst.meas.base.tests.AlgorithmTestCase Class Reference

Public Member Functions

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

Detailed Description

Definition at line 588 of file tests.py.

Member Function Documentation

◆ makeForcedMeasurementConfig()

def 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 660 of file tests.py.

660  def makeForcedMeasurementConfig(self, plugin=None, dependencies=()):
661  """Create an instance of `ForcedMeasurementTask.ConfigClass`.
662 
663  In addition to the plugins specified in the plugin and dependencies
664  arguments, the `TransformedCentroid` and `TransformedShape` plugins
665  will be run and used as the centroid and shape slots; these simply
666  transform the reference catalog centroid and shape to the measurement
667  coordinate system.
668 
669  Parameters
670  ----------
671  plugin : `str`
672  Name of measurement plugin to enable.
673  dependencies : iterable of `str`, optional
674  Names of dependencies of the measurement plugin.
675 
676  Returns
677  -------
678  config : `ForcedMeasurementTask.ConfigClass`
679  The resulting task configuration.
680  """
681 
682  config = ForcedMeasurementTask.ConfigClass()
683  config.slots.centroid = "base_TransformedCentroid"
684  config.slots.shape = "base_TransformedShape"
685  config.slots.modelFlux = None
686  config.slots.apFlux = None
687  config.slots.psfFlux = None
688  config.slots.gaussianFlux = None
689  config.plugins.names = (plugin,) + tuple(dependencies) + ("base_TransformedCentroid",
690  "base_TransformedShape")
691  return config
692 

◆ makeForcedMeasurementTask()

def 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 693 of file tests.py.

694  algMetadata=None):
695  """Create a configured instance of `ForcedMeasurementTask`.
696 
697  Parameters
698  ----------
699  plugin : `str`, optional
700  Name of measurement plugin to enable. If `None`, a configuration
701  must be supplied as the ``config`` parameter. If both are
702  specified, ``config`` takes precedence.
703  dependencies : iterable of `str`, optional
704  Names of dependencies of the specified measurement plugin.
705  config : `SingleFrameMeasurementTask.ConfigClass`, optional
706  Configuration for the task. If `None`, a measurement plugin must
707  be supplied as the ``plugin`` paramter. If both are specified,
708  ``config`` takes precedence.
709  refSchema : `lsst.afw.table.Schema`, optional
710  Reference table schema. If `None`, a default schema is
711  generated.
712  algMetadata : `lsst.daf.base.PropertyList`, optional
713  Measurement algorithm metadata. If `None`, a default container
714  will be generated.
715 
716  Returns
717  -------
718  task : `ForcedMeasurementTask`
719  A configured instance of the measurement task.
720  """
721  if config is None:
722  if plugin is None:
723  raise ValueError("Either plugin or config argument must not be None")
724  config = self.makeForcedMeasurementConfig(plugin=plugin, dependencies=dependencies)
725  if refSchema is None:
726  refSchema = TestDataset.makeMinimalSchema()
727  if algMetadata is None:
728  algMetadata = lsst.daf.base.PropertyList()
729  return ForcedMeasurementTask(refSchema=refSchema, algMetadata=algMetadata, config=config)
730 
731 
lsst::daf::base::PropertyList
Class for storing ordered metadata with comments.
Definition: PropertyList.h:68

◆ makeSingleFrameMeasurementConfig()

def 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 590 of file tests.py.

590  def makeSingleFrameMeasurementConfig(self, plugin=None, dependencies=()):
591  """Create an instance of `SingleFrameMeasurementTask.ConfigClass`.
592 
593  Only the specified plugin and its dependencies will be run; the
594  Centroid, Shape, and ModelFlux slots will be set to the truth fields
595  generated by the `TestDataset` class.
596 
597  Parameters
598  ----------
599  plugin : `str`
600  Name of measurement plugin to enable.
601  dependencies : iterable of `str`, optional
602  Names of dependencies of the measurement plugin.
603 
604  Returns
605  -------
606  config : `SingleFrameMeasurementTask.ConfigClass`
607  The resulting task configuration.
608  """
609  config = SingleFrameMeasurementTask.ConfigClass()
610  config.slots.centroid = "truth"
611  config.slots.shape = "truth"
612  config.slots.modelFlux = None
613  config.slots.apFlux = None
614  config.slots.psfFlux = None
615  config.slots.gaussianFlux = None
616  config.slots.calibFlux = None
617  config.plugins.names = (plugin,) + tuple(dependencies)
618  return config
619 

◆ makeSingleFrameMeasurementTask()

def 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 620 of file tests.py.

621  algMetadata=None):
622  """Create a configured instance of `SingleFrameMeasurementTask`.
623 
624  Parameters
625  ----------
626  plugin : `str`, optional
627  Name of measurement plugin to enable. If `None`, a configuration
628  must be supplied as the ``config`` parameter. If both are
629  specified, ``config`` takes precedence.
630  dependencies : iterable of `str`, optional
631  Names of dependencies of the specified measurement plugin.
632  config : `SingleFrameMeasurementTask.ConfigClass`, optional
633  Configuration for the task. If `None`, a measurement plugin must
634  be supplied as the ``plugin`` paramter. If both are specified,
635  ``config`` takes precedence.
636  schema : `lsst.afw.table.Schema`, optional
637  Measurement table schema. If `None`, a default schema is
638  generated.
639  algMetadata : `lsst.daf.base.PropertyList`, optional
640  Measurement algorithm metadata. If `None`, a default container
641  will be generated.
642 
643  Returns
644  -------
645  task : `SingleFrameMeasurementTask`
646  A configured instance of the measurement task.
647  """
648  if config is None:
649  if plugin is None:
650  raise ValueError("Either plugin or config argument must not be None")
651  config = self.makeSingleFrameMeasurementConfig(plugin=plugin, dependencies=dependencies)
652  if schema is None:
653  schema = TestDataset.makeMinimalSchema()
654  # Clear all aliases so only those defined by config are set.
655  schema.setAliasMap(None)
656  if algMetadata is None:
657  algMetadata = lsst.daf.base.PropertyList()
658  return SingleFrameMeasurementTask(schema=schema, algMetadata=algMetadata, config=config)
659 
The documentation for this class was generated from the following file:
Generated on Thu Sep 30 2021 20:03:44 for LSST Applications by doxygen 1.9.1