SourceColumnView¶
- class lsst.afw.table.SourceColumnView¶
Bases:
_SourceColumnViewBase
Attributes Summary
Methods Summary
extract
(*patterns, **kwds)Extract a dictionary of {<name>: <column-array>} in which the field names match the given shell-style glob pattern(s).
get
(key)Get a column view; key may be a key object or the name of a field.
getAllBits
(self)getApInstFlux
(self)getApInstFluxErr
(self)getBits
([keys])Get the bits associated with the specified keys.
getCalibInstFlux
(self)getCalibInstFluxErr
(self)getGaussianInstFlux
(self)getGaussianInstFluxErr
(self)getIxx
(self)getIxy
(self)getIyy
(self)getModelInstFlux
(self)getModelInstFluxErr
(self)getPsfInstFlux
(self)getPsfInstFluxErr
(self)getSchema
(self)getTable
(self)getX
(self)getY
(self)get_bool_array
(key)Get the value of a flag column as a boolean array; key must be a key object or the name of a field.
set
(key, value)Set a full column to an array or scalar; key may be a key object or the name of a field.
Attributes Documentation
- schema¶
- table¶
Methods Documentation
- extract(*patterns, **kwds)¶
Extract a dictionary of {<name>: <column-array>} in which the field names match the given shell-style glob pattern(s).
Any number of glob patterns may be passed (including none); the result will be the union of all the result of each glob considered separately.
Note that extract(“*”, copy=True) provides an easy way to transform a row-major ColumnView into a possibly more efficient set of contiguous NumPy arrays.
String fields are silently ignored. Support for
Flag
columns is deprecated; at present they are copied into full boolean arrays, but after v26 they will be silently ignored as well.- Parameters:
- patternsArray of
str
List of glob patterns to use to select field names.
- kwds
dict
Dictionary of additional keyword arguments. May contain:
items
list
The result of a call to self.schema.extract(); this will be used instead of doing any new matching, and allows the pattern matching to be reused to extract values from multiple records. This keyword is incompatible with any position arguments and the regex, sub, and ordered keyword arguments.
where
array index expressionAny expression that can be passed as indices to a NumPy array, including slices, boolean arrays, and index arrays, that will be used to index each column array. This is applied before arrays are copied when copy is True, so if the indexing results in an implicit copy no unnecessary second copy is performed.
copy
bool
If True, the returned arrays will be contiguous copies rather than strided views into the catalog. This ensures that the lifetime of the catalog is not tied to the lifetime of a particular catalog, and it also may improve the performance if the array is used repeatedly. Default is False.
regex
str
orre
patternA regular expression to be used in addition to any glob patterns passed as positional arguments. Note that this will be compared with re.match, not re.search.
sub
str
A replacement string (see re.MatchObject.expand) used to set the dictionary keys of any fields matched by regex.
ordered
bool
If True, a collections.OrderedDict will be returned instead of a standard dict, with the order corresponding to the definition order of the Schema. Default is False.
- patternsArray of
- Returns:
- d
dict
Dictionary of extracted name-column array sets.
- d
- Raises:
- ValueError
Raised if a list of
items
is supplied with additional keywords.
- get(key)¶
Get a column view; key may be a key object or the name of a field.
- getAllBits(self: lsst.afw.table._BaseColumnViewBase) lsst.afw.table.BitsColumn ¶
- getApInstFlux(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getApInstFluxErr(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getBits(keys=None)¶
Get the bits associated with the specified keys.
- getCalibInstFlux(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getCalibInstFluxErr(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getGaussianInstFlux(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getGaussianInstFluxErr(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getIxx(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getIxy(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getIyy(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getModelInstFlux(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getModelInstFluxErr(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getPsfInstFlux(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getPsfInstFluxErr(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getPsfIxx()¶
- getPsfIxy()¶
- getPsfIyy()¶
- getSchema(self: lsst.afw.table._BaseColumnViewBase) lsst.afw.table.Schema ¶
- getTable(self: lsst.afw.table._SourceColumnViewBase) lsst.afw.table.SourceTable ¶
- getX(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- getY(self: lsst.afw.table.SourceColumnView) numpy.ndarray ¶
- get_bool_array(key)¶
Get the value of a flag column as a boolean array; key must be a key object or the name of a field.
- Parameters:
- key
lsst.afw.table.KeyFlag
Flag column to search for.
- key
- Returns:
- Raises:
- TypeError
Raised if the key is not a KeyFlag.
Deprecated since version v26: Catalog.__getitem__ now provides better support for accessing Flag/bool columns. Will be removed after v26.
- set(key, value)¶
Set a full column to an array or scalar; key may be a key object or the name of a field.