lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogConfig Class Reference

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

Public Member Functions
Tuple[Set, Set]	get_columns_in (self)

Static Public Attributes
	match_tract_catalog
	refcat_sharding_type
	target_sharding_type
	cat_ref
	cat_target
	skymap
	cat_output_ref
	cat_output_target

Detailed Description

Configure a MatchTractCatalogTask, including a configurable matching subtask.

Definition at line 168 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.

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 189 of file match_tract_catalog.py.

Member Data Documentation

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 71 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 77 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 51 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 58 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 174 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 178 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 65 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 183 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