PeakRecord

class lsst.afw.detection.PeakRecord

Bases: lsst.afw.table.BaseRecord

Attributes Summary

schema
table

Methods Summary

assign(*args, **kwargs) Overloaded function.
extract(*patterns, **kwargs) Extract a dictionary of {<name>: <field-value>} in which the field names match the given shell-style glob pattern(s).
get(self, arg0)
getAngle(self, arg0)
getArrayB(self, arg0)
getArrayD(self, arg0)
getArrayF(self, arg0)
getArrayI(self, arg0)
getArrayU(self, arg0)
getB(self, arg0)
getCentroid(*args, **kwargs) Overloaded function.
getD(self, arg0)
getF(self)
getFlag(self, arg0)
getFx(self)
getFy(self)
getI(self)
getId(self)
getIx(self)
getIy(self)
getL(self, arg0)
getPeakValue(self)
getSchema(self)
getString(self, arg0)
getTable(self)
getU(self, arg0)
set(self, arg0, arg1)
setAngle(self, arg0, arg1)
setArrayB(self, arg0, arg1)
setArrayD(self, arg0, arg1)
setArrayF(self, arg0, arg1)
setArrayI(self, arg0, arg1)
setArrayU(self, arg0, arg1)
setB(self, arg0, arg1)
setD(self, arg0, arg1)
setF(self, arg0, arg1)
setFlag(self, arg0, arg1)
setFx(self, arg0)
setFy(self, arg0)
setI(self, arg0, arg1)
setId(self, arg0)
setIx(self, arg0)
setIy(self, arg0)
setL(self, arg0, arg1)
setPeakValue(self, arg0)
setString(self, arg0, arg1)
setU(self, arg0, arg1)

Attributes Documentation

schema
table

Methods Documentation

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.BaseRecord) -> None
  2. assign(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.BaseRecord, arg1: lsst.afw.table.SchemaMapper) -> None
extract(*patterns, **kwargs)

Extract a dictionary of {<name>: <field-value>} in which the field names match the given shell-style glob pattern(s).

Any number of glob patterns may be passed; the result will be the union of all the result of each glob considered separately.

Parameters:
items : dict

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.

split : bool

If True, fields with named subfields (e.g. points) will be split into separate items in the dict; instead of {“point”: lsst.geom.Point2I(2,3)}, for instance, you’d get {“point.x”: 2, “point.y”: 3}. Default is False.

regex : str or re pattern object

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.

get(self: object, arg0: object) → object
getAngle(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyAngle) → lsst::geom::Angle
getArrayB(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayB) → numpy.ndarray
getArrayD(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayD) → numpy.ndarray
getArrayF(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayF) → numpy.ndarray
getArrayI(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayI) → numpy.ndarray
getArrayU(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayU) → numpy.ndarray
getB(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyB) → int
getCentroid(*args, **kwargs)

Overloaded function.

  1. getCentroid(self: lsst.afw.detection.PeakRecord, arg0: bool) -> lsst.geom.Point2I
  2. getCentroid(self: lsst.afw.detection.PeakRecord) -> lsst.geom.Point2D
getD(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyD) → float
getF(self: lsst.afw.detection.PeakRecord) → lsst.geom.Point2D
getFlag(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyFlag) → bool
getFx(self: lsst.afw.detection.PeakRecord) → float
getFy(self: lsst.afw.detection.PeakRecord) → float
getI(self: lsst.afw.detection.PeakRecord) → lsst.geom.Point2I
getId(self: lsst.afw.detection.PeakRecord) → int
getIx(self: lsst.afw.detection.PeakRecord) → int
getIy(self: lsst.afw.detection.PeakRecord) → int
getL(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyL) → int
getPeakValue(self: lsst.afw.detection.PeakRecord) → float
getSchema(self: lsst.afw.table.BaseRecord) → lsst.afw.table.Schema
getString(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyString) → str
getTable(self: lsst.afw.detection.PeakRecord) → lsst.afw.detection.PeakTable
getU(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyU) → int
set(self: object, arg0: object, arg1: object) → None
setAngle(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyAngle, arg1: lsst::geom::Angle) → None
setArrayB(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayB, arg1: object) → None
setArrayD(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayD, arg1: object) → None
setArrayF(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayF, arg1: object) → None
setArrayI(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayI, arg1: object) → None
setArrayU(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyArrayU, arg1: object) → None
setB(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyB, arg1: int) → None
setD(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyD, arg1: float) → None
setF(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyF, arg1: float) → None
setFlag(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyFlag, arg1: bool) → None
setFx(self: lsst.afw.detection.PeakRecord, arg0: float) → None
setFy(self: lsst.afw.detection.PeakRecord, arg0: float) → None
setI(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyI, arg1: int) → None
setId(self: lsst.afw.detection.PeakRecord, arg0: int) → None
setIx(self: lsst.afw.detection.PeakRecord, arg0: int) → None
setIy(self: lsst.afw.detection.PeakRecord, arg0: int) → None
setL(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyL, arg1: int) → None
setPeakValue(self: lsst.afw.detection.PeakRecord, arg0: float) → None
setString(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyString, arg1: str) → None
setU(self: lsst.afw.table.BaseRecord, arg0: lsst.afw.table.KeyU, arg1: int) → None