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 175 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 209 of file diff_matched_tract_catalog.py.
209 def columns_in_ref(self) -> list[str]:
210 columns_all = [self.coord_format.column_ref_coord1, self.coord_format.column_ref_coord2]
211 if self.compute_stats:
212 columns_all.append(self.column_ref_extended)
213 for column_lists in (
214 (
215 self.columns_ref_copy,
216 ),
217 (x.columns_in_ref for x in self.columns_flux.values()),
218 ):
219 for column_list in column_lists:
220 columns_all.extend(column_list)
221
222 return list({column: None for column in columns_all}.keys())
223
◆ columns_in_target()
| list[str] lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target | ( | self | ) |
Definition at line 225 of file diff_matched_tract_catalog.py.
225 def columns_in_target(self) -> list[str]:
226 columns_all = [self.coord_format.column_target_coord1, self.coord_format.column_target_coord2]
227 if self.compute_stats:
228 columns_all.append(self.column_target_extended)
229 if self.coord_format.coords_ref_to_convert is not None:
230 columns_all.extend(col for col in self.coord_format.coords_ref_to_convert.values()
231 if col not in columns_all)
232 for column_lists in (
233 (
234 self.columns_target_coord_err,
235 self.columns_target_select_false,
236 self.columns_target_select_true,
237 self.columns_target_copy,
238 ),
239 (x.columns_in_target for x in self.columns_flux.values()),
240 ):
241 for column_list in column_lists:
242 columns_all.extend(col for col in column_list if col not in columns_all)
243 return columns_all
244
◆ validate()
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.validate | ( | self | ) |
Definition at line 336 of file diff_matched_tract_catalog.py.
336 def validate(self):
337 super().validate()
338
339 errors = []
340
341 for columns_mag, columns_in, name_columns_copy in (
342 (self.columns_ref_mag_to_nJy, self.columns_in_ref, "columns_ref_copy"),
343 (self.columns_target_mag_to_nJy, self.columns_in_target, "columns_target_copy"),
344 ):
345 columns_copy = getattr(self, name_columns_copy)
346 for column_old, column_new in columns_mag.items():
347 if column_old not in columns_in:
348 errors.append(
349 f"{column_old=} key in self.columns_mag_to_nJy not found in {columns_in=}; did you"
350 f" forget to add it to self.{name_columns_copy}={columns_copy}?"
351 )
352 if column_new in columns_copy:
353 errors.append(
354 f"{column_new=} value found in self.{name_columns_copy}={columns_copy}"
355 f" this will cause a collision. Please choose a different name."
356 )
357 if errors:
358 raise ValueError("\n".join(errors))
359
360
361@deprecated(reason="This class is no longer being used and will be removed after v28.",
362 version="v28.0", category=FutureWarning)
363@dataclass(frozen=True)
Member Data Documentation
◆ 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 179 of file diff_matched_tract_catalog.py.
◆ column_ref_extended
|
static |
Initial value:
= pexConfig.Field[str](
default='is_pointsource',
deprecated='This field is no longer being used and will be removed after v28.',
doc='The boolean reference table column specifying if the target is extended',
)
Definition at line 183 of file diff_matched_tract_catalog.py.
◆ column_ref_extended_inverted
|
static |
Initial value:
= pexConfig.Field[bool](
default=True,
deprecated='This field is no longer being used and will be removed after v28.',
doc='Whether column_ref_extended specifies if the object is compact, not extended',
)
Definition at line 188 of file diff_matched_tract_catalog.py.
◆ column_target_extended
|
static |
Initial value:
= pexConfig.Field[str](
default='refExtendedness',
deprecated='This field is no longer being used and will be removed after v28.',
doc='The target table column estimating the extendedness of the object (0 <= x <= 1)',
)
Definition at line 193 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 245 of file diff_matched_tract_catalog.py.
◆ columns_in_ref
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_ref |
Definition at line 342 of file diff_matched_tract_catalog.py.
◆ columns_in_target
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target |
Definition at line 343 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 255 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 251 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 260 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 264 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 269 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 278 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 273 of file diff_matched_tract_catalog.py.
◆ compute_stats
|
static |
Initial value:
= pexConfig.Field[bool](
default=False,
deprecated='This field is no longer being used and will be removed after v28.',
doc='Whether to compute matched difference statistics',
)
Definition at line 198 of file diff_matched_tract_catalog.py.
◆ coord_format
|
static |
Initial value:
= pexConfig.ConfigField[ConvertCatalogCoordinatesConfig](
doc="Configuration for coordinate conversion",
)
Definition at line 283 of file diff_matched_tract_catalog.py.
◆ extendedness_cut
|
static |
Initial value:
= pexConfig.Field[float](
deprecated="This field is no longer being used and will be removed after v28.",
default=0.5,
doc='Minimum extendedness for a measured source to be considered extended',
)
Definition at line 286 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 203 of file diff_matched_tract_catalog.py.
◆ mag_brightest_ref
|
static |
Initial value:
= pexConfig.Field[float](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Brightest magnitude cutoff for binning',
default=15,
)
Definition at line 296 of file diff_matched_tract_catalog.py.
◆ mag_ceiling_target
|
static |
Initial value:
= pexConfig.Field[float](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Ceiling (maximum/faint) magnitude for target sources',
default=None,
optional=True,
)
Definition at line 301 of file diff_matched_tract_catalog.py.
◆ mag_faintest_ref
|
static |
Initial value:
= pexConfig.Field[float](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Faintest magnitude cutoff for binning',
default=30,
)
Definition at line 307 of file diff_matched_tract_catalog.py.
◆ mag_num_bins
|
static |
Initial value:
= pexConfig.Field[int](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Number of magnitude bins',
default=15,
)
Definition at line 291 of file diff_matched_tract_catalog.py.
◆ mag_zeropoint_ref
|
static |
Initial value:
= pexConfig.Field[float](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Magnitude zeropoint for reference sources',
default=31.4,
)
Definition at line 312 of file diff_matched_tract_catalog.py.
◆ mag_zeropoint_target
|
static |
Initial value:
= pexConfig.Field[float](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Magnitude zeropoint for target sources',
default=31.4,
)
Definition at line 317 of file diff_matched_tract_catalog.py.
◆ percentiles
|
static |
Initial value:
= pexConfig.ListField[str](
deprecated="This field is no longer being used and will be removed after v28.",
doc='Percentiles to compute for diff/chi values',
# -2, -1, +1, +2 sigma percentiles for normal distribution
default=('2.275', '15.866', '84.134', '97.725'),
itemCheck=lambda x: 0 <= Decimal(x) <= 100,
listCheck=is_sequence_set,
)
Definition at line 322 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 330 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-9.0.0/Linux64/pipe_tasks/g599934f4f4+b8c5400ca5/python/lsst/pipe/tasks/diff_matched_tract_catalog.py
