xdem.EPC.subsample

Contents

xdem.EPC.subsample#

EPC.subsample(subsample, return_indices=False, random_state=None)#
Overloads:

  • self, subsample (int | float), return_indices (Literal[False]), random_state (int | np.random.Generator | None) → NDArrayNum

  • self, subsample (int | float), return_indices (Literal[True]), random_state (int | np.random.Generator | None) → tuple[NDArrayNum, …]

  • self, subsample (float | int), return_indices (bool), random_state (int | np.random.Generator | None) → NDArrayNum | tuple[NDArrayNum, …]

Randomly sample the point cloud. Only valid values are considered.

Parameters:

  • subsample (float | int) – Subsample size. If <= 1, a fraction of the total pixels to extract. If > 1, the number of pixels.

  • return_indices (bool) – Whether to return the extracted indices only.

  • random_state (int | Generator | None) – Random state or seed number.

Returns:

Array of sampled valid values, or array of sampled indices.

Contents