OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <hdf_bin.h>

Inheritance diagram for hdf4_bin:
[legend]
Collaboration diagram for hdf4_bin:
[legend]

Public Member Functions

 hdf4_bin ()
 
virtual ~hdf4_bin ()
 
int64_t get_beg ()
 
int get_ext ()
 
int create (const char *l3b_filename, int32_t nrows)
 
int open (const char *l3b_filename)
 
int readBinIndex (int row_num_to_read)
 
int read (float *data, binListStruct *binList)
 
int read (float *data, float *var, binListStruct *binList)
 
int read (float *data, binListStruct *binList, int nbins_to_read)
 
int read (float *data, float *var, binListStruct *binList, int nbins_to_read)
 
int readBinList (int nbins_to_read)
 
int readBinList ()
 
int readBinList (int nbins_to_read, int32_t list_reset_ptr)
 
int readQual (uint8_t *qual, int32_t nbins_to_read)
 
int readQual (uint8_t *qual, int32_t nbins_to_read, int32_t row_num_to_read)
 
int readSums (float *sums, int32_t nbins_to_read, int iprod)
 
int readSums (float *sums, int32_t *listOfBins, int32_t nbins_to_read, int iprod)
 
int64_t get_bin_num (int kbin)
 
int get_nobs (int kbin)
 
int get_nscenes (int kbin)
 
float get_weights (int kbin)
 
float get_time_rec (int kbin)
 
int set_bin_num (int offset, int64_t bin_num)
 
int inc_nobs (int offset, int nobs)
 
int inc_nscenes (int offset, int nscenes)
 
int inc_weights (int offset, float weights)
 
int set_weights (int offset, float weights)
 
int inc_time_rec (int offset, float time_rec)
 
int clear_binlist ()
 
int copy_binlist (int src, int dest)
 
int write (char *product_list, int32_t nwrite, float *data, binListStruct *binList)
 
int writeBinList (int32_t nbins_to_write)
 
int writeQual (uint8_t *qual, int32_t nbins_to_write)
 
int writeSums (float *sums, int32_t nbins_to_write, const char *prodname)
 
int copy (char *product_list, int32_t nwrite, int32_t *binsToCopy, Hdf::binListStruct *inBinList, Hdf::hdf4_bin *input_binfile)
 
int close ()
 
bool has_qual ()
 
int setDataPtr (int nbins_to_read)
 
int setDataPtrAbsolute (int32_t recordNum)
 
int incNumRec (int n_write)
 
hid_t get_index_table ()
 
hid_t get_list_table ()
 
hid_t get_data_table (int i)
 
virtual int read (char *product_list)
 
- Public Member Functions inherited from hdf_bin
 hdf_bin ()
 
virtual ~hdf_bin ()
 
virtual int query ()
 
virtual int query (char *product_list)
 
virtual int query (char ***prod_array)
 
virtual int get_prodname (int iprod, char *prodname)
 
virtual void setProductList (int numProducts, char *prodNames[])
 
virtual const char * getProdName (int prodNum) const
 
virtual int getProdIndex (const char *prodname) const
 
virtual const char * getActiveProdName (int prodNum) const
 
virtual int read (char *product_list)
 
virtual int64_t get_numbin (int irow)
 
virtual int64_t get_basebin (int irow)
 
virtual void bin2latlon (int64_t bin_num, float &lat, float &lon)
 
virtual int32_t nprod ()
 
virtual int32_t get_list_ptr ()
 
virtual int copymeta (int32_t nfiles, Hdf::hdf_bin *input_binfile[])
 

Public Attributes

int32_t noext
 
- Public Attributes inherited from hdf_bin
int64_t totbins
 
int32_t nrows
 
bool active_data_prod [MAXNVDATA]
 
int32_t n_data_records
 
int32_t n_active_prod
 
bool isHDF5
 
bool isCDF4
 
bool hasQual
 
bool hasNoext
 
uint32_t deflate
 
meta_l3bType meta_l3b
 

Additional Inherited Members

- Protected Attributes inherited from hdf_bin
int32_t n_data_prod
 
char proddata_name [MAXNPROD][80]
 
