pyIntensityFeatures.instruments.satellites

Satellite instrument support functions.

Functions

get_auroral_slice(time_data, glat_data, glon_data, ...)

Retrieve an auroral image slice that spans the desired lat range.

Module Contents

pyIntensityFeatures.instruments.satellites.get_auroral_slice(time_data, glat_data, glon_data, int_data, clean_mask=None, start_time=None, hemisphere=1, min_colat=45)[source]

Retrieve an auroral image slice that spans the desired lat range.

Parameters:
time_dataarray-like

1D array of time indexes

glat_dataarray-like

2D array of geographic latitudes

glon_dataarray-like

2D array of geographic longitudes

int_dataarray-like

2D array of intensity values

clean_maskarray-like or NoneType

None to create a mask of finite values or 2D mask array specifying good values (default=None)

start_timedt.datetime or NoneType

Start time to search from or None to start from beginning of available data (default=None)

hemisphereint

Hemisphere to consider, where 1 is North and -1 is South (default=1)

min_colatint or float

Absolute value of the most equatorward latitude to include (default=45)

Returns:
intensityarray-like

Array with dimensions of time x sweep-locations containing the rectified intensity at the auroral daytime pierce point

glatarray-like

Array with dimensions of time x sweep-locations containing the geodetic latitude

glonarray-like

Array with dimensions of time x sweep-locations containing the geographic longitude

sweep_timesarray-like

Array with the starting and ending times of the auroral sweep. Gives the start and end times searched if no sweep is found.

Raises:
ValueError

If imager data does not have the same shape