Configuration

Global configuration module for RadiObject settings including TileDB context management, read/write options, and S3 cloud storage configuration.

`radiobject.ctx`

TileDB context configuration for radiology data.

`CompressionConfig`

Bases: BaseModel

Compression settings for volume data.

`Compressor`

Bases: str, Enum

Compression algorithms suited for radiology data.

`OrientationConfig`

Bases: BaseModel

Orientation detection and standardization settings.

`validate_canonical_target()`

Ensure canonical target is valid.

`RadiObjectConfig`

Bases: BaseModel

Configuration for RadiObject TileDB context.

`to_tiledb_config(include_s3_credentials=False)`

Convert to TileDB Config object.

Parameters:

Name	Type	Description	Default
`include_s3_credentials`	`bool`	If True, fetch AWS credentials from boto3. This is off by default to avoid expensive/failing credential lookups for local-only operations.	`False`

`to_tiledb_ctx(include_s3_credentials=False)`

Convert to TileDB Ctx object.

Parameters:

Name	Type	Description	Default
`include_s3_credentials`	`bool`	If True, fetch AWS credentials from boto3.	`False`

`validate_compression_level()`

Ensure compression level is valid for the algorithm.

`ReadConfig`

Bases: BaseModel

Settings for reading TileDB arrays.

`S3Config`

Bases: BaseModel

S3/cloud storage settings.

`SliceOrientation`

Bases: str, Enum

Preferred slicing orientation for tile optimization.

`TileConfig`

Bases: BaseModel

Tile dimensions for chunked storage.

`extents_for_shape(shape)`

Compute optimal tile extents based on orientation and volume shape.

`WriteConfig`

Bases: BaseModel

Settings applied when creating new TileDB arrays (immutable after creation).

`configure(*, write=None, read=None, s3=None)`

Update global configuration.

Examples:

Configure write settings (tile strategy, compression):

configure(write=WriteConfig(
    tile=TileConfig(orientation=SliceOrientation.AXIAL),
    compression=CompressionConfig(algorithm=Compressor.ZSTD, level=5),
))

Configure read settings (memory, concurrency):

configure(read=ReadConfig(memory_budget_mb=2048, max_workers=8))

Configure S3 settings:

configure(s3=S3Config(region="us-west-2"))

`get_radiobject_config()`

Get the current RadiObject configuration.

`get_tiledb_config()`

Get the underlying TileDB Config object for advanced users.

`get_tiledb_ctx()`

Get the global TileDB context (lazily built from config).

`reset_radiobject_config()`

Reset RadiObject configuration to defaults.