TransformObjectCatalogConfig#

class lsst.pipe.tasks.postprocess.TransformObjectCatalogConfig(*args, **kw)#

Bases: TransformCatalogBaseConfig

Attributes Summary

camelCase

Write per-band columns names with camelCase, else underscore For example: gPsFlux instead of g_PsFlux.

coaddName

Name of coadd (str, default 'deep')

columnsFromDataId

Columns to extract from the dataId (List, default None)

connections

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

floatFillValue

Fill value for float fields when populating empty tables.

functorFile

Path to YAML file specifying Science Data Model functors to use when copying columns and computing calibrated values.

goodFlags

List of 'good' flags that should be set False when populating empty tables.

integerFillValue

Fill value for integer fields when populating empty tables.

multilevelOutput

Whether results dataframe should have a multilevel column index (True) or be flat and name-munged (False).

outputBands

These bands and only these bands will appear in the output, NaN-filled if the input does not include them.

primaryKey

Name of column to be set as the DataFrame index.

saveLogOutput

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

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

camelCase#

Write per-band columns names with camelCase, else underscore For example: gPsFlux instead of g_PsFlux. (bool, default False)

coaddName#

Name of coadd (str, default 'deep')

columnsFromDataId#

Columns to extract from the dataId (List, default None)

connections: pexConfig.ConfigField#

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

floatFillValue#

Fill value for float fields when populating empty tables. (float, default nan)

functorFile#

Path to YAML file specifying Science Data Model functors to use when copying columns and computing calibrated values. (str, default None)

goodFlags#

List of ‘good’ flags that should be set False when populating empty tables. All other flags are considered to be ‘bad’ flags and will be set to True. (List, default [])

integerFillValue#

Fill value for integer fields when populating empty tables. (int, default -1)

multilevelOutput#

Whether results dataframe should have a multilevel column index (True) or be flat and name-munged (False). If True, the output storage class will be set to DataFrame, since astropy tables do not support multi-level indexing. Deprecated: Support for multi-level outputs is deprecated and will be removed after v29. (bool, default False)

outputBands#

These bands and only these bands will appear in the output, NaN-filled if the input does not include them. If None, then use all bands found in the input. (List, default None)

primaryKey#

Name of column to be set as the DataFrame index. If None, the indexwill be named id (str, default None)

saveLogOutput#

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

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.