/* * 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 "@(#) start_image.c 1.26 05/08/19 SwRI" #include #include #include "ret_codes.h" #include "user_defs.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * START_IMAGE SUBROUTINE * * * * DESCRIPTION * * This routine will find the sensor set which contains the start of an * * image (scan line = 0). This routine should be called AFTER file_pos has * * been called. Some assumptions are made by this module the first of which * * assumes that calibration set zero is ALWAYS defined to hold the scan line * * number and this is a single quantity (one value, not an array of values). * * Second, instruments are sweeping instruments so the value of FULL_SWP does * * not matter for read_drec. Third, the scan line value increases from * * sensor set to sensor set, so we only need to check the value for the first * * sensor set in the data record. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten the filename extension for the data to be used * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * * * USAGE * * x = start_image (data_key, exten, vnum, idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * lseek() moves the file pointer to a location within * * the file * * read() reads N bytes from the file associated with * * the file descriptor given * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * ir_read_header() reads data from the header file * * read_drec () universal read routine that retrieves data for * * the time sample being processed * * ir_network_order() converts data read from data/header files * * between network byte order and host byte order * * ir_swap_data_array () swaps the data values if necessary to be * * in host byte order * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * SDDAS_CHAR ir_swap_data flag that is used to determine when the data * * matrix is to be converted to host byte order * * * * INTERNAL VARIABLES * * struct idf_data structure holding all of the currently * * *EXP_DATA returned data values to be processed * * struct experiment_info a pointer to the structure that holds specific * * *ex experiment information * * struct ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * int num_bytes the number of bytes requested from the file * * int ret_bytes the number of bytes actually read by READ() * * off_t ret_val value returned by called module * * char reset_called flag indicating if LOCATE_EX was called * * char find_zero flag indicating if a search for scan line zero * * is needed * * char past_start flag indicating that lseek returned an error * * SDDAS_LONG cal_value scan line value * * SDDAS_LONG base_value comparison scan value * * SDDAS_SHORT rval value returned by called module * * SDDAS_SHORT sensor sensor value of interest * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT start_image (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, void *idf_data_ptr) { extern struct general_info ginfo; extern SDDAS_CHAR ir_swap_data; struct idf_data *EXP_DATA; struct experiment_info *ex; struct ptr_rec *ptr; int num_bytes, ret_bytes; off_t ret_val; char reset_called, find_zero, past_start; SDDAS_LONG cal_value, base_value; SDDAS_SHORT rval, sensor; /**************************************************************************/ /* 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) { rval = ir_locate_ex (data_key, exten, vnum, 0); if (rval != ALL_OKAY) return (IMAGE_NOT_FOUND); ginfo.called_locate = 1; reset_called = 1; } else reset_called = 0; /***************************************************************************/ /* Set a pointer to the structure which holds all pointers for header and */ /* data information for the experiment currently being processed. */ /***************************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; sensor = *ptr->SENSOR_INDEX; /****************************************************************************/ /* Since void pointer, make sure correct type of data structure being used.*/ /* Data structures define the same elements at the beginning of the */ /* structure definition. */ /****************************************************************************/ EXP_DATA = (struct idf_data *) idf_data_ptr; if (EXP_DATA->header_format != ORIGINAL_HEADER) return (WRONG_DATA_STRUCTURE); /***************************************************************************/ /* Call read_drec to get the sample associated with the FILE_POS location */ /* and do not advance since we only want to get the first value for */ /* comparison purposes. */ /***************************************************************************/ rval = read_drec (data_key, exten, vnum, idf_data_ptr, sensor, 0, 1); if (rval < 0 || rval % 3 == 0) { if (reset_called) ginfo.called_locate = 0; return (rval); } /*******************************************************************/ /* Be sure to reset ex structure after calling read_drec() since */ /* multiple VIDF file crossing may cause a reallocation of the */ /* existing ex structures so address may change. */ /*******************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; cal_value = *(EXP_DATA->cal_data + 0); base_value = cal_value; find_zero = (cal_value == 0) ? 0 : 1; past_start = 0; /**************************************************************************/ /* Find the data record that contains a scan line value of zero. */ /**************************************************************************/ while (find_zero) { /********************************************************************/ /* Back up and read the previous data record. -2 is used since fd */ /* is at the END of the current data record. */ /********************************************************************/ num_bytes = ptr->d_size; ret_val = lseek (ex->fdd, (off_t) (-2 * num_bytes), 1); /********************************************************************/ /* If an error is returned by lseek, set to beginning of file. */ /********************************************************************/ if (ret_val == -1) { ret_val = lseek (ex->fdd, (off_t) 0, 0); ret_bytes = read (ex->fdd, ex->DATA_MEM, num_bytes); ir_swap_data = 1; ir_network_order (0, 1); cal_value = 0; past_start = 1; } else { ret_bytes = read (ex->fdd, ex->DATA_MEM, num_bytes); ir_swap_data = 1; ir_network_order (0, 1); if (ret_bytes <= 0 || ret_bytes != num_bytes) { /***************************************************************/ /* An error was encountered when trying to read from the file.*/ /***************************************************************/ if (ret_bytes < 0) { if (reset_called) ginfo.called_locate = 0; return (IMAGE_READ_ERROR); } /****************************************************************/ /* An EOF was encountered. If a non-real time file is being */ /* processed, an error was encountered. */ /****************************************************************/ else { if (ret_bytes != num_bytes) ret_val = lseek (ex->fdd, (off_t) (-1 * ret_bytes), 1); if (reset_called) ginfo.called_locate = 0; if (ex->requested_time.btime_sec >= 0) return (IMAGE_READ_ERROR); else return (EOF_STATUS); } } } /*****************************************************************/ /* Read the header associated with the data record. */ /*****************************************************************/ ret_val = lseek (ex->fdh, (off_t)*(ptr->HDR_OFF), 0); rval = ir_read_header (idf_data_ptr); if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 0; if (rval == RHDR_READ_ERROR) return (IMAGE_READ_ERROR); else if (rval == RHDR_HDR_MALLOC) return (IMAGE_HDR_MALLOC); else if (rval == RHDR_HDR_REALLOC) return (IMAGE_HDR_REALLOC); else return (rval); } /********************************************************************/ /* Make sure the data array is in host byte order. Must be done */ /* AFTER the header record information has checked. */ /********************************************************************/ ir_swap_data_array (); /***********************************************************************/ /* Initialize variables pertinent to the read_drec routine. */ /***********************************************************************/ ex->accum_ss_sz = 0; ptr->time_row = 0; ptr->time_col = 0; ptr->cur_sen_set = 0; ptr->reset_hdr = 1; rval = read_drec (data_key, exten, vnum, idf_data_ptr, sensor, 0, 1); if (rval < 0 || rval % 3 == 0) { if (reset_called) ginfo.called_locate = 0; return (rval); } ex = ginfo.expt; ptr = ex->info_ptr; if (!past_start) cal_value = *(EXP_DATA->cal_data + 0); if (cal_value == 0 || cal_value > base_value) find_zero = 0; else base_value = cal_value; } /***********************************************************************/ /* Reset variables pertinent to the read_drec routine. */ /***********************************************************************/ ex->accum_ss_sz = 0; ptr->time_row = 0; ptr->time_col = 0; ptr->cur_sen_set = 0; ptr->reset_hdr = 1; find_zero = (cal_value == 0) ? 0 : 1; /**********************************************************************/ /* Find the sensor set that sets the scan line to zero. */ /**********************************************************************/ while (find_zero) { /**********************************************************************/ /* Read the sweep. (use no advance to test cal value). */ /**********************************************************************/ rval = read_drec (data_key, exten, vnum, idf_data_ptr, sensor, 0, 1); if (rval < 0 || rval % 3 == 0) { if (reset_called) ginfo.called_locate = 0; return (rval); } ex = ginfo.expt; ptr = ex->info_ptr; cal_value = *(EXP_DATA->cal_data + 0); if (cal_value == 0) find_zero = 0; else { /********************************************************************/ /* Advance to the next sensor set. */ /********************************************************************/ rval = read_drec (data_key, exten, vnum, idf_data_ptr, sensor, 1, 1); if (rval < 0 || rval % 3 == 0) { if (reset_called) ginfo.called_locate = 0; return (rval); } ex = ginfo.expt; ptr = ex->info_ptr; } } if (reset_called) ginfo.called_locate = 0; return (ALL_OKAY); }