Inheritance diagram for lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig:

Public Member Functions
tuple[set, set]	get_columns_in (self)

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

Public Attributes
dict	dimensions = {"skymap"}

Static Public Attributes
	coord_unit

	diff_matched_catalog

	match_multiple_target

	match_tract_catalog

	output_matched_catalog

	refcat_sharding_type

	target_sharding_type

	cat_ref

	cat_target

	skymap

	cat_output_matched

	cat_output_ref

	cat_output_target

Detailed Description

Configure a MatchTractCatalogTask, including a configurable matching subtask.

Definition at line 231 of file match_tract_catalog.py.

Member Function Documentation

◆ get_columns_in()

tuple[set, set] lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.get_columns_in ( self )

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.

Definition at line 271 of file match_tract_catalog.py.

◆ get_columns_ordered_in()

tuple[dict[str, None], dict[str, None]] lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.get_columns_ordered_in ( self )

Get the ordered set of input columns required for matching.

Returns
-------
columns_ref : `set` [`str`]
    The set of required input catalog column names.
columns_target : `set` [`str`]
    The set of required target catalog column names.

Definition at line 280 of file match_tract_catalog.py.

Member Data Documentation

◆ cat_output_matched

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.cat_output_matched

staticinherited

Initial value:

=  cT.Output(
        doc="Target matched catalog with indices of reference matches",
        name="matched_{name_input_cat_ref}_{name_input_cat_target}",
        storageClass="ArrowAstropy",
        dimensions=("tract", "skymap"),
    )

Definition at line 76 of file match_tract_catalog.py.

◆ cat_output_ref

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.cat_output_ref

staticinherited

Initial value:

=  cT.Output(
        doc="Reference matched catalog with indices of target matches",
        name="match_ref_{name_input_cat_ref}_{name_input_cat_target}",
        storageClass="ArrowAstropy",
        dimensions=("tract", "skymap"),
    )

Definition at line 82 of file match_tract_catalog.py.

◆ cat_output_target

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.cat_output_target

staticinherited

Initial value:

=  cT.Output(
        doc="Target matched catalog with indices of reference matches",
        name="match_target_{name_input_cat_ref}_{name_input_cat_target}",
        storageClass="ArrowAstropy",
        dimensions=("tract", "skymap"),
    )

Definition at line 88 of file match_tract_catalog.py.

◆ cat_ref

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.cat_ref

staticinherited

Initial value:

=  cT.Input(
        doc="Reference object catalog to match from",
        name="{name_input_cat_ref}",
        storageClass="ArrowAstropy",
        dimensions=("tract", "skymap"),
        deferLoad=True,
    )

Definition at line 56 of file match_tract_catalog.py.

◆ cat_target

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.cat_target

staticinherited

Initial value:

=  cT.Input(
        doc="Target object catalog to match",
        name="{name_input_cat_target}",
        storageClass="ArrowAstropy",
        dimensions=("tract", "skymap"),
        deferLoad=True,
    )

Definition at line 63 of file match_tract_catalog.py.

◆ coord_unit

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.coord_unit

static

Initial value:

=  pexConfig.Field[str](
        doc="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.",
        optional=True,
    )

Definition at line 237 of file match_tract_catalog.py.

◆ diff_matched_catalog

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.diff_matched_catalog

static

Initial value:

=  pexConfig.ConfigurableField(
        target=DiffMatchedTractCatalogTaskBase,
        doc="Task to make a matched catalog out of the match index tables",
    )

Definition at line 243 of file match_tract_catalog.py.

◆ dimensions

dict lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.dimensions = {"skymap"}

inherited

Definition at line 117 of file match_tract_catalog.py.

◆ match_multiple_target

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.match_multiple_target

static

Initial value:

=  pexConfig.Field[bool](
        doc="Whether to match multiple target tract catalogs",
        default=False,
    )

Definition at line 247 of file match_tract_catalog.py.

◆ match_tract_catalog

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.match_tract_catalog

static

Initial value:

=  pexConfig.ConfigurableField(
        target=MatchTractCatalogSubTask,
        doc="Task to match sources in a reference tract catalog with a target catalog",
    )

Definition at line 251 of file match_tract_catalog.py.

◆ output_matched_catalog

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.output_matched_catalog

static

Initial value:

=  pexConfig.Field[bool](
        doc="Whether to run the diff_matched_catalog task and write a matched catalog,"
            " not just the catalogs of match indices",
        default=False,
    )

Definition at line 255 of file match_tract_catalog.py.

◆ refcat_sharding_type

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.refcat_sharding_type

static

Initial value:

=  pexConfig.ChoiceField[str](
        doc="The type of sharding (spatial splitting) for the reference catalog",
        allowed={"tract": "Tract-based shards", "none": "No sharding at all"},
        default="tract",
    )

Definition at line 260 of file match_tract_catalog.py.

◆ skymap

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConnections.skymap

staticinherited

Initial value:

=  cT.Input(
        doc="Input definition of geometry/bbox and projection/wcs for coadded exposures",
        name=BaseSkyMap.SKYMAP_DATASET_TYPE_NAME,
        storageClass="SkyMap",
        dimensions=("skymap",),
    )

Definition at line 70 of file match_tract_catalog.py.

◆ target_sharding_type

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig.target_sharding_type

static

Initial value:

=  pexConfig.ChoiceField[str](
        doc="The type of sharding (spatial splitting) for the target catalog",
        allowed={"tract": "Tract-based shards", "none": "No sharding at all"},
        default="tract",
    )

Definition at line 265 of file match_tract_catalog.py.

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

python/lsst/pipe/tasks/match_tract_catalog.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ get_columns_in()

◆ get_columns_ordered_in()

Member Data Documentation

◆ cat_output_matched

◆ cat_output_ref

◆ cat_output_target

◆ cat_ref

◆ cat_target

◆ coord_unit

◆ diff_matched_catalog

◆ dimensions

◆ match_multiple_target

◆ match_tract_catalog

◆ output_matched_catalog

◆ refcat_sharding_type

◆ skymap

◆ target_sharding_type