# {py:mod}`bluesky_tiled_plugins.writing.consolidators`

```{py:module} bluesky_tiled_plugins.writing.consolidators
```

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Patch <bluesky_tiled_plugins.writing.consolidators.Patch>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.Patch
    :summary:
    ```
* - {py:obj}`ConsolidatorBase <bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase
    :summary:
    ```
* - {py:obj}`CSVConsolidator <bluesky_tiled_plugins.writing.consolidators.CSVConsolidator>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CSVConsolidator
    :summary:
    ```
* - {py:obj}`HDF5Consolidator <bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator
    :summary:
    ```
* - {py:obj}`MultipartRelatedConsolidator <bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator
    :summary:
    ```
* - {py:obj}`TIFFConsolidator <bluesky_tiled_plugins.writing.consolidators.TIFFConsolidator>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.TIFFConsolidator
    :summary:
    ```
* - {py:obj}`JPEGConsolidator <bluesky_tiled_plugins.writing.consolidators.JPEGConsolidator>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.JPEGConsolidator
    :summary:
    ```
* - {py:obj}`NPYConsolidator <bluesky_tiled_plugins.writing.consolidators.NPYConsolidator>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.NPYConsolidator
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`consolidator_factory <bluesky_tiled_plugins.writing.consolidators.consolidator_factory>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.consolidator_factory
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`CONSOLIDATOR_REGISTRY <bluesky_tiled_plugins.writing.consolidators.CONSOLIDATOR_REGISTRY>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CONSOLIDATOR_REGISTRY
    :summary:
    ```
````

### API

`````{py:class} Patch
:canonical: bluesky_tiled_plugins.writing.consolidators.Patch

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.Patch
```

````{py:attribute} shape
:canonical: bluesky_tiled_plugins.writing.consolidators.Patch.shape
:type: tuple[int, ...]
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.Patch.shape
```

````

````{py:attribute} offset
:canonical: bluesky_tiled_plugins.writing.consolidators.Patch.offset
:type: tuple[int, ...]
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.Patch.offset
```

````

````{py:method} combine_patches(patches: list[bluesky_tiled_plugins.writing.consolidators.Patch]) -> bluesky_tiled_plugins.writing.consolidators.Patch
:canonical: bluesky_tiled_plugins.writing.consolidators.Patch.combine_patches
:classmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.Patch.combine_patches
```

````

