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)

Static Public Attributes
	column_matched_prefix_ref
	column_ref_extended
	column_ref_extended_inverted
	column_target_extended
	columns_flux
	columns_ref_copy
	columns_target_coord_err
	columns_target_copy
	columns_target_select_true
	columns_target_select_false
	coord_format
	extendedness_cut
	mag_num_bins
	mag_brightest_ref
	mag_ceiling_target
	mag_faintest_ref
	mag_zeropoint_ref
	mag_zeropoint_target
	percentiles

Detailed Description

Definition at line 152 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 178 of file diff_matched_tract_catalog.py.

    def columns_in_ref(self) -> list[str]:
        columns_all = [self.coord_format.column_ref_coord1, self.coord_format.column_ref_coord2,
                       self.column_ref_extended]
        for column_lists in (
            (
                self.columns_ref_copy,
            ),
            (x.columns_in_ref for x in self.columns_flux.values()),
        ):
            for column_list in column_lists:
                columns_all.extend(column_list)
 
        return set(columns_all)
 

columns_in_target()

list[str] lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_in_target

(

self

)

Definition at line 193 of file diff_matched_tract_catalog.py.

    def columns_in_target(self) -> list[str]:
        columns_all = [self.coord_format.column_target_coord1, self.coord_format.column_target_coord2,
                       self.column_target_extended]
        if self.coord_format.coords_ref_to_convert is not None:
            columns_all.extend(col for col in self.coord_format.coords_ref_to_convert.values()
                               if col not in columns_all)
        for column_lists in (
            (
                self.columns_target_coord_err,
                self.columns_target_select_false,
                self.columns_target_select_true,
                self.columns_target_copy,
            ),
            (x.columns_in_target for x in self.columns_flux.values()),
        ):
            for column_list in column_lists:
                columns_all.extend(col for col in column_list if col not in columns_all)
        return columns_all
 

Member Data Documentation

column_matched_prefix_ref

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.column_matched_prefix_ref

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default='refcat_',
        doc='The prefix for matched columns copied from the reference catalog',
    )

Definition at line 156 of file diff_matched_tract_catalog.py.

column_ref_extended

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.column_ref_extended

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default='is_pointsource',
        doc='The boolean reference table column specifying if the target is extended',
    )

Definition at line 161 of file diff_matched_tract_catalog.py.

column_ref_extended_inverted

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.column_ref_extended_inverted

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc='Whether column_ref_extended specifies if the object is compact, not extended',
    )

Definition at line 166 of file diff_matched_tract_catalog.py.

column_target_extended

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.column_target_extended

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default='refExtendedness',
        doc='The target table column estimating the extendedness of the object (0 <= x <= 1)',
    )

Definition at line 171 of file diff_matched_tract_catalog.py.

columns_flux

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.columns_flux

static

Initial value:

=  pexConfig.ConfigDictField(
        doc="Configs for flux columns for each band",
        keytype=str,
        itemtype=MatchedCatalogFluxesConfig,
    )

Definition at line 212 of file diff_matched_tract_catalog.py.

columns_ref_copy

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.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 217 of file diff_matched_tract_catalog.py.

columns_target_coord_err

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.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 222 of file diff_matched_tract_catalog.py.

columns_target_copy

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.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 226 of file diff_matched_tract_catalog.py.

columns_target_select_false

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.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 236 of file diff_matched_tract_catalog.py.

columns_target_select_true

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.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 231 of file diff_matched_tract_catalog.py.

coord_format

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.coord_format

static

Initial value:

=  pexConfig.ConfigField[ConvertCatalogCoordinatesConfig](
        doc="Configuration for coordinate conversion",
    )

Definition at line 241 of file diff_matched_tract_catalog.py.

extendedness_cut

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.extendedness_cut

static

Initial value:

=  pexConfig.Field[float](
        dtype=float,
        default=0.5,
        doc='Minimum extendedness for a measured source to be considered extended',
    )

Definition at line 244 of file diff_matched_tract_catalog.py.

mag_brightest_ref

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.mag_brightest_ref

static

Initial value:

=  pexConfig.Field[float](
        doc='Brightest magnitude cutoff for binning',
        default=15,
    )

Definition at line 253 of file diff_matched_tract_catalog.py.

mag_ceiling_target

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.mag_ceiling_target

static

Initial value:

=  pexConfig.Field[float](
        doc='Ceiling (maximum/faint) magnitude for target sources',
        default=None,
        optional=True,
    )

Definition at line 257 of file diff_matched_tract_catalog.py.

mag_faintest_ref

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.mag_faintest_ref

static

Initial value:

=  pexConfig.Field[float](
        doc='Faintest magnitude cutoff for binning',
        default=30,
    )

Definition at line 262 of file diff_matched_tract_catalog.py.

mag_num_bins

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.mag_num_bins

static

Initial value:

=  pexConfig.Field[int](
        doc='Number of magnitude bins',
        default=15,
    )

Definition at line 249 of file diff_matched_tract_catalog.py.

mag_zeropoint_ref

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.mag_zeropoint_ref

static

Initial value:

=  pexConfig.Field[float](
        doc='Magnitude zeropoint for reference sources',
        default=31.4,
    )

Definition at line 266 of file diff_matched_tract_catalog.py.

mag_zeropoint_target

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.mag_zeropoint_target

static

Initial value:

=  pexConfig.Field[float](
        doc='Magnitude zeropoint for target sources',
        default=31.4,
    )

Definition at line 270 of file diff_matched_tract_catalog.py.

percentiles

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig.percentiles

static

Initial value:

=  pexConfig.ListField[str](
        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=is_percentile,
        listCheck=is_sequence_set,
    )

Definition at line 274 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/g29320951ab+012e1474a1/python/lsst/pipe/tasks/diff_matched_tract_catalog.py