lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig:
Public Member Functions | |
| list[str] | columns_in_ref (self) |
| list[str] | columns_in_target (self) |
| validate (self) | |
Public Attributes | |
| columns_in_ref | |
| columns_in_target | |
Detailed Description
Definition at line 161 of file diff_matched_tract_catalog.py.
Member Function Documentation
◆ columns_in_ref()
| list[str] lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_ref | ( | self | ) |
Definition at line 203 of file diff_matched_tract_catalog.py.
203 def columns_in_ref(self) -> list[str]:
204 columns_all = [self.coord_format.column_ref_coord1, self.coord_format.column_ref_coord2]
205 for column_lists in (
206 (
207 self.columns_ref_copy,
208 ),
209 (x.columns_in_ref for x in self.columns_flux.values()),
210 ):
211 for column_list in column_lists:
212 columns_all.extend(column_list)
213
214 return list({column: None for column in columns_all}.keys())
215
◆ columns_in_target()
| list[str] lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target | ( | self | ) |
Definition at line 217 of file diff_matched_tract_catalog.py.
217 def columns_in_target(self) -> list[str]:
218 columns_all = [self.coord_format.column_target_coord1, self.coord_format.column_target_coord2]
219 if self.coord_format.coords_ref_to_convert is not None:
220 columns_all.extend(col for col in self.coord_format.coords_ref_to_convert.values()
221 if col not in columns_all)
222 for column_lists in (
223 (
224 self.columns_target_coord_err,
225 self.columns_target_select_false,
226 self.columns_target_select_true,
227 self.columns_target_copy,
228 ),
229 (x.columns_in_target for x in self.columns_flux.values()),
230 ):
231 for column_list in column_lists:
232 columns_all.extend(col for col in column_list if col not in columns_all)
233 return columns_all
234
◆ validate()
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.validate | ( | self | ) |
Definition at line 287 of file diff_matched_tract_catalog.py.
287 def validate(self):
288 super().validate()
289
290 errors = []
291
292 for columns_mag, columns_in, name_columns_copy in (
293 (self.columns_ref_mag_to_nJy, self.columns_in_ref, "columns_ref_copy"),
294 (self.columns_target_mag_to_nJy, self.columns_in_target, "columns_target_copy"),
295 ):
296 columns_copy = getattr(self, name_columns_copy)
297 for column_old, column_new in columns_mag.items():
298 if column_old not in columns_in:
299 errors.append(
300 f"{column_old=} key in self.columns_mag_to_nJy not found in {columns_in=}; did you"
301 f" forget to add it to self.{name_columns_copy}={columns_copy}?"
302 )
303 if column_new in columns_copy:
304 errors.append(
305 f"{column_new=} value found in self.{name_columns_copy}={columns_copy}"
306 f" this will cause a collision. Please choose a different name."
307 )
308 if errors:
309 raise ValueError("\n".join(errors))
310
311
Member Data Documentation
◆ cat_match_ref
|
staticinherited |
Initial value:
= cT.Input(
doc="Reference match catalog with indices of target matches",
name="match_ref_{name_input_cat_ref}_{name_input_cat_target}",
storageClass="ArrowAstropy",
dimensions=("tract", "skymap"),
deferLoad=True,
)
Definition at line 78 of file diff_matched_tract_catalog.py.
◆ cat_match_target
|
staticinherited |
Initial value:
= cT.Input(
doc="Target match catalog with indices of references matches",
name="match_target_{name_input_cat_ref}_{name_input_cat_target}",
storageClass="ArrowAstropy",
dimensions=("tract", "skymap"),
deferLoad=True,
)
Definition at line 85 of file diff_matched_tract_catalog.py.
◆ cat_matched
|
staticinherited |
Initial value:
= cT.Output(
doc="Catalog with reference and target columns for joined sources",
name="matched_{name_input_cat_ref}_{name_input_cat_target}",
storageClass="ArrowAstropy",
dimensions=("tract", "skymap"),
)
Definition at line 98 of file diff_matched_tract_catalog.py.
◆ 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 58 of file diff_matched_tract_catalog.py.
◆ 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 65 of file diff_matched_tract_catalog.py.
◆ column_match_candidate_ref
|
static |
Initial value:
= pexConfig.Field[str](
default='match_candidate',
doc='The column name for the boolean field identifying reference objects'
' that were used for matching',
optional=True,
)
Definition at line 165 of file diff_matched_tract_catalog.py.
◆ column_match_candidate_target
|
static |
Initial value:
= pexConfig.Field[str](
default='match_candidate',
doc='The column name for the boolean field identifying target objects'
' that were used for matching',
optional=True,
)
Definition at line 171 of file diff_matched_tract_catalog.py.
◆ column_matched_prefix_ref
|
static |
Initial value:
= pexConfig.Field[str](
default='refcat_',
doc='The prefix for matched columns copied from the reference catalog',
)
Definition at line 177 of file diff_matched_tract_catalog.py.
◆ column_matched_prefix_target
|
static |
Initial value:
= pexConfig.Field[str](
default='',
doc='The prefix for matched columns copied from the target catalog',
)
Definition at line 181 of file diff_matched_tract_catalog.py.
◆ columns_flux
|
static |
Initial value:
= pexConfig.ConfigDictField(
doc="Configs for flux columns for each band",
keytype=str,
itemtype=MatchedCatalogFluxesConfig,
default={},
)
Definition at line 235 of file diff_matched_tract_catalog.py.
◆ columns_in_ref
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_ref |
Definition at line 293 of file diff_matched_tract_catalog.py.
◆ columns_in_target
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target |
Definition at line 294 of file diff_matched_tract_catalog.py.
◆ columns_match_target
|
staticinherited |
Initial value:
= cT.Input(
doc="Target match catalog columns",
name="match_target_{name_input_cat_ref}_{name_input_cat_target}.columns",
storageClass="ArrowColumnList",
dimensions=("tract", "skymap"),
)
Definition at line 92 of file diff_matched_tract_catalog.py.
◆ columns_ref_copy
|
static |
Initial value:
= pexConfig.ListField[str](
doc='Reference table columns to copy into cat_matched',
default=[],
listCheck=is_sequence_set,
)
Definition at line 245 of file diff_matched_tract_catalog.py.
◆ columns_ref_mag_to_nJy
|
static |
Initial value:
= pexConfig.DictField[str, str](
doc='Reference table AB mag columns to convert to nJy flux columns with new names',
default={},
)
Definition at line 241 of file diff_matched_tract_catalog.py.
◆ columns_target_coord_err
|
static |
Initial value:
= pexConfig.ListField[str](
doc='Target table coordinate columns with standard errors (sigma)',
listCheck=lambda x: (len(x) == 2) and (x[0] != x[1]),
)
Definition at line 250 of file diff_matched_tract_catalog.py.
◆ columns_target_copy
|
static |
Initial value:
= pexConfig.ListField[str](
doc='Target table columns to copy into cat_matched',
default=('patch',),
listCheck=is_sequence_set,
)
Definition at line 254 of file diff_matched_tract_catalog.py.
◆ columns_target_mag_to_nJy
|
static |
Initial value:
= pexConfig.DictField[str, str](
doc='Target table AB mag columns to convert to nJy flux columns with new names',
default={},
)
Definition at line 259 of file diff_matched_tract_catalog.py.
◆ columns_target_select_false
|
static |
Initial value:
= pexConfig.ListField[str](
doc='Target table columns to require to be False for selecting sources',
default=('merge_peak_sky',),
listCheck=is_sequence_set,
)
Definition at line 268 of file diff_matched_tract_catalog.py.
◆ columns_target_select_true
|
static |
Initial value:
= pexConfig.ListField[str](
doc='Target table columns to require to be True for selecting sources',
default=('detect_isPrimary',),
listCheck=is_sequence_set,
)
Definition at line 263 of file diff_matched_tract_catalog.py.
◆ coord_format
|
static |
Initial value:
= pexConfig.ConfigField[ConvertCatalogCoordinatesConfig](
doc="Configuration for coordinate conversion",
)
Definition at line 273 of file diff_matched_tract_catalog.py.
◆ filter_on_match_candidate
|
static |
Initial value:
= pexConfig.Field[bool](
default=False,
doc='Whether to use provided column_match_candidate_[ref/target] to'
' exclude rows from the output table. If False, any provided'
' columns will be copied instead.'
)
Definition at line 189 of file diff_matched_tract_catalog.py.
◆ include_unmatched
|
static |
Initial value:
= pexConfig.Field[bool](
default=False,
doc='Whether to include unmatched rows in the matched table',
)
Definition at line 185 of file diff_matched_tract_catalog.py.
◆ prefix_best_coord
|
static |
Initial value:
= pexConfig.Field[str](
default=None,
doc="A string prefix for ra/dec coordinate columns generated from the reference coordinate if "
"available, and target otherwise. Ignored if None or include_unmatched is False.",
optional=True,
)
Definition at line 195 of file diff_matched_tract_catalog.py.
◆ 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 276 of file diff_matched_tract_catalog.py.
◆ skymap
|
staticinherited |
Initial value:
= cT.Input(
doc="Input definition of geometry/bbox and projection/wcs for coadded exposures",
name="{name_skymap}",
storageClass="SkyMap",
dimensions=("skymap",),
)
Definition at line 72 of file diff_matched_tract_catalog.py.
◆ 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 281 of file diff_matched_tract_catalog.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/pipe_tasks/g99af87f6a8+b0f4ad7b8d/python/lsst/pipe/tasks/diff_matched_tract_catalog.py
Generated on Thu Nov 27 2025 09:15:22 for LSST Applications by
1.13.2