ophyd-async 0.2.0__py3-none-any.whl → 0.3a2__py3-none-any.whl

ophyd_async/epics/_backend/common.py

@@ -0,0 +1,25 @@
+from enum import Enum
+from typing import Any, Optional, Tuple, Type
+
+
+def get_supported_enum_class(
+    pv: str,
+    datatype: Optional[Type[Enum]],
+    pv_choices: Tuple[Any, ...],
+) -> Type[Enum]:
+    if not datatype:
+        return Enum("GeneratedChoices", {x or "_": x for x in pv_choices}, type=str)  # type: ignore
+
+    if not issubclass(datatype, Enum):
+        raise TypeError(f"{pv} has type Enum not {datatype.__name__}")
+    if not issubclass(datatype, str):
+        raise TypeError(f"{pv} has type Enum but doesn't inherit from String")
+    choices = tuple(v.value for v in datatype)
+    if set(choices) != set(pv_choices):
+        raise TypeError(
+            (
+                f"{pv} has choices {pv_choices}, "
+                f"which do not match {datatype}, which has {choices}"
+            )
+        )
+    return datatype

ophyd_async/epics/areadetector/__init__.py

@@ -1,3 +1,5 @@
+from .aravis import AravisDetector
+from .pilatus import PilatusDetector
 from .single_trigger_det import SingleTriggerDet
 from .utils import (
     FileWriteMode,
@@ -9,6 +11,7 @@ from .utils import (
 )
 
 __all__ = [
+    "AravisDetector",
     "SingleTriggerDet",
     "FileWriteMode",
     "ImageMode",
@@ -16,4 +19,5 @@ __all__ = [
     "ad_rw",
     "NDAttributeDataType",
     "NDAttributesXML",
+    "PilatusDetector",
 ]

ophyd_async/epics/areadetector/aravis.py

@@ -0,0 +1,69 @@
+from typing import get_args
+
+from bluesky.protocols import HasHints, Hints
+
+from ophyd_async.core import DirectoryProvider, StandardDetector, TriggerInfo
+from ophyd_async.epics.areadetector.controllers.aravis_controller import (
+    AravisController,
+)
+from ophyd_async.epics.areadetector.drivers import ADBaseShapeProvider
+from ophyd_async.epics.areadetector.drivers.aravis_driver import AravisDriver
+from ophyd_async.epics.areadetector.writers import HDFWriter, NDFileHDF
+
+
+class AravisDetector(StandardDetector, HasHints):
+    """
+    Ophyd-async implementation of an ADAravis Detector.
+    The detector may be configured for an external trigger on a GPIO port,
+    which must be done prior to preparing the detector
+    """
+
+    _controller: AravisController
+    _writer: HDFWriter
+
+    def __init__(
+        self,
+        name: str,
+        directory_provider: DirectoryProvider,
+        driver: AravisDriver,
+        hdf: NDFileHDF,
+        gpio_number: AravisController.GPIO_NUMBER = 1,
+        **scalar_sigs: str,
+    ):
+        # Must be child of Detector to pick up connect()
+        self.drv = driver
+        self.hdf = hdf
+
+        super().__init__(
+            AravisController(self.drv, gpio_number=gpio_number),
+            HDFWriter(
+                self.hdf,
+                directory_provider,
+                lambda: self.name,
+                ADBaseShapeProvider(self.drv),
+                **scalar_sigs,
+            ),
+            config_sigs=(self.drv.acquire_time, self.drv.acquire),
+            name=name,
+        )
+
+    async def _prepare(self, value: TriggerInfo) -> None:
+        await self.drv.fetch_deadtime()
+        await super()._prepare(value)
+
+    def get_external_trigger_gpio(self):
+        return self._controller.gpio_number
+
+    def set_external_trigger_gpio(self, gpio_number: AravisController.GPIO_NUMBER):
+        supported_gpio_numbers = get_args(AravisController.GPIO_NUMBER)
+        if gpio_number not in supported_gpio_numbers:
+            raise ValueError(
+                f"{self.__class__.__name__} only supports the following GPIO "
+                f"indices: {supported_gpio_numbers} but was asked to "
+                f"use {gpio_number}"
+            )
+        self._controller.gpio_number = gpio_number
+
+    @property
+    def hints(self) -> Hints:
+        return self._writer.hints

ophyd_async/epics/areadetector/controllers/ad_sim_controller.py

@@ -30,8 +30,8 @@ class ADSimController(DetectorControl):
 
     async def arm(
         self,
+        num: int,
         trigger: DetectorTrigger = DetectorTrigger.internal,
-        num: int = 0,
         exposure: Optional[float] = None,
     ) -> AsyncStatus:
         assert (

ophyd_async/epics/areadetector/controllers/aravis_controller.py

@@ -0,0 +1,73 @@
+import asyncio
+from typing import Literal, Optional, Tuple
+
+from ophyd_async.core import (
+    AsyncStatus,
+    DetectorControl,
+    DetectorTrigger,
+    set_and_wait_for_value,
+)
+from ophyd_async.epics.areadetector.drivers.aravis_driver import (
+    AravisDriver,
+    AravisTriggerMode,
+    AravisTriggerSource,
+)
+from ophyd_async.epics.areadetector.utils import ImageMode, stop_busy_record
+
+
+class AravisController(DetectorControl):
+    GPIO_NUMBER = Literal[1, 2, 3, 4]
+
+    def __init__(self, driver: AravisDriver, gpio_number: GPIO_NUMBER) -> None:
+        self._drv = driver
+        self.gpio_number = gpio_number
+
+    def get_deadtime(self, exposure: float) -> float:
+        return self._drv.dead_time or 0
+
+    async def arm(
+        self,
+        num: int = 0,
+        trigger: DetectorTrigger = DetectorTrigger.internal,
+        exposure: Optional[float] = None,
+    ) -> AsyncStatus:
+        if num == 0:
+            image_mode = ImageMode.continuous
+        else:
+            image_mode = ImageMode.multiple
+        if exposure is not None:
+            await self._drv.acquire_time.set(exposure)
+
+        trigger_mode, trigger_source = self._get_trigger_info(trigger)
+        # trigger mode must be set first and on it's own!
+        await self._drv.trigger_mode.set(trigger_mode)
+
+        await asyncio.gather(
+            self._drv.trigger_source.set(trigger_source),
+            self._drv.num_images.set(num),
+            self._drv.image_mode.set(image_mode),
+        )
+
+        status = await set_and_wait_for_value(self._drv.acquire, True)
+        return status
+
+    def _get_trigger_info(
+        self, trigger: DetectorTrigger
+    ) -> Tuple[AravisTriggerMode, AravisTriggerSource]:
+        supported_trigger_types = (
+            DetectorTrigger.constant_gate,
+            DetectorTrigger.edge_trigger,
+        )
+        if trigger not in supported_trigger_types:
+            raise ValueError(
+                f"{self.__class__.__name__} only supports the following trigger "
+                f"types: {supported_trigger_types} but was asked to "
+                f"use {trigger}"
+            )
+        if trigger == DetectorTrigger.internal:
+            return AravisTriggerMode.off, "Freerun"
+        else:
+            return (AravisTriggerMode.on, f"Line{self.gpio_number}")
+
+    async def disarm(self):
+        await stop_busy_record(self._drv.acquire, False, timeout=1)

ophyd_async/epics/areadetector/controllers/pilatus_controller.py

@@ -1,49 +1,61 @@
 import asyncio
-from typing import Optional, Set
+from typing import Optional
 
-from ophyd_async.core import AsyncStatus, DetectorControl, DetectorTrigger
+from ophyd_async.core.async_status import AsyncStatus
+from ophyd_async.core.detector import DetectorControl, DetectorTrigger
 from ophyd_async.epics.areadetector.drivers.ad_base import (
-    DEFAULT_GOOD_STATES,
-    DetectorState,
     start_acquiring_driver_and_ensure_status,
 )
-
-from ..drivers.pilatus_driver import PilatusDriver, TriggerMode
-from ..utils import ImageMode, stop_busy_record
-
-TRIGGER_MODE = {
-    DetectorTrigger.internal: TriggerMode.internal,
-    DetectorTrigger.constant_gate: TriggerMode.ext_enable,
-    DetectorTrigger.variable_gate: TriggerMode.ext_enable,
-}
+from ophyd_async.epics.areadetector.drivers.pilatus_driver import (
+    PilatusDriver,
+    PilatusTriggerMode,
+)
+from ophyd_async.epics.areadetector.utils import ImageMode, stop_busy_record
 
 
 class PilatusController(DetectorControl):
+    _supported_trigger_types = {
+        DetectorTrigger.internal: PilatusTriggerMode.internal,
+        DetectorTrigger.constant_gate: PilatusTriggerMode.ext_enable,
+        DetectorTrigger.variable_gate: PilatusTriggerMode.ext_enable,
+    }
+
     def __init__(
         self,
         driver: PilatusDriver,
-        good_states: Set[DetectorState] = set(DEFAULT_GOOD_STATES),
     ) -> None:
-        self.driver = driver
-        self.good_states = good_states
+        self._drv = driver
 
     def get_deadtime(self, exposure: float) -> float:
-        return 0.001
+        # Cite: https://media.dectris.com/User_Manual-PILATUS2-V1_4.pdf
+        """The required minimum time difference between ExpPeriod and ExpTime
+        (readout time) is 2.28 ms"""
+        return 2.28e-3
 
     async def arm(
         self,
+        num: int,
         trigger: DetectorTrigger = DetectorTrigger.internal,
-        num: int = 0,
         exposure: Optional[float] = None,
     ) -> AsyncStatus:
+        if exposure is not None:
+            await self._drv.acquire_time.set(exposure)
         await asyncio.gather(
-            self.driver.trigger_mode.set(TRIGGER_MODE[trigger]),
-            self.driver.num_images.set(999_999 if num == 0 else num),
-            self.driver.image_mode.set(ImageMode.multiple),
-        )
-        return await start_acquiring_driver_and_ensure_status(
-            self.driver, good_states=self.good_states
+            self._drv.trigger_mode.set(self._get_trigger_mode(trigger)),
+            self._drv.num_images.set(999_999 if num == 0 else num),
+            self._drv.image_mode.set(ImageMode.multiple),
         )
+        return await start_acquiring_driver_and_ensure_status(self._drv)
+
+    @classmethod
+    def _get_trigger_mode(cls, trigger: DetectorTrigger) -> PilatusTriggerMode:
+        if trigger not in cls._supported_trigger_types.keys():
+            raise ValueError(
+                f"{cls.__name__} only supports the following trigger "
+                f"types: {cls._supported_trigger_types.keys()} but was asked to "
+                f"use {trigger}"
+            )
+        return cls._supported_trigger_types[trigger]
 
     async def disarm(self):
-        await stop_busy_record(self.driver.acquire, False, timeout=1)
+        await stop_busy_record(self._drv.acquire, False, timeout=1)

ophyd_async/epics/areadetector/drivers/aravis_driver.py

@@ -0,0 +1,154 @@
+from enum import Enum
+from typing import Callable, Dict, Literal, Optional, Tuple
+
+from ophyd_async.epics.areadetector.drivers import ADBase
+from ophyd_async.epics.areadetector.utils import ad_r, ad_rw
+
+
+class AravisTriggerMode(str, Enum):
+    """GigEVision GenICAM standard: on=externally triggered"""
+
+    on = "On"
+    off = "Off"
+
+
+"""A minimal set of TriggerSources that must be supported by the underlying record.
+    To enable hardware triggered scanning, line_N must support each N in GPIO_NUMBER.
+    To enable software triggered scanning, freerun must be supported.
+    Other enumerated values may or may not be preset.
+    To prevent requiring one Enum class per possible configuration, we set as this Enum
+    but read from the underlying signal as a str.
+    """
+AravisTriggerSource = Literal["Freerun", "Line1", "Line2", "Line3", "Line4"]
+
+
+def _reverse_lookup(
+    model_deadtimes: Dict[float, Tuple[str, ...]],
+) -> Callable[[str], float]:
+    def inner(pixel_format: str, model_name: str) -> float:
+        for deadtime, pixel_formats in model_deadtimes.items():
+            if pixel_format in pixel_formats:
+                return deadtime
+        raise ValueError(
+            f"Model {model_name} does not have a defined deadtime "
+            f"for pixel format {pixel_format}"
+        )
+
+    return inner
+
+
+_deadtimes: Dict[str, Callable[[str, str], float]] = {
+    # cite: https://cdn.alliedvision.com/fileadmin/content/documents/products/cameras/Manta/techman/Manta_TechMan.pdf retrieved 2024-04-05  # noqa: E501
+    "Manta G-125": lambda _, __: 63e-6,
+    "Manta G-145": lambda _, __: 106e-6,
+    "Manta G-235": _reverse_lookup(
+        {
+            118e-6: (
+                "Mono8",
+                "Mono12Packed",
+                "BayerRG8",
+                "BayerRG12",
+                "BayerRG12Packed",
+                "YUV411Packed",
+            ),
+            256e-6: ("Mono12", "BayerRG12", "YUV422Packed"),
+            390e-6: ("RGB8Packed", "BGR8Packed", "YUV444Packed"),
+        }
+    ),
+    "Manta G-895": _reverse_lookup(
+        {
+            404e-6: (
+                "Mono8",
+                "Mono12Packed",
+                "BayerRG8",
+                "BayerRG12Packed",
+                "YUV411Packed",
+            ),
+            542e-6: ("Mono12", "BayerRG12", "YUV422Packed"),
+            822e-6: ("RGB8Packed", "BGR8Packed", "YUV444Packed"),
+        }
+    ),
+    "Manta G-2460": _reverse_lookup(
+        {
+            979e-6: (
+                "Mono8",
+                "Mono12Packed",
+                "BayerRG8",
+                "BayerRG12Packed",
+                "YUV411Packed",
+            ),
+            1304e-6: ("Mono12", "BayerRG12", "YUV422Packed"),
+            1961e-6: ("RGB8Packed", "BGR8Packed", "YUV444Packed"),
+        }
+    ),
+    # cite: https://cdn.alliedvision.com/fileadmin/content/documents/products/cameras/various/appnote/GigE/GigE-Cameras_AppNote_PIV-Min-Time-Between-Exposures.pdf retrieved 2024-04-05  # noqa: E501
+    "Manta G-609": lambda _, __: 47e-6,
+    # cite: https://cdn.alliedvision.com/fileadmin/content/documents/products/cameras/Mako/techman/Mako_TechMan_en.pdf retrieved 2024-04-05  # noqa: E501
+    "Mako G-040": _reverse_lookup(
+        {
+            101e-6: (
+                "Mono8",
+                "Mono12Packed",
+                "BayerRG8",
+                "BayerRG12Packed",
+                "YUV411Packed",
+            ),
+            140e-6: ("Mono12", "BayerRG12", "YUV422Packed"),
+            217e-6: ("RGB8Packed", "BGR8Packed", "YUV444Packed"),
+        }
+    ),
+    "Mako G-125": lambda _, __: 70e-6,
+    # Assume 12 bits: 10 bits = 275e-6
+    "Mako G-234": _reverse_lookup(
+        {
+            356e-6: (
+                "Mono8",
+                "BayerRG8",
+                "BayerRG12",
+                "BayerRG12Packed",
+                "YUV411Packed",
+                "YUV422Packed",
+            ),
+            # Assume 12 bits: 10 bits = 563e-6
+            726e-6: ("RGB8Packed", "BRG8Packed", "YUV444Packed"),
+        }
+    ),
+    "Mako G-507": _reverse_lookup(
+        {
+            270e-6: (
+                "Mono8",
+                "Mono12Packed",
+                "BayerRG8",
+                "BayerRG12Packed",
+                "YUV411Packed",
+            ),
+            363e-6: ("Mono12", "BayerRG12", "YUV422Packed"),
+            554e-6: ("RGB8Packed", "BGR8Packed", "YUV444Packed"),
+        }
+    ),
+}
+
+
+class AravisDriver(ADBase):
+    # If instantiating a new instance, ensure it is supported in the _deadtimes dict
+    """Generic Driver supporting the Manta and Mako drivers.
+    Fetches deadtime prior to use in a Streaming scan.
+    Requires driver firmware up to date:
+    - Model_RBV must be of the form "^(Mako|Manta) (model)$"
+    """
+
+    def __init__(self, prefix: str, name: str = "") -> None:
+        self.trigger_mode = ad_rw(AravisTriggerMode, prefix + "TriggerMode")
+        self.trigger_source = ad_rw(str, prefix + "TriggerSource")
+        self.model = ad_r(str, prefix + "Model")
+        self.pixel_format = ad_rw(str, prefix + "PixelFormat")
+        self.dead_time: Optional[float] = None
+        super().__init__(prefix, name=name)
+
+    async def fetch_deadtime(self) -> None:
+        # All known in-use version B/C have same deadtime as non-B/C
+        model: str = (await self.model.get_value()).removesuffix("B").removesuffix("C")
+        if model not in _deadtimes:
+            raise ValueError(f"Model {model} does not have defined deadtimes")
+        pixel_format: str = await self.pixel_format.get_value()
+        self.dead_time = _deadtimes.get(model)(pixel_format, model)

ophyd_async/epics/areadetector/drivers/pilatus_driver.py

@@ -4,7 +4,7 @@ from ..utils import ad_rw
 from .ad_base import ADBase
 
 
-class TriggerMode(str, Enum):
+class PilatusTriggerMode(str, Enum):
     internal = "Internal"
     ext_enable = "Ext. Enable"
     ext_trigger = "Ext. Trigger"
@@ -13,6 +13,6 @@ class TriggerMode(str, Enum):
 
 
 class PilatusDriver(ADBase):
-    def __init__(self, prefix: str) -> None:
-        self.trigger_mode = ad_rw(TriggerMode, prefix + "TriggerMode")
-        super().__init__(prefix)
+    def __init__(self, prefix: str, name: str = "") -> None:
+        self.trigger_mode = ad_rw(PilatusTriggerMode, prefix + "TriggerMode")
+        super().__init__(prefix, name)

ophyd_async/epics/areadetector/pilatus.py

@@ -0,0 +1,50 @@
+from typing import Optional, Sequence
+
+from bluesky.protocols import Hints
+
+from ophyd_async.core import DirectoryProvider
+from ophyd_async.core.detector import StandardDetector
+from ophyd_async.core.signal import SignalR
+from ophyd_async.epics.areadetector.controllers.pilatus_controller import (
+    PilatusController,
+)
+from ophyd_async.epics.areadetector.drivers.ad_base import ADBaseShapeProvider
+from ophyd_async.epics.areadetector.drivers.pilatus_driver import PilatusDriver
+from ophyd_async.epics.areadetector.writers.hdf_writer import HDFWriter
+from ophyd_async.epics.areadetector.writers.nd_file_hdf import NDFileHDF
+
+
+class PilatusDetector(StandardDetector):
+    """A Pilatus StandardDetector writing HDF files"""
+
+    _controller: PilatusController
+    _writer: HDFWriter
+
+    def __init__(
+        self,
+        name: str,
+        directory_provider: DirectoryProvider,
+        driver: PilatusDriver,
+        hdf: NDFileHDF,
+        config_sigs: Optional[Sequence[SignalR]] = None,
+        **scalar_sigs: str,
+    ):
+        self.drv = driver
+        self.hdf = hdf
+
+        super().__init__(
+            PilatusController(self.drv),
+            HDFWriter(
+                self.hdf,
+                directory_provider,
+                lambda: self.name,
+                ADBaseShapeProvider(self.drv),
+                **scalar_sigs,
+            ),
+            config_sigs=config_sigs or (self.drv.acquire_time,),
+            name=name,
+        )
+
+    @property
+    def hints(self) -> Hints:
+        return self._writer.hints

ophyd_async/epics/areadetector/writers/_hdffile.py

@@ -1,19 +1,33 @@
+from pathlib import Path
 from typing import Iterator, List
 
 from event_model import StreamDatum, StreamResource, compose_stream_resource
 
+from ophyd_async.core import DirectoryInfo
+
 from ._hdfdataset import _HDFDataset
 
 
 class _HDFFile:
-    def __init__(self, full_file_name: str, datasets: List[_HDFDataset]) -> None:
+    """
+    :param directory_info: Contains information about how to construct a StreamResource
+    :param full_file_name: Absolute path to the file to be written
+    :param datasets: Datasets to write into the file
+    """
+
+    def __init__(
+        self,
+        directory_info: DirectoryInfo,
+        full_file_name: Path,
+        datasets: List[_HDFDataset],
+    ) -> None:
         self._last_emitted = 0
         self._bundles = [
             compose_stream_resource(
                 spec="AD_HDF5_SWMR_SLICE",
-                root="/",
+                root=str(directory_info.root),
                 data_key=ds.name,
-                resource_path=full_file_name,
+                resource_path=str(full_file_name.relative_to(directory_info.root)),
                 resource_kwargs={
                     "path": ds.path,
                     "multiplier": ds.multiplier,
@@ -30,10 +44,10 @@ class _HDFFile:
     def stream_data(self, indices_written: int) -> Iterator[StreamDatum]:
         # Indices are relative to resource
         if indices_written > self._last_emitted:
-            indices = dict(
-                start=self._last_emitted,
-                stop=indices_written,
-            )
+            indices = {
+                "start": self._last_emitted,
+                "stop": indices_written,
+            }
             self._last_emitted = indices_written
             for bundle in self._bundles:
                 yield bundle.compose_stream_datum(indices)

ophyd_async/epics/areadetector/writers/hdf_writer.py

@@ -1,7 +1,8 @@
 import asyncio
-from typing import AsyncIterator, Dict, List, Optional
+from pathlib import Path
+from typing import AsyncGenerator, AsyncIterator, Dict, List, Optional
 
-from bluesky.protocols import Asset, Descriptor, Hints
+from bluesky.protocols import Descriptor, Hints, StreamAsset
 
 from ophyd_async.core import (
     DEFAULT_TIMEOUT,
@@ -13,6 +14,7 @@ from ophyd_async.core import (
     set_and_wait_for_value,
     wait_for_value,
 )
+from ophyd_async.core.signal import observe_value
 
 from ._hdfdataset import _HDFDataset
 from ._hdffile import _HDFFile
@@ -45,15 +47,16 @@ class HDFWriter(DetectorWriter):
             self.hdf.num_extra_dims.set(0),
             self.hdf.lazy_open.set(True),
             self.hdf.swmr_mode.set(True),
-            self.hdf.file_path.set(info.directory_path),
-            self.hdf.file_name.set(f"{info.filename_prefix}{self.hdf.name}"),
+            # See https://github.com/bluesky/ophyd-async/issues/122
+            self.hdf.file_path.set(str(info.root / info.resource_dir)),
+            self.hdf.file_name.set(f"{info.prefix}{self.hdf.name}{info.suffix}"),
             self.hdf.file_template.set("%s/%s.h5"),
             self.hdf.file_write_mode.set(FileWriteMode.stream),
         )
 
         assert (
             await self.hdf.file_path_exists.get_value()
-        ), f"File path {info.directory_path} for hdf plugin does not exist"
+        ), f"File path {self.hdf.file_path.get_value()} for hdf plugin does not exist"
 
         # Overwrite num_capture to go forever
         await self.hdf.num_capture.set(0)
@@ -88,27 +91,35 @@ class HDFWriter(DetectorWriter):
         }
         return describe
 
-    async def wait_for_index(
-        self, index: int, timeout: Optional[float] = DEFAULT_TIMEOUT
-    ):
-        def matcher(value: int) -> bool:
-            return value // self._multiplier >= index
-
-        matcher.__name__ = f"index_at_least_{index}"
-        await wait_for_value(self.hdf.num_captured, matcher, timeout=timeout)
+    async def observe_indices_written(
+        self, timeout=DEFAULT_TIMEOUT
+    ) -> AsyncGenerator[int, None]:
+        """Wait until a specific index is ready to be collected"""
+        async for num_captured in observe_value(self.hdf.num_captured, timeout):
+            yield num_captured // self._multiplier
 
     async def get_indices_written(self) -> int:
         num_captured = await self.hdf.num_captured.get_value()
         return num_captured // self._multiplier
 
-    async def collect_stream_docs(self, indices_written: int) -> AsyncIterator[Asset]:
+    async def collect_stream_docs(
+        self, indices_written: int
+    ) -> AsyncIterator[StreamAsset]:
         # TODO: fail if we get dropped frames
         await self.hdf.flush_now.set(True)
         if indices_written:
             if not self._file:
+                path = Path(await self.hdf.full_file_name.get_value())
                 self._file = _HDFFile(
-                    await self.hdf.full_file_name.get_value(), self._datasets
+                    self._directory_provider(),
+                    # See https://github.com/bluesky/ophyd-async/issues/122
+                    path,
+                    self._datasets,
                 )
+                # stream resource says "here is a dataset",
+                # stream datum says "here are N frames in that stream resource",
+                # you get one stream resource and many stream datums per scan
+
                 for doc in self._file.stream_resources():
                     yield "stream_resource", doc
             for doc in self._file.stream_data(indices_written):