Auroral Transport Model (ATM)

Perform inverse ATM calculation

Perform an inverse calculation using VERSION 1 of the TREx Auroral Transport Model and the supplied input parameters.

Input notes:

  • timestamp
    • timestamp is expected to be in UTC
    • only specific dates are valid at this time. A 400 error will be returned if an unsupported date is requested. If you want to get a date that we have not enabled support for yet, please contact us.
    • the 'Z' character at the end of the timestamp is optional, and will be ignored if it is supplied
  • latitude and longitude
    • are to be in geodetic coordinates
    • latitude is currently limited to >=50.0 and <61.5 degrees
    • longitude is currently limited >=-110 and <-70 and degrees
  • valid values for nrlmsis_model_version are '00' and '2.0'
  • valid values for precipitation_flux_spectral_type are 'gaussian' and 'maxwellian'
  • intensity parameters are expected to be height-integrated values, and in Rayleighs
  • by default requests are cached; use the 'no_cache' parameter to disable this functionality

Output notes:

  • output parameter of the request are toggles the enable/disable each field's inclusion in the response
  • all output parameters are false by default
  • altitude is in kilometers
  • energy flux: erg/cm2/s
  • characteristic energy: eV
  • emission data: 1-D array -- volume emission rate (1/cm^3/s)
  • plasma electron density: 1-D array -- density (cm^-3)
  • plasma O2+ density: 1-D array -- density (cm^-3)
  • plasma NO+ density: 1-D array -- density (cm^-3)
  • plasma O+ density: 1-D array -- density (cm^-3)
  • plasma ionisation rate: 1-D array -- ionisation rate (1/cm^3/s)
  • plasma electron temperature: 1-D array -- temperature (K)
  • plasma ion temperature: 1-D array -- temperature (K)
  • plasma peterson conductivity: 1-D array -- conductivity (S/m)
  • plasma hall conductivity: 1-D array -- conductivity (S/m)
  • neutral O2 density: 1-D array -- density (cm^-3)
  • neutral O density: 1-D array -- density (cm^-3)
  • neutral N2 density: 1-D array -- density (cm^-3)
  • neutral N density: 1-D array -- density (cm^-3)
  • neutral temperature: 1-D array -- temperature (K)
post/api/v1/atm/inverse

Request

Request body

atm_model_version'1.0'
timestampstring date-time required
geodetic_latitudenumber required
geodetic_longitudenumber required
intensity_4278number
intensity_5577number
intensity_6300number
intensity_8446number
precipitation_flux_spectral_type'gaussian' | 'maxwellian'
nrlmsis_model_version'00' | '2.0'
atmospheric_attenuation_correctionboolean
no_cacheboolean

Response

Calculated outputs

calculation_duration_msnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.