/* * 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 "@(#) calc_center.c 1.38 05/08/19 SwRI" #include #include #include "ret_codes.h" #include "gen_defs.h" #include "user_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * IR_CALC_CENTER_SWEEP SUBROUTINE * * * * DESCRIPTION * * This routine is called to calculate the center sweep values for the * * virtual instrument being processed. The center values are calculated in * * one of three ways, depending on how the bins are created, that is using a * * fixed sweep format or using a variable sweep format, and on the spacing * * option specified. For a fixed sweep format, there are two ways in which * * the bins are to be created. If the user specified VARIABLE width spacing, * * the center values are computed using the tables specified to modify the * * sample sequence values. If the user specified any other spacing option, * * the array that holds the sample sequence values are set from 0 to number * * of bins (swp_len) and these values are sent to the CONVERT_TO_UNITS module * * to retrieve the center sweep values. For a variable sweep formats, the * * calculations use the starting center bin value, the number of requested * * bins and the delta for each bin to determine the center values. * * * * INPUT VARIABLES * * SDDAS_FLOAT *cval pointer to the location where the center * * values are to be stored * * SDDAS_SHORT sensor the sensor for which the center values are * * to be created * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * * * USAGE * * x = ir_calc_center_sweep (&cval, sensor, idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * exp() returns double-precision exponential function * * of the argument * * log() returns double-precision natural logarithm of * * the argument * * ir_alloc_swp_data() allocates space for the sample sequence values* * convert_to_units() converts the specified data type into the * * data format requested * * read_drec () universal read routine that retrieves * * data for the time sample being processed * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds 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 ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * struct bin_info *bptr a pointer to the structure that holds sweep * * binning information * * reg SDDAS_LONG *swp_data pointer to sample sequence values * * register SDDAS_SHORT bin looping variable * * reg SDDAS_SHORT *samp_ptr pointer to SAMP_INDEX values returned * * register SDDAS_FLOAT *cptr pointer to center sweep values * * double log_start the log of the starting center value * * double step the calculated center value * * double ret_val value returned by exp () function * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * SDDAS_DOUBLE slope the delta value to use to obtain other bins * * SDDAS_DOUBLE add_delta delta value added to create the bins * * SDDAS_FLOAT *stop_cptr loop termination variable * * SDDAS_LONG *stop_loop loop termination variable * * SDDAS_LONG fill_value the value identified as the FILL value * * SDDAS_SHORT rval holds the value returned by the called routine* * SDDAS_SHORT old_swp_size the number of elements in the sample sequence * * array before possible reallocation * * SDDAS_CHAR exten[] filename extension for the data to be used * * SDDAS_CHAR chk_fill flag indicating if the data is to be checked * * for FILL values * * SDDAS_CHAR full_swp flag that indicates if 1 value is being * * requested or all values for the record * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_calc_center_sweep (SDDAS_FLOAT *cval, SDDAS_SHORT sensor, void *idf_data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; struct ptr_rec *ptr; struct bin_info *bptr; register SDDAS_LONG *swp_data; register SDDAS_SHORT bin, *samp_ptr; register SDDAS_FLOAT *cptr; double log_start, ret_val, step; /* leave since returned by log() system call. */ SDDAS_ULONG data_key; SDDAS_USHORT vnum; SDDAS_DOUBLE slope, add_delta; SDDAS_FLOAT *stop_cptr; SDDAS_LONG *stop_loop, fill_value; SDDAS_SHORT rval, old_swp_size; SDDAS_CHAR exten[3], chk_fill, full_swp = 0; 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; ptr = ex->info_ptr; bptr = ex->bin_ptr; /**************************************************************************/ /* Determine center values for a fixed sweep scenario. In all cases, */ /* loop from 0 to swp_len - 1 to define all steps in case instrument is */ /* subsampling (not returning all steps.) */ /**************************************************************************/ if (bptr->swp_type == FIXED_SWEEP) { /*********************************************************************/ /* Read the sweep (use no advance) in case the file_pos routine */ /* did not call read_drec(). In case of scalar packed source, just */ /* pick up one sample. */ /*********************************************************************/ rval = read_drec (data_key, exten, vnum, idf_data_ptr, sensor, 0, full_swp); if (rval != ALL_OKAY && rval != DREC_NO_SENSOR) return (CALC_CENTER_DREC); /*******************************************************************/ /* Be sure to reset ex structure after calling read_drec() since */ /* multiple VIDF file crossing may cause a reallocation of the */ /* existing ex structures so address may change. */ /*******************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; bptr = ex->bin_ptr; /***********************************************************************/ /* The size of the sample sequence array may need to be enlarged. */ /***********************************************************************/ old_swp_size = EXP_DATA->num_swp_steps; rval = ir_alloc_swp_data ((SDDAS_USHORT) bptr->num_bins, idf_data_ptr); if (rval != ALL_OKAY) return (rval); /***********************************************************************/ /* Set the sample sequence values from 0 to swp_len to cover the full */ /* range. */ /***********************************************************************/ EXP_DATA->num_swp_steps = bptr->num_bins; swp_data = EXP_DATA->swp_data; for (bin = 0; bin < bptr->num_bins; ++bin, ++swp_data) *swp_data = bin; /***********************************************************************/ /* Determine center values for a non-variable spacing mode. */ /***********************************************************************/ if (bptr->swp_fmt != VARIABLE_SPACING) { rval = convert_to_units (data_key, exten, vnum, idf_data_ptr, sensor, SWEEP_STEP, 0, bptr->num_tbls, bptr->swp_tbls, bptr->tbl_oper, cval, chk_fill, fill_value); if (rval != ALL_OKAY) return (rval); /***********************************************************************/ /* If ANY of the tables to be applied are function of calibration */ /* data or spacecraft potential data, then NOT all of the centers */ /* were converted, only a subset. DO NOT set the non-converted values */ /* to the last good center value. This causes band values resulting */ /* in zero, which some applications check for and terminate plotting. */ /***********************************************************************/ if (bptr->num_bins > EXP_DATA->num_sample && (ex->cal_mod_swp || ex->pot_mod_swp)) bptr->num_converted = EXP_DATA->num_sample; } /************************************************************************/ /* The set of tables to be applied to get the center values are passed */ /* to convert_to_units. */ /************************************************************************/ else if (bptr->swp_fmt == VARIABLE_SPACING) { rval = convert_to_units (data_key, exten, vnum, idf_data_ptr, sensor, SWEEP_STEP, 0, bptr->num_center, bptr->center_tbls, bptr->center_opers, cval, chk_fill, fill_value); if (rval != ALL_OKAY) return (rval); } /************************************************************************/ /* Put back the previous sample sequence values. */ /************************************************************************/ EXP_DATA->num_swp_steps = old_swp_size; swp_data = EXP_DATA->swp_data; samp_ptr = ptr->hdr_fmt1_ptr->SAMP_INDEX; stop_loop = swp_data + EXP_DATA->num_swp_steps; for (; swp_data < stop_loop; ++swp_data, ++samp_ptr) *swp_data = *samp_ptr; } /************************************************************************/ /* Determine center bin values using the start and delta values. */ /************************************************************************/ else if (bptr->swp_type == VARIABLE_SWEEP && bptr->swp_fmt == LIN_SPACING) { cptr = cval; stop_cptr = cptr + bptr->num_bins; if (bptr->start_center < bptr->stop_center) for (add_delta = 0; cptr < stop_cptr; add_delta += bptr->delta_bin, ++cptr) *cptr = bptr->start_center + add_delta; else for (add_delta = 0; cptr < stop_cptr; add_delta += bptr->delta_bin, ++cptr) *cptr = bptr->start_center - add_delta; } else if (bptr->swp_type == VARIABLE_SWEEP && bptr->swp_fmt == LOG_SPACING) { log_start = log ((double) bptr->start_center); slope = bptr->delta_bin; cptr = cval; stop_cptr = cptr + bptr->num_bins; if (bptr->start_center < bptr->stop_center) for (add_delta = 0; cptr < stop_cptr; add_delta += slope, ++cptr) { step = log_start + add_delta; ret_val = exp (step); *cptr = (SDDAS_FLOAT) ret_val; } else for (add_delta = 0; cptr < stop_cptr; add_delta += slope, ++cptr) { step = log_start - add_delta; ret_val = exp (step); *cptr = (SDDAS_FLOAT) ret_val; } } return (ALL_OKAY); }