CatalogMatchConfig#

class lsst.analysis.tools.tasks.CatalogMatchConfig(*args, **kw)#

Bases: PipelineTaskConfig

Attributes Summary

`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`decColumn`	Dec column.
`epoch`	Epoch to which reference objects are shifted.
`extraColumnSelectors`	Other selectors that are not used in this task, but whose columnsmay be needed downstream (`ConfigurableActionStructField`, default {'selector1': lsst.analysis.tools.actions.vector.selectors.SnSelector(plotLabelKey='', fluxType='{band}_psfFlux', threshold=500.0, maxSN=1000000.0, uncertaintySuffix='Err', bands=[]), 'selector2': lsst.analysis.tools.actions.vector.selectors.StarSelector(plotLabelKey='', vectorKey='{band}_extendedness', extendedness_maximum=0.5), 'selector3': lsst.analysis.tools.actions.vector.selectors.GalaxySelector(plotLabelKey='', vectorKey='{band}_extendedness', extendedness_minimum=0.5), 'selector4': lsst.analysis.tools.actions.vector.selectors.CoaddPlotFlagSelector(selectWhenFalse=['{band}_psfFlux_flag', '{band}_pixelFlags_saturatedCenter', '{band}_extendedness_flag', 'coord_flag', 'sky_object'], selectWhenTrue=['detect_isPatchInner', 'detect_isDeblendedSource'], bands=[])})
`extraColumns`	Other catalog columns to persist to downstream tasks (`List`, default `['patch', 'ebv']`)
`extraPerBandColumns`	Other columns to load that should be loaded for each band individually.
`filterNames`	Physical filter names to persist downstream.
`idColumn`	Unique ID column for the target catalog.
`matchRadius`	The radius to use for matching, in arcsecs.
`matchesRefCat`	Is the catalog being matched to stored as a reference catalog? (`bool`, default `False`)
`patchColumn`	Patch column.
`raColumn`	RA column.
`refDecColumn`	Dec column name for the reference (being matched to) catalog.
`refRaColumn`	RA column name for the reference (being matched to) catalog.
`referenceCatalogLoader`	Reference catalog loader (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig'>`)
`returnNonMatches`	Return the rows of the reference catalog that didn't get matched? (`bool`, default `False`)
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`selectorActions`	Which selectors to use to narrow down the data for QA plotting.
`selectorBands`	Band to use when selecting objects, primarily for extendedness.
`sourceSelectorActions`	What types of sources to use.
`targetDecColumn`	Dec column name for the target (being matched) catalog.
`targetRaColumn`	RA column name for the target (being matched) catalog.

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

decColumn#: Dec column. Deprecated: This field was replaced with targetDecColumn and is unused. Will be removed after v27. (str, default 'coord_dec')

epoch#: Epoch to which reference objects are shifted. (float, default 2015.0)

extraColumnSelectors#: Other selectors that are not used in this task, but whose columnsmay be needed downstream (ConfigurableActionStructField, default {'selector1': lsst.analysis.tools.actions.vector.selectors.SnSelector(plotLabelKey='', fluxType='{band}_psfFlux', threshold=500.0, maxSN=1000000.0, uncertaintySuffix='Err', bands=[]), 'selector2': lsst.analysis.tools.actions.vector.selectors.StarSelector(plotLabelKey='', vectorKey='{band}_extendedness', extendedness_maximum=0.5), 'selector3': lsst.analysis.tools.actions.vector.selectors.GalaxySelector(plotLabelKey='', vectorKey='{band}_extendedness', extendedness_minimum=0.5), 'selector4': lsst.analysis.tools.actions.vector.selectors.CoaddPlotFlagSelector(selectWhenFalse=['{band}_psfFlux_flag', '{band}_pixelFlags_saturatedCenter', '{band}_extendedness_flag', 'coord_flag', 'sky_object'], selectWhenTrue=['detect_isPatchInner', 'detect_isDeblendedSource'], bands=[])})

extraColumns#: Other catalog columns to persist to downstream tasks (List, default ['patch', 'ebv'])

extraPerBandColumns#: Other columns to load that should be loaded for each band individually. (List, default ['cModelFlux'])

filterNames#: Physical filter names to persist downstream. (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

idColumn#: Unique ID column for the target catalog. (str, default 'objectId')

matchRadius#: The radius to use for matching, in arcsecs. (float, default 1.0)

matchesRefCat#: Is the catalog being matched to stored as a reference catalog? (bool, default False)

patchColumn#: Patch column. (str, default 'patch')

raColumn#: RA column. Deprecated: This field was replaced with targetRaColumn and is unused. Will be removed after v27. (str, default 'coord_ra')

refDecColumn#: Dec column name for the reference (being matched to) catalog. (str, default 'dec')

refRaColumn#: RA column name for the reference (being matched to) catalog. (str, default 'ra')

referenceCatalogLoader#: Reference catalog loader (ConfigurableInstance, default <class 'lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig'>)

returnNonMatches#: Return the rows of the reference catalog that didn’t get matched? (bool, default False)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

selectorActions#: Which selectors to use to narrow down the data for QA plotting. (ConfigurableActionStructField, default {'flagSelector': lsst.analysis.tools.actions.vector.selectors.MatchingFlagSelector(selectWhenFalse=[], selectWhenTrue=['detect_isPrimary'], bands=[])})

selectorBands#: Band to use when selecting objects, primarily for extendedness. (List, default ['i'])

sourceSelectorActions#: What types of sources to use. (ConfigurableActionStructField, default {})

targetDecColumn#: Dec column name for the target (being matched) catalog. (str, default 'coord_dec')

targetRaColumn#: RA column name for the target (being matched) catalog. (str, default 'coord_ra')

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

CatalogMatchConfig#

Notes#