BIDSTaskEvent

Bases: BIDSBehEvent

A class representing task events.

This class describes timing and other properties of events recorded during a run. Events are, for example, stimuli presented to the participant or participant responses.

Examples:

>>> from psychopy_bids import bids
>>> event = bids.BIDSTaskEvent(onset=1.0, duration=0)

Notes

For more details on task event files, see BIDS Specification.

Source code in psychopy_bids/bids/bidstaskevent.py

class BIDSTaskEvent(BIDSBehEvent):
    """A class representing task events.

    This class describes timing and other properties of events recorded during a run. Events are,
    for example, stimuli presented to the participant or participant responses.

    Examples
    --------
    >>> from psychopy_bids import bids
    >>> event = bids.BIDSTaskEvent(onset=1.0, duration=0)

    Notes
    -----
    For more details on task event files, see [BIDS Specification](https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/05-task-events.html).
    """

    def __init__(
        self,
        onset: Union[int, float, str],
        duration: Union[int, float, str],
        *args: tuple,
        trial_type: Union[str, None] = None,
        sample: Union[int, str, None] = None,
        response_time: Union[int, float, str, None] = None,
        value: object = None,
        hed: Union[str, None] = None,
        stim_file: Union[str, None] = None,
        identifier: Union[str, None] = None,
        database: Union[str, None] = None,
        **kwargs: dict,
    ) -> None:
        """Initialize a BIDSTaskEvent object.

        Parameters
        ----------
        onset : int, float, str
            Onset (in seconds) of the event, measured from the beginning of the acquisition of the
            first data point stored in the corresponding task data file.
        duration : int, float, str
            Duration of the event (measured from onset) in seconds.
        *args : tuple
            Any arguments that the object's superclass's `__init__` method might require.
        trial_type : str, optional
            Primary categorisation of each trial to identify them as instances of the experimental
            conditions.
        sample : int, str, optional
            Onset of the event according to the sampling scheme of the recorded modality.
        response_time : int, float, str, optional
            Marker value associated with the event.
        value : object, optional
            Marker value associated with the event.
        hed : str, optional
            Hierarchical Event Descriptor (HED) Tag.
        stim_file : str, optional
            Represents the location of the stimulus file (such as an image, video, or audio file)
            presented at the given onset time.
        identifier : str, optional
            Represents the database identifier of the stimulus file presented at the given onset
            time.
        database : str, optional
            Represents the database of the stimulus file presented at the given onset time.
        **kwargs : dict
            Any keyword arguments that the object's superclass's `__init__` method might require.
        """
        super().__init__(*args, **kwargs)
        self.__dict__ = self

        self["onset"] = self._validateOnset(onset)
        self["duration"] = self._validateDuration(duration)
        self["trial_type"] = self._validateAttribute("trial_type", trial_type)
        self["sample"] = self._validateSample(sample)
        self["response_time"] = self._validateResponseTime(response_time)
        self["value"] = value
        self["hed"] = self._validateAttribute("hed", hed)
        self["stim_file"] = self._validateAttribute("stim_file", stim_file)
        self["identifier"] = self._validateAttribute("identifier", identifier)
        self["database"] = self._validateAttribute("database", database)

    def __setitem__(self, key: str, value: object) -> None:
        """Set the value associated with a specific key.

        If the key already exists in the event, the new value will be validated using
        the `_validateAttribute` method before being set.

        Parameters
        ----------
        key : str
            The key for which to set the value.
        value : object
            The value to be associated with the key.
        """
        if key == "onset":
            value = self._validateOnset(value)
        if key == "duration":
            value = self._validateDuration(value)
        if key in ["trial_type", "hed", "stim_file", "identifier", "database"]:
            value = self._validateAttribute(key, value)
        if key == "sample":
            value = self._validateSample(value)
        if key == "response_time":
            value = self._validateResponseTime(value)

        super().__setitem__(key, value)

    def __repr__(self) -> str:
        """Return a printable representational string of the given object.

        This method returns a string representation of the BIDSTaskEvent object containing its
        attribute-value pairs.

        Returns:
        -------
        str
            A string representation of the BIDSTaskEvent object.
        """
        msg = f"BIDSTaskEvent({', '.join(f'{k}={v}' for k, v in self.items() if v is not None)})"
        return msg

    @staticmethod
    def _validateOnset(value: Union[int, float, str]) -> float:
        """Validate and format the onset value.

        This method ensures that the onset value is a numeric type or can be successfully converted
        to a float. If the value is provided as a string, it must be a numeric string (containing
        only digits).

        Parameters
        ----------
        value : int, float, str
            The onset value to be validated. Can be provided as an int, float, or numeric string.

        Returns
        -------
        float
            The validated onset value, rounded to four decimal places.

        Raises
        ------
        OnsetError
            If the provided onset value is not a valid numeric type or string.
        """
        if isinstance(value, (int, float)):
            return round(value, 4)
        if isinstance(value, str) and value.isnumeric():
            return round(float(value), 4)
        raise OnsetError(value)

    @staticmethod
    def _validateDuration(value: Union[int, float, str]) -> Union[float, str]:
        """Validate and process the duration value.

        This method checks the provided value and validates whether it represents a valid
        duration for an event. Valid duration values include non-negative integers or floats,
        as well as the string "n/a". If the provided value is numeric as a string, it is
        converted to a float before validation.

        Parameters
        ----------
        value : int, float, str
            The value to be validated as a valid event duration.

        Returns
        -------
        float or str
            The processed and validated duration value.

        Raises
        ------
        DurationError
            If the provided value is not a valid event duration.
        """
        if value == "n/a":
            return value
        if isinstance(value, (int, float)) and value >= 0:
            return round(value, 4)
        if isinstance(value, str) and value.isnumeric():
            return round(float(value), 4)
        raise DurationError(value)

    @staticmethod
    def _validateSample(value: Union[int, str, None]) -> Union[int, None]:
        """Validate and process the sample value.

        This method checks the provided value and validates whether it represents a valid sample
        index for an event. Valid sample values include positive integers. If the provided value is
        numeric as a string, it is converted to an integer before validation.

        Parameters
        ----------
        value : int or str
            The value to be validated as a valid sample index.

        Returns
        -------
        int or None
            The processed and validated sample index, or None if the value is not valid.

        Raises
        ------
        SampleError
            If the provided value is not a valid sample index.
        """
        if isinstance(value, int):
            return value
        if isinstance(value, str) and value.isnumeric():
            return int(value)
        if value:
            raise SampleError(value)
        return None

    @staticmethod
    def _validateResponseTime(
        value: Union[int, float, str, None],
    ) -> Union[float, str, None]:
        """Validate and process the response time value.

        This method checks the provided value and validates whether it represents a valid response
        time for an event. Valid response time values include non-negative integers, floats, as well
        as the string "n/a". If the provided value is numeric as a string, it is converted to a
        float before validation.

        Parameters
        ----------
        value : int or float or str
            The value to be validated as a valid response time.

        Returns
        -------
        float or str or None
            The processed and validated response time value, or None if the value is not valid.

        Raises
        ------
        ResponseTimeError
            If the provided value is not a valid response time.
        """
        if value == "n/a":
            return value
        if isinstance(value, str) and value.isnumeric():
            return round(float(value), 4)
        if isinstance(value, (int, float)):
            return round(value, 4)
        if value:
            raise ResponseTimeError(value)
        return None

    @staticmethod
    def _validateAttribute(key: str, value: object) -> Union[str, None]:
        """Validate and process an attribute value.

        This method performs validation on an attribute value. If the value is not None,
            it checks whether it's an instance of string. If it's a string, it is returned as-is.
        If the value is not a string, an error class corresponding to the key's name is raised.

        Parameters
        ----------
        key : str
            The key representing the attribute's name.
        value : object
            The value to be validated.

        Returns
        -------
        str or None
            The validated string value or None if the value is None.

        Raises
        ------
        AttributeError
            If the provided value is not a valid string attribute.
        """
        if value is not None:
            if isinstance(value, str):
                return value

            error_class = {
                "trial_type": TrialTypeError,
                "hed": HedError,
                "stim_file": StimFileError,
                "identifier": IdentifierError,
                "database": DatabaseError,
            }.get(key, AttributeError)
            raise error_class(value)
        return None

    @property
    def onset(self):
        """
        Onset (in seconds) of the event, measured from the beginning of the acquisition of the
        first data point stored in the corresponding task data file.
        """
        return self.get("onset")

    @onset.setter
    def onset(self, onset):
        self["onset"] = self._validateOnset(onset)

    @property
    def duration(self) -> float:
        """
        Duration of the event (measured from onset) in seconds.
        """
        return self.get("duration")

    @duration.setter
    def duration(self, duration: float) -> None:
        self["duration"] = self._validateDuration(duration)

    @property
    def trial_type(self):
        """
        Primary categorisation of each trial to identify them as instances of the experimental
        conditions.
        """
        return self.get("trial_type")

    @trial_type.setter
    def trial_type(self, trial_type):
        self["trial_type"] = self._validateAttribute("trial_type", trial_type)

    @property
    def sample(self):
        """
        Onset of the event according to the sampling scheme of the recorded modality.
        """
        return self.get("sample")

    @sample.setter
    def sample(self, sample):
        self["sample"] = self._validateSample(sample)

    @property
    def response_time(self):
        """
        Response time measured in seconds.
        """
        return self.get("response_time")

    @response_time.setter
    def response_time(self, response_time):
        self["response_time"] = self._validateResponseTime(response_time)

    @property
    def value(self):
        """
        Marker value associated with the event.
        """
        return self.get("value")

    @value.setter
    def value(self, value):
        self["value"] = self._validateAttribute("value", value)

    @property
    def hed(self):
        """
        Hierarchical Event Descriptor (HED) Tag.
        """
        return self.get("hed")

    @hed.setter
    def hed(self, hed):
        self["hed"] = self._validateAttribute("hed", hed)

    @property
    def stim_file(self):
        """
        Represents the location of the stimulus file (such as an image, video, or audio file)
        presented at the given onset time.
        """
        return self.get("stim_file")

    @stim_file.setter
    def stim_file(self, stim_file):
        self["stim_file"] = self._validateAttribute("stim_file", stim_file)

    @property
    def identifier(self):
        """
        Represents the database identifier of the stimulus file presented at the given onset time.
        """
        return self.get("identifier")

    @identifier.setter
    def identifier(self, identifier):
        self["identifier"] = self._validateAttribute("identifier", identifier)

    @property
    def database(self):
        """
        Represents the database of the stimulus file presented at the given onset time.
        """
        return self.get("database")

    @database.setter
    def database(self, database):
        self["database"] = self._validateAttribute("database", database)

