/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) proc_sdlev.c 1.8 05/08/19 SwRI" #include #include "ret_codes.h" #include "user_defs.h" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_PROCESS_SENSOR_DATA_LEVELS SUBROUTINE * * * * DESCRIPTION * * This routine converts the data for the specified sensor into the data * * level(s) requested for this sensor by the call to FILL_SENSOR_INFO. * * If no data was returned in the EXP_DATA structure, the data is set to * * OUTSIDE_MIN indicating that no data was found. These values will not * * be included in the data matrices since these values are outside the * * valid range of values. In addition, the sample sequence values are * * updated if the flag indicates that sample sequence values have changed. * * * * INPUT VARIABLES * * SDDAS_SHORT sensor sensor for which data is to be retrieved * * SDDAS_CHAR found_data flag indicating if data was returned for * * requested sensor * * SDDAS_CHAR recalc_swp recalculate sweep values flag * * void *idf_data_ptr ptr to memory location for the structure * * that holds returned data values (read_drec)* * SDDAS_SHORT index index variable pertinent to the sensor * * * * USAGE * * x = ir_process_sensor_data_levels (sensor, found_data, recalc_swp, * * idf_data_ptr, index) * * * * NECESSARY SUBPROGRAMS * * convert_to_units() converts the specified data type into the * * data format requested * * ir_stuff_units_data () process the data for the time sample just * * retrieved by the call to READ_DREC() * * ir_calc_band_widths() calculates the sweep band widths * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure holding information concerning * * the experiment that is being processed * * SDDAS_FLOAT *ir_swp_base_units space used to hold sample sequence * * values (used by all parameters) * * SDDAS_FLOAT *ir_swp_low, space holding the sweep band widths * * *ir_swp_high (used by all parameters) * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure holding all of the currently * * returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct fill_data *fptr pointer to the fill_data structure being * * processed * * struct bin_info *bptr a pointer to the structure holding sweep * * binning information * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_LONG fill_value the value identified as the FILL value * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * SDDAS_SHORT ret_val holds values returned various routines * * SDDAS_CHAR exten[] filename extension for the data to be used * * SDDAS_CHAR chk_fill flag indicating if data is to be checked * * for FILL values * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ SDDAS_SHORT ir_process_sensor_data_levels (SDDAS_SHORT sensor, SDDAS_CHAR found_data, SDDAS_CHAR recalc_swp, void *idf_data_ptr, SDDAS_SHORT index) { extern struct general_info ginfo; extern SDDAS_FLOAT *ir_swp_base_units, *ir_swp_low, *ir_swp_high; struct idf_data *EXP_DATA; struct experiment_info *ex; struct fill_data *fptr; struct bin_info *bptr; SDDAS_ULONG data_key; SDDAS_USHORT vnum; SDDAS_LONG fill_value; SDDAS_SHORT ret_val; SDDAS_CHAR exten[3], chk_fill; /*********************************************************************/ /* Initialize variables. */ /*********************************************************************/ EXP_DATA = (struct idf_data *) idf_data_ptr; ex = ginfo.expt; data_key = ex->data_key; vnum = ex->version; strcpy (exten, ex->exten); chk_fill = ex->fill_flag; fill_value = ex->fill_value; bptr = ex->bin_ptr; fptr = ex->fill_arrays; /****************************************************************/ /* Convert data into all data levels requested for this sensor. */ /****************************************************************/ ret_val = ir_stuff_units_data (sensor, found_data, index, idf_data_ptr); if (ret_val != ALL_OKAY) return (ret_val); /******************************************************************/ /* Retrieve the sample sequence values if the flag indicates that */ /* new sweep values need to be read or if there is a cal table */ /* that modifies the sweep steps or if spacecraft potential data */ /* modifies the sweep steps. */ /******************************************************************/ if (bptr->swp_type == VARIABLE_SWEEP && (recalc_swp || ex->cal_mod_swp || ex->pot_mod_swp)) { ret_val = convert_to_units (data_key, exten, vnum, idf_data_ptr, sensor, SWEEP_STEP, 0, bptr->num_tbls, bptr->swp_tbls, bptr->tbl_oper, ir_swp_base_units, chk_fill, fill_value); if (ret_val != ALL_OKAY) return (ret_val); if (bptr->input_fmt == BAND_STORAGE) { ret_val = ir_calc_band_widths (ir_swp_base_units, ir_swp_low, ir_swp_high, EXP_DATA->num_swp_steps, bptr->delta_bin, bptr->swp_fmt, sensor, idf_data_ptr); if (ret_val != ALL_OKAY) return (ret_val); } } *(fptr->sensors + index) = sensor; return (ALL_OKAY); }