/* * 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 "@(#) point_buf.c 1.25 05/08/19 SwRI" #include "user_defs.h" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_POINT_BUFFER SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to stuff data into the data buffers * * returned by FILL_DATA() according to the center sweep values returned * * by each data sample. Each center sweep value is examined to determine * * which bin or bins the data sample lies within. If the center sweep * * value for the sample is not found within the defined bands, the data is * * ignored. If the center sweep value is found, the data is placed into * * appropriate bin(s). * * * * INPUT VARIABLES * * SDDAS_USHORT num_sample the number of elements per data buffer * * SDDAS_FLOAT *smnmx lower and upper data cutoff values * * SDDAS_CHAR found_data flag indicating if data was returned for * * requested sensor * * SDDAS_FLOAT time_frac percentage of the time resolution covered * * by the sweep * * SDDAS_LONG offset_unit offset used to get to correct data level * * sub-buffer in the data array * * SDDAS_FLOAT *dptr pointer to the data array * * SDDAS_FLOAT *tfrac pointer to the normalization factors * * SDDAS_CHAR *bin_stat pointer to the bin status array * * SDDAS_FLOAT *tmp_buf pointer to the converted data levels * * SDDAS_CHAR data_type type of data to be processed * * SDDAS_SHORT num_bins maximum number of bins available to be * * filled * * SDDAS_SHORT sensor sensor for which data is to be retrieved * * * * USAGE * * ir_point_buffer (num_sample, smnmx, found_data, time_frac,offset_unit,* * &dptr, &tfrac, &bin_stat, &tmp_buf, data_type, num_bins, * * sensor) * * * * NECESSARY SUBPROGRAMS * * ir_find_bin () determines the bin(s) a value falls within * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure holding information concerning * * the experiment that is being processed * * SDDAS_FLOAT *ir_swp_base_units space used to hold sample sequence * * values (used by all parameters) * * * * INTERNAL VARIABLES * * struct bin_info *bptr a pointer to the structure holding sweep * * binning information * * register SDDAS_FLOAT *f1 fast float pointer * * register SDDAS_FLOAT *f2 fast float pointer * * register SDDAS_FLOAT *f3 fast float pointer * * register SDDAS_FLOAT *f4 fast float pointer * * register SDDAS_SHORT *s1 fast short pointer * * register SDDAS_CHAR *c1 fast char pointer * * SDDAS_FLOAT *f1_end pointer loop terminator * * SDDAS_FLOAT *bin_low pointer to lowest sweep bin edge * * SDDAS_FLOAT *bin_high pointer to higest sweep bin edge * * SDDAS_FLOAT mxmn[] minimum and maximum extent of sweep bins * * SDDAS_FLOAT *temp temporary pointer * * SDDAS_FLOAT lower_cutoff lower data cutoff value * * SDDAS_FLOAT upper_cutoff upper data cutoff value * * SDDAS_FLOAT dval data value computed once and used in loop * * SDDAS_LONG band_offset offset to get to the band width values for * * the scan range associated with the sensor * * SDDAS_SHORT sbins[] starting and ending sweep bins * * SDDAS_SHORT bin_index sweep bin index to use for binning data * * SDDAS_BOOL in_range flag indicating d_qual value within range * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ void ir_point_buffer (SDDAS_USHORT num_sample, SDDAS_FLOAT *smnmx, SDDAS_CHAR found_data, SDDAS_FLOAT time_frac, SDDAS_LONG offset_unit, SDDAS_FLOAT *dptr, SDDAS_FLOAT *tfrac, SDDAS_CHAR *bin_stat, SDDAS_FLOAT *tmp_buf, SDDAS_CHAR data_type, SDDAS_SHORT num_bins, SDDAS_SHORT sensor) { extern struct general_info ginfo; extern SDDAS_FLOAT *ir_swp_base_units; struct bin_info *bptr; register SDDAS_FLOAT *f1, *f2, *f3, *f4; register SDDAS_SHORT *s1; register SDDAS_CHAR *c1; SDDAS_FLOAT *f1_end, *bin_low, *bin_high, mxmn[2], *temp; SDDAS_FLOAT lower_cutoff, upper_cutoff, dval; SDDAS_LONG band_offset; SDDAS_SHORT sbins[2], bin_index; SDDAS_BOOL in_range; /*********************************************************************/ /* This data object is not associated with any particular band, */ /* therefore, just place the value into all the bins. */ /*********************************************************************/ lower_cutoff = *smnmx; upper_cutoff = *(smnmx + 1); bptr = ginfo.expt->bin_ptr; if (data_type == D_QUAL) { c1 = bin_stat + offset_unit; f1 = dptr + offset_unit; f2 = tfrac + offset_unit; f3 = f1 + num_bins; /********************************************************************/ /* Since same value is placed in all bins, if it is a "fill" value,*/ /* simply ignore so just return. TMP_BUF[0] holds the data in */ /* converted units. */ /********************************************************************/ if (*tmp_buf < VALID_MIN) return; in_range = (*tmp_buf >= lower_cutoff && *tmp_buf <= upper_cutoff) ? sTrue : sFalse; dval = *tmp_buf * time_frac; for ( ; f1 < f3; ++f1, ++f2, ++c1) { /****************************************************************/ /* Include only data values that fall within the cutoff range. */ /****************************************************************/ if (in_range == sTrue) { if (*c1 == 0) { *f1 = dval; *c1 = 1; *f2 = time_frac; } else { *f1 += dval; *f2 += time_frac; } } /*****************************************************************/ /* If data was found but was excluded because of cutoff values, */ /* set the data value to a flagged value to indicate that the */ /* bin was returned (not missing). This is done if NO previous */ /* data has been placed into this bin. */ /*****************************************************************/ else if (found_data && *c1 == 0) *f1 = OUTSIDE_MAX; } } else { /*********************************************************************/ /* Begin a somewhat lengthy setup of all of the arrays which will */ /* used in placing the data. The setups perform several functions. */ /* The first is to establish the location of the band edges of the */ /* bins in which the data is to be placed. In the case of discrete */ /* bands the band edges are stored in separate arrays, one for the */ /* set of low edges and one for the set of upper edges. In the case */ /* of continuous bands the upper edge of one band is the lower edge */ /* of the next band. */ /*********************************************************************/ if (bptr->swp_fmt == ZERO_SPACING) { band_offset = *(bptr->sen_index + sensor) * bptr->num_bins; bin_low = (SDDAS_FLOAT *) (bptr->band_low + band_offset); bin_high = (SDDAS_FLOAT *) (bptr->band_high + band_offset); } else { band_offset = *(bptr->sen_index + sensor) * (bptr->num_bins + 1); bin_low = (SDDAS_FLOAT *) (bptr->band_low + band_offset); bin_high = bin_low + 1; } /*********************************************************************/ /* Third, the search routines which locate the apprpriate bins in */ /* which the data is to be placed want to see the bins presented in */ /* ascending order - that is the lower edge being the smaller in */ /* of the two edges. At this time if the band edges need to be */ /* switched go ahead and do so. At the same time grab the least and */ /* greatest value which can be stored within these bands. This will */ /* be used to prevent try to locate a bin for a data value which has */ /* none within these bins. */ /*********************************************************************/ if (*bin_low < *(bin_low + 1)) { mxmn[0] = *bin_low; mxmn[1] = *(bin_high + bptr->num_bins - 1); } else { mxmn[0] = *(bin_high + bptr->num_bins - 1); mxmn[1] = *bin_low; temp = bin_low; bin_low = bin_high; bin_high = temp; } /*********************************************************************/ /* The filling of the sweep array begins here according to the */ /* following outine */ /* */ /* 1) Set up intial pointers to the data edges. */ /* 2) Loop over each sweep step */ /* 3) Find the sweep bins covered by the data */ /* 4) If data is not in bins try next data point */ /* 5) Put data into found bin */ /*********************************************************************/ f1 = ir_swp_base_units; f2 = tmp_buf; f3 = dptr + offset_unit; f4 = tfrac + offset_unit; c1 = bin_stat + offset_unit; s1 = sbins; f1_end = f1 + num_sample; for ( ; f1 < f1_end; ++f2, ++f1) { ir_find_bin (*f1, *f1, bin_low, bin_high, mxmn, sbins, bptr->input_fmt, bptr->swp_fmt, bptr->num_bins); /***************************************************************/ /* Use variable instead of having to do pointer look-up each */ /* time it is used for speed reasons. */ /***************************************************************/ bin_index = *s1; if (bin_index != -1) { if (*f2 >= lower_cutoff && *f2 <= upper_cutoff) { if (*(c1 + bin_index) == 0) { *(f3 + bin_index) = *f2 * time_frac; *(c1 + bin_index) = 1; *(f4 + bin_index) = time_frac; } else { *(f3 + bin_index) += *f2 * time_frac; *(f4 + bin_index) += time_frac; } } /**************************************************/ /* Value is a "fill" value? Simply ignore. */ /**************************************************/ else if (*f2 < VALID_MIN) continue; else if (found_data && *(c1 + bin_index) == 0) *(f3 + bin_index) = OUTSIDE_MAX; } } } }