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 171 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 205 of file diff_matched_tract_catalog.py.
205 def columns_in_ref(self) -> list[str]:
206 columns_all = [self.coord_format.column_ref_coord1, self.coord_format.column_ref_coord2]
207 if self.compute_stats:
208 columns_all.append(self.column_ref_extended)
209 for column_lists in (
210 (
211 self.columns_ref_copy,
212 ),
213 (x.columns_in_ref for x in self.columns_flux.values()),
214 ):
215 for column_list in column_lists:
216 columns_all.extend(column_list)
217
218 return list({column: None for column in columns_all}.keys())
219
◆ columns_in_target()
| list[str] lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target | ( | self | ) |
Definition at line 221 of file diff_matched_tract_catalog.py.
221 def columns_in_target(self) -> list[str]:
222 columns_all = [self.coord_format.column_target_coord1, self.coord_format.column_target_coord2]
223 if self.compute_stats:
224 columns_all.append(self.column_target_extended)
225 if self.coord_format.coords_ref_to_convert is not None:
226 columns_all.extend(col for col in self.coord_format.coords_ref_to_convert.values()
227 if col not in columns_all)
228 for column_lists in (
229 (
230 self.columns_target_coord_err,
231 self.columns_target_select_false,
232 self.columns_target_select_true,
233 self.columns_target_copy,
234 ),
235 (x.columns_in_target for x in self.columns_flux.values()),
236 ):
237 for column_list in column_lists:
238 columns_all.extend(col for col in column_list if col not in columns_all)
239 return columns_all
240
◆ validate()
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.validate | ( | self | ) |
Definition at line 332 of file diff_matched_tract_catalog.py.
332 def validate(self):
333 super().validate()
334
335 errors = []
336
337 for columns_mag, columns_in, name_columns_copy in (
338 (self.columns_ref_mag_to_nJy, self.columns_in_ref, "columns_ref_copy"),
339 (self.columns_target_mag_to_nJy, self.columns_in_target, "columns_target_copy"),
340 ):
341 columns_copy = getattr(self, name_columns_copy)
342 for column_old, column_new in columns_mag.items():
343 if column_old not in columns_in:
344 errors.append(
345 f"{column_old=} key in self.columns_mag_to_nJy not found in {columns_in=}; did you"
346 f" forget to add it to self.{name_columns_copy}={columns_copy}?"
347 )
348 if column_new in columns_copy:
349 errors.append(
350 f"{column_new=} value found in self.{name_columns_copy}={columns_copy}"
351 f" this will cause a collision. Please choose a different name."
352 )
353 if errors:
354 raise ValueError("\n".join(errors))
355
356
357@deprecated(reason="This class is no longer being used and will be removed after v28.",
358 version="v28.0", category=FutureWarning)
359@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 175 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 179 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 184 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 189 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 241 of file diff_matched_tract_catalog.py.
◆ columns_in_ref
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_ref |
Definition at line 338 of file diff_matched_tract_catalog.py.
◆ columns_in_target
| lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target |
Definition at line 339 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 251 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 247 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 256 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 260 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 265 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 274 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 269 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 194 of file diff_matched_tract_catalog.py.
◆ coord_format
|
static |
Initial value:
= pexConfig.ConfigField[ConvertCatalogCoordinatesConfig](
doc="Configuration for coordinate conversion",
)
Definition at line 279 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 282 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 199 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 292 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 297 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 303 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 287 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 308 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 313 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 318 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 326 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-8.0.0/Linux64/pipe_tasks/ge6cb8fbbf7+d119aed356/python/lsst/pipe/tasks/diff_matched_tract_catalog.py
