Skip to content

Fill in some gaps in developer/advanced user documentation #457

@melissalinkert

Description

@melissalinkert

There are a variety of topics and features that aren't clearly represented by a documentation page, so are difficult to reference in support threads or other discussions. In no particular order:

  • Memoizer/memo files
    - only slightly documented in the MATLAB dev page, but this should really have it's own page
    - should also include things to consider when updating/adding readers, e.g. what should be declared as transient
  • MetadataStore/MetadataRetrieve specifics
    - there are some code examples, but recent work in OMEXMLMetadata: prevent IndexOutOfBoundsException when setting references ome-model#229 and related PRs highlights that more clarification around the expected usage and limitations might be useful
  • Min/max API
    - there is a single reference to MinMaxCalculator, but no discussion of IMinMaxStore, and no discussion of the benefits or implications of MinMaxCalculator
    - also the use of IFormatReader.getBitsPerPixel()?
  • Modulo API
    - not referenced anywhere that I could find apart from https://docs.openmicroscopy.org/ome-model/6.0.0/ome-tiff/data.html#modulo-datasets, which doesn't cover any of the Bio-Formats API or how it is used in command line tools/plugins; a page would have been nice in the context of Fix and refactor ModuloC handling in ImageJ plugins bioformats#4371
  • Domain-specific reference for HCS data
    - we have some code examples, but it would be nice to tie everything together (including the whole OME Plate/Well/WellSample vs Bio-Formats series concept) into a single page similar to what we have for WSI

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions