lsst.afw.table

The lsst.afw.table module provides handlers for tables of data, catalogs, and data records that comprise both for the LSST Science Pipelines.

This module is a part of the larger lsst.afw package that provides the foundation of the pipelines.

Contributing

lsst.afw.table is developed at https://github.com/lsst/afw. You can find Jira issues for this module under the afw component.

Python API reference

lsst.afw.table Package

Functions

clone(self)
copyAliasMapWithPrefix(inSchema, outSchema) Copy an alias map from one schema into another.
copyIntoCatalog(catalog, target[, …]) Copy entries from one Catalog into another.
makeMergedSchema(sourceSchema, targetSchema) Return a schema that is a deep copy of a mapping between source and target schemas.
matchRaDec(*args, **kwargs) Overloaded function.
matchXy(*args, **kwargs) Overloaded function.
matchesFromCatalog(catalog[, sourceSlotConfig]) Generate a list of ReferenceMatches from a Catalog of “unpacked matches”.
matchesToCatalog(matches, matchMeta) Denormalise matches into a Catalog of “unpacked matches”.
packMatches(matches) Make a catalog of matches from a sequence of matches.
reindexCatalog(catalog, indices[, deep]) Apply a numpy index array to an afw Catalog
unpackMatches(*args, **kwargs) Overloaded function.
updateRefCentroids(*args, **kwargs) Overloaded function.
updateSourceCoords(*args, **kwargs) Overloaded function.

Classes

