pyIntensityFeatures =================== .. py:module:: pyIntensityFeatures .. autoapi-nested-parse:: Package to identify intensity features in imager data. .. !! processed by numpydoc !! Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/generated/pyIntensityFeatures/_main/index /autoapi/generated/pyIntensityFeatures/instruments/index /autoapi/generated/pyIntensityFeatures/proc/index /autoapi/generated/pyIntensityFeatures/tests/index /autoapi/generated/pyIntensityFeatures/utils/index Attributes ---------- .. autoapisummary:: pyIntensityFeatures.logger pyIntensityFeatures.__version__ Classes ------- .. autoapisummary:: pyIntensityFeatures.AuroralBounds Package Contents ---------------- .. py:data:: logger .. py:class:: AuroralBounds(inst_data, time_var, glon_var, glat_var, intensity_var, alt, transpose=False, opt_coords=None, hemisphere=1, stime=None, etime=None, slice_func=satellites.get_auroral_slice, slice_kwargs=None, clean_func=None, clean_kwargs=None) Bases: :py:obj:`object` Manage intensity data and obtain auroral luminosity boundaries. :Parameters: **inst_data** : object Instrument data of any type (e.g., pysat.Instrument, xr.Dataset, pds.DataFrame, dict of arrays) with appropriate observations. **time_var** : str or int Time key, attribute, variable name, or index **glon_var** : str Geographic longitude key, attribute, variable name, or index **glat_var** : str Geographic latitude key, attribute, variable name, or index **intensity_var** : str Observed intensity key, attribute, variable name, or index **alt** : float or int Altitude in km at which the aurora is observed **transpose** : bool or dict Flag that indicates whether or not the 2D data accessed by `glon_var`, `glat_var`, and `intensity_var` needs to be transposed. If a dict is supplied, the keys should correspond the the different variable names and allows different flags for each set of data. (default=False) **opt_coords** : dict or NoneType Dict of coordinates to include in `boundaries` or None to only have the required coordinates (default=None) **hemipshere** : int Integer denoting hemisphere, 1 for North and -1 for South (default=1) **stime** : object or NoneType Time object or None to use earliest time from `inst_data` (default=None) **etime** : object or NoneType Time object or None to use latest time from `inst_data` (default=None) **slice_func** : function Appropriate function to retrieve an auroral image slice (default=pyIntensityFeatures.instruments.satellites.get_auroral_slice) **slice_kwargs** : dict or NoneType Kwargs to be used by `slice_func` (default=None) **clean_func** : function or NoneType Appropriate function to clean the intensity data (default=None) **clean_kwargs** : dict or NoneType Kwargs to be used by `clean_func` (default=None) :Attributes: **inst_data** .. **time_var** .. **glon_var** .. **glat_var** .. **intensity_var** .. **alt** .. **opt_coords** .. **hemipshere** .. **stime** .. **etime** .. **slice_func** .. **clean_func** .. **boundaries** : xr.Dataset or NoneType Dataset with Auroral Luminosity Boundaries or NoneType if not run .. rubric:: Methods ================== ========== **set_boundaries** Set the `boundaries` attribute using the assigned data. **update_times** Update `stime` and `etime` attributes to reflect current data in `inst_data`, if available. ================== ========== .. !! processed by numpydoc !! .. py:attribute:: inst_data .. py:property:: alt Altitude in km at which the intensity data is located. .. !! processed by numpydoc !! .. py:attribute:: time_var .. py:attribute:: glon_var .. py:attribute:: glat_var .. py:attribute:: intensity_var .. py:property:: hemisphere Hemisphere for data processing (1 for North, -1 for South). .. !! processed by numpydoc !! .. py:property:: stime Starting time for loaded data. .. !! processed by numpydoc !! .. py:property:: etime Ending time for loaded data. .. !! processed by numpydoc !! .. py:attribute:: boundaries :value: None .. py:method:: __eq__(other) Perform equality check. :Parameters: **other** : any Other object to compare for equality :Returns: bool True if objects are identical, False if they are not. .. !! processed by numpydoc !! .. py:method:: __repr__() Print basic class properties. .. !! processed by numpydoc !! .. py:method:: __str__() Descriptively print the class properties. .. !! processed by numpydoc !! .. py:method:: _get_variable(var) Get the data variable data as an array from the data object. :Parameters: **var** : str Data variable name :Returns: ret_data :array-like numpy array of the desired data. .. rubric:: Notes Uses the `transpose` attribute to determine whether or not returned data will be transposed. .. !! processed by numpydoc !! .. py:method:: set_boundaries(min_mlat_base=59.0, mag_method='ALLOWTRACE', mlat_inc=1.0, mlt_inc=0.5, un_threshold=1.25, dayglow_threshold=300.0, strict_fit=False, lt_out_bin=5.0, max_iqr=1.5) Set `boundaries` with auroral boundaries from intensity data. :Parameters: **min_mlat_base** : float Base minimum co-latitude for intensity profiles. (default=59.0) **method** : str Method for converting between geographic and magnetic coordinates. (default='ALLOWTRACE') **mlat_inc** : float Magnetic latitude increment for gridding intensity. (default=1.0) **mlt_inc** : float Magnetic local time increment for gridding intensity. (default=0.5) **un_threshold** : float Maximum acceptable uncertainty value in degrees (default=1.25) **dayglow_threshold** : float Maximum allowable background intensity value in Rayleighs (default=300.0) **strict_fit** : bool Enforce positive values for the x-offsets in quadratic-Gaussian fits (default=False) **lt_out_bin** : float Size of local time bin in hours over which outliers in the data will be identified (default=5.0) **max_iqr** : float Maximum multiplier for the interquartile range (IQR) used to identify outliers above or below the upper or lower quartile (default=1.5) .. seealso:: :obj:`utils.coords.convert_geo_to_mag` .. .. rubric:: Notes Luminosity boundary identification finding and verification based on, but not identical to, the method developed by Longden, et al. (2010). .. rubric:: References Longden, N. S., et al. (2010) Estimating the location of the open-closed magnetic field line boundary from auroral images, 28 (9), p 1659-1678, doi:10.5194/angeo-28-1659-2010. .. only:: latex .. !! processed by numpydoc !! .. py:method:: update_times() Update `stime` and `etime` based on potentially updated data. .. !! processed by numpydoc !! .. py:data:: __version__