lsst.pipe.tasks g88ce0b65e2+63aa580cb9
Loading...
Searching...
No Matches
Classes | Functions | Variables
lsst.pipe.tasks.diff_matched_tract_catalog Namespace Reference

Classes

class  DiffMatchedTractCatalogConfig
 
class  DiffMatchedTractCatalogConnections
 
class  DiffMatchedTractCatalogTask
 
class  MatchedCatalogFluxesConfig
 
class  MatchType
 
class  MeasurementType
 
class  MeasurementTypeInfo
 
class  Median
 
class  Percentile
 
class  SigmaIQR
 
class  SigmaMAD
 
class  SourceType
 
class  SourceTypeInfo
 
class  Statistic
 

Functions

 is_sequence_set (Sequence x)
 
 is_percentile (str x)
 
 _get_stat_name (*args)
 
 _get_column_name (band, *args)
 
 compute_stats (values_ref, values_target, errors_target, row, stats, suffixes, prefix, skip_diff=False)
 
 _get_columns (Dict bands_columns, Dict suffixes, Dict suffixes_flux, Dict suffixes_mag, Dict stats, ComparableCatalog target, str column_dist)
 

Variables

dict DiffMatchedTractCatalogBaseTemplates
 

Function Documentation

◆ _get_column_name()

lsst.pipe.tasks.diff_matched_tract_catalog._get_column_name ( band,
* args )
protected

Definition at line 401 of file diff_matched_tract_catalog.py.

◆ _get_columns()

lsst.pipe.tasks.diff_matched_tract_catalog._get_columns ( Dict bands_columns,
Dict suffixes,
Dict suffixes_flux,
Dict suffixes_mag,
Dict stats,
ComparableCatalog target,
str column_dist )
protected
Get column names for a table of difference statistics.

Parameters
----------
bands_columns : `Dict` [`str`,`MatchedCatalogFluxesConfig`]
    Dict keyed by band of flux column configuration.
suffixes, suffixes_flux, suffixes_mag : `Dict` [`MeasurementType`, `str`]
    Dict of suffixes for each `MeasurementType` type, for general columns (e.g.
    coordinates), fluxes and magnitudes, respectively.
stats : `Dict` [`str`, `Statistic`]
    Dict of suffixes for each `Statistic` type.
target : `ComparableCatalog`
    A target catalog with coordinate column names.
column_dist : `str`
    The name of the distance column.

Returns
-------
columns : `Dict` [`str`, `type`]
    Dictionary of column types keyed by name.
n_models : `int`
    The number of models measurements will be made for.

Notes
-----
Presently, models must be identical for each band.

Definition at line 476 of file diff_matched_tract_catalog.py.

◆ _get_stat_name()

lsst.pipe.tasks.diff_matched_tract_catalog._get_stat_name ( * args)
protected

Definition at line 397 of file diff_matched_tract_catalog.py.

◆ compute_stats()

lsst.pipe.tasks.diff_matched_tract_catalog.compute_stats ( values_ref,
values_target,
errors_target,
row,
stats,
suffixes,
prefix,
skip_diff = False )
Compute statistics on differences and store results in a row.

Parameters
----------
values_ref : `numpy.ndarray`, (N,)
    Reference values.
values_target : `numpy.ndarray`, (N,)
    Measured values.
errors_target : `numpy.ndarray`, (N,)
    Errors (standard deviations) on `values_target`.
row : `numpy.ndarray`, (1, C)
    A numpy array with pre-assigned column names.
stats : `Dict` [`str`, `Statistic`]
    A dict of `Statistic` values to measure, keyed by their column suffix.
suffixes : `Dict` [`MeasurementType`, `str`]
    A dict of measurement type column suffixes, keyed by the measurement type.
prefix : `str`
    A prefix for all column names (e.g. band).
skip_diff : `bool`
    Whether to skip computing statistics on differences. Note that
    differences will still be computed for chi statistics.

Returns
-------
row_with_stats : `numpy.ndarray`, (1, C)
    The original `row` with statistic values assigned.

Definition at line 405 of file diff_matched_tract_catalog.py.

◆ is_percentile()

lsst.pipe.tasks.diff_matched_tract_catalog.is_percentile ( str x)

Definition at line 53 of file diff_matched_tract_catalog.py.

◆ is_sequence_set()

lsst.pipe.tasks.diff_matched_tract_catalog.is_sequence_set ( Sequence x)

Definition at line 49 of file diff_matched_tract_catalog.py.

Variable Documentation

◆ DiffMatchedTractCatalogBaseTemplates

dict lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogBaseTemplates
Initial value:
1= {
2 "name_input_cat_ref": "truth_summary",
3 "name_input_cat_target": "objectTable_tract",
4 "name_skymap": BaseSkyMap.SKYMAP_DATASET_TYPE_NAME,
5}

Definition at line 57 of file diff_matched_tract_catalog.py.