Computation functions ======================= .. _toc_comp_stats: Statistics ------------ .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`accumulate` - Add up the values per field in a :class:`Fieldset` * - :func:`average` - Compute the average per field in a :class:`Fieldset` * - :func:`average_ew` - Compute the zonal averages for each field in a :class:`Fieldset` * - :func:`average_ns` - Compute the meridional averages for each field in a :class:`Fieldset` * - :func:`corr_a` - Compute the area-weighted correlation for each field in a :class:`Fieldset` * - :func:`covar` - Return the covariance of two :class:`Fieldset` objects * - :func:`covar_a` - Compute the area-weighted covariance for each field in a :class:`Fieldset` * - :func:`deacc` - De-accumulate values in a :class:`Fieldset` * - :func:`frequencies` - Compute the frequencies of a :class:`Fieldset` * - :func:`integrate` - Compute the average weighted by the gridcell area for each field in :class:`Fieldset` * - :func:`max` - Maximum * - :func:`maxvalue` - Maximum value of a :class:`Fieldset` * - :func:`mean` - Return the mean of the values in a :class:`Fieldset` or :class:`Geopoints` * - :func:`mean_ew` - Generate a :class:`Fieldset` out of East-West means * - :func:`min` - Minimum * - :func:`minvalue` - Minimum value of a :class:`Fieldset` or :class:`Geopoints` * - :func:`percentile` - Compute a set of percentiles in a :class:`Fieldset` * - :func:`rms` - Compute he pointwise root mean square for :class:`Fieldset` * - :func:`rms_a` - Compute the area-weighted root mean square for :class:`Fieldset` * - :func:`stdev` - Return the standard deviation of all the fields in a :class:`Fieldset` * - :func:`stdev_a` - Compute the area-weighted standard deviation for each field in a :class:`Fieldset` * - :func:`sum` - Compute the sum of the values in a :class:`Fieldset` or :class:`Geopoints` * - :func:`var` - Return the variance of all the fields in a :class:`Fieldset` * - :func:`var_a` - Compute the area-weighted variance for each field in a :class:`Fieldset` .. _toc_comp_geo: Geographic ------------ .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`bearing` - Compute the bearings with respect to a reference in a :class:`Fieldset` point * - :func:`convolve` - Perform spatial convolution on a :class:`Fieldset` * - :func:`coslat` - Generate a field with the cosine of the latitudes in a :class:`Fieldset` * - :func:`distance` - Compute the distances in a :class:`Fieldset` or :class:`Geopoints` to a reference point * - :func:`geosort` - Sort a :class:`Geopoints` North to South and West to East * - :func:`grid_cell_area` - Compute the grid cell area in a :class:`Fieldset` * - :func:`interpolate` - Interpolate :class:`Fieldset` values to the specified location * - :func:`latitudes` - Return the latitudes of a :class:`Fieldset` or :class:`Geopoints` * - :func:`longitudes` - Return the longitudes from a :class:`Fieldset` or :class:`Geopoints` * - :func:`nearest_gridpoint` - Return the nearest grid point value from a :class:`Fieldset` * - :func:`nearest_gridpoint_info` - Return the nearest grid point value from a :class:`Fieldset` * - :func:`offset` - Offsets the locations of :class:`Geopoints` * - :func:`regrid` - Regridding and derivatives * - :func:`reprojection` - Repoject satellite view GRIB data onto a latlon grid * - :func:`sinlat` - Generate a field with the cosine of the latitudes in a :class:`Fieldset` * - :func:`smooth_gaussian` - Perform spatial smoothing on a :class:`Fieldset` * - :func:`smooth_n_points` - Perform spatial smoothing on a :class:`Fieldset` * - :func:`solar_zenith_angle` - Compute the solar zenith angle for a :class:`Fieldset` * - :func:`subsample` - Filter the points of the first :class:`Geopoints` that exist in the second one * - :func:`surrounding_points_indexes` - Return the indexes of the four surrounding grid points in a :class:`Fieldset` * - :func:`tanlat` - Generate a field with the tangent of the latitudes in a :class:`Fieldset` .. _toc_comp_mask: Masking --------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`bitmap` - Convert numbers to missing values in a :class:`Fieldset` * - :func:`mask` - Generate masks for a :class:`Fieldset` or :class:`Geopoints` * - :func:`nobitmap` - Convert missing values to numbers in a :class:`Fieldset` * - :func:`poly_mask` - Generate polygon masks for a :class:`Fieldset` * - :func:`remove_missing_latlons` - Removing missing lat/lons form a :class:`Geopoints` * - :func:`remove_missing_values` - Remove missing values from a :class:`Geopoints` * - :func:`rmask` - Generate masks based on a radius around a point for :class:`Fieldset` .. _toc_comp_wind: Wind ------ .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`absolute_vorticity` - Compute the absolute vorticity from a relative vorticity :class:`Fieldset` * - :func:`direction` - Compute the wind direction * - :func:`divrot` - Compute the rotational wind from a spectral vorticity :class:`Fieldset` * - :func:`divwind` - Compute the divergent wind from a spectral divergence :class:`Fieldset` * - :func:`geostrophic_wind` - Compute the geostrophic wind on pressure levels in a :class:`Fieldset` * - :func:`speed` - Compute the wind speed from a u and v component :class:`Fieldset` * - :func:`streamfn` - Compute the stream function from a spectral vorticity :class:`Fieldset` * - :func:`uvwind` - Compute u/v from a spectral vorticty and divegence :class:`Fieldset` * - :func:`velpot` - Compute the velocity potential from a spectral divergence :class:`Fieldset` * - :func:`xy_from_polar` - Compute the x and y components from polar components .. _toc_comp_vertical: Vertical ---------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`geopotential_from_height` - Compute the geopotential from geometric height * - :func:`height_from_geopotential` - Compute the geometric height from geopotential * - :func:`mcross_sect` - Generate data for the cross section view * - :func:`mhovmoeller_area` - Generate data for the Hovmoeller area mode * - :func:`mhovmoeller_expand` - Generate data for the Hovmoeller expand mode * - :func:`mhovmoeller_line` - Generate data for the Hovmoeller line mode * - :func:`mhovmoeller_vertical` - Generate data for the Hovmoeller vertical mode * - :func:`ml_to_hl` - Interpolate a model level :class:`Fieldset` to height levels * - :func:`mvert_prof` - Generate data for the vertical profile view * - :func:`mvl_geopotential_on_ml` - Compute the geopotential on model levels for a :class:`Fieldset` * - :func:`mvl_ml2hPa` - Interpolate a :class:`Fieldset` on model levels to pressure levels (in hPa) * - :func:`mxs_average` - Generate data for the average view * - :func:`pl_to_hl` - Interpolate a pressure level :class:`Fieldset` to height levels * - :func:`pl_to_pl` - Interpolate pressure level fields to pressure levels * - :func:`pressure` - Compute the pressure on model levels in a :class:`Fieldset` (deprecated) * - :func:`pressure_derivative` - Compute the verical pressure derivative * - :func:`q_vector` - Compute the Q-vector * - :func:`static_stability` - Compute the static stability * - :func:`thickness` - Compute the pressure thickness on model levels in a :class:`Fieldset` (deprecated) * - :func:`unipressure` - Compute the pressure on model levels in a :class:`Fieldset` * - :func:`unithickness` - Compute the pressure thickness of model levels in a :class:`Fieldset` * - :func:`univertint` - Perform a vertical integration for a :class:`Fieldset` * - :func:`vertint` - Perform a vertical integration for a :class:`Fieldset` (deprecated) * - :func:`w_from_omega` - Compute the vertical velocity in m/s from pressure velocity .. _toc_comp_thermo: Thermodynamics ---------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`dewpoint_from_relative_humidity` - Compute the dewpoint for a given temperature and relative humidity * - :func:`dewpoint_from_specific_humidity` - Compute the dewpoint for a given specific humidity and pressure * - :func:`eqpott_m` - Compute the equivalent potential temperature on model levels * - :func:`eqpott_p` - Compute the equivalent potential temperature on pressure levels * - :func:`lifted_condensation_level` - Compute the Lifted Condensation Level (LCL) using the parcel method * - :func:`mixing_ratio` - Compute the mixing ratio from specific humidity * - :func:`potential_temperature` - Compute the potential temperature for a given temperature and pressure * - :func:`pott_m` - Compute the potential temperature on model levels * - :func:`pott_p` - Compute the potential temperature on pressure levels * - :func:`relative_humidity_from_dewpoint` - Compute the relative humidity for a given temperature and dewpoint * - :func:`relative_humidity_from_specific_humidity` - Compute the relative humidity from specific humidity * - :func:`relhum` - Compute the relative humidity from specific humidity * - :func:`saturation_mixing_ratio` - Compute the saturation mixing ratio for a given temperature and pressure * - :func:`saturation_vapour_pressure` - Compute the saturation vapour pressure for a given temperature * - :func:`seqpott_m` - Compute the saturation equivalent potential temperature on model levels * - :func:`seqpott_p` - Compute the saturation equivalent potential temperature on pressure levels * - :func:`specific_humidity_from_dewpoint` - Compute the specific humidity for a given dewpoint and pressure * - :func:`temperature_from_potential_temperature` - Compute the temperature from potential tempearture and pressure * - :func:`thermo_bufr` - Generate thermodynamical profile from :class:`Bufr` * - :func:`thermo_data_info` - Extracts information from a thermo data object * - :func:`thermo_data_values` - Extracts data and metadata from a thermo data object * - :func:`thermo_grib` - Generate thermodynamical profile from GRIB * - :func:`thermo_parcel_area` - Return a set of coloured areas from a thermo parcel path * - :func:`thermo_parcel_path` - Compute the path of an ascending thermodynamic parcel * - :func:`vapour_pressure` - Compute the vapour pressure for a given specific humidity and pressure * - :func:`virtual_temperature` - Compute the virtual temperature for a given temperature and specific humidity .. _toc_comp_calculus: Calculus ---------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`divergence` - Compute the horizontal divergence of a vector :class:`Fieldset` * - :func:`first_derivative_x` - Compute first West-East derivative of a :class:`Fieldset` * - :func:`first_derivative_y` - Compute first South-North derivative of a :class:`Fieldset` * - :func:`gradient` - Compute horizontal gradient of a :class:`Fieldset` * - :func:`integral` - Compute the surface integral of a :class:`Fieldset` * - :func:`laplacian` - Compute the horizontal Laplacian of :class:`Fieldset` * - :func:`regrid` - Regridding and derivatives * - :func:`second_derivative_x` - Compute the second West-East derivative of a :class:`Fieldset` * - :func:`second_derivative_y` - Compute the econd South-North derivative of a :class:`Fieldset` * - :func:`shear_deformation` - Compute the shear deformation of a vector :class:`Fieldset` * - :func:`stretch_deformation` - Compute the stretch deformation of a vector :class:`Fieldset` * - :func:`vorticity` - Compute the relative vorticity of a vector :class:`Fieldset` .. _toc_comp_maths: Basic mathematics ------------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`abs` - Compute the absolute value * - :func:`acos` - Compute the arc cosine * - :func:`asin` - Compute the arc sine * - :func:`atan` - Compute the arc tangent * - :func:`atan2` - Compute the arc tangent of 2 :class:`Fieldset` objects * - :func:`cos` - Compute the cosine * - :func:`div` - Compute the integer part of a divison * - :func:`exp` - Compute the exponential * - :func:`intbits` - Return ranges of bits * - :func:`log` - Compute the natural logarithm * - :func:`log10` - Compute the base 10 logarithm * - :func:`mod` - Compute the integer remainder of a divison * - :func:`sgn` - Compute the sign * - :func:`sin` - Compute the sine * - :func:`sqrt` - Compute the square root * - :func:`tan` - Compute the tangent