BaseCoord

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

BaseCoord(
    units: pint.registry.Quantity | str | None[Quantity, str, None] = None,
    step: Any = None,
)-> None

Coordinate interface.

Coordinates are used to manage labels and indexing along a single data dimension.

Coordinates should usually be created with get_coords rather than using the class directly.

Methods

Name Description
convert_units Convert from one unit to another. Set units if None are set.
empty Empty out the coordinate.
get_attrs_dict Get attrs dict.
get_next_index Get the index a value would have in a coordinate.
get_sample_count Return the number of samples represented by a value.
get_slice_tuple Get a tuple with (start, stop) and perform basic checks.
index Index the coordinate and return new coordinate.
max Return max value.
min Return min value.
new Create new instance with some attributed updated.
select Returns an entity that can be used in a list for numpy indexing
set_units Set new units on coordinates.
simplify_units Simplify the coordinate units.
snap Snap the coordinates to evenly sampled grid points.
sort Sort the contents of the coord. Return new coord and slice for sorting.
to_summary Get the summary info about the coord.
update Update parts of the coordinate.
update_data Update the data of the coordinate.
update_limits Update the limits or sampling of the coordinates.