char * product_array [MAXNPROD]
 
l3::L3ShapebinShape
 
size_t binListPtr
 
size_t lastBinListPtr
 
int lastNumBins
 

Detailed Description

Definition at line 134 of file hdf_bin.h.

Constructor & Destructor Documentation

◆ hdf4_bin()

hdf4_bin ( )

Definition at line 105 of file bin_io.cpp.

◆ ~hdf4_bin()

~hdf4_bin ( )
virtual

Definition at line 118 of file bin_io.cpp.

Member Function Documentation

◆ clear_binlist()

int clear_binlist ( )
inlinevirtual

Implements hdf_bin.

Definition at line 238 of file hdf_bin.h.

◆ close()

int close ( )
virtual

Implements hdf_bin.

Definition at line 951 of file bin_io.cpp.

◆ copy()

int copy ( char *  product_list,
int32_t  nwrite,
int32_t *  binsToCopy,
Hdf::binListStruct inBinList,
Hdf::hdf4_bin input_binfile 
)

Definition at line 673 of file bin_io.cpp.

◆ copy_binlist()

int copy_binlist ( int  src,
int  dest 
)
inlinevirtual

Implements hdf_bin.

Definition at line 243 of file hdf_bin.h.

◆ create()

int create ( const char *  l3b_filename,
int32_t  nrows 
)
virtual

Implements hdf_bin.

Definition at line 160 of file bin_io.cpp.

◆ get_beg()

int64_t get_beg ( )
inlinevirtual

Implements hdf_bin.

Definition at line 158 of file hdf_bin.h.

◆ get_bin_num()

int64_t get_bin_num ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 188 of file hdf_bin.h.

◆ get_data_table()

hid_t get_data_table ( int  i)
inlinevirtual

Implements hdf_bin.

Definition at line 279 of file hdf_bin.h.

◆ get_ext()

int get_ext ( )
inlinevirtual

Implements hdf_bin.

Definition at line 162 of file hdf_bin.h.

◆ get_index_table()

hid_t get_index_table ( )
inlinevirtual

Implements hdf_bin.

Definition at line 271 of file hdf_bin.h.

◆ get_list_table()

hid_t get_list_table ( )
inlinevirtual

Implements hdf_bin.

Definition at line 275 of file hdf_bin.h.

◆ get_nobs()

int get_nobs ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 192 of file hdf_bin.h.

◆ get_nscenes()

int get_nscenes ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 196 of file hdf_bin.h.

◆ get_time_rec()

float get_time_rec ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 204 of file hdf_bin.h.

◆ get_weights()

float get_weights ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 200 of file hdf_bin.h.

◆ has_qual()

bool has_qual ( )
virtual

Implements hdf_bin.

Definition at line 1135 of file bin_io.cpp.

◆ inc_nobs()

int inc_nobs ( int  offset,
int  nobs 
)
inlinevirtual

Implements hdf_bin.

Definition at line 213 of file hdf_bin.h.

◆ inc_nscenes()

int inc_nscenes ( int  offset,
int  nscenes 
)
inlinevirtual

Implements hdf_bin.

Definition at line 218 of file hdf_bin.h.

◆ inc_time_rec()

int inc_time_rec ( int  offset,
float  time_rec 
)
inlinevirtual

Implements hdf_bin.

Definition at line 233 of file hdf_bin.h.

◆ inc_weights()

int inc_weights ( int  offset,
float  weights 
)
inlinevirtual

Implements hdf_bin.

Definition at line 223 of file hdf_bin.h.

◆ incNumRec()

int incNumRec ( int  n_write)
inlinevirtual

Implements hdf_bin.

Definition at line 267 of file hdf_bin.h.

◆ open()

int open ( const char *  l3b_filename)
virtual

Implements hdf_bin.

Definition at line 233 of file bin_io.cpp.

◆ read() [1/5]

int read

Definition at line 358 of file bin_io.cpp.

◆ read() [2/5]

int read ( float *  data,
binListStruct binList 
)

Definition at line 590 of file bin_io.cpp.

◆ read() [3/5]

