from_file#

pymovements.stimulus.image.from_file(image_path: str | Path, metadata: dict[str, Any] | None = None) → ImageStimulus[source]#

Load image stimulus from file.

Parameters:
  • image_path (str | Path) – Path to file to be read.

  • metadata (dict[str, Any] | None) – Dictionary containing additional metadata. (default: None)

Returns:

Returns the image stimulus file.

Return type:

ImageStimulus