/* * 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_tensor_darray.c 1.1 05/08/19 SwRI" #include "libbase_idfs.h" #include "ret_codes.h" /**************************************************************************** * * * IR_FILL_TENSOR_DATA_ARRAY SUBROUTINE * * * * DESCRIPTION * * This routine fills in the data structure with the tensor data for the * * requested sensor/time period combination. The algorithms for * * extracting the data are dependent upon the size of the data elements * * (in bits). As the program stands, it will handle data up to 32 bits in * * length. For larger sizes, code must be added. * * * * INPUT VARIABLES * * SDDAS_SHORT sensor the sensor being requested * * SDDAS_LONG sen_index gives position of sensors in sensor set * * void *data_ptr ptr to memory location for the structure * * that holds returned tensor data values * * * * USAGE * * x = ir_fill_tensor_data_array (sensor, sen_index, data_ptr) * * * * NECESSARY SUBPROGRAMS * * ir_transfer_tensor_data () transfers the integer raw values into the * * data type defined in the VIDF for the * * sensor being processed for tensor data * * * * EXTERNAL VARIABLES * * struct general_info structure holding information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct tensor_data *TENSOR_DATA structure that holds all 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 * * reg SDDAS_LONG *ret_ptr ptr to the array where data is returned * * register SDDAS_ULONG *lpt data is interpreted as an array of longs * * register SDDAS_ULONG i looping variable * * register SDDAS_USHORT *s1 data is interpreted as an array of shorts * * register SDDAS_UCHAR *ucpt data is interpreted as an array of chars * * SDDAS_FLOAT *ret_data pointer to data for the tensor * * SDDAS_ULONG num_sets the no. of samples returned for each sensor* * SDDAS_ULONG offset current bit pointed to within the sensor * * set for bit data * * SDDAS_LONG num_bytes number of bytes to bypass in order to get * * to the current sensor set * * SDDAS_LONG *stop_loop loop termination variable * * SDDAS_LONG data_val the data value to be processed * * SDDAS_CHAR *sen pointer to the sensor being processed * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ SDDAS_SHORT ir_fill_tensor_data_array (SDDAS_SHORT sensor, SDDAS_LONG sen_index, void *data_ptr) { extern struct general_info ginfo; struct tensor_data *TENSOR_DATA; struct experiment_info *ex; struct ptr_rec *ptr; register SDDAS_LONG *ret_ptr; register SDDAS_ULONG *lpt, i; register SDDAS_USHORT *s1; register SDDAS_UCHAR *ucpt; SDDAS_FLOAT *ret_data; SDDAS_ULONG num_sets, offset; SDDAS_LONG num_bytes, *stop_loop, data_val; SDDAS_CHAR *sen; /***********************************************************************/ /* Set a pointer to structure which holds all pointers for header and */ /* data information for the experiment currently being processed. */ /***********************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; /****************************************************************************/ /* No need to make sure data structure is correct type or that the header */ /* format is correct since this module is indirectly called by */ /* read_tensor_data () which checks for this issue. */ /****************************************************************************/ TENSOR_DATA = (struct tensor_data *) data_ptr; TENSOR_DATA->filled_data = 1; /********************************************************************/ /* Set pointers to the tensor data which holds values as read from */ /* the data record and initialize to all fill values. */ /********************************************************************/ TENSOR_DATA->tensor_rank = ex->tensor_rank; for (i = 0; i < ex->tensor_rank; ++i) { TENSOR_DATA->tensor_sizes[i] = ex->tensor_sizes[i]; TENSOR_DATA->tnext_dimen[i] = ex->tnext_dimen[i]; } TENSOR_DATA->num_vals = ex->tensor_elements; ret_ptr = TENSOR_DATA->sen_data; stop_loop = ret_ptr + ex->tensor_elements; for (; ret_ptr < stop_loop; ++ret_ptr) *ret_ptr = ex->fill_value; ret_ptr = TENSOR_DATA->sen_data; num_sets = ptr->hdr_fmt2_ptr->TENSOR_ELEMENTS; /**********************************************************************/ /* Determine the number of bits needed to be bypassed to get to the */ /* current sensor set. Convert that number to bytes (partial bytes */ /* included). */ /**********************************************************************/ num_bytes = ex->accum_ss_sz / 8; if (ex->accum_ss_sz % 8 != 0) ++num_bytes; /**********************************************************************/ /* CARRIE - For now, just concentrate on byte-oriented data. */ /* The data elements are packed into a byte. (Bit information) */ /**********************************************************************/ if (ex->tdw_len < 8) return (TENSOR_DATA_TDW_LEN); /******************************************************************/ /* The data requires one or more bytes per element. */ /******************************************************************/ else { /*******************************************************************/ /* Determine the number of bytes per data element. Data and cal. */ /* data are the same size (bytes), although currently cal. data is */ /* not permissible for tensor IDFS data sets. The premise at this */ /* time is that all data is <= 32 bits in length. Data is laid */ /* down in 1, 2, or 4 bytes. */ /*******************************************************************/ if (ex->tdw_len == 8) { ucpt = ptr->DATA + num_bytes + num_sets * sen_index; for (offset = 0; offset < num_sets; ++offset, ++ucpt) { data_val = *ucpt; *(ret_ptr + offset) = data_val; } } else if (ex->tdw_len <= 16) /* interpret as shorts */ { s1 = (SDDAS_USHORT *) (ptr->DATA + num_bytes + num_sets * sizeof (SDDAS_USHORT) * sen_index); for (offset = 0; offset < num_sets; ++offset, ++s1) { data_val = *s1; *(ret_ptr + offset) = data_val; } } else /* interpret as longs */ { lpt = (SDDAS_ULONG *) (ptr->DATA + num_bytes + num_sets * sizeof (SDDAS_ULONG) * sen_index); for (offset = 0; offset < num_sets; ++offset, ++lpt) { data_val = *lpt; *(ret_ptr + offset) = data_val; } } } /**********************************************************************/ /* Transfer the integer raw values into the the data type defined in */ /* the VIDF for the sensor being processed. */ /**********************************************************************/ sen = (SDDAS_CHAR *) TENSOR_DATA->sen_data; ret_data = TENSOR_DATA->tdata; ir_transfer_tensor_data (ret_data, sen, ex->tensor_elements, *(ex->d_type + sensor), *(ex->sen_tdw_len + sensor), ex->fill_value); return (ALL_OKAY); }