CoordSummary

class of dascore.core.coords
inherits from: DascoreBaseModel, pydantic.main.BaseModel
source

CoordSummary(
    dtype: str = ““,
    min: Any ,
    max: Any ,
    step: Any | None[Any, None] = None,
    units: Quantity | str | None = None,
    dims: tuple[str, …] = (),
    len: int | None[int, None] = None,
    data_id: str | None[str, None] = None,
    step_numerator: int | None[int, None] = None,
    step_denominator: int | None[int, None] = None,
    origin_offset: int | None[int, None] = None,
    jittered: bool = False,
    gapped: bool = False,
    offset_min: float | None[float, None] = None,
    offset_max: float | None[float, None] = None,
    run_count: int | None[int, None] = None,
    runs: tuple[tuple[RunRecord, …], None] = None,
)-> None

A summary for coordinates.

Provides enough information for indexing coordinates and creating range coordinates. Like the coordinate, it states a step (None if it has none) and whether the labels are jittered or gapped on it; runs are the coordinate’s run records, kept for a coordinate of more than one and at most max_index_runs.

Methods

Name Description
get_correct_dtype_cast_values Ensure the correct dtype is provided and value conform to it.
model_copy Copy the model, dropping cached values the update invalidates.
new Create new instance with some attributed updated.
to_coord Convert to an evenly sampled coord, if possible.