AliasMap
ArrayDKey
ArrayFKey
ArrayKey
BaseCatalog
BaseColumnView
BaseRecord
BaseTable
BitsColumn
Box2DKey
Box2IKey
Catalog
Centroid
CoordKey
CoordinateType
CovarianceMatrix2dKey
CovarianceMatrix2fKey
CovarianceMatrix3dKey
CovarianceMatrix3fKey
CovarianceMatrix4dKey
CovarianceMatrix4fKey
CovarianceMatrixKey
CovarianceMatrixXdKey
CovarianceMatrixXfKey
EllipseKey
ExposureCatalog
ExposureColumnView
ExposureRecord
ExposureTable
Field
FieldAngle
FieldArrayB
FieldArrayD
FieldArrayF
FieldArrayI
FieldArrayU
FieldB
FieldBaseAngle
FieldBaseArrayB
FieldBaseArrayD
FieldBaseArrayF
FieldBaseArrayI
FieldBaseArrayU
FieldBaseB
FieldBaseD
FieldBaseF
FieldBaseFlag
FieldBaseI
FieldBaseL
FieldBaseString
FieldBaseU
FieldD
FieldF
FieldFlag
FieldI
FieldL
FieldString
FieldU
Flux
GroupView(schema, ids, groups) A mapping (i.e.
IdFactory
Key
KeyAngle
KeyArrayB
KeyArrayD
KeyArrayF
KeyArrayI
KeyArrayU
KeyB
KeyBaseAngle
KeyBaseArrayB
KeyBaseArrayD
KeyBaseArrayF
KeyBaseArrayI
KeyBaseArrayU
KeyBaseB
KeyBaseD
KeyBaseF
KeyBaseFlag
KeyBaseI
KeyBaseL
KeyBaseString
KeyBaseU
KeyD
KeyF
KeyFlag
KeyI
KeyL
KeyString
KeyU
MatchControl
MultiMatch(schema, dataIdFormat[, …]) Initialize a multi-catalog match.
Point2DKey
Point2IKey
Point3DKey
Point3IKey
PointKey
QuadrupoleKey
ReferenceMatch
Schema
SchemaItem
SchemaItemAngle
SchemaItemArrayB
SchemaItemArrayD
SchemaItemArrayF
SchemaItemArrayI
SchemaItemArrayU
SchemaItemB
SchemaItemD
SchemaItemF
SchemaItemFlag
SchemaItemI
SchemaItemL
SchemaItemString
SchemaItemU
SchemaMapper
Shape
SimpleCatalog
SimpleColumnView
SimpleMatch
SimpleRecord
SimpleTable
SlotDefinition
SourceCatalog
SourceColumnView
SourceMatch
SourceRecord
SourceTable
SubSchema
matchCls alias of lsst.afw.table.SourceMatch

Class Inheritance Diagram

Inheritance diagram of lsst.afw.table.AliasMap, lsst.afw.table.ArrayDKey, lsst.afw.table.ArrayFKey, lsst.afw.table._arrays.ArrayKey, lsst.afw.table.BaseCatalog, lsst.afw.table.BaseColumnView, lsst.afw.table.BaseRecord, lsst.afw.table.BaseTable, lsst.afw.table.BitsColumn, lsst.afw.table.Box2DKey, lsst.afw.table.Box2IKey, lsst.afw.table._base.Catalog, lsst.afw.table.Centroid, lsst.afw.table.CoordKey, lsst.afw.table.CoordinateType, lsst.afw.table.CovarianceMatrix2dKey, lsst.afw.table.CovarianceMatrix2fKey, lsst.afw.table.CovarianceMatrix3dKey, lsst.afw.table.CovarianceMatrix3fKey, lsst.afw.table.CovarianceMatrix4dKey, lsst.afw.table.CovarianceMatrix4fKey, lsst.afw.table._aggregates.CovarianceMatrixKey, lsst.afw.table.CovarianceMatrixXdKey, lsst.afw.table.CovarianceMatrixXfKey, lsst.afw.table.EllipseKey, lsst.afw.table.ExposureCatalog, lsst.afw.table.ExposureColumnView, lsst.afw.table.ExposureRecord, lsst.afw.table.ExposureTable, lsst.afw.table._schema.Field, lsst.afw.table.FieldAngle, lsst.afw.table.FieldArrayB, lsst.afw.table.FieldArrayD, lsst.afw.table.FieldArrayF, lsst.afw.table.FieldArrayI, lsst.afw.table.FieldArrayU, lsst.afw.table.FieldB, lsst.afw.table.FieldBaseAngle, lsst.afw.table.FieldBaseArrayB, lsst.afw.table.FieldBaseArrayD, lsst.afw.table.FieldBaseArrayF, lsst.afw.table.FieldBaseArrayI, lsst.afw.table.FieldBaseArrayU, lsst.afw.table.FieldBaseB, lsst.afw.table.FieldBaseD, lsst.afw.table.FieldBaseF, lsst.afw.table.FieldBaseFlag, lsst.afw.table.FieldBaseI, lsst.afw.table.FieldBaseL, lsst.afw.table.FieldBaseString, lsst.afw.table.FieldBaseU, lsst.afw.table.FieldD, lsst.afw.table.FieldF, lsst.afw.table.FieldFlag, lsst.afw.table.FieldI, lsst.afw.table.FieldL, lsst.afw.table.FieldString, lsst.afw.table.FieldU, lsst.afw.table.Flux, lsst.afw.table.multiMatch.GroupView, lsst.afw.table.IdFactory, lsst.afw.table._schema.Key, lsst.afw.table.KeyAngle, lsst.afw.table.KeyArrayB, lsst.afw.table.KeyArrayD, lsst.afw.table.KeyArrayF, lsst.afw.table.KeyArrayI, lsst.afw.table.KeyArrayU, lsst.afw.table.KeyB, lsst.afw.table.KeyBaseAngle, lsst.afw.table.KeyBaseArrayB, lsst.afw.table.KeyBaseArrayD, lsst.afw.table.KeyBaseArrayF, lsst.afw.table.KeyBaseArrayI, lsst.afw.table.KeyBaseArrayU, lsst.afw.table.KeyBaseB, lsst.afw.table.KeyBaseD, lsst.afw.table.KeyBaseF, lsst.afw.table.KeyBaseFlag, lsst.afw.table.KeyBaseI, lsst.afw.table.KeyBaseL, lsst.afw.table.KeyBaseString, lsst.afw.table.KeyBaseU, lsst.afw.table.KeyD, lsst.afw.table.KeyF, lsst.afw.table.KeyFlag, lsst.afw.table.KeyI, lsst.afw.table.KeyL, lsst.afw.table.KeyString, lsst.afw.table.KeyU, lsst.afw.table.MatchControl, lsst.afw.table.multiMatch.MultiMatch, lsst.afw.table.Point2DKey, lsst.afw.table.Point2IKey, lsst.afw.table.Point3DKey, lsst.afw.table.Point3IKey, lsst.afw.table._aggregates.PointKey, lsst.afw.table.QuadrupoleKey, lsst.afw.table.ReferenceMatch, lsst.afw.table.Schema, lsst.afw.table._schema.SchemaItem, lsst.afw.table.SchemaItemAngle, lsst.afw.table.SchemaItemArrayB, lsst.afw.table.SchemaItemArrayD, lsst.afw.table.SchemaItemArrayF, lsst.afw.table.SchemaItemArrayI, lsst.afw.table.SchemaItemArrayU, lsst.afw.table.SchemaItemB, lsst.afw.table.SchemaItemD, lsst.afw.table.SchemaItemF, lsst.afw.table.SchemaItemFlag, lsst.afw.table.SchemaItemI, lsst.afw.table.SchemaItemL, lsst.afw.table.SchemaItemString, lsst.afw.table.SchemaItemU, lsst.afw.table.SchemaMapper, lsst.afw.table.Shape, lsst.afw.table.SimpleCatalog, lsst.afw.table.SimpleColumnView, lsst.afw.table.SimpleMatch, lsst.afw.table.SimpleRecord, lsst.afw.table.SimpleTable, lsst.afw.table.SlotDefinition, lsst.afw.table.SourceCatalog, lsst.afw.table.SourceColumnView, lsst.afw.table.SourceMatch, lsst.afw.table.SourceRecord, lsst.afw.table.SourceTable, lsst.afw.table.SubSchema, lsst.afw.table.SourceMatch

lsst.afw.table.io Package

Class Inheritance Diagram

Inheritance diagram of lsst.afw.table.io.InputArchive, lsst.afw.table.io.OutputArchive, lsst.afw.table.io.Persistable

lsst.afw.table.testUtils Module

Functions

assertSchemasEqual(testCase, schema1, schema2) Assert that two Schemas are equal.
diffSchemas(schema1, schema2[, flags]) Return a string diff of two schemas.
joinWords(items) Join a sequence of words into a comma-separated, ‘and’-finalized string with correct English syntax.