/* * 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 "@(#) buf_fill.c 1.20 05/08/19 SwRI" #include #include "user_defs.h" #include "ret_codes.h" #include "gen_defs.h" #include "libtrec_idfs.h" #include "libIDFSFill.h" /******************************************************************************* * * * BUFFER_BIN_FILL SUBROUTINE * * * * DESCRIPTION * * This routine fills in the missing bin elements for the data buffer being * * referenced by the DPTR variable. The empty data bins will be filled in * * according to the method selected in the call to SET_BIN_INFO for this data * * set. A least-squares method is replaced by a constant column row approach * * with a minimum of 3 data points since a least-squares fit method is valid * * for 2-D fits and a buffer is a 1-D fit. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten filename extension of data to be used * * SDDAS_USHORT vnum version number associated with this * * combination (allows for multiple opens) * * SDDAS_FLOAT *dptr pointer to where the data values are being * * returned * * SDDAS_CHAR *bin_stat array holding the status of the sweep bins * * SDDAS_SHORT data_block max. number of elements in the data set * * SDDAS_LONG need_filled number of filled bins needed to perform the * * calculations to determine the missing value * * SDDAS_CHAR bin_project flag indicating if the data is to be * * projected to the end of the bins * * * * USAGE * * x = buffer_bin_fill (data_key, exten, vnum, dptr, bin_stat, data_block, * * need_filled, bin_project) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if requested combination has * * already been pand points to the * * correct structure allocated for the combo * * ir_normalize () sets data and bin status values in order to * * differentiate missing bins from bins that * * were found but data was outside cutoff * * values * * IDFSFill_column_constant () fills a partially filled column of data by * * projecting the known values * * IDFSFill_column_linear () fills a partially filled column of data by * * linear interpolation between known values * * sizeof () the size of the specified object in bytes * * realloc() reallocates memory * * * * EXTERNAL VARIABLES * * struct general_info structure holding 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_CHAR *in_stat, *new_stat pointers to bin_stat arrays * * reg SDDAS_CHAR *stop_stat loop termination pointer * * size_t bytes the number of bytes to allocate * * SDDAS_SHORT ret_val holds called routine status flags * * SDDAS_CHAR fill_method method chosen for filling in missing bins * * void *tmp_ptr pointer which holds address passed back by * * the call to the REALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT buffer_bin_fill (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_FLOAT *dptr, SDDAS_CHAR *bin_stat, SDDAS_SHORT data_block, SDDAS_LONG need_filled, SDDAS_CHAR bin_project) { extern struct general_info ginfo; extern SDDAS_UINT ir_tmp_bytes; extern void *ir_tmp_space; register struct experiment_info *ex; register SDDAS_CHAR *in_stat, *new_stat, *stop_stat; size_t bytes; SDDAS_SHORT ret_val; SDDAS_CHAR fill_method; void *tmp_ptr; /*************************************************************************/ /* Check to see if the combination being processed has been processed */ /* before. If not, an error condition - probably didn't call FILE_OPEN. */ /* Since a 0 is passed for the last parameter, the only possible error is*/ /* that the requested combination was not found among processed combos. */ /*************************************************************************/ if (!ginfo.called_locate) { ret_val = ir_locate_ex (data_key, exten, vnum, 0); if (ret_val != ALL_OKAY) return (BUF_BIN_NOT_FOUND); } ex = ginfo.expt; /**************************************************************************/ /* Since routines called by this module modify the bin_stat values, copy */ /* the bin_stat values into a temporary array so that the contents ARE */ /* NOT modified, which is necessary if plotting the same data buffer */ /* more than once. */ /**************************************************************************/ bytes = data_block * sizeof (SDDAS_CHAR); if (bytes > ir_tmp_bytes) { if ((tmp_ptr = realloc (ir_tmp_space, bytes)) == NO_MEMORY) return (BUF_BIN_MALLOC); ir_tmp_space = tmp_ptr; ir_tmp_bytes = (SDDAS_UINT) bytes; } in_stat = bin_stat; stop_stat = bin_stat + data_block; new_stat = (SDDAS_CHAR *) ir_tmp_space; for (; in_stat < stop_stat; ++new_stat, ++in_stat) *new_stat = *in_stat; /**************************************************************************/ /* Identify the missing bins. */ /**************************************************************************/ new_stat = (SDDAS_CHAR *) ir_tmp_space; fill_method = ex->bin_ptr->bin_fill; ir_normalize (dptr, new_stat, (SDDAS_LONG) data_block); /**************************************************************************/ /* To perform a least squares fit, must have more than 1 column of data; */ /* since this is a single column of data, change this option. */ /**************************************************************************/ if (fill_method == LEAST_SQ_FIT) { fill_method = CON_COL_ROW; need_filled = 3; } if (fill_method == CON_ROW_COL || fill_method == CON_COL_ROW) IDFSFill_column_constant (dptr, new_stat, (SDDAS_LONG) data_block, need_filled, bin_project); else if (fill_method == LIN_ROW_COL || fill_method == LIN_COL_ROW) IDFSFill_column_linear (dptr, new_stat, (SDDAS_LONG) data_block, need_filled, bin_project); return (ALL_OKAY); }