/* * 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 "@(#) fill_cal_bit.c 1.19 05/08/19 SwRI" #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * IR_FILL_CAL_ARRAY_BIT SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve the calibration data for each cali- * * bration set for the sensor being processed if the virtual instrument has * * a bit word length (< 8 bits). There are two ways in which cal. data can * * be laid down within the record: (1) one value to be used by all sensors * * and (2) each sensor has its own calibration data area. The two ways are * * non-exclusive; that is, the cal. data may be a mixture of both type. The * * order of the possible calibration sets is as follows: 1) cal. sets for the * * sample sequence values applicable to all sensors, 2) cal. sets for the * * sensor data applicable to all sensors, 3) cal. sets for the sample * * sequence values defined per sensor, 4) cal. sets for the sensor data * * defined per sensor. For cal. data defined per sensor, all cal. data is * * laid down sequentially. (S0S0S0, S1S1S1, etc.) * * * * INPUT VARIABLES * * SDDAS_LONG sen_index index value that tells the position of the * * sensor within the sensors returned * * void *data_ptr ptr to memory location for the structure * * that holds returned data values (either * * idf_data or tensor_data) * * * * USAGE * * ir_fill_cal_array_bit (sen_index, data_ptr) * * * * NECESSARY SUBPROGRAMS * * ir_fill_cal_array_bit_sen () processes cal. sets which affect sensor * * data, defined sensor by sensor * * ir_fill_cal_array_bit_swp () processes cal. sets which affect sample * * sequence values, defined sensor by sensor * * ir_fill_cal_array_bit_all_sen () processes cal. sets which affect sensor* * data, one set defined for all sensors * * ir_fill_cal_array_bit_all_swp () processes cal. sets which affect sample* * sequence values, one set defined for all * * sensors * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo 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 tensor_data *TENSOR_DATA structure that holds all 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 * * register SDDAS_SHORT i looping variable * * SDDAS_ULONG cal_data_offset index into CAL_DATA array returned in data * * structure for the cal set being processed * * SDDAS_ULONG num_per_sen the number of calibration values per sensor * * SDDAS_LONG block_offset the no. of bytes to bypass in order to get to * * the correct sensor set * * SDDAS_LONG sen_offset the no. of bytes (or bits) to bypass in order * * to get to the requested sensor * * SDDAS_LONG swp_cal_offset the current bit pointed to within the sensor * * set for the sample sequence calibration data * * SDDAS_LONG sen_cal_offset the current bit pointed to within the sensor * * set for the sensor calibration data * * SDDAS_LONG all_swp_cal_offset current bit pointed to within the sensor * * set for the sample sequence calibration data * * defined for all sensors to share * * SDDAS_LONG all_sen_cal_offset current bit pointed to within the sensor * * set for the sensor calibration data defined * * for all sensors to share * * SDDAS_CHAR byte_size how many bits are used per data element * * within each byte (necessary due to padding) * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_fill_cal_array_bit (SDDAS_LONG sen_index, void *data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct tensor_data *TENSOR_DATA; struct experiment_info *ex; struct ptr_rec *ptr; register SDDAS_SHORT i; SDDAS_ULONG cal_data_offset, num_per_sen; SDDAS_LONG block_offset, sen_offset, swp_cal_offset; SDDAS_LONG sen_cal_offset, all_swp_cal_offset, all_sen_cal_offset; SDDAS_CHAR byte_size; ex = ginfo.expt; ptr = ex->info_ptr; if (ex->header_format == ORIGINAL_HEADER) { /**************************************************************************/ /* Copy the number of elements in each cal. set into EXP_DATA structure. */ /* This addition was necessary since convert_to_units was using */ /* ex->CSET_NUM, which may or may not be correct since, with fwd set to 1*/ /* on read_drec(), new header info. is read into this field. */ /**************************************************************************/ EXP_DATA = (struct idf_data *) data_ptr; for (i = 0; i < ex->cal_sets; ++i) *(EXP_DATA->cset_num + i) = *(ex->CSET_NUM + i); EXP_DATA->cal_len = 0; } else { /****************************************************************************/ /* Not sure if need to copy like above and create TENSOR_DATA->cset_num. */ /****************************************************************************/ TENSOR_DATA = (struct tensor_data *) data_ptr; TENSOR_DATA->cal_len = 0; } /****************************************************************************/ /* Byte_size indicates how many bits are used per data element within each */ /* byte. For 5, 6 and 7 bit data, there are pad bits so that there is */ /* only one sample per byte (takes 8 bits). For 3 bit data, use 4 since */ /* the data is laid down as a 4-bit value with the most significant bit */ /* set to zero. The rest of the cases divide evenly into the byte. */ /****************************************************************************/ byte_size = (ex->tdw_len >= 5) ? 8 : (ex->tdw_len == 3) ? 4 : ex->tdw_len; /**************************************************************************/ /* The no. of bits needed to bypass in order to get to the current */ /* sensor set. Convert that no. to bytes. */ /**************************************************************************/ block_offset = ex->accum_ss_sz / 8; if (ex->accum_ss_sz % 8 != 0) ++block_offset; /************************************************************************/ /* To point to the correct calibration data, we must be at the correct */ /* sensor set and the correct sensor. These must be calculated once */ /* and updated as the sensor sets are being processed. */ /************************************************************************/ num_per_sen = ptr->num_swp_cal / *ptr->N_SEN; sen_offset = num_per_sen * byte_size * sen_index; /* in bits */ swp_cal_offset = sen_offset + ptr->swp_bit; num_per_sen = ptr->num_sen_cal / *ptr->N_SEN; sen_offset = num_per_sen * byte_size * sen_index; /* in bits */ sen_cal_offset = sen_offset + ptr->sen_bit; /************************************************************************/ /* Some cal. sets may be defined once for all sensors to use. */ /************************************************************************/ all_swp_cal_offset = ptr->all_swp_bit; all_sen_cal_offset = ptr->all_sen_bit; /********************************************************************/ /* Retrieve the data associated with each calibration set for the */ /* sensor being processed. */ /********************************************************************/ cal_data_offset = 0; for (i = 0; i < ex->cal_sets; ++i) { /**********************************************************************/ /* Calibration data applicable to all sensors in the sensor set. */ /**********************************************************************/ if (*(ex->cal_scope + i) == 1) { /*******************************************************************/ /* Processing sample sequence calibration data? */ /*******************************************************************/ if (*(ex->cal_target + i) == 1) ir_fill_cal_array_bit_all_swp (&cal_data_offset, byte_size, block_offset, i, &all_swp_cal_offset, data_ptr); /*******************************************************************/ /* Processing sensor calibration data. */ /*******************************************************************/ else ir_fill_cal_array_bit_all_sen (&cal_data_offset, byte_size, block_offset, i, &all_sen_cal_offset, data_ptr); } /******************************************************************/ /* Pick up sweep calibration data for this cal. set. */ /******************************************************************/ else if (*(ex->cal_target + i) == 1) ir_fill_cal_array_bit_swp (&cal_data_offset, byte_size, block_offset, i, &swp_cal_offset, data_ptr); /******************************************************************/ /* Pick up sensor calibration data for this cal. set. */ /******************************************************************/ else ir_fill_cal_array_bit_sen (&cal_data_offset, byte_size, block_offset, i, &sen_cal_offset, data_ptr); } }