database property writable

Represents the database of the stimulus file presented at the given onset time.

duration property writable

Duration of the event (measured from onset) in seconds.

hed property writable

Hierarchical Event Descriptor (HED) Tag.

identifier property writable

Represents the database identifier of the stimulus file presented at the given onset time.

onset property writable

Onset (in seconds) of the event, measured from the beginning of the acquisition of the first data point stored in the corresponding task data file.

response_time property writable

Response time measured in seconds.

sample property writable

Onset of the event according to the sampling scheme of the recorded modality.

stim_file property writable

Represents the location of the stimulus file (such as an image, video, or audio file) presented at the given onset time.

trial_type property writable

Primary categorisation of each trial to identify them as instances of the experimental conditions.

value property writable

Marker value associated with the event.

__init__(onset, duration, *args, trial_type=None, sample=None, response_time=None, value=None, hed=None, stim_file=None, identifier=None, database=None, **kwargs)

Initialize a BIDSTaskEvent object.

Parameters:

Name	Type	Description	Default
onset	(int, float, str)	Onset (in seconds) of the event, measured from the beginning of the acquisition of the first data point stored in the corresponding task data file.	required
duration	(int, float, str)	Duration of the event (measured from onset) in seconds.	required
*args	tuple	Any arguments that the object's superclass's __init__ method might require.	()
trial_type	str	Primary categorisation of each trial to identify them as instances of the experimental conditions.	None
sample	(int, str)	Onset of the event according to the sampling scheme of the recorded modality.	None
response_time	(int, float, str)	Marker value associated with the event.	None
value	object	Marker value associated with the event.	None
hed	str	Hierarchical Event Descriptor (HED) Tag.	None
stim_file	str	Represents the location of the stimulus file (such as an image, video, or audio file) presented at the given onset time.	None
identifier	str	Represents the database identifier of the stimulus file presented at the given onset time.	None
database	str	Represents the database of the stimulus file presented at the given onset time.	None
**kwargs	dict	Any keyword arguments that the object's superclass's __init__ method might require.	{}

