Returns a new array with dropped labels for missing values along the provided dimension. Parameters ---------- dim : Hashable Dimension along which to drop missing values. Dropping along multiple dimensions simultaneously is not yet supported.
(
self,
dim: Hashable,
*,
how: Literal["any", "all"] = "any",
thresh: int | None = None,
)
| 3421 | return self._from_temp_dataset(dataset) |
| 3422 | |
| 3423 | def dropna( |
| 3424 | self, |
| 3425 | dim: Hashable, |
| 3426 | *, |
| 3427 | how: Literal["any", "all"] = "any", |
| 3428 | thresh: int | None = None, |
| 3429 | ) -> Self: |
| 3430 | """Returns a new array with dropped labels for missing values along |
| 3431 | the provided dimension. |
| 3432 | |
| 3433 | Parameters |
| 3434 | ---------- |
| 3435 | dim : Hashable |
| 3436 | Dimension along which to drop missing values. Dropping along |
| 3437 | multiple dimensions simultaneously is not yet supported. |
| 3438 | how : {"any", "all"}, default: "any" |
| 3439 | - any : if any NA values are present, drop that label |
| 3440 | - all : if all values are NA, drop that label |
| 3441 | |
| 3442 | thresh : int or None, default: None |
| 3443 | If supplied, require this many non-NA values. |
| 3444 | |
| 3445 | Returns |
| 3446 | ------- |
| 3447 | dropped : DataArray |
| 3448 | |
| 3449 | Examples |
| 3450 | -------- |
| 3451 | >>> temperature = [ |
| 3452 | ... [0, 4, 2, 9], |
| 3453 | ... [np.nan, np.nan, np.nan, np.nan], |
| 3454 | ... [np.nan, 4, 2, 0], |
| 3455 | ... [3, 1, 0, 0], |
| 3456 | ... ] |
| 3457 | >>> da = xr.DataArray( |
| 3458 | ... data=temperature, |
| 3459 | ... dims=["Y", "X"], |
| 3460 | ... coords=dict( |
| 3461 | ... lat=("Y", np.array([-20.0, -20.25, -20.50, -20.75])), |
| 3462 | ... lon=("X", np.array([10.0, 10.25, 10.5, 10.75])), |
| 3463 | ... ), |
| 3464 | ... ) |
| 3465 | >>> da |
| 3466 | <xarray.DataArray (Y: 4, X: 4)> Size: 128B |
| 3467 | array([[ 0., 4., 2., 9.], |
| 3468 | [nan, nan, nan, nan], |
| 3469 | [nan, 4., 2., 0.], |
| 3470 | [ 3., 1., 0., 0.]]) |
| 3471 | Coordinates: |
| 3472 | lat (Y) float64 32B -20.0 -20.25 -20.5 -20.75 |
| 3473 | lon (X) float64 32B 10.0 10.25 10.5 10.75 |
| 3474 | Dimensions without coordinates: Y, X |
| 3475 | |
| 3476 | >>> da.dropna(dim="Y", how="any") |
| 3477 | <xarray.DataArray (Y: 2, X: 4)> Size: 64B |
| 3478 | array([[0., 4., 2., 9.], |
| 3479 | [3., 1., 0., 0.]]) |
| 3480 | Coordinates: |