/* * 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 "@(#) get_const.c 1.30 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /****************************************************************************** * * * IR_GET_CONSTANTS SUBROUTINE * * * * DESCRIPTION * * This module is called in order to allocate the space to hold the angle * * offset values that are used to compute the returned azimuthal angles and * * to retrieve all angle constants for the virtual instrument in question. * * The angle offset values are initialized to zero. If one of the defined * * constants is an azimuthal angle offset constant, the values are replaced * * by the values read from the VIDF file. * * * * 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_constants (btime_yr, btime_day, btime_sec, btime_nsec, * * etime_yr, etime_day, etime_sec, etime_nsec) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * free () frees allocated memory * * malloc() allocates memory * * realloc() reallocates previously allocated memory * * ReadVIDF() reads information from the VIDF file * * ir_tento() returns the power of 10 value to multiply by * * to get values to the correct base (scaling) * * ir_get_const_rval () returns an error code unique to this module * * for each possible ReadVIDF() error code * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * SDDAS_UINT ir_tmp_bytes number of bytes allocated for scratch space * * void *ir_tmp_space scratch space for various uses * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * reg SDDAS_FLOAT *fptr pointer to floating point values * * reg SDDAS_FLOAT *stop_ptr loop termination variable * * register SDDAS_LONG *lptr pointer to long values * * register SDDAS_LONG ind index into allocated memory locations * * register SDDAS_SHORT i looping variables * * reg SDDAS_CHAR *stop_sca loop termination 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_SHORT len the number of elements to be returned * * SDDAS_CHAR constant_id the constant identification category * * SDDAS_CHAR *const_sca memory that holds the scaling values * * SDDAS_CHAR *cptr pointer to character values * * char num_constants the number of constants to allocate space for * * size_t bytes the number of bytes to allocate space for * * int ret_val holds the value returned by called routine * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * *****************************************************************************/ SDDAS_SHORT ir_get_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; extern SDDAS_UINT ir_tmp_bytes; extern void *ir_tmp_space; struct experiment_info *ex; register SDDAS_FLOAT *fptr, *stop_ptr; register SDDAS_LONG *lptr, ind; register SDDAS_SHORT i; register SDDAS_CHAR *stop_sca; SDDAS_ULONG data_key; SDDAS_LONG start_at_zero; SDDAS_SHORT len; SDDAS_CHAR constant_id, *const_sca, *cptr; /* Leave variables as is, no typedefs. */ char num_constants; size_t bytes; int ret_val; void *tmp_ptr; /**************************************************************************/ /* Allocate the space to hold the angle constant values for each sensor */ /* and initialize. */ /**************************************************************************/ ex = ginfo.expt; data_key = ex->data_key; num_constants = (ex->phi_method == 1) ? 6 : 4; bytes = (num_constants * ex->num_sensor * sizeof (SDDAS_FLOAT)); if (ex->bmem.base_constant != NO_MEMORY) { free (ex->bmem.base_constant); ex->bmem.base_constant = NO_MEMORY; } if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (CONST_ANG_MALLOC); ex->bmem.base_constant = tmp_ptr; ex->constants = (SDDAS_FLOAT *) ex->bmem.base_constant; /************************************************************************/ /* For optimization purposes, it's advised to use ++x instead of x++. */ /************************************************************************/ fptr = ex->constants; stop_ptr = ex->constants + ex->num_sensor; for (; fptr < stop_ptr; ++fptr) *fptr = 0.0; fptr = ex->constants + ex->num_sensor; stop_ptr = ex->constants + num_constants * ex->num_sensor; for (; fptr < stop_ptr; ++fptr) *fptr = -1.0; /**************************************************************************/ /* Allocate temporary space to hold the constant ids (one per constant). */ /**************************************************************************/ start_at_zero = 0; ex = ginfo.expt; if (ex->num_consts != 0) { bytes = ex->num_sensor * sizeof (SDDAS_CHAR); if (bytes > ir_tmp_bytes) { if ((tmp_ptr = realloc (ir_tmp_space, bytes)) == NO_MEMORY) return (CONST_TEMP_MALLOC); ir_tmp_space = tmp_ptr; ir_tmp_bytes = (SDDAS_UINT) bytes; } const_sca = (SDDAS_CHAR *) ir_tmp_space; 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 (ir_get_const_rval (ret_val)); if (constant_id >= AZ_OFFSET_ID && constant_id <= FINAL_ELEV_ID) { len = ex->num_sensor; ind = constant_id - AZ_OFFSET_ID; fptr = ex->constants + ind * ex->num_sensor; lptr = (SDDAS_LONG *) (ex->constants + ind * len); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) lptr, _VIDF_CONST, i, start_at_zero, len); if (ret_val < 0) return (ir_get_const_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) const_sca, _CONST_SCA, i, start_at_zero, len); if (ret_val < 0) return (ir_get_const_rval (ret_val)); stop_sca = const_sca + ex->num_sensor; for (cptr = const_sca; cptr < stop_sca; ++fptr, ++lptr, ++cptr) *fptr = *lptr * ir_tento (*cptr); } else if (ex->phi_method == 1 && (constant_id == INIT_AZ_ID || constant_id == FINAL_AZ_ID)) { len = ex->num_sensor; ind = (constant_id == INIT_AZ_ID) ? START_PHI_OFF : STOP_PHI_OFF; fptr = ex->constants + ind * ex->num_sensor; lptr = (SDDAS_LONG *) (ex->constants + ind * len); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) lptr, _VIDF_CONST, i, start_at_zero, len); if (ret_val < 0) return (ir_get_const_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) const_sca, _CONST_SCA, i, start_at_zero, len); if (ret_val < 0) return (ir_get_const_rval (ret_val)); stop_sca = const_sca + ex->num_sensor; for (cptr = const_sca; cptr < stop_sca; ++fptr, ++lptr, ++cptr) *fptr = *lptr * ir_tento (*cptr); } } } return (ALL_OKAY); } /******************************************************************************* * * * IR_GET_CONST_RVAL SUBROUTINE * * * * DESCRIPTION * * This routine returns an error code unique to IR_GET_CONSTANTS() based * * upon the error code returned by the call to ReadVIDF(). * * * * INPUT VARIABLES * * int ret_val the error code returned by ReadVIDF() * * * * USAGE * * x = ir_get_const_rval (ret_val) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * None * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_get_const_rval (int ret_val) { switch (ret_val) { case IDF_MANY_BYTES: return (CONST_IDF_MANY_BYTES); case IDF_TBL_NUM: return (CONST_IDF_TBL_NUM); case IDF_CON_NUM: return (CONST_IDF_CON_NUM); case IDF_NO_ENTRY: return (CONST_IDF_NO_ENTRY); case VIDF_ELEMENT_NOT_FOUND: return (CONST_IDF_ELE_NOT_FOUND); default: return ((SDDAS_SHORT) ret_val); } }