Source code in psychopy_bids/bids/bidstaskevent.py

def __init__(
    self,
    onset: Union[int, float, str],
    duration: Union[int, float, str],
    *args: tuple,
    trial_type: Union[str, None] = None,
    sample: Union[int, str, None] = None,
    response_time: Union[int, float, str, None] = None,
    value: object = None,
    hed: Union[str, None] = None,
    stim_file: Union[str, None] = None,
    identifier: Union[str, None] = None,
    database: Union[str, None] = None,
    **kwargs: dict,
) -> None:
    """Initialize a BIDSTaskEvent object.

    Parameters
    ----------
    onset : int, float, str
        Onset (in seconds) of the event, measured from the beginning of the acquisition of the
        first data point stored in the corresponding task data file.
    duration : int, float, str
        Duration of the event (measured from onset) in seconds.
    *args : tuple
        Any arguments that the object's superclass's `__init__` method might require.
    trial_type : str, optional
        Primary categorisation of each trial to identify them as instances of the experimental
        conditions.
    sample : int, str, optional
        Onset of the event according to the sampling scheme of the recorded modality.
    response_time : int, float, str, optional
        Marker value associated with the event.
    value : object, optional
        Marker value associated with the event.
    hed : str, optional
        Hierarchical Event Descriptor (HED) Tag.
    stim_file : str, optional
        Represents the location of the stimulus file (such as an image, video, or audio file)
        presented at the given onset time.
    identifier : str, optional
        Represents the database identifier of the stimulus file presented at the given onset
        time.
    database : str, optional
        Represents the database of the stimulus file presented at the given onset time.
    **kwargs : dict
        Any keyword arguments that the object's superclass's `__init__` method might require.
    """
    super().__init__(*args, **kwargs)
    self.__dict__ = self

    self["onset"] = self._validateOnset(onset)
    self["duration"] = self._validateDuration(duration)
    self["trial_type"] = self._validateAttribute("trial_type", trial_type)
    self["sample"] = self._validateSample(sample)
    self["response_time"] = self._validateResponseTime(response_time)
    self["value"] = value
    self["hed"] = self._validateAttribute("hed", hed)
    self["stim_file"] = self._validateAttribute("stim_file", stim_file)
    self["identifier"] = self._validateAttribute("identifier", identifier)
    self["database"] = self._validateAttribute("database", database)

