spinifex.get_dtec

Module to calculate electron densities

Classes

DTEC

object with all electron densities

Functions

`_get_dtec`(→ DTEC)	Get the electron densities for a given set of ionospheric piercepoints
`_get_dtec_from_altaz`(→ DTEC)	get electron densities for user defined altaz coordinates
`_get_dtec_from_skycoord`(→ DTEC)	get electron densities for user defined times and source coordinate
`get_dtec_from_altaz`(→ DTEC)	get rotation measures for user defined altaz coordinates
`get_dtec_from_skycoord`(→ DTEC)	get electron densities for user defined times and source coordinate

Module Contents

class spinifex.get_dtec.DTEC[source]

Bases: NamedTuple

object with all electron densities

airmass: numpy.typing.NDArray[numpy.floating[Any]][source]: conversion from vertical to slant TEC

electron_density: numpy.typing.NDArray[numpy.floating[Any]][source]: electron density (TECU)

electron_density_error: numpy.typing.NDArray[numpy.floating[Any]][source]: electron density uncertainty (TECU)

height: numpy.typing.NDArray[numpy.floating[Any]][source]: array of altitudes (km)

loc: astropy.coordinates.EarthLocation[source]: observer location

times: astropy.time.Time[source]: time axis

spinifex.get_dtec._get_dtec(ipp: spinifex.geometry.IPP, iono_model: spinifex.ionospheric.ModelDensityFunction[spinifex.ionospheric.models.O], iono_options: spinifex.ionospheric.models.O | None = None) → DTEC[source]

Get the electron densities for a given set of ionospheric piercepoints

Parameters

ippIPP: ionospheric piercepoints
iono_modelModelDensityFunction, optional: ionospheric model, by default ionospheric_models.ionex
iono_optionsOptionType, optional: options for the ionospheric model, by default None

Returns

DTEC: electron densities object

spinifex.get_dtec._get_dtec_from_altaz(loc: astropy.coordinates.EarthLocation, altaz: astropy.coordinates.AltAz, iono_model: spinifex.ionospheric.ModelDensityFunction[spinifex.ionospheric.models.O], height_array: astropy.units.Quantity = DEFAULT_IONO_HEIGHT, iono_options: spinifex.ionospheric.models.O | None = None) → DTEC[source]

get electron densities for user defined altaz coordinates

Parameters

locEarthLocation: observer location
altazAltAz: altaz coordinates
height_arrayu.Quantity, optional: altitudes, by default default_height
iono_modelModelDensityFunction, optional: ionospheric model, by default ionospheric_models.ionex
iono_optionsdict: keyword arguments for the ionospheric model

Returns

DTEC: electron density object

spinifex.get_dtec._get_dtec_from_skycoord(loc: astropy.coordinates.EarthLocation, times: astropy.time.Time, source: astropy.coordinates.SkyCoord, iono_model: spinifex.ionospheric.ModelDensityFunction[spinifex.ionospheric.models.O], height_array: astropy.units.Quantity = DEFAULT_IONO_HEIGHT, iono_options: spinifex.ionospheric.models.O | None = None) → DTEC[source]

get electron densities for user defined times and source coordinate

Parameters

locEarthLocation: observer location
timesTime: times
sourceSkyCoord: coordinates of the source
height_arrayNDArray, optional: altitudes, by default default_height
iono_modelModelDensityFunction, optional: ionospheric model, by default ionospheric_models.ionex
iono_kwargsdict: keyword arguments for the ionospheric model

Returns

DTEC: relectron density object

spinifex.get_dtec.get_dtec_from_altaz(loc: astropy.coordinates.EarthLocation, altaz: astropy.coordinates.AltAz, iono_model_name: str = 'ionex', **iono_kwargs: Any) → DTEC[source]

get rotation measures for user defined altaz coordinates

Parameters

locEarthLocation: observer location
altazAltAz: altaz coordinates
iono_model_namestr, optional: ionospheric model name, by default “ionex”. Must be a supported ionospheric model.
iono_optionsdict: keyword arguments for the ionospheric model

Returns

DTEC: electron density object

spinifex.get_dtec.get_dtec_from_skycoord(loc: astropy.coordinates.EarthLocation, times: astropy.time.Time, source: astropy.coordinates.SkyCoord, iono_model_name: str = 'ionex', **iono_kwargs: Any) → DTEC[source]

get electron densities for user defined times and source coordinate

Parameters

locEarthLocation: observer location
timesTime: times
sourceSkyCoord: coordinates of the source
iono_model_namestr, optional: ionospheric model name, by default “ionex”. Must be a supported ionospheric model.
iono_kwargsdict: keyword arguments for the ionospheric model

Returns

DTEC: relectron density object