scale_sample_coordinates#

scale_sample_coordinates(samples: DataFrame, coordinate_type: str | None, resolution: float, scale_xy: float, scale_z: float) → DataFrame[source]#

Scales sampled coordinates using to given coordinate type.

The “absolute” coordinate type scales sample index coordinate into absolute positions (in um). The “step” coordinate type scales sample index coordinates by step size. Otherwise, samples index coordinates are not modified.

Parameters:

  • samples – Sample cell ids and coordinates.

  • coordinate_type ({'absolute', 'step', None}) – The coordinate scaling type.

  • resolution – Distance between samples (um).

  • scale_xy – Resolution scaling in x/y (um/pixel).

  • scale_z – Resolution scaling in z (um/pixel).

Returns:

Sample cell ids and scaled coordinates.