`````

`````{py:class} ConsolidatorBase(stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase
```

````{py:attribute} supported_mimetypes
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.supported_mimetypes
:type: set[str]
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.supported_mimetypes
```

````

````{py:attribute} join_method
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.join_method
:type: typing.Literal[stack, concat]
:value: >
   'concat'

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.join_method
```

````

````{py:attribute} join_chunks
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.join_chunks
:type: bool
:value: >
   True

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.join_chunks
```

````

````{py:method} get_supported_mimetype(sres)
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.get_supported_mimetype
:classmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.get_supported_mimetype
```

````

````{py:property} shape
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.shape
:type: tuple[int, ...]

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.shape
```

````

````{py:property} chunks
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.chunks
:type: tuple[tuple[int, ...], ...]

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.chunks
```

````

````{py:property} has_skips
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.has_skips
:type: bool

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.has_skips
```

````

````{py:method} adapter_parameters() -> dict
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.adapter_parameters

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.adapter_parameters
```

````

````{py:method} structure() -> tiled.structures.array.ArrayStructure
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.structure

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.structure
```

````

````{py:method} consume_stream_datum(doc: event_model.documents.StreamDatum)
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.consume_stream_datum

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.consume_stream_datum
```

````

````{py:method} get_data_source() -> tiled.structures.data_source.DataSource
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.get_data_source

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.get_data_source
```

````

````{py:method} init_adapter(adapter_class=None)
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.init_adapter

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.init_adapter
```

````

````{py:method} update_from_stream_resource(stream_resource: event_model.documents.StreamResource)
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.update_from_stream_resource
:abstractmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.update_from_stream_resource
```

````

````{py:method} validate(fix_errors=False) -> list[str]
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.validate

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.validate
```

````

````{py:method} get_adapter(adapters_by_mimetype=None)
:canonical: bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.get_adapter

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase.get_adapter
```

````

`````

`````{py:class} CSVConsolidator(stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.CSVConsolidator

Bases: {py:obj}`bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CSVConsolidator
```

````{py:attribute} supported_mimetypes
:canonical: bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.supported_mimetypes
:type: set[str]
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.supported_mimetypes
```

````

````{py:attribute} join_method
:canonical: bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.join_method
:type: typing.Literal[stack, concat]
:value: >
   'concat'

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.join_method
```

````

````{py:attribute} join_chunks
:canonical: bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.join_chunks
:type: bool
:value: >
   False

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.join_chunks
```

````

````{py:method} adapter_parameters() -> dict
:canonical: bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.adapter_parameters

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CSVConsolidator.adapter_parameters
```

````

`````

`````{py:class} HDF5Consolidator(stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator

Bases: {py:obj}`bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator
```

````{py:attribute} supported_mimetypes
:canonical: bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator.supported_mimetypes
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator.supported_mimetypes
```

````

````{py:method} adapter_parameters() -> dict
:canonical: bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator.adapter_parameters

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator.adapter_parameters
```

````

````{py:method} update_from_stream_resource(stream_resource: event_model.documents.StreamResource)
:canonical: bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator.update_from_stream_resource

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.HDF5Consolidator.update_from_stream_resource
```

````

`````

`````{py:class} MultipartRelatedConsolidator(permitted_extensions: set[str], stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator

Bases: {py:obj}`bluesky_tiled_plugins.writing.consolidators.ConsolidatorBase`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator
```

````{py:method} get_datum_uri(indx: int)
:canonical: bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator.get_datum_uri

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator.get_datum_uri
```

````

````{py:method} consume_stream_datum(doc: event_model.documents.StreamDatum)
:canonical: bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator.consume_stream_datum

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator.consume_stream_datum
```

````

`````

`````{py:class} TIFFConsolidator(stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.TIFFConsolidator

Bases: {py:obj}`bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.TIFFConsolidator
```

````{py:attribute} supported_mimetypes
:canonical: bluesky_tiled_plugins.writing.consolidators.TIFFConsolidator.supported_mimetypes
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.TIFFConsolidator.supported_mimetypes
```

````

`````

`````{py:class} JPEGConsolidator(stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.JPEGConsolidator

Bases: {py:obj}`bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.JPEGConsolidator
```

````{py:attribute} supported_mimetypes
:canonical: bluesky_tiled_plugins.writing.consolidators.JPEGConsolidator.supported_mimetypes
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.JPEGConsolidator.supported_mimetypes
```

````

`````

`````{py:class} NPYConsolidator(stream_resource: event_model.documents.StreamResource, descriptor: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.consolidators.NPYConsolidator

Bases: {py:obj}`bluesky_tiled_plugins.writing.consolidators.MultipartRelatedConsolidator`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.NPYConsolidator
```

````{py:attribute} supported_mimetypes
:canonical: bluesky_tiled_plugins.writing.consolidators.NPYConsolidator.supported_mimetypes
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.NPYConsolidator.supported_mimetypes
```

````

````{py:attribute} join_method
:canonical: bluesky_tiled_plugins.writing.consolidators.NPYConsolidator.join_method
:type: typing.Literal[stack, concat]
:value: >
   'stack'

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.NPYConsolidator.join_method
```

````

`````

````{py:data} CONSOLIDATOR_REGISTRY
:canonical: bluesky_tiled_plugins.writing.consolidators.CONSOLIDATOR_REGISTRY
:value: >
   'defaultdict(...)'

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.CONSOLIDATOR_REGISTRY
```

````

````{py:function} consolidator_factory(stream_resource_doc, descriptor_doc)
:canonical: bluesky_tiled_plugins.writing.consolidators.consolidator_factory

```{autodoc2-docstring} bluesky_tiled_plugins.writing.consolidators.consolidator_factory
```
````