DiffMatchedTractCatalogConfig

class lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogConfig(*args, **kw)

Bases: PipelineTaskConfig

Attributes Summary

column_match_candidate_ref	The column name for the boolean field identifying reference objects that were used for matching (str, default 'match_candidate')
column_match_candidate_target	The column name for the boolean field identifying target objects that were used for matching (str, default 'match_candidate')
column_matched_prefix_ref	The prefix for matched columns copied from the reference catalog (str, default 'refcat_')
column_matched_prefix_target	The prefix for matched columns copied from the target catalog (str, default '')
columns_flux	Configs for flux columns for each band (ConfigDict, default {})
columns_in_ref
columns_in_target
columns_ref_copy	Reference table columns to copy into cat_matched (List, default [])
columns_ref_mag_to_nJy	Reference table AB mag columns to convert to nJy flux columns with new names (Dict, default {})
columns_target_coord_err	Target table coordinate columns with standard errors (sigma) (List)
columns_target_copy	Target table columns to copy into cat_matched (List, default ('patch',))
columns_target_mag_to_nJy	Target table AB mag columns to convert to nJy flux columns with new names (Dict, default {})
columns_target_select_false	Target table columns to require to be False for selecting sources (List, default ('merge_peak_sky',))
columns_target_select_true	Target table columns to require to be True for selecting sources (List, default ('detect_isPrimary',))
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
coord_format	Configuration for coordinate conversion (ConvertCatalogCoordinatesConfig, default <class 'lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig'>)
filter_on_match_candidate	Whether to use provided column_match_candidate_[ref/target] to exclude rows from the output table.
include_unmatched	Whether to include unmatched rows in the matched table (bool, default False)
prefix_best_coord	A string prefix for ra/dec coordinate columns generated from the reference coordinate if available, and target otherwise.
refcat_sharding_type	The type of sharding (spatial splitting) for the reference catalog (str, default 'tract')
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
target_sharding_type	The type of sharding (spatial splitting) for the target catalog (str, default 'tract')

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

column_match_candidate_ref

The column name for the boolean field identifying reference objects that were used for matching (str, default 'match_candidate')

column_match_candidate_target

The column name for the boolean field identifying target objects that were used for matching (str, default 'match_candidate')

column_matched_prefix_ref

The prefix for matched columns copied from the reference catalog (str, default 'refcat_')

column_matched_prefix_target

The prefix for matched columns copied from the target catalog (str, default '')

columns_flux

Configs for flux columns for each band (ConfigDict, default {})

columns_in_ref

columns_in_target

columns_ref_copy

Reference table columns to copy into cat_matched (List, default [])

columns_ref_mag_to_nJy

Reference table AB mag columns to convert to nJy flux columns with new names (Dict, default {})

columns_target_coord_err

Target table coordinate columns with standard errors (sigma) (List)

columns_target_copy

Target table columns to copy into cat_matched (List, default ('patch',))

columns_target_mag_to_nJy

Target table AB mag columns to convert to nJy flux columns with new names (Dict, default {})

columns_target_select_false

Target table columns to require to be False for selecting sources (List, default ('merge_peak_sky',))

columns_target_select_true

Target table columns to require to be True for selecting sources (List, default ('detect_isPrimary',))

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

coord_format

Configuration for coordinate conversion (ConvertCatalogCoordinatesConfig, default <class 'lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig'>)

filter_on_match_candidate

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. (bool, default False)

include_unmatched

Whether to include unmatched rows in the matched table (bool, default False)

prefix_best_coord

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. (str, default None)

refcat_sharding_type

The type of sharding (spatial splitting) for the reference catalog (str, default 'tract')

Allowed values:

'tract'

Tract-based shards

'none'

No sharding at all

'None'

Field is optional

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

target_sharding_type

The type of sharding (spatial splitting) for the target catalog (str, default 'tract')

Allowed values:

'tract'

Tract-based shards

'none'

No sharding at all

'None'

Field is optional

Methods Documentation

validate()

Validate the Config, raising an exception if invalid.

Raises

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.