lsst.meas.base  19.0.0-9-g463f923+1
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.

◆ 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.

◆ 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.

◆ 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.


The documentation for this class was generated from the following file: