get_sample_count

method of dascore.core.coords.BaseCoord

source

get_sample_count(
    self ,
    value ,
    samples = False,
    enforce_lt_coord = False,
)-> ‘int’

Return the number of samples represented by a value.

This is calculated by dividing the value by dt and rounding up. Therefore, the output will always be greater or equal to 1.

Parameters

Parameter	Description
value	The value (supports units).
samples	If True, value is already in units of samples.
enforce_lt_coord	If True, raise an error if the number of samples obtained exceeds the length of the coordinate.