MatchTractCatalogConfig

class lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig(*args, **kw)

Bases: PipelineTaskConfig

Configure a MatchTractCatalogTask, including a configurable matching subtask.

Attributes Summary

connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
coord_unit	lsst.geom unit (or astropy equivalent) of the coordinate columns.Only used to determine the tract for rows in non-tract-sharded catalogs without a tract column.
diff_matched_catalog	Task to make a matched catalog out of the match index tables (ConfigurableInstance, default <class 'lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogBaseConfig'>)
match_multiple_target	Whether to match multiple target tract catalogs (bool, default False)
match_tract_catalog	Task to match sources in a reference tract catalog with a target catalog (ConfigurableInstance, default <class 'lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubConfig'>)
output_matched_catalog	Whether to run the diff_matched_catalog task and write a matched catalog, not just the catalogs of match indices (bool, default False)
refcat_sharding_type	The type of sharding (spatial splitting) for the reference catalog (str, default 'tract')
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
target_sharding_type	The type of sharding (spatial splitting) for the target catalog (str, default 'tract')

Methods Summary

get_columns_in()	Get the set of input columns required for matching.
get_columns_ordered_in()	Get the ordered set of input columns required for matching.

Attributes Documentation

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

coord_unit

lsst.geom unit (or astropy equivalent) of the coordinate columns.Only used to determine the tract for rows in non-tract-sharded catalogs without a tract column. (str, default None)

diff_matched_catalog

Task to make a matched catalog out of the match index tables (ConfigurableInstance, default <class 'lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogBaseConfig'>)

match_multiple_target

Whether to match multiple target tract catalogs (bool, default False)

match_tract_catalog

Task to match sources in a reference tract catalog with a target catalog (ConfigurableInstance, default <class 'lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubConfig'>)

output_matched_catalog

Whether to run the diff_matched_catalog task and write a matched catalog, not just the catalogs of match indices (bool, default False)

refcat_sharding_type

The type of sharding (spatial splitting) for the reference catalog (str, default 'tract')

Allowed values:

'tract'

Tract-based shards

'none'

No sharding at all

'None'

Field is optional

saveLogOutput

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

target_sharding_type

The type of sharding (spatial splitting) for the target catalog (str, default 'tract')

Allowed values:

'tract'

Tract-based shards

'none'

No sharding at all

'None'

Field is optional

Methods Documentation

get_columns_in() → tuple[set, set]

Get the set of input columns required for matching.

This function exists for backward compatibility and simply returns the results of get_columns_ordered_in cast to sets.

get_columns_ordered_in() → tuple[dict[str, None], dict[str, None]]

Get the ordered set of input columns required for matching.

Returns

columns_refset [str]

The set of required input catalog column names.

columns_targetset [str]

The set of required target catalog column names.