__repr__()

Return a printable representational string of the given object.

This method returns a string representation of the BIDSTaskEvent object containing its attribute-value pairs.

Returns:

str A string representation of the BIDSTaskEvent object.

Source code in psychopy_bids/bids/bidstaskevent.py

def __repr__(self) -> str:
    """Return a printable representational string of the given object.

    This method returns a string representation of the BIDSTaskEvent object containing its
    attribute-value pairs.

    Returns:
    -------
    str
        A string representation of the BIDSTaskEvent object.
    """
    msg = f"BIDSTaskEvent({', '.join(f'{k}={v}' for k, v in self.items() if v is not None)})"
    return msg

__setitem__(key, value)

Set the value associated with a specific key.

If the key already exists in the event, the new value will be validated using the _validateAttribute method before being set.

Parameters:

Name	Type	Description	Default
key	str	The key for which to set the value.	required
value	object	The value to be associated with the key.	required

Source code in psychopy_bids/bids/bidstaskevent.py

def __setitem__(self, key: str, value: object) -> None:
    """Set the value associated with a specific key.

    If the key already exists in the event, the new value will be validated using
    the `_validateAttribute` method before being set.

    Parameters
    ----------
    key : str
        The key for which to set the value.
    value : object
        The value to be associated with the key.
    """
    if key == "onset":
        value = self._validateOnset(value)
    if key == "duration":
        value = self._validateDuration(value)
    if key in ["trial_type", "hed", "stim_file", "identifier", "database"]:
        value = self._validateAttribute(key, value)
    if key == "sample":
        value = self._validateSample(value)
    if key == "response_time":
        value = self._validateResponseTime(value)

    super().__setitem__(key, value)

