lsst.afw g5a732f18d5+53520f316c
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.afw.table._baseColumnView._BaseColumnViewBase Class Reference

Public Member Functions

 getBits (self, keys=None)
 
 __getitem__ (self, key)
 
 __setitem__ (self, key, value)
 
 get_bool_array (self, key)
 
 extract (self, *patterns, **kwds)
 

Static Public Attributes

 get = __getitem__
 
 set = __setitem__
 

Detailed Description

Definition at line 37 of file _baseColumnView.py.

Member Function Documentation

◆ __getitem__()

lsst.afw.table._baseColumnView._BaseColumnViewBase.__getitem__ ( self,
key )
Get a column view; key may be a key object or the name of a field.

Definition at line 64 of file _baseColumnView.py.

◆ __setitem__()

lsst.afw.table._baseColumnView._BaseColumnViewBase.__setitem__ ( self,
key,
value )
Set a full column to an array or scalar; key may be a key object or
the name of a field.

Definition at line 75 of file _baseColumnView.py.

◆ extract()

lsst.afw.table._baseColumnView._BaseColumnViewBase.extract ( self,
* 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
----------
patterns : Array 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 expression
        Any 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` or `re` pattern
        A 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.

Returns
-------
d : `dict`
    Dictionary of extracted name-column array sets.

Raises
------
ValueError
    Raised if a list of ``items`` is supplied with additional keywords.

Definition at line 115 of file _baseColumnView.py.

◆ get_bool_array()

lsst.afw.table._baseColumnView._BaseColumnViewBase.get_bool_array ( self,
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.

Returns
-------
value : `list` of `bool`
    Array of booleans corresponding to the flag.

Raises
------
TypeError
    Raised if the key is not a KeyFlag.

Definition at line 92 of file _baseColumnView.py.

◆ getBits()

lsst.afw.table._baseColumnView._BaseColumnViewBase.getBits ( self,
keys = None )
Get the bits associated with the specified keys.

Parameters
----------
key : `str`
    Key to retrieve. Unlike the C++ version, each key may be a
    field name or a key, and if keys is `None` then all bits
    are returned.

Returns
-------
bits : `int`
     Integer array of the requested bitmask.

Definition at line 39 of file _baseColumnView.py.

Member Data Documentation

◆ get

lsst.afw.table._baseColumnView._BaseColumnViewBase.get = __getitem__
static

Definition at line 73 of file _baseColumnView.py.

◆ set

lsst.afw.table._baseColumnView._BaseColumnViewBase.set = __setitem__
static

Definition at line 81 of file _baseColumnView.py.


The documentation for this class was generated from the following file: