Source code for convnwb.utils.convert

"""Utility functions for converting data types."""

from datetime import datetime
from dateutil.tz import tzlocal

import numpy as np

###################################################################################################
###################################################################################################

def convert_str_to_bool(string):
    """Convert a string to a boolean.

    Parameters
    ----------
    string : {'True', 'False'}
        String to convert to boolean.

    Returns
    -------
    bool
        Boolean represetation of the string.
    """

    assert string.lower() in ['true', 'false']
    return string.lower() == 'true'


def convert_strlist_to_bool(lst):
    """Convert a list of strings to a list of boolean.

    Parameters
    ----------
    lst : list of str
        List of strings to convert to boolean.

    Returns
    -------
    list of bool
        List with elements converted to boolean.
    """

    return [convert_str_to_bool(el) for el in lst]


def convert_type(variable, dtype):
    """Convert type of a given variable.

    Parameters
    ----------
    variable
        Variable to type cast.
    dtype : type
        Type to cast to.

    Returns
    -------
    out
        Typecast `value`, with type `dtype`.
    """

    out = dtype(variable)

    return out


def convert_to_array(data, dtype):
    """Convert to an array of specified data type.

    Parameters
    ----------
    data : array_like
        Data to cast to an array.
    dtype : str
        Data type to cast the array.

    Returns
    -------
    array : np.ndarray
        Data, converted to array.
    """

    array = np.array(data).astype(dtype)

    return array


def convert_time_to_date(timestamp, tz=None):
    """Convert a time value to a datetime date.

    Parameters
    ----------
    timestamp : float
        Timestamp value to convert.
    tz : dateutil.tz.tz, optional
        Timezone information. If not provided, defaults to the local time zone.

    Returns
    -------
    date : datetime.datetime
        Date corresponding to the given timestamp.
    """

    if not tz:
        tz = tzlocal()

    date = datetime.fromtimestamp(timestamp, tz=tz)

    return date