LombScarglePeriodogram#

class lsst.meas.base.LombScarglePeriodogram(config, name, metadata)#

Compute the single-band period of a DiaObject given a set of DiaSources.

Attributes Summary

`needsFilter`	This plugin requires a filter to be specified.
`outputCols`	DiaObject column names output by the plugin.
`plugType`	Does the plugin operate on a single source or the whole catalog (`str`)? If the plugin operates on a single source at a time, this should be set to `"single"`; if it expects the whoe catalog, to `"multi"`.

Methods Summary

`calculate`(diaObjects, diaSources, ...)	Compute the periodogram.
`getExecutionOrder`()	Used to set the relative order of plugin execution.

Attributes Documentation

needsFilter = True#: This plugin requires a filter to be specified. Plugin’s using filter names usually deal with fluxes and only a sub-set of the DiaSource catalog. Plugins that to not use the filter name usually run over a value common across all observations/detections such as position.

outputCols = ['period', 'power']#: DiaObject column names output by the plugin. DiaCalculationTask should raise an error if another pluging is run output to the same column. Output columns should be defined in the DPDD/cat/Apdb schema. Filter dependent columns should be specified without the filter name perpended to them. eg psfFluxMean instead of u_psfFluxMean.

plugType = 'multi'#: Does the plugin operate on a single source or the whole catalog (str)? If the plugin operates on a single source at a time, this should be set to "single"; if it expects the whoe catalog, to "multi". If the plugin is of type "multi", the fail method must be implemented to accept the whole catalog. If the plugin is of type "single", fail should accept a single source record.

Methods Documentation

calculate(diaObjects, diaSources, filterDiaSources, band)#

Compute the periodogram.

Parameters#

diaObjectspandas.DataFrame: Summary objects to store values in.
diaSourcespandas.DataFrame or pandas.DataFrameGroupBy: Catalog of DiaSources summarized by this DiaObject.

classmethod getExecutionOrder()#

Used to set the relative order of plugin execution.

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

All plugins must implement this method with an appropriate run level