Constellation Mission Planning Tool¶

['Uses shifted copies of the satellite trajectory to reconstruct ',
 '    the model data for the variable name given.',
 '    ',
 "    - model: 'CTIPe', 'IRI', 'GITM', 'SWMF_IE', 'TIEGCM'",
 '    - variable_name = choose from list of standardized variable names from model chosen',
 '    - file_dir = file path to model data',
 '    - sat_time: a numpy array of the utc timestamps',
 '    - c1, c2, c3: numpy arrays of the positions correlating to the utc timestamps',
 '        (c1, c2, c3) should be (x,y,z) in R_E for cartesian coordinates, and (lon, lat, ',
 '        radius (R_E) or altitude (km)) for spherical coordinates. ',
 "    - coord_type: one of 'GDZ', 'GEO', 'GSM', 'GSE', 'SM', 'GEI', 'MAG', 'SPH', 'RLL'",
 "    - coord_grid: either 'car' or 'sph'. Note that not all combinations ",
 "        make sense (e.g. 'SPH' and 'car') and are not allowed.   ",
 '        Note that GDZ sph is the only coordinate system that assumes the third coordinate',
 '        is an altitude and is in km. All other spherical coordinate systems expect',
 '        a radius in R_E, and all cartesian coordinate systems expect x, y, z values',
 '        in R_E. All times should be in UTC timestamps.',
 '    - recon_option = string representing reconstruction and comparison method',
 "        Choose from 'UnMod_AvgSlice','UnMod_AvgDSlice','AvgMod_AvgSlice',",
 "        'AvgMod_AvgDSlice', 'UnMod_OrbitSliceD', 'UnMod_OrbitSliceN', 'AvgMod_OrbitSliceD',",
 "        and 'AvgMod_OrbitSliceN'",
 '        - UnMod means the satellite trajectory is not modified',
 '        - AvgMod means the dimensions not reconstructed are replaced with either ',
 '          the average value of the original and offset satellite trajectories or',
 '          the value given in the xx_avg keywords.',
 '        - AvgSlice means recon is compared with a slice at the average dimensions ',
 '          not reconstructed, again using either the average or the given value ',
 '          in the xx_avg keywords.',
 '        - AvgDSlice means recon is compared with an average of all the slices ',
 '          in the range of the dimensions not reconstructed. Weighted averages',
 '          are not supported.',
 '        - OrbitSlice means the model data is retrieved along all trajectories ',
 '          in the given constellation instead of along a given dimensional average.',
 '          The OrbitSlice option is what an inifite number of satellites would',
 '          see if positioned along the trajectory with time offsets t+dt, where',
 '          dt is the difference in time between satellites along the orbit. For ',
 '          computation purposes, the user may enter the value of dt in seconds ',
 '          in the input line or use the default of 60 seconds. The trajectories',
 '          are split into orbits, defined as where the latitude differential ',
 '          changes from positive to negative, and then extracted from the model',
 "          for the calculated time grid. The 'D' and 'N' variations are for",
 '          retrieving only the day or night portions of the orbit rather than ',
 '          the entire orbit to avoid averaging data of different natures. Whether',
 '          a given time+spatial coordinate is on the day or night side is ',
 '          determined by converting the time+spatial coordinates of the orbit slices',
 '          into GSE spherical coordinates and filtering based on longitude.',
 '          The longitude logic compensates to keep equatorial crossing in GSE',
 '          at the same MLT as the original set.',
 '          NOTE: Orbital slicing may not produce the desired result in cartesian ',
 '          coordinates.',
 '    - recon_dims = string representing choice of dimensions to use in reconstruction',
 "        'tc1','tc2','tc3','c1c2','c1c3','c2c3' are the options. ",
 '        The first name is the x-axis, and the second name is the y-axis.',
 '    - time_offsets: a list of time offsets in seconds to be applied to the trajectories (in s)',
 '    - c1_offsets: a list of offsets to be applied to the c1 coordinate in the trajectory',
 '        in the same units indicated by the coordinate system options',
 '    - c2_offsets: a list of offsets to be applied to the c2 coordinate in the trajectory',
 '        in the same units indicated by the coordinate system options',
 '    - c3_offsets: a list of offsets to be applied to the c3 coordinate in the trajectory',
 '        in the same units indicated by the coordinate system options',
 '    - the offset lists entered MUST BE THE SAME LENGTH or be equal to [0.], and',
 '        must be in the same coordinate system and units as the input coordinates.',
 '    - t_avg: the average time in UTC seconds used for when time is not a reconstructed',
 '        dimension and the recon_option chosen requires averaging. Default is',
 '        the average time of the entire set of input and offset trajectories.',
 '    - c1_avg: the average c1 value used for when c1 is not a reconstructed',
 '        dimension and the recon_option chosen requires averaging. Default is',
 '        the average c1 value of the entire set of input and offset trajectories.',
 '    - c2_avg: the average c2 value used for when c2 is not a reconstructed',
 '        dimension and the recon_option chosen requires averaging. Default is',
 '        the average c2 value of the entire set of input and offset trajectories.',
 '    - c3_avg: the average c3 value used for when c3 is not a reconstructed',
 '        dimension and the recon_option chosen requires averaging. Default is',
 '        the average c3 value of the entire set of input and offset trajectories.        ',
 '    - dx = grid resolution for the x axis in the same units as x, default of 2. ',
 '    - dy = grid resolution for the y axis in the same units as y, default of 2.',
 '    - d1 = grid resolution for the first non-reconstructed dimension. Only used',
 '        if _AvgDSlice options are chosen and if slicing in local time. Default=0.',
 '    - d2 = grid resolution for the second non-reconstructed dimension. Only used',
 '        if _AvgDSlice options are chosen. Default=0.',
 '    - dt = time resolution of sampling for orbit slicing option. Default=60 s.',
 "    - run_option = one of 'all' or 'flythrough'. Default is all.",
 '    Note: The dx and dy values are assumed to be in the units of the associated ',
 '        coordinate indicated by the coordinate options (s, R_E, deg, or km).',
 '    Note: When reconstructing in two spatial cartesian coordinates ',
 '        (e.g. xy, yz, or xz), filter the input satellite trajectory to only ',
 '        include times where the third spatial dimension inputs are either ',
 '        positive OR negative values to avoid a combined reconstruction of both ',
 '        hemispheres in the same plots. For example, if you wish to perform a',
 '        reconstruction of the x and y dimensions in spatial coordinates for',
 '        the North Pole, then filter the satellite trajectory to only include',
 '        times where the z dimension is positive. Similarly, reconstructions of',
 '        the South Pole can be performed by simply filtering out the times where',
 '        the z dimension is positive. This filtering is not needed when time is',
 '        one of the reconstructed dimensions, but it can be done if desired.',
 '        Example: ',
 '            import numpy as np',
 "            pos_idx = np.where(results['c3']>0.)[0]  #North Pole is z>0.",
 "            time = results['utc_time'][pos_idx]",
 "            c1 = results['c1'][pos_idx]",
 "            c2 = results['c2'][pos_idx]",
 "            c3 = results['c3'][pos_idx]",
 '    Cartesian note: For cartesian reconstructions of nearly spherical ',
 "        trajectories, 'Unmod_AvgDSlice' option is recommended to avoid reconstructing",
 '        a ring of data around the Earth. Reconstructions will be better achieved',
 '        in spherical coordinates for these scenarios. To easily switch between',
 '        coordinate systems, from GSE cartesian to GEO spherical, for example:',
 '            from kamodo_ccmc.flythrough.utils import ConvertCoord',
 '            lon, lat, radius, units = ConvertCoord(utc_time,x,y,z,',
 "                          'GSE','car','GEO','sph')",
 '        See the relevant flythrough example notebook for more details on this function.',
 '    ']

Text(0, 0.5, 'Frequency')