Crate wsi_dicom 

DICOM whole-slide export for wsi-rs datasets.

The crate facade intentionally stays small: public types and functions are re-exported from focused internal modules, while implementation details live behind crate-private module boundaries.

Optional cuda and metal features enable acceleration plumbing where the corresponding platform runtime is available. The bench-internals feature exposes unstable helpers for the repository’s benchmark harness only.

Modules

prelude

Common imports for applications using wsi-dicom.

Structs

DefaultTransferSyntaxRequest

Request for source-aware default transfer syntax selection.

DicomMetadata

Metadata accepted by the DICOM writer after strict JSON or FHIR mapping.

DoctorOptions

Options for checking validator tool availability.

DoctorReport

Validator environment report.

DoctorTool

Status for one validator tool check.

EncodedFrame

Finished compressed frame bytes ready for DICOM encapsulated Pixel Data insertion.

Export

Builder for exporting one wsi-rs-readable whole-slide image to DICOM VL WSI.

ExportMetrics

Export, routing, encode, validation, and writer counters.

ExportOptions

Options controlling how a source WSI should be converted into DICOM.

ExportReport

Top-level report returned by a DICOM export.

ExportRequest

A validated request to export one vendor WSI into one DICOM output directory.

FrameSamples

Borrowed interleaved samples and geometry for DICOM J2K/HTJ2K frame encoding.

GpuEncodeMetrics

GPU JPEG 2000 encode configuration, counters, and stage timings.

InstanceReport

Report for one generated DICOM instance.

J2kFrameEncodeRequest

Request to encode one already-composed tile into DICOM-ready J2K/HTJ2K frame bytes.

JpegDirectHtj2kMetrics

Direct JPEG-to-HTJ2K coefficient-transcode counters and timings.

RouteCorpusCoverageFailure

Failure encountered while profiling one source in a corpus.

RouteCorpusCoverageReport

Route coverage report for a source corpus.

RouteCounters

Route, pixel-profile, and non-GPU-specific frame counters.

RouteCoverageReport

Route coverage report across source levels.

RouteCoverageRequest

Request to sample route coverage without writing DICOM.

RouteProfileReport

Route profiling report for one source level.

RouteProfileRequest

Request to profile frame routing for one level without writing DICOM.

SelfTestOptions

Options for generating and validating a deterministic tiny DICOM export.

SelfTestReport

Report returned by the deterministic DICOM self-test.

ValidationCheck

Result of one external validator or pixel decode check.

ValidationOptions

Options for validating generated DICOM files with external tools.

ValidationReport

Report from validating one file or directory of DICOM files.

WriteTimings

Processing and writer timing metrics.

Enums

CodecValidation

Runtime validation policy for newly encoded compressed frame bytes.

DoctorStatus

Availability status for a validator tool.

EncodeBackendPreference

Runtime preference for JPEG 2000 Lossless encode backends.

Error

Error type returned by public wsi-dicom APIs.

ExportPreset

User-facing export presets for common conversion goals.

IccProfilePolicy

Policy for DICOM Optical Path ICC profile handling when source color metadata is unavailable.

IccProfileSource

Provenance for the ICC profile written to a DICOM instance.

JpegDirectHtj2kProfile

Direct JPEG-to-HTJ2K coefficient path used for HTJ2K export from JPEG tiles.

MetadataSource

Source of metadata for the DICOM export request.

RouteCoverageTarget

Target for route coverage profiling.

RouteProgressSink

Progress reporting destination for route coverage work.

TransferSyntax

DICOM transfer syntax choices for exported VL Whole Slide Microscopy files.

UidPolicy

Policy for identifiers generated when the caller does not supply them.

ValidationStatus

Status for one DICOM validation check.

Constants

METADATA_JSON_MAX_BYTES

Maximum accepted metadata JSON file size.

Functions

default_transfer_syntax_for_source

Pick the default transfer syntax for a source.

doctor_dicom_environment

Check local external DICOM validator availability.

encode_dicom_j2k_frame

Encode one composed tile into finished compressed DICOM frame bytes.

export_dicom

Export a wsi-rs-readable WSI into DICOM VL Whole Slide Microscopy files.

profile_dicom_route_corpus_coverage

Profile route coverage for every WSI-like file under a source root.

profile_dicom_route_coverage

Profile route coverage across exportable slide planes without writing DICOM.

profile_dicom_routes

Profile the route selection and encode path for a bounded number of frames.

run_dicom_self_test

Generate a tiny deterministic source DICOM, export it, and validate the output.

validate_dicom_path

Validate a DICOM file or recursively discovered DICOM directory.