/* * 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 "@(#) $Id: proc_cdata.c 20511 2009-09-28 15:00:43Z carrie $ SwRI" #include "ret_codes.h" #include "user_defs.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_PROCESS_CELESTIAL_POSITION_DATA SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve the data from the idfs data set that * * is used to compute celestial position angles. The data is retrieved one * * angle at a time. The percentage of the data sample to be included in the * * current delta-t time period is determined and the data value is multiplied * * by that percentage before being added to the memory location for the angle * * being processed. The percentage or frac value is also saved so that the * * data value can be normalized before it is returned. It has been dictated * * that the IDFS source must be a scalar instrument, so only one data value * * is retrieved. * * * * INPUT VARIABLES * * struct celestial_info *cp_ptr a pointer to the structure that holds * * celestial position information * * struct time_span structure that holds the time period for * * src_time the current delta-t being processed * * SDDAS_SHORT which_angle index specifying which celestial position * * angle is being processed * * SDDAS_USHORT swp_step current step of the sweep being processed * * * * USAGE * * x = ir_process_celestial_position_data (&cp_ptr, src_time, which_angle, * * swp_step) * * * * NECESSARY SUBPROGRAMS * * convert_to_units() converts the specified data type into the * * data format requested * * ir_celestial_position_time_frac () determines the percentage of * * the data sample to be used for the delta-t * * being processed * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * SDDAS_FLOAT ir_conv_fill[] temporary array that holds the values * * returned by convert_to_units() * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * struct idf_data *CP_DATA structure holding the data for the celestial* * position angle being processed * * reg SDDAS_SHORT angle_index index representing the angle being processed* * SDDAS_FLOAT *dptr ptr to the memory that holds the data value * * to be used for the current celestial * * position angle * * SDDAS_FLOAT *fptr ptr to the normalization factor (frac) for * * the data for the current celestial position * * angle * * SDDAS_FLOAT time_frac the percentage of the data to be included * * for the delta-t being processed * * SDDAS_LONG fill_value the value identified as the FILL value * * SDDAS_LONG offset offset into data locations * * SDDAS_LONG *cp_opers ptr to table operators for unit conversion * * SDDAS_SHORT ret_val holds value returned by called module * * SDDAS_CHAR chk_fill flag indicating if the data is to be checked* * for FILL values * * SDDAS_CHAR *cp_tbls ptr to tables for unit conversion * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_process_celestial_position_data (struct celestial_info *cp_ptr, struct time_span src_time, SDDAS_SHORT which_angle, SDDAS_USHORT swp_step) { extern struct general_info ginfo; extern SDDAS_FLOAT ir_conv_fill[]; struct experiment_info *ex; struct idf_data *CP_DATA; register SDDAS_SHORT angle_index; SDDAS_FLOAT *dptr, *fptr, time_frac = 0.0; SDDAS_LONG fill_value, offset, *cp_opers; SDDAS_SHORT ret_val; SDDAS_CHAR chk_fill, *cp_tbls; /**********************************************************************/ /* Convert data into units defined for the celestial position angle. */ /* The experiment_info structure should be the celestial position */ /* angle IDFS source. Data is from scalar source so only one value. */ /**********************************************************************/ ex = ginfo.expt; fill_value = ex->fill_value; chk_fill = ex->fill_flag; CP_DATA = (struct idf_data *) cp_ptr->idf_data_ptr[which_angle]; if (CP_DATA->filled_data) { /********************************************************************/ /* Retrieve unit conversion info. for the celestial position angle */ /* being processed. */ /********************************************************************/ offset = 0; for (angle_index = 0; angle_index < which_angle; ++angle_index) offset += cp_ptr->num_tbls[angle_index]; cp_tbls = cp_ptr->tbl_apply + offset; cp_opers = cp_ptr->tbl_oper + offset; ret_val = convert_to_units (cp_ptr->data_key, cp_ptr->exten, cp_ptr->version, cp_ptr->idf_data_ptr[which_angle], cp_ptr->sensor[which_angle], SENSOR, 0, cp_ptr->num_tbls[which_angle], cp_tbls, cp_opers, ir_conv_fill, chk_fill, fill_value); if (ret_val != ALL_OKAY) return (ret_val); } else ir_conv_fill[0] = OUTSIDE_MIN; /*************************************************************************/ /* Determine the percentage of the data value to be included in the */ /* current delta-t time period. The frac value should normally be */ /* between 0.0 and 1.0; however, if a gap was encountered on the data */ /* set that called the celestial position angle calculation, the frac */ /* for the celestial position angle could be negative, indicating that */ /* the sample is somewhere before the gap or in the gap region. A */ /* negative frac could also happen if a gap is encountered for a */ /* non-time controlling source and the start of the data after the gap */ /* is beyond the end time of the delta-t period. For both cases, the */ /* data is not included in the current iteration. */ /*************************************************************************/ time_frac = ir_celestial_position_time_frac (cp_ptr, src_time, which_angle); if (which_angle == 0) cp_ptr->last_comp_frac = time_frac; if (time_frac > 1.0) return (CP_BAD_FRAC); if (time_frac < 0.0) return (ALL_OKAY); /*****************************************************************/ /* The assumption is that the frac value can never be negative. */ /* It is only set to a negative value as an initialization value.*/ /*****************************************************************/ offset = (NUM_CP_ANGLES * swp_step) + which_angle; dptr = cp_ptr->celestial_data + offset; fptr = cp_ptr->time_frac + offset; if (*fptr < 0.0) { /****************************************************************/ /* The celestial position angle source must be a scalar */ /* instrument, so only one angle value defined to be retrieved.*/ /* If the value is OUTSIDE_MIN, leave as is. */ /****************************************************************/ if (ir_conv_fill[0] >= VALID_MIN) { *dptr = ir_conv_fill[0] * time_frac; *fptr = time_frac; } } else { /****************************************************************/ /* The celestial position angle source must be a scalar */ /* instrument, so only one angle value defined to be retrieved.*/ /* If the value is OUTSIDE_MIN, leave as is. */ /****************************************************************/ if (ir_conv_fill[0] >= VALID_MIN) { *dptr += ir_conv_fill[0] * time_frac; *fptr += time_frac; } } return (ALL_OKAY); }