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

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

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

## Module Contents

### Classes

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

* - {py:obj}`RunNormalizer <bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer
    :summary:
    ```
* - {py:obj}`TiledWriter <bluesky_tiled_plugins.writing.tiled_writer.TiledWriter>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.TiledWriter
    :summary:
    ```
````

### Functions

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

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

### Data

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

* - {py:obj}`BATCH_SIZE <bluesky_tiled_plugins.writing.tiled_writer.BATCH_SIZE>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.BATCH_SIZE
    :summary:
    ```
* - {py:obj}`MAX_ARRAY_SIZE <bluesky_tiled_plugins.writing.tiled_writer.MAX_ARRAY_SIZE>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.MAX_ARRAY_SIZE
    :summary:
    ```
* - {py:obj}`RESERVED_DATA_KEYS <bluesky_tiled_plugins.writing.tiled_writer.RESERVED_DATA_KEYS>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RESERVED_DATA_KEYS
    :summary:
    ```
* - {py:obj}`JSON_TO_NUMPY_DTYPE <bluesky_tiled_plugins.writing.tiled_writer.JSON_TO_NUMPY_DTYPE>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.JSON_TO_NUMPY_DTYPE
    :summary:
    ```
* - {py:obj}`MIMETYPE_LOOKUP <bluesky_tiled_plugins.writing.tiled_writer.MIMETYPE_LOOKUP>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.MIMETYPE_LOOKUP
    :summary:
    ```
* - {py:obj}`logger <bluesky_tiled_plugins.writing.tiled_writer.logger>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.logger
    :summary:
    ```
* - {py:obj}`ExternalEventDataReference <bluesky_tiled_plugins.writing.tiled_writer.ExternalEventDataReference>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.ExternalEventDataReference
    :summary:
    ```
````

### API

````{py:data} BATCH_SIZE
:canonical: bluesky_tiled_plugins.writing.tiled_writer.BATCH_SIZE
:value: >
   10000

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.BATCH_SIZE
```

````

````{py:data} MAX_ARRAY_SIZE
:canonical: bluesky_tiled_plugins.writing.tiled_writer.MAX_ARRAY_SIZE
:value: >
   16

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.MAX_ARRAY_SIZE
```

````

````{py:data} RESERVED_DATA_KEYS
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RESERVED_DATA_KEYS
:value: >
   ['time', 'seq_num']

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RESERVED_DATA_KEYS
```

````

````{py:data} JSON_TO_NUMPY_DTYPE
:canonical: bluesky_tiled_plugins.writing.tiled_writer.JSON_TO_NUMPY_DTYPE
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.JSON_TO_NUMPY_DTYPE
```

````

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

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.MIMETYPE_LOOKUP
```

````

````{py:data} logger
:canonical: bluesky_tiled_plugins.writing.tiled_writer.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.logger
```

````

````{py:exception} ValidationError()
:canonical: bluesky_tiled_plugins.writing.tiled_writer.ValidationError

Bases: {py:obj}`Exception`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.ValidationError
```

````

````{py:function} concatenate_stream_datums(*docs: event_model.documents.StreamDatum)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.concatenate_stream_datums

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.concatenate_stream_datums
```
````

````{py:data} ExternalEventDataReference
:canonical: bluesky_tiled_plugins.writing.tiled_writer.ExternalEventDataReference
:value: >
   'namedtuple(...)'

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.ExternalEventDataReference
```

````

`````{py:class} RunNormalizer(patches: dict[str, collections.abc.Callable] | None = None, spec_to_mimetype: dict[str, str] | None = None)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer

Bases: {py:obj}`event_model.DocumentRouter`

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer
```

````{py:method} start(doc: event_model.documents.RunStart)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.start

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.start
```

````

````{py:method} stop(doc: event_model.documents.RunStop)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.stop

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.stop
```

````

````{py:method} descriptor(doc: event_model.documents.EventDescriptor)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.descriptor

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.descriptor
```

````

````{py:method} event(doc: event_model.documents.Event)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.event

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.event
```

````

````{py:method} resource(doc: event_model.documents.Resource)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.resource

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.resource
```

````

````{py:method} stream_resource(doc: event_model.documents.StreamResource)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.stream_resource

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.stream_resource
```

````

````{py:method} stream_datum(doc: event_model.documents.StreamDatum)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.stream_datum

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.stream_datum
```

````

````{py:method} datum(doc: event_model.documents.Datum)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.datum

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.datum
```

````

````{py:method} datum_page(doc: event_model.documents.DatumPage)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.datum_page

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.datum_page
```

````

````{py:method} event_page(doc: event_model.documents.EventPage)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.event_page

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.event_page
```

````

````{py:method} emit(name, doc)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.emit

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.emit
```

````

````{py:method} subscribe(func, name='all')
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.subscribe

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.subscribe
```

````

````{py:method} unsubscribe(token)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.unsubscribe

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.RunNormalizer.unsubscribe
```

````

`````

`````{py:class} TiledWriter(client: tiled.client.base.BaseClient, *, normalizer: type[event_model.DocumentRouter] | None = RunNormalizer, patches: dict[str, collections.abc.Callable] | None = None, spec_to_mimetype: dict[str, str] | None = None, backup_directory: str | None = None, batch_size: int = BATCH_SIZE, max_array_size: int = MAX_ARRAY_SIZE, validate: bool = False)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.TiledWriter

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.TiledWriter
```

````{py:method} from_uri(uri, *, normalizer: type[event_model.DocumentRouter] | None = RunNormalizer, patches: dict[str, collections.abc.Callable] | None = None, spec_to_mimetype: dict[str, str] | None = None, backup_directory: str | None = None, batch_size: int = BATCH_SIZE, **kwargs)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.TiledWriter.from_uri
:classmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.TiledWriter.from_uri
```

````

````{py:method} from_profile(profile, *, normalizer: type[event_model.DocumentRouter] | None = RunNormalizer, patches: dict[str, collections.abc.Callable] | None = None, spec_to_mimetype: dict[str, str] | None = None, backup_directory: str | None = None, batch_size: int = BATCH_SIZE, **kwargs)
:canonical: bluesky_tiled_plugins.writing.tiled_writer.TiledWriter.from_profile
:classmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.writing.tiled_writer.TiledWriter.from_profile
```

````

`````