Skip to content

renaming batch schemes #2

@along4

Description

@along4

Summary

Review the current in-memory pipeline naming convention that uses the *Batch suffix and decide whether a more readable term should be used consistently across stage models.

Motivation

The current names like TransportedPhotonBatch, PhotoelectronBatch, McpEventBatch, IntensifierOutputBatch, and TimepixHitBatch are internally consistent, but Batch may not be the clearest term for readers. It is not immediately obvious whether Batch means:

  • in-memory stage data
  • chunked processing
  • temporary event collections
  • persisted output tables

A clearer convention such as *Data, *Table, or another term may improve readability.

Current behavior

Today, *Batch refers to in-memory, columnar data structures passed between stages. It does not refer to HDF5 schema definitions.

Goal

Decide on a clearer naming convention for in-memory stage models and, if warranted, rename them consistently across the codebase.

Possible directions

  • keep *Batch and document the meaning explicitly
  • rename in-memory stage models to *Data
  • rename in-memory stage models to *Table
  • choose another term that better distinguishes in-memory pipeline contracts from persisted schema

Acceptance criteria

  • the team agrees on the semantic meaning of the in-memory model suffix
  • the chosen naming convention is documented
  • if renamed, the change is applied consistently across code, tests, and docs

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions