/* * 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 "@(#) reset_buf.c 1.17 05/08/19 SwRI" #include "ret_codes.h" #include "user_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * IR_RESET_BUFFERS SUBROUTINE * * * * DESCRIPTION * * This routine is called to reset some variables for another iteration of * * the data buffer retrieval routines. For each buffer that was flagged * * ready to be processed by the last call, the buffer will be freed up and * * reset so that it may be used if needed by the current call. The start * * pixel, stop pixel, buffer status, bin status array and data array will be * * reset. Since there may be more than one data array (many units), all data * * and bin status arrays for this buffer group will be cleared. All units * * for each buffer are laid down together, so that if the sensor had three * * units being returned (A, B, C), it would be laid down in 15 buffers as: * * ABC (buf 1) ABC (buf 2) ABC (buf 3) ABC (buf 4) ABC (buf 5) * * * * INPUT VARIABLES * * SDDAS_CHAR data_envelope flag indicating if data envelope (min/max) * * or just the data sample is being processed * * * * USAGE * * ir_reset_buffers (data_envelope) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concern- * * ing the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * struct fill_data *fptr pointer to the fill_data structure being * * processed * * struct fill_sensor *sptr pointer to the fill_sensor structure being * * processed * * struct bin_info *bptr a pointer to the structure that holds sweep * * binning information * * register SDDAS_FLOAT *dptr pointer to the data array * * register SDDAS_FLOAT *tfrac pointer to the normalization factors * * register SDDAS_SHORT sensor looping variable over all sensors * * register SDDAS_CHAR buffer looping variable for the buffers * * reg SDDAS_CHAR *bin_stat pointer to the bin status array * * SDDAS_FLOAT *stop_dptr loop termination variable * * SDDAS_LONG offset_buf offset indicating which buffer to start from* * SDDAS_LONG from_start offset to get to the data of interest * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_reset_buffers (SDDAS_CHAR data_envelope) { extern struct general_info ginfo; struct experiment_info *ex; struct fill_data *fptr; struct fill_sensor *sptr; struct bin_info *bptr; register SDDAS_FLOAT *dptr, *tfrac; register SDDAS_SHORT sensor; register SDDAS_CHAR buffer, *bin_stat; SDDAS_FLOAT *stop_dptr; SDDAS_LONG offset_buf, from_start; /*************************************************************************/ /* Point to the project/mission/exper/vinst/extension/version combo */ /* being processed. */ /*************************************************************************/ ex = ginfo.expt; bptr = ex->bin_ptr; fptr = ex->fill_arrays; /***************************************************************************/ /* Check each buffer. If the buffer was flagged as ready to be processed */ /* by the last call, reset the buf_stat element for the buffer. */ /***************************************************************************/ for (buffer = 0; buffer < NUM_BUFFERS; ++buffer) { if (*(fptr->buf_stat + buffer) == BUFFER_READY) { *(fptr->buf_stat + buffer) = FREE_BUFFER; *(fptr->bpix + buffer) = *(fptr->epix + buffer) = -1; /********************************************************************/ /* Clear all data and bin status arrays (1 per data level) */ /* associated with the buffer. */ /********************************************************************/ for (sensor = 0; sensor < fptr->sensors_used; ++sensor) { /******************************************************************/ /* For data & bin status arrays, there are NUM_BUFFER*num_sample */ /* elements for EACH data level being returned for each sensor. */ /* Set the pointers to the beginning of the first buffer for */ /* this sensor. */ /******************************************************************/ from_start = NUM_BUFFERS * *(fptr->num_units + sensor) * bptr->num_bins; dptr = fptr->data + from_start; tfrac = fptr->tot_frac + from_start; bin_stat=fptr->bin_stat + from_start; /*************************************************************/ /* There is one buffer for each of the data levels (units) */ /* with num_bins elements per buffer. */ /*************************************************************/ sptr = ex->fill_sen_ptr + *(fptr->ind_fill_sen + sensor); from_start = sptr->num_units * bptr->num_bins; offset_buf = buffer * from_start; dptr += offset_buf; bin_stat += offset_buf; tfrac += offset_buf; stop_dptr = dptr + from_start; /*************************************************************/ /* If a data envelope is being processed, the data element */ /* stores the minimum value and the tot_frac element stores */ /* the maximum value, so initialize somewhat differently. */ /*************************************************************/ if (data_envelope) { for (; dptr < stop_dptr; ++dptr, ++tfrac, ++bin_stat) { *dptr = OUTSIDE_MIN; *tfrac = OUTSIDE_MIN; *bin_stat = 0; } } else { for (; dptr < stop_dptr; ++dptr, ++tfrac, ++bin_stat) { *dptr = OUTSIDE_MIN; *tfrac = 0.0; *bin_stat = 0; } } } } } }