calculate_coefficients#

Workflow for calculating spherical harmonic coefficients.

Working location structure:

(name)
├── data
│   └── data.LOCATIONS
│       └── (name)_(key)_(seed).LOCATIONS.tar.xz
└── calculations
    └── calculations.COEFFICIENTS
        ├── (name)_(key)_(seed)_(tick).COEFFICIENTS.csv
        └── (name)_(key)_(seed)_(tick)_(region).COEFFICIENTS.csv

Data from data.LOCATIONS are used to calculate coefficients, which are saved to calculations.COEFFICIENTS.

If region is specified, the region is included in the output key. For calculations with offset but no chunking, the output key extension starts with .(offset). to specify the index offset. For calculations with chunking, the output key extension starts with .(offset).(chunk). to specify the index offset and chunk size.

Flows

run_flow

Main calculate coefficients flow.

run_flow(context: ContextConfig, series: SeriesConfig, parameters: ParametersConfig) → None[source]#: Main calculate coefficients flow.

Configs

`ContextConfig`	Context configuration for calculate coefficients flow.
`ParametersConfig`	Parameter configuration for calculate coefficients flow.
`SeriesConfig`	Series configuration for calculate coefficients flow.

class ContextConfig[source]#

Context configuration for calculate coefficients flow.

working_location: str#: Location for input and output files (local path or S3 bucket).

class ParametersConfig[source]#

Parameter configuration for calculate coefficients flow.

key: str#: Simulation key to calculate.

seed: int#: Simulation random seed to calculate.

tick: int#: Simulation tick to calculate.

offset: int = 0#: Index offset for skipped calculations.

chunk: int | None = None#: Number of indices to calculate, starting from offset.

region: str | None = None#: Subcellular region to calculate.

scale: int = 1#: Rescaling factor for image array.

order: int = 16#: Order of the spherical harmonics coefficient parametrization.

class SeriesConfig[source]#

Series configuration for calculate coefficients flow.

name: str#: Name of the simulation series.