projects/maven/KP_Toolkit/
mvn_kp_iuvs_search.pro
:Name: mvn_kp_iuvs_search :Author: Kris Larsen & John Martin :Description: Searches input IUVS KP data structure based on min and/or max search parameters :Params: iuvs_in: in, required, type=array of structures IUVS KP data structure (data structure output from mvn_kp_read) iuvs_out: out, required, type=array of structures output KP data structure containing datat that met all search criteria :Keywords: list: in, optional, type=boolean List out possible tags names to search (& index identifiers associated with tags). No search performed. If no observation keyword supplied, will only list “common” variables (geometry values which exist in all observation modes). If observation keyword supplied, will also list tags for that observation mode. tag: in, optional, type=intarr/strarr Required if /list keyword not supplied. The name, or names, of the IUVS data parameter (or integer index) to search on. Use /list keyword to see possible names or index integers to search on. observation: in, optional, type=string Specify a specific observation to either list or search within. species: in, optional, type=string Specify a species to search. Only applicable if searching a tag which has multiple species (CO2, CO, H, O, C, N, N2 for periapse scale_height) min: in, optional, type=fltarr the minimum value of the parameter to be searched on (or array of values). One or more minimum values. If multiple tags input & multiple min values input, each min value will correspond with each tag (by array position). If multiple tags & one min value, the min value is used for all tags. Cannot enter more min values than tags. max: in, optional, type=fltarr the maximum value of the parameter to be searced on (or array of values) One or more maximum values. If multiple tags input & multiple max values input, each max value will correspond with each tag (by array position). If multiple tags & one max value, the max value is used for all tags. Cannot enter more max values than tags. altitude: in, optional, type=fltarr(2) Narrow down altitude bins to search within. Provide min/max as two item array. Only applicable if searching for a tag that is binned by altitude (e.g. Periapse radiance values) range: in, optional, type=boolean Print out orbit number for first and last element of input data structure. debug: in, optional, type=boolean On error, - "Stop immediately at the statement that caused the error and print the current program stack." If not specified, error message will be printed and IDL with return to main program level and stop. Note: When searching for common geometry values, if any observation mode during an orbit matches the search criteria, that orbit will be considered a match. All observation modes are kept and stored in the iuvs_out data structure for that matching orbit, even if only one observation mode had the common geometry value match the criteria. To see which observation mode matched the common search, a new structure tag is added at the top level of the iuvs_out data structure 'MATCHING_OBS' with a string containing which observation modes matched the common search criteria. If an observation is sepcified (using the observation keyword), any common gemoetry value is still searched across all observation modes - not just the observation mode that was specified. If you want to search for a common geometry value, only in a specific set of observation modes, then use mvn_kp_read, with /iuvs_[mode] keywords to read in only the IUVS observation modes you want to search. Then use this IUVS data structure, which only contains the observation modes you want to search, as the input to mvn_kp_iuvs_search.
Routines
Routines from mvn_kp_iuvs_search.pro
MVN_KP_IUVS_TAG_PARSER, kp_data, input_tag, common_tag, level1_index, observation=observation, species=species, index_species=index_species
MVN_KP_IUVS_TAG_LIST_COMMON, data
MVN_KP_IUVS_TAG_LIST_MODE, observation, observation_name
result = MVN_KP_IUVS_SEARCH_COMMON(data, tag_index, min_value, max_value)
result = MVN_KP_IUVS_SEARCH_MEASUREMENTS(observation, observation_name, measureI, speciesID, min=min, max=max, altitude=altitude)
MVN_KP_IUVS_SEARCH, iuvs_in, iuvs_out, tag=tag, species=species, observation=observation, min=min, max=max, list=list, range=range, debug=debug, altitude=altitude
Routine details
top source MVN_KP_IUVS_TAG_PARSER
MVN_KP_IUVS_TAG_PARSER, kp_data, input_tag, common_tag, level1_index, observation=observation, species=species, index_species=index_species
Parameters
- kp_data
- input_tag
- common_tag
- level1_index
Keywords
- observation
- species
- index_species
top source MVN_KP_IUVS_TAG_LIST_MODE
MVN_KP_IUVS_TAG_LIST_MODE, observation, observation_name
Parameters
- observation
- observation_name
top source MVN_KP_IUVS_SEARCH_COMMON
result = MVN_KP_IUVS_SEARCH_COMMON(data, tag_index, min_value, max_value)
Parameters
- data
- tag_index
- min_value
- max_value
top source MVN_KP_IUVS_SEARCH_MEASUREMENTS
result = MVN_KP_IUVS_SEARCH_MEASUREMENTS(observation, observation_name, measureI, speciesID, min=min, max=max, altitude=altitude)
Parameters
- observation
- observation_name
- measureI
- speciesID
Keywords
- min
- max
- altitude
File attributes
Modification date: | Tue Oct 21 13:53:24 2014 |
Lines: | 534 |