/* * 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 "@(#) proc_spin.c 1.2 05/08/19 SwRI" #include "ret_codes.h" #include "user_defs.h" #include "gen_defs.h" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_PROCESS_SPIN_DATA SUBROUTINE * * * * DESCRIPTION * * This routine processes data for the spin just retrieved by the call * * to READ_DREC_SPIN(). If data is returned for the sensor, it is * * converted into the data level(s) requested for this sensor. Otherwise, * * the data is set to OUTSIDE_MIN indicating that no data was found. * * These values will not be included in the data buffers since these * * values are outside the lower and upper cutoff boundaries. * * * * INPUT VARIABLES * * SDDAS_SHORT sensor sensor for which data is to be retrieved * * SDDAS_CHAR set_time flag that indicates when to save the time * * for the current spin * * SDDAS_CHAR *hdr_change flag indicating a header change occurred * * SDDAS_USHORT start_ele element number within the sweep where the * * spin starts for the sensor in question * * SDDAS_FLOAT start_ele_frac the percentage of the spin period covered * * by element flagged as the start of spin * * SDDAS_USHORT stop_ele element number within the sweep where the * * spin stops for the sensor in question * * SDDAS_FLOAT stop_ele_frac the percentage of the spin period covered * * by element flagged as the end of spin * * SDDAS_LONG num_sweeps number of sweeps contained within the spin * * void **data_arrays array of addresses for idf_data structures * * utilized by sensor to acquire full spin * * * * USAGE * * x = ir_process_spin_data (sensor, set_time, &hdr_change, start_ele, * * start_ele_frac, stop_ele, stop_ele_frac, * * num_sweeps, data_arrays) * * * * NECESSARY SUBPROGRAMS * * ir_fill_phi_bins() stores data into the phi bins that are * * covered by sensor data being processed * * ir_pps_buffer () stores data in the buffer according to PPS * * using SAMP_INDEX values * * ir_point_buffer () stores data into buffer using the center * * sweep values to find the bin * * ir_band_buffer () stores data into the buffer using sweep * * bands to find the bin(s) covered by the * * sample * * ir_process_sensor_data_levels () transforms sensor data into all data * * levels (units) requested * * ir_adjust_spin_element_data_val () applies the percentage factor to * * the data for the starting/ending elements * * of the current spin * * ir_adjust_spin_sweep () sets those elements which do not belong to * * the current spin so that they are not * * included in the data buffers * * ir_set_spin_start_time_period () sets the start time for the spin * * ir_set_spin_end_time_period () sets the end time for the spin * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure holding information concerning * * the experiment that is being processed * * SDDAS_FLOAT *ir_units_data buffer space holding the values from call * * to convert_to_units for each data level * * requested (used so only 1 call is needed * * per data value) * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure holding all of the currently * * returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct fill_data *fptr pointer to the fill_data structure being * * processed * * struct bin_info *bptr a pointer to the structure holding sweep * * binning information * * struct fill_sensor *sptr pointer to fill_sensor structure being * * processed * * struct in_fill *mptr pointer to data level combination being * * processed * * struct in_fill *mptr_end loop termination variable * * reg SDDAS_FLOAT *tmp_buf pointer to the converted data levels * * reg SDDAS_FLOAT *dptr pointer to the data array * * reg SDDAS_FLOAT *tfrac pointer to the normalization factors * * reg SDDAS_LONG swp_num looping variable representing sweep number * * register SDDAS_CHAR *c1 pointer to the sensor usage flags * * register SDDAS_CHAR *c_end loop termination variable * * reg SDDAS_CHAR *bin_stat pointer to the bin status array * * SDDAS_FLOAT set_frac fraction of the data value to be added * * to or included in the buffer * * SDDAS_LONG offset offset value to get to the data of interest* * SDDAS_LONG last_sweep the last sweep to be processed * * SDDAS_USHORT num_steps_last_swp the number of steps in the sweep * * last processed * * SDDAS_SHORT rval holds values returned various routines * * SDDAS_SHORT index index variable * * SDDAS_SHORT num_phi_bins number of phi bins defined for collapsing * * SDDAS_CHAR recalc_swp recalculate sweep values flag * * SDDAS_CHAR found_data flag indicating if data was returned for * * requested sensor * * void *idf_data_ptr ptr to memory location for the structure * * that holds returned data values (read_drec)* * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ SDDAS_SHORT ir_process_spin_data (SDDAS_SHORT sensor, SDDAS_CHAR set_time, SDDAS_CHAR *hdr_change, SDDAS_USHORT start_ele, SDDAS_FLOAT start_ele_frac, SDDAS_USHORT stop_ele, SDDAS_FLOAT stop_ele_frac, SDDAS_LONG num_sweeps, void **data_arrays) { extern struct general_info ginfo; extern SDDAS_FLOAT *ir_units_data; struct idf_data *EXP_DATA; struct experiment_info *ex; struct fill_data *fptr; struct bin_info *bptr; struct fill_sensor *sptr; struct in_fill *mptr, *mptr_end; register SDDAS_FLOAT *tmp_buf, *dptr, *tfrac; register SDDAS_LONG swp_num; register SDDAS_CHAR *c1, *c_end, *bin_stat; SDDAS_FLOAT set_frac; SDDAS_LONG offset, last_sweep; SDDAS_USHORT num_steps_last_swp; SDDAS_SHORT rval, index, num_phi_bins; SDDAS_CHAR found_data, recalc_swp; void *idf_data_ptr; /*************************************************************************/ /* Set a pointer to the correct fill_data structure. Set num_phi_bins */ /* to 1 if no collapsing info. in order to fail the conditional below. */ /*************************************************************************/ ex = ginfo.expt; fptr = ex->fill_arrays; bptr = ex->bin_ptr; set_frac = 1.0000000000; recalc_swp = 1; num_phi_bins = (ex->collapse_ptr != NO_MEMORY) ? ex->collapse_ptr->phi_bins : 1; /**********************************************************************/ /* Set pointers to the correct element in the arrays for this sensor.*/ /**********************************************************************/ c1 = ex->sensors_needed; c_end = c1 + sensor; for (index = 0; c1 < c_end;) index += *c1++; /*****************************************************************/ /* Process each sweep within the spin for the sensor. */ /*****************************************************************/ last_sweep = num_sweeps - 1; for (swp_num = 0; swp_num < num_sweeps; ++swp_num) { idf_data_ptr = *(data_arrays + swp_num); EXP_DATA = (struct idf_data *) idf_data_ptr; found_data = EXP_DATA->filled_data; num_steps_last_swp = EXP_DATA->num_sample - 1; /*****************************************************************/ /* Is this sensor to be included in the processing? */ /*****************************************************************/ if (*(ex->sensors_needed + sensor) == 1) { rval = ir_process_sensor_data_levels (sensor, found_data, recalc_swp, idf_data_ptr, index); if (rval != ALL_OKAY) return (rval); } /*********************************************************************/ /* Multiply the data values by the fractional percentage for the */ /* starting element and ending element. */ /*********************************************************************/ if (swp_num == 0) { ir_adjust_spin_element_data_val (index, start_ele, start_ele_frac); /*********************************************************************/ /* If start of spin is found within a sweep, set elements PRIOR to */ /* the start of spin to OUTSIDE_MIN values. */ /*********************************************************************/ if (start_ele != 0) ir_adjust_spin_sweep (sensor, index, idf_data_ptr, 1, start_ele); /***********************************************************************/ /* Save the time associated with this spin. */ /***********************************************************************/ if (set_time == 1) { rval = ir_set_spin_start_time_period (sensor, start_ele, start_ele_frac, idf_data_ptr); if (rval != ALL_OKAY) return (rval); } } /***********************************************************************/ /* Could be just 1 sweep so no else-if. */ /***********************************************************************/ if (swp_num == last_sweep) { ir_adjust_spin_element_data_val (index, stop_ele, stop_ele_frac); /*********************************************************************/ /* If end of spin is found within a sweep, set elements AFTER end */ /* of spin to OUTSIDE_MIN values. */ /*********************************************************************/ if (stop_ele != num_steps_last_swp) ir_adjust_spin_sweep (sensor, index, idf_data_ptr, 0, stop_ele); /***********************************************************************/ /* Save the time associated with this spin. */ /***********************************************************************/ if (set_time == 1) { rval = ir_set_spin_end_time_period (sensor, stop_ele, stop_ele_frac, idf_data_ptr); if (rval != ALL_OKAY) return (rval); } } /*****************************************************************/ /* Copy data into the phi bins if collapsing over phi dimension. */ /*****************************************************************/ if (num_phi_bins != 1 && found_data) { rval = ir_fill_phi_bins (index, sensor, EXP_DATA->num_sample, set_frac, idf_data_ptr, 0); if (rval != ALL_OKAY) return (rval); } /***********************************************************************/ /* Set pointers to the memory allocated to process the current sensor, */ /* with index used to get to the correct sensor offset. */ /***********************************************************************/ sptr = ex->fill_sen_ptr + *(fptr->ind_fill_sen + index); offset = *(fptr->num_units + index) * bptr->num_bins; dptr = fptr->data + offset; tfrac = fptr->tot_frac + offset; bin_stat = fptr->bin_stat + offset; /*****************************************************************/ /* Is this sensor to be included in the processing? */ /*****************************************************************/ if (*(ex->sensors_needed + sensor) == 1) { /******************************************************************/ /* Transfer converted data for all data levels. Index into */ /* ir_units_data by swp_len since this holds the no. of elements */ /* returned by READ_DREC(), which may be more than num_bins. */ /******************************************************************/ offset = 0; tmp_buf = ir_units_data; mptr = sptr->min_max_app; mptr_end = mptr + sptr->num_units; if (bptr->swp_type == FIXED_SWEEP) { for ( ; mptr < mptr_end; ++mptr, offset += bptr->num_bins, tmp_buf += ex->swp_len) ir_pps_buffer (EXP_DATA->num_sample, &mptr->sen_min, found_data, set_frac, offset, dptr, tfrac, bin_stat, tmp_buf, mptr->data_type, bptr->num_bins, idf_data_ptr); } else { if (bptr->input_fmt == POINT_STORAGE) { for ( ; mptr < mptr_end; ++mptr, offset += bptr->num_bins, tmp_buf += ex->swp_len) ir_point_buffer (EXP_DATA->num_sample, &mptr->sen_min, found_data, set_frac, offset, dptr, tfrac, bin_stat, tmp_buf, mptr->data_type, bptr->num_bins, sensor); } else { for ( ; mptr < mptr_end; ++mptr, offset += bptr->num_bins, tmp_buf += ex->swp_len) ir_band_buffer (EXP_DATA->num_sample, &mptr->sen_min, found_data, set_frac, offset, dptr, tfrac, bin_stat, tmp_buf, mptr->data_type, bptr->num_bins, sensor); } } } if (EXP_DATA->hdr_change) { *hdr_change = 1; recalc_swp = 1; } else recalc_swp = 0; } return (ALL_OKAY); }