Directory: projects/maven/KP_Toolkit/misc_lib/

Contents

.pro files

mg_linear_function.pro

A simple scaling function borrowed from Modern IDL: A Guide to IDL Programming by Michael Galloy modernidl.idldev.com :Keywords: in_range : in, required, float array Input maximim and minimum values out_range: out, required, float array Output scaled values

mvn_combine_structs.pro

NAME: COMBINE_STRUCTS PURPOSE: takes two arrays of structures str1,str2 which have the same number of elements but possibly different tags and makes another structure which has the same number of elements but the tags of both str1,str2 and has their respective tags values copied into it CALLING SEQUENCE combine_structs, struct1, struct2, newstruct, structyp=structyp INPUTS: struct1,struc2: The two structures to be combined.

mvn_copy_struct.pro

mvn_kp_config.pro

mvn_kp_config_file.pro

mvn_kp_plotimage.pro

NAME: SUBCELL AUTHOR: Craig B.

mvn_kp_range.pro

Print out time and/or orbit range of input kp data structure for in situ or IUVS data :Keywords: kp_data : in, required, type array kp data to pull out time/orbit range for

mvn_kp_range_select.pro

HERE RESTS THE ONE SENTENCE ROUTINE DESCRIPTION :Params: bounds : in, required, type="lonarr(ndims, 3)" bounds :Keywords: start : out, optional, type=lonarr(ndims) input for start argument to H5S_SELECT_HYPERSLAB count : out, optional, type=lonarr(ndims) input for count argument to H5S_SELECT_HYPERSLAB block : out, optional, type=lonarr(ndims) input for block keyword to H5S_SELECT_HYPERSLAB stride : out, optional, type=lonarr(ndims) input for stride keyword to H5S_SELECT_HYPERSLAB

mvn_kp_structure_index.pro

ROUTINE TO CONVERT A STRING NAMED KP PARAMETER TO A NUMERICAL INDEX :Params: kp_data: in, required, type=structure the data structure (not sure why this is passed, something to check later) base_tag_count: in, required, type=integer the number of base level tags in the data structure first_level_count: in, required, type=integer the number of first level tags in the data structure base_tags: in, required, type=strarr(base_tag_count) the names of the base level tags first_level_tags: in, required, type=strarr(first_level_count) the names of the first level tags.

mvn_kp_tag_list.pro

ROUTINE TO LIST THE AVAILABLE TAGS IN A GIVEN STRUCTURE, CALLED BY THE /LIST KEYWORD IN HIGHER LEVEL ROUTINES :Params: kp_data: in, required, type=structure the data structure (not sure why this is passed, something to check later) base_tag_count: in, required, type=integer the number of base level tags in the data structure first_level_count: in, required, type=integer the number of first level tags in the data structure base_tags: in, required, type=strarr(base_tag_count) the names of the base level tags first_level_tags: in, required, type=strarr(first_level_count) the names of the first level tags.

mvn_kp_tag_parser.pro

A ROUTINE TO DYNAMICALLY RETURN WHICH TAGS ARE INCLUDED IN THE KP DATA STRUCTURE :Params: kp_data : in, required, type=structure the kp data structure from which to extract tag names base_tag_count: out, required, type=integer the number of tags in the base level of the structure (will be instrument names of observational modes) first_level_count: out, required, type=integer the number of tags in the first level of the structure second_level_count: out, required, type=integer the number of tags in the second level of the structure base_tags: out, required, type=strarr(base_tag_count) the names of the base level tags first_level_tags: out, required, type=strarr(first_level_count) the names of the first level tags second_level_tags: out, requried, type=strarr(second_level_count) the names of hte second level tags

mvn_kp_tag_verify.pro

ROUNTINE THAT CHECKS THAT A REQUESTED TAG NAME OR INDEX IS INCLUDED IN THE DATA STRUCTURE :Params: kp_data: in, required, type=structure the data structure to check out (why is this passed?) parameter: in, required, type=integer/string the tag name or number to check for the existence of base_tag_count: in, required, type=integer the number of base level tags first_level_count: in, required, type=integer the number of first level tags base_tags:in, required, type=strarr(base_tag_count) the names of the base level tags first_level_tags: in, required, type=strarr(first_level_count) the names of the first level tags check: out, required, type=integer returned flag to indicate if a given tag name/index exists in the data structure level0_index: out, required, type=integer the integer index of the base level tag name for the requested parameter level1_index: out, required, type=integer the integer index of hte first level tag name for the requested parameter tag_names: out, required, strarr(2) the base and first level tag names for the requested parameter, for later routine use