Compute the multi-band LombScargle periodogram of a DiaObject given a set of DiaSources.
Definition at line 272 of file diaCalculationPlugins.py.
◆ calculate()
| lsst.meas.base.diaCalculationPlugins.LombScarglePeriodogramMulti.calculate |
( |
| self, |
|
|
| diaObjects, |
|
|
| diaSources, |
|
|
** | kwargs ) |
Compute the multi-band LombScargle periodogram of a DiaObject given
a set of DiaSources.
Parameters
----------
diaObjects : `pandas.DataFrame`
Summary objects to store values in.
diaSources : `pandas.DataFrame` or `pandas.DataFrameGroupBy`
Catalog of DiaSources summarized by this DiaObject.
**kwargs : `dict`
Unused kwargs that are always passed to a plugin.
Reimplemented from lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.
Definition at line 364 of file diaCalculationPlugins.py.
◆ calculate_baluev_fap()
| lsst.meas.base.diaCalculationPlugins.LombScarglePeriodogramMulti.calculate_baluev_fap |
( |
| time, |
|
|
| n, |
|
|
| maxPeriod, |
|
|
| zmax ) |
|
static |
Calculate the False-Alarm probability using the Baluev approximation.
Parameters
----------
time : `array`
The input time axis.
n : `int`
The number of detections.
maxPeriod : `float`
The maximum period in the grid.
zmax : `float`
The maximum power in the grid.
Returns
-------
fap_estimate : `float`
The False-Alarm probability Baluev approximation.
Notes
----------
.. [1] Baluev, R. V. 2008, MNRAS, 385, 1279
.. [2] Süveges, M., Guy, L.P., Eyer, L., et al. 2015, MNRAS, 450, 2052
Definition at line 287 of file diaCalculationPlugins.py.
◆ fail()
| lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.fail |
( |
| self, |
|
|
| diaObject, |
|
|
| columns, |
|
|
| error = None ) |
|
inherited |
Set diaObject position values to nan.
Parameters
----------
diaObject : `dict`
Summary object to store values in.
columns : `list` of `str`
List of string names of columns to write a the failed value.
error : `BaseException` or `None`
Error to pass. Kept for consistency with CatologCalculationPlugin.
Unused.
Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.
Definition at line 141 of file diaCalculation.py.
◆ generate_lsp_params()
| lsst.meas.base.diaCalculationPlugins.LombScarglePeriodogramMulti.generate_lsp_params |
( |
| lsp_model, |
|
|
| fbest, |
|
|
| bands ) |
|
static |
Generate the Lomb-Scargle parameters.
Parameters
----------
lsp_model : `astropy.timeseries.LombScargleMultiband`
The Lomb-Scargle model.
fbest : `float`
The best period.
bands : `array`
The bands of the time series.
Returns
-------
Amp : `array`
The amplitude of the time series.
Ph : `array`
The phase of the time series.
Notes
----------
.. [1] VanderPlas, J. T., & Ivezic, Z. 2015, ApJ, 812, 18
Definition at line 321 of file diaCalculationPlugins.py.
◆ getExecutionOrder()
| lsst.meas.base.diaCalculationPlugins.LombScarglePeriodogramMulti.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 283 of file diaCalculationPlugins.py.
◆ getLogName()
| lsst.meas.base.pluginsBase.BasePlugin.getLogName |
( |
| self | ) |
|
|
inherited |
◆ getTransformClass()
| lsst.meas.base.pluginsBase.BasePlugin.getTransformClass |
( |
| ) |
|
|
staticinherited |
Get the measurement transformation appropriate to this plugin.
This returns a subclass of `transforms.MeasurementTransform`, which
may be instantiated with details of the algorithm configuration and
then called with information about calibration and WCS to convert from
raw measurement quantities to calibrated units. Calibrated data is
then provided in a separate output table.
Notes
-----
By default, we copy everything from the input to the output without
transformation.
Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.
Definition at line 169 of file pluginsBase.py.
◆ APCORR_ORDER
| float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0 |
|
staticinherited |
◆ CENTROID_ORDER
| float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0 |
|
staticinherited |
◆ config
| lsst.meas.base.pluginsBase.BasePlugin.config = config |
|
inherited |
◆ ConfigClass
◆ DEFAULT_CATALOGCALCULATION
| float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0 |
|
staticinherited |
◆ FLUX_MOMENTS_CALCULATED
| float lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.FLUX_MOMENTS_CALCULATED = 5.0 |
|
staticinherited |
◆ FLUX_ORDER
| float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0 |
|
staticinherited |
◆ inputCols
| list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.inputCols = [] |
|
staticinherited |
◆ logName
| lsst.meas.base.pluginsBase.BasePlugin.logName = logName |
|
inherited |
◆ name
| lsst.meas.base.pluginsBase.BasePlugin.name = name |
|
inherited |
◆ needsFilter
| bool lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.needsFilter = True |
|
staticinherited |
◆ outputCols
| list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.outputCols = [] |
|
staticinherited |
◆ plugType
| str lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single' |
|
staticinherited |
◆ registry
◆ SHAPE_ORDER
| float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0 |
|
staticinherited |
The documentation for this class was generated from the following file:
1.13.2