lsst.meas.base 22.0.1-26-g26961ef+b4cfca32e7
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition Class Reference
Inheritance diagram for lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition:
lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin lsst.meas.base.catalogCalculation.CatalogCalculationPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def __init__ (self, config, name, metadata)
 
def getExecutionOrder (cls)
 
def calculate (self, diaObjects, diaObjectId, **kwargs)
 

Public Attributes

 pixelator
 

Static Public Attributes

 ConfigClass = HTMIndexDiaPositionConfig
 
string plugType = 'single'
 
list inputCols = ["ra", "decl"]
 
list outputCols = ["pixelId"]
 
bool needsFilter = False
 

Detailed Description

Compute the mean position of a DiaObject given a set of DiaSources.

Notes
-----
This plugin was implemented to satisfy requirements of old APDB interface
which required ``pixelId`` column in DiaObject with HTM20 index. APDB
interface had migrated to not need that information, but we keep this
plugin in case it may be useful for something else.

Definition at line 148 of file diaCalculationPlugins.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.__init__ (   self,
  config,
  name,
  metadata 
)

Member Function Documentation

◆ calculate()

def lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.calculate (   self,
  diaObjects,
  diaObjectId,
**  kwargs 
)
Compute the mean position of a DiaObject given a set of DiaSources

Parameters
----------
diaObjects : `pandas.dataFrame`
    Summary objects to store values in and read ra/decl from.
diaObjectId : `int`
    Id of the diaObject to update.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Reimplemented from lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.

Definition at line 174 of file diaCalculationPlugins.py.

◆ getExecutionOrder()

def lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.getExecutionOrder (   cls)
Used to set the relative order of plugin execution.

The values returned by `getExecutionOrder` are compared across all
plugins, and smaller numbers run first.

Notes
-----
`CatalogCalculationPlugin`\s must run with
`BasePlugin.DEFAULT_CATALOGCALCULATION` or higher.

All plugins must implement this method with an appropriate run level

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 171 of file diaCalculationPlugins.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.ConfigClass = HTMIndexDiaPositionConfig
static

Definition at line 158 of file diaCalculationPlugins.py.

◆ inputCols

list lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.inputCols = ["ra", "decl"]
static

Definition at line 162 of file diaCalculationPlugins.py.

◆ needsFilter

bool lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.needsFilter = False
static

Definition at line 164 of file diaCalculationPlugins.py.

◆ outputCols

list lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.outputCols = ["pixelId"]
static

Definition at line 163 of file diaCalculationPlugins.py.

◆ pixelator

lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.pixelator

Definition at line 168 of file diaCalculationPlugins.py.

◆ plugType

string lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition.plugType = 'single'
static

Definition at line 160 of file diaCalculationPlugins.py.


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