_validateAttribute(key, value) staticmethod

Validate and process an attribute value.

This method performs validation on an attribute value. If the value is not None, it checks whether it's an instance of string. If it's a string, it is returned as-is. If the value is not a string, an error class corresponding to the key's name is raised.

Parameters:

Name	Type	Description	Default
key	str	The key representing the attribute's name.	required
value	object	The value to be validated.	required

Returns:

Type	Description
str or None	The validated string value or None if the value is None.

Raises:

Type	Description
AttributeError	If the provided value is not a valid string attribute.

Source code in psychopy_bids/bids/bidstaskevent.py

@staticmethod
def _validateAttribute(key: str, value: object) -> Union[str, None]:
    """Validate and process an attribute value.

    This method performs validation on an attribute value. If the value is not None,
        it checks whether it's an instance of string. If it's a string, it is returned as-is.
    If the value is not a string, an error class corresponding to the key's name is raised.

    Parameters
    ----------
    key : str
        The key representing the attribute's name.
    value : object
        The value to be validated.

    Returns
    -------
    str or None
        The validated string value or None if the value is None.

    Raises
    ------
    AttributeError
        If the provided value is not a valid string attribute.
    """
    if value is not None:
        if isinstance(value, str):
            return value

        error_class = {
            "trial_type": TrialTypeError,
            "hed": HedError,
            "stim_file": StimFileError,
            "identifier": IdentifierError,
            "database": DatabaseError,
        }.get(key, AttributeError)
        raise error_class(value)
    return None

_validateDuration(value) staticmethod

Validate and process the duration value.

This method checks the provided value and validates whether it represents a valid duration for an event. Valid duration values include non-negative integers or floats, as well as the string "n/a". If the provided value is numeric as a string, it is converted to a float before validation.

Parameters:

Name	Type	Description	Default
value	(int, float, str)	The value to be validated as a valid event duration.	required

Returns:

Type	Description
float or str	The processed and validated duration value.

Raises:

Type	Description
DurationError	If the provided value is not a valid event duration.

Source code in psychopy_bids/bids/bidstaskevent.py

@staticmethod
def _validateDuration(value: Union[int, float, str]) -> Union[float, str]:
    """Validate and process the duration value.

    This method checks the provided value and validates whether it represents a valid
    duration for an event. Valid duration values include non-negative integers or floats,
    as well as the string "n/a". If the provided value is numeric as a string, it is
    converted to a float before validation.

    Parameters
    ----------
    value : int, float, str
        The value to be validated as a valid event duration.

    Returns
    -------
    float or str
        The processed and validated duration value.

    Raises
    ------
    DurationError
        If the provided value is not a valid event duration.
    """
    if value == "n/a":
        return value
    if isinstance(value, (int, float)) and value >= 0:
        return round(value, 4)
    if isinstance(value, str) and value.isnumeric():
        return round(float(value), 4)
    raise DurationError(value)

_validateOnset(value) staticmethod

Validate and format the onset value.

