earthkit.meteo.solar.cos_solar_zenith_angle_integrated¶
- earthkit.meteo.solar.cos_solar_zenith_angle_integrated(begin_date: DateLike, end_date: DateLike, latitudes: ArrayLike, longitudes: ArrayLike, *, intervals_per_hour: int = 1, integration_order: int = 3)¶
- earthkit.meteo.solar.cos_solar_zenith_angle_integrated(begin_date: DateLike, end_date: DateLike, latitudes: xarray.DataArray, longitudes: xarray.DataArray, *, intervals_per_hour: int = 1, integration_order: int = 3) xarray.DataArray
- earthkit.meteo.solar.cos_solar_zenith_angle_integrated(begin_date: DateLike, end_date: DateLike, latitudes: earthkit.data.FieldList, longitudes: None = None, *, intervals_per_hour: int = 1, integration_order: int = 3) earthkit.data.FieldList
- earthkit.meteo.solar.cos_solar_zenith_angle_integrated(begin_date: DateLike, end_date: DateLike, latitudes: earthkit.data.Field, longitudes: None = None, *, intervals_per_hour: int = 1, integration_order: int = 3) earthkit.data.Field
Compute the time-integrated cosine of the solar zenith angle.
- Parameters:
begin_date (
datetime.datetime | numpy.datetime64) – Start of the integration interval.end_date (
datetime.datetime | numpy.datetime64) – End of the integration interval.latitudes (
array-like | xarray.DataArray | FieldList | Field) – Latitude (degrees), or a field|(s) whose geography provides latitude/longitude values.longitudes (
array-like | xarray.DataArray | None, optional) – Longitude (degrees). Must be provided with array/xarray inputs and must be omitted (or set toNone) whenlatitudesisFieldListorField.intervals_per_hour (
int, optional) – Number of sub-intervals per hour used in the numerical integration.integration_order (
int, optional) – Order of the integration scheme.
- Returns:
Time-integrated cosine of the solar zenith angle.
- Return type:
array-like | xarray.DataArray | FieldList | Field
Implementations¶
cos_solar_zenith_angle_integrated()calls one of the following implementations depending on the type of the input arguments:earthkit.meteo.solar.array.cos_solar_zenith_angle_integrated()otherwiseearthkit.meteo.solar.xarray.cos_solar_zenith_angle_integrated()when any input is xarray.DataArrayearthkit.meteo.solar.fieldlist.cos_solar_zenith_angle_integrated()whenlatitudesis FieldList or Field
The function returns an object of the same type as the input arguments.