pyIntensityFeatures.utils.grids
Functions to support, create, and process grids.
Functions
|
Identify the unique values to the desired significance. |
|
Create an intensity grid, using the mean and standard deviation. |
Module Contents
- pyIntensityFeatures.utils.grids.unique(vals, decimals=3, **kwargs)[source]
Identify the unique values to the desired significance.
- Parameters:
- valsarray-like
Input array that will be flattened unless axis is specified
- decimalsint
Number of decimal places to round to. If the number is negative, it specifies the number of positions to the left of the decimal point. (default=3)
- **kwargsdict
Keyword arguements supported by numpy’s unique function.
- Returns:
- uvalsarray-like
Sorted array of unique values.
See also
np.unique
- pyIntensityFeatures.utils.grids.grid_intensity(intensity, mlat, mlt, eq_mlat=45.0, mlat_inc=1.0, mlt_inc=0.5)[source]
Create an intensity grid, using the mean and standard deviation.
- Parameters:
- intensitynp.array
Input intensity array with NaN fill values
- mlatnp.array
Magnetic latitude at intensity locations
- mltnp.array
Magnetic local time at intensity locations
- eq_mlatfloat
Most equatorward magnetic latitude magnitude, do not account for the hemisphere (defaut=45.0)
- mlat_incfloat
Magnetic latitude increment for output (default=1.0)
- mlt_incfloat
Magnetic local time increment for output (default=0.5)
- Returns:
- mean_intensitynp.array
2D array of mean intensity values
- std_intensitynp.array
2D array of intensity standard deviations
- num_intensitynp.array
2D array of intensity counts per bin
- mlat_binsnp.array
Magnetic latitude of output bin centres
- mlt_binsnp.array
Magnetic local time of output bin centres
Notes
The hemisphere is determined using the sign of the data in mlat