Method merge

xarray/core/coordinates.py:542–584

Merge two sets of coordinates to create a new Dataset The method implements the logic used for joining coordinates in the result of a binary operation performed on xarray objects: - If two index coordinates conflict (are not equal), an exception is raised. You mus

(
        self,
        other: Mapping[Any, Any] | None,
        *,
        compat: CompatOptions | CombineKwargDefault = "minimal",
    )

            self._update_coords(variables, indexes)

    def merge(
        self,
        other: Mapping[Any, Any] | None,
        *,
        compat: CompatOptions | CombineKwargDefault = "minimal",
    ) -> Dataset:
        """Merge two sets of coordinates to create a new Dataset

        The method implements the logic used for joining coordinates in the
        result of a binary operation performed on xarray objects:

        - If two index coordinates conflict (are not equal), an exception is
          raised. You must align your data before passing it to this method.
        - If an index coordinate and a non-index coordinate conflict, the non-
          index coordinate is dropped.
        - If two non-index coordinates conflict, both are dropped.

        Parameters
        ----------
        other : dict-like, optional
            A :py:class:`Coordinates` object or any mapping that can be turned
            into coordinates.
        compat : {"identical", "equals", "broadcast_equals", "no_conflicts", "override", "minimal"}, default: "minimal"
            Compatibility checks to use between coordinate variables.

        Returns
        -------
        merged : Dataset
            A new Dataset with merged coordinates.
        """
        from xarray.core.dataset import Dataset

        if other is None:
            return self.to_dataset()

        if not isinstance(other, Coordinates):
            other = Dataset(coords=other).coords

        coords, indexes = merge_coordinates_without_align([self, other], compat=compat)
        coord_names = set(coords)
        return Dataset._construct_direct(
            variables=coords, coord_names=coord_names, indexes=indexes
        )

    def __or__(self, other: Mapping[Any, Any] | None) -> Coordinates:
        """Merge two sets of coordinates to create a new Coordinates object