Source code for feets.extractors.ext_std

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2017-2024, Cabral, Juan
# Copyright (c) 2025, QuatroPe; Clariá, Felipe
# License: MIT
# Full Text:
#     https://github.com/quatrope/feets/blob/master/LICENSE

# =============================================================================
# DOC
# =============================================================================

"""Standard deviation extractor."""

# =============================================================================
# IMPORTS
# =============================================================================

from light_curve import StandardDeviation as _StandardDeviation

from .light_curve_extractor import LightCurveExtractor
from ..libs import doctools


# =============================================================================
# EXTRACTOR CLASS
# =============================================================================




class Std(LightCurveExtractor):
    r"""Standard deviation of magnitude.

    **Std** (:math:`\sigma_m`)

    .. math::

        \sigma_m = \sqrt{\sum_i (m_i - \langle m \rangle)^2 / (N-1)}

    where :math:`N` is the number of observations and :math:`\langle m \rangle`
    is the mean magnitude.

    Parameters
    ----------
    transform : str or bool or None, optional
        Transformer to apply to the feature values. If str, must be one of:

        - 'default' - use default transformer for the feature, it same as
          giving True. The default for this feature is 'identity'
        - 'arcsinh' - Hyperbolic arcsine feature transformer
        - 'clipped_lg' - Decimal logarithm of a value clipped to a minimum
          value
        - 'identity' - Identity feature transformer
        - 'lg' - Decimal logarithm feature transformer
        - 'ln1p' - :math:`ln(1+x)` feature transformer
        - 'sqrt' - Square root feature transformer

        If bool, must be True to use default transformer or False to disable.
        If None, no transformation is applied.
    """

    features = ["Std"]

    def __init__(self, transform=None):
        self.transform = transform
        self._extract = _StandardDeviation(**self.params)



    @doctools.doc_inherit(LightCurveExtractor.extract)
    def extract(self, magnitude, time=None, error=None):
        """
        Parameters
        ----------
        magnitude : array-like
        time : array-like, optional
        error : array-like, optional
        """
        [std] = self._extract(time, magnitude, error)
        return {"Std": std}