/* * 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 "@(#) create_tbl.c 1.29 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /***************************************************************************** * * * IR_CREATE_TBL SUBROUTINE * * * * DESCRIPTION * * This routine is called to construct the table values using information * * from the VIDF file. In some instances, the only action to be taken is * * the scaling of the coefficients; that is, the table does not need to be * * expanded every time this routine is called. The action is determined * * based upon the value of the parameter "expand_tbl". When processing * * for loops, it is advised to use ++x instead of x++ for optimization * * purposes. * * * * INPUT VARIABLES * * SDDAS_SHORT sen the sensor being processed * * SDDAS_SHORT which_tbl the number of the table being processed * * SDDAS_FLOAT *tbl pointer to the table * * SDDAS_LONG tbl_size the maximum number of values associated with * * the given sensor * * SDDAS_LONG tbl_off variable which holds the offset into table * * (-1 if need to read this info. from VIDF file)* * SDDAS_CHAR tbl_fmt table format * * SDDAS_CHAR expand_tbl flag indicating if the table is to be expanded* * 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_create_tbl (sen, &tbl, tbl_size, tbl_fmt, which_tbl, expand_tbl,* * tbl_off, 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 * * 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_poly_expand() calculates values using a set of polynomial * * coefficients * * ir_create_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 * * struct inst_tbl_info a pointer to the structure which holds * * *tbl_info_ptr non-array table definition information * * for each table defined for data source * * reg SDDAS_FLOAT *f1,*f2 pointers to data values (SDDAS_FLOAT values) * * reg SDDAS_FLOAT *stop_loop loop termination variable * * register SDDAS_LONG *l1 pointer to the values read * * register SDDAS_CHAR *c1 pointer to the scaling values * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * size_t bytes the number of bytes to allocate space for * * size_t num_bytes_slong the number of bytes needed for a SDDAS_LONG * * size_t num_bytes_sfloat the number of bytes needed for a SDDAS_FLOAT * * SDDAS_FLOAT x looping variable to construct the table * * SDDAS_FLOAT *fwk the values read from the VIDF file once the * * scaling factor has been applied * * SDDAS_FLOAT power the scaling to be applied to the table values * * SDDAS_LONG *lwk memory that holds the values * * SDDAS_LONG offset sensor offset into table * * SDDAS_LONG base_off indexing variable * * SDDAS_CHAR *cwk2 memory that holds the scaling values * * SDDAS_CHAR scale scaling factor to be applied to all values * * SDDAS_CHAR tbl_var flag indicating if the table is modifying * * sensor or sweep step data * * 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_create_tbl (SDDAS_SHORT sen, SDDAS_FLOAT *tbl, SDDAS_LONG tbl_size, SDDAS_CHAR tbl_fmt, SDDAS_SHORT which_tbl, SDDAS_CHAR expand_tbl, SDDAS_LONG tbl_off, 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; struct inst_tbl_info *tbl_info_ptr; register SDDAS_FLOAT *f1, *f2, *stop_loop; register SDDAS_LONG *l1; register SDDAS_CHAR *c1; SDDAS_ULONG data_key; SDDAS_FLOAT x, *fwk, power; SDDAS_LONG *lwk, offset, base_off; SDDAS_CHAR *cwk2, scale, tbl_var; /* Leave variables as is, no typedefs. */ size_t bytes, num_bytes_slong, num_bytes_sfloat; int ret_val; void *tmp_ptr; /*************************************************************************/ /* Allocate space to hold the values to be read from the VIDF file. */ /*************************************************************************/ ex = ginfo.expt; data_key = ex->data_key; num_bytes_slong = sizeof (SDDAS_LONG); num_bytes_sfloat = sizeof (SDDAS_FLOAT); bytes = (num_bytes_slong + num_bytes_sfloat + sizeof (SDDAS_CHAR)) * tbl_fmt; if (bytes > ir_tmp_bytes) { if ((tmp_ptr = realloc (ir_tmp_space, bytes)) == NO_MEMORY) return (CREATE_TBL_MALLOC); ir_tmp_space = tmp_ptr; ir_tmp_bytes = (SDDAS_UINT) bytes; } lwk = (SDDAS_LONG *) ir_tmp_space; base_off = num_bytes_slong * tbl_fmt; /* Cast ir_tmp_space to char * since void * and offset is in bytes. */ fwk = (SDDAS_FLOAT *) ((SDDAS_CHAR *) ir_tmp_space + base_off); base_off += num_bytes_sfloat * tbl_fmt; cwk2 = (SDDAS_CHAR *) ((SDDAS_CHAR *) ir_tmp_space + base_off); tbl_info_ptr = ex->tbl_info_ptr + which_tbl; tbl_var = tbl_info_ptr->tbl_var; /*************************************************************************/ /* Read the offset value into the table for this sensor, the values and */ /* the size of the scaling table. If the offset value passed into this */ /* routine is -1, read the offset value into the table from the VIDF */ /* file; otherwise, use the offset value passed into this routine. */ /*************************************************************************/ if (tbl_off == -1) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &offset, _TBL_OFF, which_tbl, (SDDAS_LONG) sen, 1); if (ret_val < 0) return (ir_create_rval (ret_val)); /*******************************************************************/ /* If offset is still -1, perhaps critical action table? If not, */ /* error condition; otherwise, just set to zero since "real" */ /* table values will be picked up by header change using status */ /* byte value. */ /*******************************************************************/ if (offset == -1) { if (tbl_info_ptr->crit_act_sz == 0) return (CREATE_BAD_TBL_OFFSET); else offset = 0; } } else offset = tbl_off; ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) lwk, _TBL, which_tbl, offset, (SDDAS_SHORT) tbl_fmt); if (ret_val < 0) return (ir_create_rval (ret_val)); /**********************************************************************/ /* There is one scaling value per value. */ /**********************************************************************/ if (tbl_info_ptr->tbl_sca_sz > 0) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) cwk2, _TBL_SCA, which_tbl, offset, (SDDAS_SHORT) tbl_fmt); if (ret_val < 0) return (ir_create_rval (ret_val)); stop_loop = fwk + tbl_fmt; for (f1 = fwk, l1 = lwk, c1 = cwk2; f1 < stop_loop; ++f1, ++l1, ++c1) *f1 = *l1 * ir_tento (*c1); } /**********************************************************************/ /* There is a single scaling value for each sensor. */ /**********************************************************************/ else if (tbl_info_ptr->tbl_sca_sz < 0) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &scale, _TBL_SCA, which_tbl, (SDDAS_LONG) sen, 1); if (ret_val < 0) return (ir_create_rval (ret_val)); power = ir_tento (scale); stop_loop = fwk + tbl_fmt; for (f1 = fwk, l1 = lwk; f1 < stop_loop; ++f1, ++l1) *f1 = *l1 * power; } /**********************************************************************/ /* The stored values are considered already scaled. Value must be */ /* equal to zero by process of elimination so no need to check. */ /**********************************************************************/ else { stop_loop = fwk + tbl_fmt; for (f1 = fwk, l1 = lwk; f1 < stop_loop; ++f1, ++l1) *f1 = *l1; } /**********************************************************************/ /* Once original table values have been retrieved, override the */ /* polynomial with the new slope/intercept values. The routine to */ /* override the coefficients has already checked to make sure the */ /* table is defined as a first order polynomial for all sensors. */ /**********************************************************************/ if (tbl_info_ptr->tbl_var == FN_SC_POTENTIAL && ex->override_potential_poly == sTrue) { f1 = fwk; *f1++ = ex->potential_intercept; *f1 = ex->potential_slope; } /**********************************************************************/ /* If the table is to be expanded and if the table modifies sensor */ /* data and if injested data is signed binary data, special table */ /* expansion is necessary due to the signed nature. */ /**********************************************************************/ if (expand_tbl && tbl_var == FN_RAW_SENSOR && *(ex->d_type + sen) == 1) { /********************************************************************/ /* Once the scaling factor(s) has been applied to the values, the */ /* table should be formed using the set of polynomial coefficients.*/ /* TBL_SIZE is the number of elements in the expanded table. */ /* FWK holds the scaled coefficients. */ /********************************************************************/ stop_loop = tbl + tbl_size; for (f1 = tbl, x = -tbl_size / 2.0; f1 < stop_loop; x += 1.0, ++f1) *f1 = ir_poly_expand (x, fwk, (SDDAS_LONG) tbl_fmt); } else if (expand_tbl) { /********************************************************************/ /* Once the scaling factor(s) has been applied to the values, the */ /* table should be formed using the set of polynomial coefficients.*/ /* TBL_SIZE is the number of elements in the expanded table. */ /* FWK holds the scaled coefficients. */ /********************************************************************/ stop_loop = tbl + tbl_size; for (f1 = tbl, x = 0.0; f1 < stop_loop; x += 1.0, ++f1) *f1 = ir_poly_expand (x, fwk, (SDDAS_LONG) tbl_fmt); } /*************************************************************************/ /* Copy the scaled coefficients into the table; don't expand the table. */ /*************************************************************************/ else { stop_loop = tbl + tbl_fmt; for (f1 = tbl, f2 = fwk; f1 < stop_loop; ++f1, ++f2) *f1 = *f2; } return (ALL_OKAY); } /******************************************************************************* * * * IR_CREATE_RVAL SUBROUTINE * * * * DESCRIPTION * * This routine returns an error code unique to the module IR_CREATE_TBL() * * 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_create_rval (ret_val) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * None * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_create_rval (int ret_val) { switch (ret_val) { case IDF_MANY_BYTES: return (CREATE_IDF_MANY_BYTES); case IDF_TBL_NUM: return (CREATE_IDF_TBL_NUM); case IDF_CON_NUM: return (CREATE_IDF_CON_NUM); case IDF_NO_ENTRY: return (CREATE_IDF_NO_ENTRY); case VIDF_ELEMENT_NOT_FOUND: return (CREATE_IDF_ELE_NOT_FOUND); default: return ((SDDAS_SHORT) ret_val); } }