/* * 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 "@(#) pps_env_buf.c 1.2 05/08/19 SwRI" #include "user_defs.h" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_PPS_ENV_BUFFER SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to stuff data into the data buffers * * returned by FILL_DATA_ENVELOPE() according to SAMP INDEX values * * returned by each data sample. The pps or SAMP INDEX values are used as * * indexes into the data buffers. This is the same scheme that is used * * by fill_data(), but in reality there should only be one data value * * since the data must be scalar AND the documentation says that the PPS * * index for scalar instruments must be set to zero (0). * * * * INPUT VARIABLES * * SDDAS_USHORT num_sample the number of elements per data buffer * * reg SDDAS_FLOAT *smnmx lower and upper data cutoff values * * SDDAS_CHAR found_data flag indicating if data was returned for * * requested sensor * * SDDAS_LONG offset_unit offset used to get to correct data level * * sub-buffer in the data array * * SDDAS_FLOAT *dmin pointer to the data minimum array * * SDDAS_FLOAT *dmax pointer to the data maximum array * * 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 * * void *idf_data_ptr ptr to memory location for the structure * * that holds returned data values (read_drec)* * * * USAGE * * ir_pps_env_buffer (num_sample, smnmx, found_data, offset_unit, &dmin, * * &dmax, &bin_stat, &tmp_buf, data_type, num_bins, * * idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds all of the currently * * returned data values to be processed * * reg SDDAS_FLOAT *data_min fast float pointer to data min value * * reg SDDAS_FLOAT *data_max fast float pointer to data max value * * register SDDAS_FLOAT *f3 fast float pointer * * register SDDAS_LONG *l1 fast long pointer * * reg SDDAS_CHAR *c1 fast char pointer * * SDDAS_FLOAT lower_cutoff lower data cutoff value * * SDDAS_FLOAT upper_cutoff upper data cutoff value * * SDDAS_LONG *l1_end pointer loop terminator * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ void ir_pps_env_buffer (SDDAS_USHORT num_sample, register SDDAS_FLOAT *smnmx, SDDAS_CHAR found_data, SDDAS_LONG offset_unit, SDDAS_FLOAT *dmin, SDDAS_FLOAT *dmax, SDDAS_CHAR *bin_stat, SDDAS_FLOAT *tmp_buf, SDDAS_CHAR data_type, SDDAS_SHORT num_bins, void *idf_data_ptr) { struct idf_data *EXP_DATA; register SDDAS_FLOAT *data_min, *data_max, *f3; register SDDAS_LONG *l1; register SDDAS_CHAR *c1; SDDAS_FLOAT lower_cutoff, upper_cutoff; SDDAS_LONG *l1_end; /*********************************************************************/ /* 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); EXP_DATA = (struct idf_data *) idf_data_ptr; if (data_type == D_QUAL) { c1 = bin_stat + offset_unit; data_min = dmin + offset_unit; data_max = dmax + offset_unit; f3 = data_min + num_bins; for (; data_min < f3; ++data_min, ++data_max, ++c1) { /****************************************************************/ /* Include only data values that fall within the cutoff range. */ /* TMP_BUF[0] holds the data in converted units. */ /****************************************************************/ if (*tmp_buf >= lower_cutoff && *tmp_buf <= upper_cutoff) { /****************************************************************/ /* Nothing placed into this bin yet? If so, set both min and */ /* max to the data value being processed. */ /****************************************************************/ if (*c1 == 0) { *c1 = 1; *data_min = *tmp_buf; *data_max = *tmp_buf; } else if (*tmp_buf < *data_min) *data_min = *tmp_buf; else if (*tmp_buf > *data_max) *data_max = *tmp_buf; } /**************************************************/ /* Value is a "fill" value? Simply ignore. */ /**************************************************/ else if (*tmp_buf < VALID_MIN) continue; /*****************************************************************/ /* 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) { *data_min = OUTSIDE_MAX; *data_max = OUTSIDE_MAX; } } } else { /*********************************************************************/ /* 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) Put data into found bin */ /* */ /* The data should be scalar, so only 1 step should be processed. */ /*********************************************************************/ l1 = EXP_DATA->swp_data; l1_end = l1 + num_sample; c1 = bin_stat + offset_unit; data_min = dmin + offset_unit; data_max = dmax + offset_unit; f3 = tmp_buf; for ( ; l1 < l1_end; ++l1, ++f3) { /****************************************************************/ /* Include only data values that fall within the cutoff range. */ /****************************************************************/ if (*f3 >= lower_cutoff && *f3 <= upper_cutoff) { /****************************************************************/ /* Nothing placed into this bin yet? If so, set both min and */ /* max to the data value being processed. */ /****************************************************************/ if (*(c1 + *l1) == 0) { *(c1 + *l1) = 1; *(data_min + *l1) = *f3; *(data_max + *l1) = *f3; } else if (*f3 < *(data_min + *l1)) *(data_min + *l1) = *f3; else if (*f3 > *(data_max + *l1)) *(data_max + *l1) = *f3; } /**************************************************/ /* Value is a "fill" value? Simply ignore. */ /**************************************************/ else if (*f3 < VALID_MIN) continue; /*****************************************************************/ /* 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 + *l1) == 0) { *(data_min + *l1) = OUTSIDE_MAX; *(data_max + *l1) = OUTSIDE_MAX; } } } }