arpes.utilities.conversion.forward.convert_through_angular_pair

arpes.utilities.conversion.forward.convert_through_angular_pair(data: Union[xarray.core.dataarray.DataArray, xarray.core.dataset.Dataset], first_point: Dict[str, float], second_point: Dict[str, float], cut_specification: Dict[str, numpy.ndarray], transverse_specification: Dict[str, numpy.ndarray], relative_coords: bool = True, trace: Callable = None, **k_coords)[source]

Converts the lower dimensional ARPES cut passing through first_point and second_point.

This is a sibling method to convert_through_angular_point. A point and a chi angle fix a plane in momentum, as do two points. This method implements the two points equivalent whereas convert_through_angular_point fixes the latter.

A difference between this function and convert_through_angular_point is that the momentum range requested by cut_specification is considered a margin outside the interval defined by first_point and second_point. I.e. np.linspace(0, 0, 400) would produce a 400 point interpolation between first_point and second_point whereas passing np.linspace(-1, 0, 400) would provide a left margin past first_point of 1 inverse angstrom.

This endpoint relative behavior can be disabled with the relative_coords flag.

Parameters
  • data – The angle space data to be converted.

  • first_point – The angle space coordinates of the first point the cut should pass through.

  • second_point – The angle space coordinates of the second point the cut should pass through. This point will have larger momentum coordinate in the output data than first_point, i.e. it will appear on the “right side” of the data if the data is plotted as a cut.

  • cut_specification – A dictionary specifying the momentum varying axes on the output data. Interpreted as defining boundaries relative to the endpoints.

  • transverse_specification – A dictionary specifying the transverse (summed) axis on the momentum converted data.

  • relative_coords – Whether to give cut_specification relative to the momentum converted location specified in coords

  • trace – Flag controlling execution tracing

  • k_coords – Passed as hints through to convert_coordinate_forward.

Returns

The momentum cut passing first through first_point and then through second_point.