This method ensures that the onset value is a numeric type or can be successfully converted to a float. If the value is provided as a string, it must be a numeric string (containing only digits).

Parameters:

Name	Type	Description	Default
value	(int, float, str)	The onset value to be validated. Can be provided as an int, float, or numeric string.	required

Returns:

Type	Description
float	The validated onset value, rounded to four decimal places.

Raises:

Type	Description
OnsetError	If the provided onset value is not a valid numeric type or string.

Source code in psychopy_bids/bids/bidstaskevent.py

@staticmethod
def _validateOnset(value: Union[int, float, str]) -> float:
    """Validate and format the onset value.

    This method ensures that the onset value is a numeric type or can be successfully converted
    to a float. If the value is provided as a string, it must be a numeric string (containing
    only digits).

    Parameters
    ----------
    value : int, float, str
        The onset value to be validated. Can be provided as an int, float, or numeric string.

    Returns
    -------
    float
        The validated onset value, rounded to four decimal places.

    Raises
    ------
    OnsetError
        If the provided onset value is not a valid numeric type or string.
    """
    if isinstance(value, (int, float)):
        return round(value, 4)
    if isinstance(value, str) and value.isnumeric():
        return round(float(value), 4)
    raise OnsetError(value)

_validateResponseTime(value) staticmethod

Validate and process the response time value.

This method checks the provided value and validates whether it represents a valid response time for an event. Valid response time values include non-negative integers, floats, as well as the string "n/a". If the provided value is numeric as a string, it is converted to a float before validation.

Parameters:

Name	Type	Description	Default
value	int or float or str	The value to be validated as a valid response time.	required

Returns:

Type	Description
float or str or None	The processed and validated response time value, or None if the value is not valid.

Raises:

Type	Description
ResponseTimeError	If the provided value is not a valid response time.

Source code in psychopy_bids/bids/bidstaskevent.py

@staticmethod
def _validateResponseTime(
    value: Union[int, float, str, None],
) -> Union[float, str, None]:
    """Validate and process the response time value.

    This method checks the provided value and validates whether it represents a valid response
    time for an event. Valid response time values include non-negative integers, floats, as well
    as the string "n/a". If the provided value is numeric as a string, it is converted to a
    float before validation.

    Parameters
    ----------
    value : int or float or str
        The value to be validated as a valid response time.

    Returns
    -------
    float or str or None
        The processed and validated response time value, or None if the value is not valid.

    Raises
    ------
    ResponseTimeError
        If the provided value is not a valid response time.
    """
    if value == "n/a":
        return value
    if isinstance(value, str) and value.isnumeric():
        return round(float(value), 4)
    if isinstance(value, (int, float)):
        return round(value, 4)
    if value:
        raise ResponseTimeError(value)
    return None

_validateSample(value) staticmethod

Validate and process the sample value.

This method checks the provided value and validates whether it represents a valid sample index for an event. Valid sample values include positive integers. If the provided value is numeric as a string, it is converted to an integer before validation.

Parameters:

Name	Type	Description	Default
value	int or str	The value to be validated as a valid sample index.	required

Returns:

Type	Description
int or None	The processed and validated sample index, or None if the value is not valid.

Raises:

Type	Description
SampleError	If the provided value is not a valid sample index.

Source code in psychopy_bids/bids/bidstaskevent.py

@staticmethod
def _validateSample(value: Union[int, str, None]) -> Union[int, None]:
    """Validate and process the sample value.

    This method checks the provided value and validates whether it represents a valid sample
    index for an event. Valid sample values include positive integers. If the provided value is
    numeric as a string, it is converted to an integer before validation.

    Parameters
    ----------
    value : int or str
        The value to be validated as a valid sample index.

    Returns
    -------
    int or None
        The processed and validated sample index, or None if the value is not valid.

    Raises
    ------
    SampleError
        If the provided value is not a valid sample index.
    """
    if isinstance(value, int):
        return value
    if isinstance(value, str) and value.isnumeric():
        return int(value)
    if value:
        raise SampleError(value)
    return None