/* * 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: get_background_const.C 22023 2012-12-06 22:46:37Z carrie $ SwRI" #include "ret_codes.h" #include "user_defs.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /******************************************************************************* * * * IR_GET_BACKGROUND_CONSTANTS SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve the pre-defined background values * * that are defined as constants in the VIDF file. There should be 1 back- * * ground value defined per sensor in the parent source. * * * * INPUT VARIABLES * * SDDAS_SHORT btime_yr the start time requested (year component) * * SDDAS_SHORT btime_day the start time requested (day component) * * SDDAS_LONG btime_sec the start time requested (seconds component)* * SDDAS_LONG btime_nsec the start time requested (nanoseconds) * * SDDAS_SHORT etime_yr the stop time requested (year component) * * SDDAS_SHORT etime_day the stop time requested (day component) * * SDDAS_LONG etime_sec the stop time requested (seconds component) * * SDDAS_LONG etime_nsec the stop time requested (nanoseconds) * * * * USAGE * * x = ir_get_background_constants (btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, * * etime_sec, etime_nsec) * * * * NECESSARY SUBPROGRAMS * * ir_tento() returns the power of 10 value to multiply by* * to get values to the correct base (scaling) * * ReadVIDF() reads information from the VIDF file * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * register struct background_info a ptr to the structure that holds back-* * *bkgd_ptr ground information * * register SDDAS_FLOAT *dptr pointer to the background constant values * * reg SDDAS_FLOAT *vec_end loop termination variable * * register SDDAS_SHORT i looping variable * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_LONG start_at_zero param. passed to ReadVIDF to avoid casting * * SDDAS_LONG ret_val holds value returned by called module * * SDDAS_LONG data_val constant value read from VIDF file * * SDDAS_SHORT sensor the sensor being processed * * SDDAS_CHAR constant_id the constant id value * * SDDAS_CHAR constant_sca the scaling factor for the constant value * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ int ir_get_background_constants (SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec, SDDAS_SHORT etime_yr, SDDAS_SHORT etime_day, SDDAS_LONG etime_sec, SDDAS_LONG etime_nsec) { extern struct general_info ginfo; struct experiment_info *ex; register struct background_info *bkgd_ptr; register SDDAS_FLOAT *dptr, *vec_end; register SDDAS_SHORT i; SDDAS_ULONG data_key; SDDAS_LONG start_at_zero, ret_val, data_val; SDDAS_SHORT sensor; SDDAS_CHAR constant_id, constant_sca; /**************************************************************************/ /* Loop over all defined constants, searching for background. */ /**************************************************************************/ ex = ginfo.expt; data_key = ex->data_key; bkgd_ptr = ex->background; /**************************************************************************/ /* Initialize to flag as missing data. */ /**************************************************************************/ dptr = bkgd_ptr->data_values; vec_end = bkgd_ptr->data_values + ex->num_sensor; for (; dptr < vec_end; ++dptr) *dptr = OUTSIDE_MIN; start_at_zero = 0; for (i = 0; i < ex->num_consts; ++i) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &constant_id, _CONST_ID, i, start_at_zero, 1); if (ret_val < 0) return (ret_val); if (constant_id == BACKGROUND_ID) { /******************************************************************/ /* Get the background value for each sensor. */ /******************************************************************/ for (sensor = 0; sensor < ex->num_sensor; ++sensor) { /****************************************************************/ /* Retrieve the constant value, which is stored as a long. */ /****************************************************************/ ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &data_val, _VIDF_CONST, i, sensor, 1); if (ret_val < 0) return (ret_val); /******************************************************************/ /* Retrieve the scaling factor, which is stored as a char, and */ /* compute background for the individual component. */ /******************************************************************/ ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &constant_sca, _CONST_SCA, i, sensor, 1); if (ret_val < 0) return (ret_val); dptr = bkgd_ptr->data_values + sensor; *dptr = data_val * ir_tento (constant_sca); } } } /*************************************************************************/ /* Make sure all background values were retrieved. If not, return */ /* error code since no background values defined. */ /*************************************************************************/ dptr = bkgd_ptr->data_values; vec_end = bkgd_ptr->data_values + ex->num_sensor; for (; dptr < vec_end; ++dptr) { if (*dptr < VALID_MIN) return (NO_BKGD_CONSTANT); } return (ALL_OKAY); }