SourceObjectTableAnalysisConfig#

class lsst.analysis.tools.tasks.SourceObjectTableAnalysisConfig(*args, **kw)#

Bases: AnalysisBaseConfig

Attributes Summary

`addOutputNamePrefix`	If True, the connections class output name will be prefixed to the analysis 'atools' name when the value is dispatched to sasquatch.
`applyAstrometricCorrections`	Apply proper motions and parallaxes to source positions.
`astrometricCorrectionParameters`	Column names for position and motion parameters in the astrometric correction catalogs.
`atools`	The analysis tools that are to be run by this task at execution (`ConfigurableActionStructField`)
`bands`	Filter bands on which to run all of the actions (`List`, default `['u', 'g', 'r', 'i', 'z', 'y']`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`correctionsMatchingRadius`	Radius in mas with which to match the mean positions of the sources with the positions in the astrometricCorrectionCatalog.
`dataset_identifier`	An identifier to be associated with output Metrics (`str`, default `None`)
`dec_column`	Name of column in refCat to use for declination.
`epoch_column`	Name of column in refCat corresponding to the epoch to which sources will be shifted.
`metric_tags`	List of tags which will be added to all configurable actions (`List`, default `[]`)
`metrics`	The analysis tools that are to be run by this task at execution (`ConfigurableActionStructField`)
`plots`	The analysis tools that are to be run by this task at execution (`ConfigurableActionStructField`)
`ra_column`	Name of column in refCat to use for right ascension.
`refCatMatchingRadius`	Radius in mas with which to match the mean positions of the sources with the positions in the reference catalog.
`refCat_bands`	Bands in refCat to be combined with `refCat_selectors` to build refCat column names.
`refCat_selectors`	Remove objects for which these flags are true.
`reference_package`	A package who's version, at the time of metric upload to a time series database, will be converted to a timestamp of when that version was produced (`str`, default `'lsst_distrib'`)
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`timestamp_version`	Which time stamp should be used as the reference timestamp for a metric in a time series database, valid values are; reference_package_timestamp, run_timestamp, current_timestamp, dataset_timestamp and explicit_timestamp:datetime where datetime is given in the form %Y%m%dT%H%M%S%z (`str`, default `'run_timestamp'`)

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

addOutputNamePrefix#: If True, the connections class output name will be prefixed to the analysis ‘atools’ name when the value is dispatched to sasquatch. (bool, default False)

applyAstrometricCorrections#: Apply proper motions and parallaxes to source positions. (bool, default True)

astrometricCorrectionParameters#: Column names for position and motion parameters in the astrometric correction catalogs. (Dict, default {'ra': 'ra', 'dec': 'dec', 'pmRA': 'raPM', 'pmDec': 'decPM', 'parallax': 'parallax', 'isolated_star_id': 'isolated_star_id'})

atools#: The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

bands#: Filter bands on which to run all of the actions (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

correctionsMatchingRadius#: Radius in mas with which to match the mean positions of the sources with the positions in the astrometricCorrectionCatalog. (float, default 0.2)

dataset_identifier#: An identifier to be associated with output Metrics (str, default None)

dec_column#: Name of column in refCat to use for declination. (str, default 'r_dec')

epoch_column#: Name of column in refCat corresponding to the epoch to which sources will be shifted. Should correspond to the positions in ra_column and dec_column. (str, default 'r_epoch')

metric_tags#: List of tags which will be added to all configurable actions (List, default [])

metrics#: The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

plots#: The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

ra_column#: Name of column in refCat to use for right ascension. (str, default 'r_ra')

refCatMatchingRadius#: Radius in mas with which to match the mean positions of the sources with the positions in the reference catalog. (float, default 1.0)

refCat_bands#: Bands in refCat to be combined with refCat_selectors to build refCat column names. (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

refCat_selectors#: Remove objects for which these flags are true. These strings are combined with refCat_bands to build the full refCat column names (List, default ['pixelFlags_saturated', 'pixelFlags_saturatedCenter'])

reference_package#: A package who’s version, at the time of metric upload to a time series database, will be converted to a timestamp of when that version was produced (str, default 'lsst_distrib')

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

timestamp_version#: Which time stamp should be used as the reference timestamp for a metric in a time series database, valid values are; reference_package_timestamp, run_timestamp, current_timestamp, dataset_timestamp and explicit_timestamp:datetime where datetime is given in the form %Y%m%dT%H%M%S%z (str, default 'run_timestamp')

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

SourceObjectTableAnalysisConfig#

Notes#