int read ( float *  data,
binListStruct binList,
int  nbins_to_read 
)

Definition at line 400 of file bin_io.cpp.

◆ read() [4/5]

int read ( float *  data,
float *  var,
binListStruct binList 
)

Definition at line 600 of file bin_io.cpp.

◆ read() [5/5]

int read ( float *  data,
float *  var,
binListStruct binList,
int  nbins_to_read 
)

Definition at line 458 of file bin_io.cpp.

◆ readBinIndex()

int readBinIndex ( int  row_num_to_read)
virtual

Implements hdf_bin.

Definition at line 333 of file bin_io.cpp.

◆ readBinList() [1/3]

int readBinList ( )
virtual

Implements hdf_bin.

Definition at line 568 of file bin_io.cpp.

◆ readBinList() [2/3]

int readBinList ( int  nbins_to_read)
virtual

Implements hdf_bin.

Definition at line 542 of file bin_io.cpp.

◆ readBinList() [3/3]

int readBinList ( int  nbins_to_read,
int32_t  list_reset_ptr 
)
virtual

Implements hdf_bin.

Definition at line 576 of file bin_io.cpp.

◆ readQual() [1/2]

int readQual ( uint8_t *  qual,
int32_t  nbins_to_read 
)
virtual

Implements hdf_bin.

Definition at line 746 of file bin_io.cpp.

◆ readQual() [2/2]

int readQual ( uint8_t *  qual,
int32_t  nbins_to_read,
int32_t  row_num_to_read 
)
virtual

Implements hdf_bin.

Definition at line 759 of file bin_io.cpp.

◆ readSums() [1/2]

int readSums ( float *  sums,
int32_t *  listOfBins,
int32_t  nbins_to_read,
int  iprod 
)
virtual

Implements hdf_bin.

Definition at line 811 of file bin_io.cpp.

◆ readSums() [2/2]

int readSums ( float *  sums,
int32_t  nbins_to_read,
int  iprod 
)
virtual

Read Bin File Product Data

Parameters
sumsarray to place sum and sumSquares for each product
nbins_to_readnumber of consecutive bins to read
iprodproduct index or -1 to read all active products set by read()
Returns
0 if OK

Implements hdf_bin.

Definition at line 778 of file bin_io.cpp.

◆ set_bin_num()

int set_bin_num ( int  offset,
int64_t  bin_num 
)
inlinevirtual

Implements hdf_bin.

Definition at line 208 of file hdf_bin.h.

◆ set_weights()

int set_weights ( int  offset,
float  weights 
)
inlinevirtual

Implements hdf_bin.

Definition at line 228 of file hdf_bin.h.

◆ setDataPtr()

int setDataPtr ( int  nbins_to_read)
inlinevirtual

Implements hdf_bin.

Definition at line 262 of file hdf_bin.h.

◆ setDataPtrAbsolute()

int setDataPtrAbsolute ( int32_t  recordNum)
virtual

Implements hdf_bin.

Definition at line 847 of file bin_io.cpp.

◆ write()

int write ( char *  product_list,
int32_t  nwrite,
float *  data,
binListStruct binList 
)

Definition at line 608 of file bin_io.cpp.

◆ writeBinList()

int writeBinList ( int32_t  nbins_to_write)
virtual

Implements hdf_bin.

Definition at line 855 of file bin_io.cpp.

◆ writeQual()

int writeQual ( uint8_t *  qual,
int32_t  nbins_to_write 
)
virtual

Implements hdf_bin.

Definition at line 883 of file bin_io.cpp.

◆ writeSums()

int writeSums ( float *  sums,
int32_t  nbins_to_write,
const char *  prodname 
)
virtual

Implements hdf_bin.

Definition at line 905 of file bin_io.cpp.

Member Data Documentation

◆ noext

int32_t noext

Definition at line 283 of file hdf_bin.h.


The documentation for this class was generated from the following files:
  • /gfs-oceanweb/web/ocssw/ocssw_src/oel_hdf4/libbin/hdf_bin.h
  • /gfs-oceanweb/web/ocssw/ocssw_src/oel_hdf4/libbin/bin_io.cpp