OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022
epr_dsd.h File Reference
#include "epr_ptrarray.h"
#include <stdio.h>
Include dependency graph for epr_dsd.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

EPR_SDSD * epr_create_dsd (int dsd_index)
 
void epr_free_dsd (EPR_SDSD *dsd)
 
EPR_SDSD * epr_read_each_dsd (FILE *envisat_source_file, int *pos)
 
EPR_SPtrArray * epr_read_all_dsds (EPR_SProductId *product_id)
 
epr_uint epr_find_first_dsd (FILE *envisat_source_file, epr_uint sph_length)
 
int epr_detect_meris_iodd_version (EPR_SProductId *product_id)
 

Function Documentation

◆ epr_create_dsd()

EPR_SDSD* epr_create_dsd ( int  dsd_index)

Opens dsd for a dataset description, obtained from an ENVISAT product file.

Parameters
dsd_indexthe number of dsd (zero-based), emrty dsd inclusive
Returns
the the pointer at the dsd information.

Definition at line 48 of file epr_dsd.c.

◆ epr_detect_meris_iodd_version()

int epr_detect_meris_iodd_version ( EPR_SProductId *  product_id)

Definition at line 125 of file epr_dsd.c.

◆ epr_find_first_dsd()

epr_uint epr_find_first_dsd ( FILE *  envisat_source_file,
epr_uint  sph_length 
)

Finds the first dataset description from an ENVISAT product file.

Parameters
envisat_source_filethe handle of the given ENVISAT product file, must not be NULL
sph_length[bytes] the length of SPH part from the given ENVISAT product file, must not be NULL
Returns
the offset to first founded dsd or 0 if not found.

Finds the first dataset description from an ENVISAT product file.

Parameters
envisat_source_filethe handle of the given ENVISAT product file, must not be NULL
sph_length[bytes] the length of SPH part from the given ENVISAT product file, must not be NULL
Returns
the offset to first searched for dsd or 0 if not found.

Definition at line 433 of file epr_dsd.c.

◆ epr_free_dsd()

void epr_free_dsd ( EPR_SDSD *  dsd)

Release the memory allocated through a dataset description, obtained from an ENVISAT product file.

Parameters
dsdthe file identifier, if NULL the function immediately returns zero.
Returns
zero for success, an error code otherwise
See also
epr_free_dsd_id

Release the memory allocated through a dataset ID.

Parameters
dsdthe dataset description identifier, if NULL the function immediately returns zero.
Returns
zero for success, an error code otherwise

Definition at line 175 of file epr_dsd.c.

◆ epr_read_all_dsds()

EPR_SPtrArray* epr_read_all_dsds ( EPR_SProductId *  product_id)

Reads all dataset descriptions from an ENVISAT product file.

Parameters
product_idthe file identifier, if NULL the function immediately returns NULL.
Returns
an array of dataset descriptions or NULL if an error occured.

Definition at line 469 of file epr_dsd.c.

◆ epr_read_each_dsd()

EPR_SDSD* epr_read_each_dsd ( FILE *  envisat_source_file,
int *  pos 
)

Reads a dataset description from an ENVISAT product file.

Parameters
envisat_source_filethe handle of the given ENVISAT product file, must not be NULL
posnumber of the dataset description in ENVISAT product file,
Returns
a new dataset description or NULL if an error occured.

Definition at line 226 of file epr_dsd.c.