MtkFileToOrbit.c

Go to the documentation of this file.

/*===========================================================================
=                                                                           =
=                             MtkFileToOrbit                                =
=                                                                           =
=============================================================================

                         Jet Propulsion Laboratory
                                   MISR
                               MISR Toolkit

            Copyright 2005, California Institute of Technology.
                           ALL RIGHTS RESERVED.
                 U.S. Government Sponsorship acknowledged.

============================================================================*/

#include "MisrFileQuery.h"
#include "MisrError.h"
#include <hdf.h>
#include <mfhdf.h>

MTKt_status MtkFileToOrbit( const char *filename, 
               int *orbit             )
{
  MTKt_status status;      /* Return status */

  status = MtkFileToOrbitNC(filename, orbit); // try netCDF
  if (status != MTK_NETCDF_OPEN_FAILED) return status;

  return MtkFileToOrbitHDF(filename, orbit); // try HDF
}

MTKt_status MtkFileToOrbitNC( const char *filename, 
               int *orbit             )
{
  MTKt_status status_code; /* Return status of this function */
  MTKt_status status;      /* Return status */

  if (filename == NULL) return MTK_NULLPTR;

  /* Open file */
  int ncid = 0;
  {
    int nc_status = nc_open(filename, NC_NOWRITE, &ncid);
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_OPEN_FAILED);
  }

  /* Read grid attribute */
  status = MtkFileToOrbitNcid(ncid, orbit);
  MTK_ERR_COND_JUMP(status);

  /* Close file */
  {
    int nc_status = nc_close(ncid);
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_CLOSE_FAILED);
  }
  ncid = 0;

  return MTK_SUCCESS;

 ERROR_HANDLE:
  if (ncid != 0) nc_close(ncid);
  return status_code;
}

MTKt_status MtkFileToOrbitHDF( const char *filename, 
               int *orbit             )
{
  MTKt_status status_code;      /* Return status of this function */
  MTKt_status status;           /* Return status */
  int32 hdf_status;        /* HDF-EOS return status */
  int32 sd_id = FAIL;      /* HDF SD file identifier. */

  if (filename == NULL)
    MTK_ERR_CODE_JUMP(MTK_NULLPTR);

  /* Open HDF File */
  hdf_status = sd_id = SDstart(filename, DFACC_READ);
  if (hdf_status == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDF_SDSTART_FAILED);

  /* Read orbit number. */
  status = MtkFileToOrbitFid(sd_id, orbit);
  MTK_ERR_COND_JUMP(status);

  /* Close HDF File */
  hdf_status = SDend(sd_id);
  if (hdf_status == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDF_SDEND_FAILED);
  sd_id = FAIL;

  return MTK_SUCCESS;

ERROR_HANDLE:
  if (sd_id != FAIL)
    SDend(sd_id);

  return status_code;
}

MTKt_status MtkFileToOrbitFid( int32 sd_id, 
                   int *orbit             )
{
  MTKt_status status_code;      /* Return status of this function */
  MTKt_status status;           /* Return status */
  MtkCoreMetaData metadata = MTK_CORE_METADATA_INIT;
                /* Core metadata structure */

  if (orbit == NULL)
    MTK_ERR_CODE_JUMP(MTK_NULLPTR);

  status = MtkFileCoreMetaDataGetFid(sd_id, "ORBITNUMBER", &metadata);
  MTK_ERR_COND_JUMP(status);

  *orbit = metadata.data.i[0];

  MtkCoreMetaDataFree(&metadata);
  return MTK_SUCCESS;

ERROR_HANDLE:
  MtkCoreMetaDataFree(&metadata);
  return status_code;
}

MTKt_status MtkFileToOrbitNcid( int ncid,               
                                int *orbit             )
{
  MTKt_status status_code;      /* Return status of this function */

  if (orbit == NULL)
    MTK_ERR_CODE_JUMP(MTK_NULLPTR);

  {
    int nc_status = nc_get_att_int(ncid, NC_GLOBAL, "Orbit_number", orbit);
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_READ_FAILED);
  }

  return MTK_SUCCESS;

ERROR_HANDLE:
  return status_code;
}