OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <hdf_bin.h>

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

Public Member Functions

 hdf5_bin ()
 
 ~hdf5_bin ()
 
int64_t get_beg ()
 
int get_ext ()
 
int open (const char *l3b_filename)
 
int create (const char *l3b_filename, int32_t nrows)
 
int readBinIndex (int row_num_to_read)
 
int readBinList (int nbins_to_read)
 
int readBinList (int nbins_to_read, int32_t list_reset_ptr)
 
int readBinList ()
 
int readQual (unsigned char *qual, int32_t nbins_to_read)
 
int readQual (unsigned char *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)
 
int writeBinList (int32_t nbins_to_write)
 
int writeSums (float *sums, int32_t nbins_to_write, const char *prodname)
 
int writeQual (uint8_t *qual, int32_t nbins_to_write)
 
int write (const char *product_list, hsize_t nwrite, float *data, binListStruct_hdf5 *binList)
 
int close ()
 
bool has_qual ()
 
hid_t get_index_table ()
 
hid_t get_list_table ()
 
hid_t get_data_table (int i)
 
hid_t get_grp0 ()
 
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 setDataPtr (int nbins_to_read)
 
int setDataPtrAbsolute (int32_t recordNum)
 
int incNumRec (int n_write)
 
- 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 int readQual (uint8_t *qual, int32_t nbins_to_read)=0
 
virtual int readQual (uint8_t *qual, int32_t nbins_to_read, int32_t row_num_to_read)=0
 
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

hsize_t binDataPtr
 
- 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 287 of file hdf_bin.h.

Constructor & Destructor Documentation

◆ hdf5_bin()

hdf5_bin ( )

Definition at line 121 of file bin_io.cpp.

◆ ~hdf5_bin()

~hdf5_bin ( )

Definition at line 132 of file bin_io.cpp.

Member Function Documentation

◆ clear_binlist()

int clear_binlist ( )
inlinevirtual

Implements hdf_bin.

Definition at line 410 of file hdf_bin.h.

◆ close()

int close ( )
virtual

Implements hdf_bin.

Definition at line 1943 of file bin_io.cpp.

◆ copy_binlist()

int copy_binlist ( int  src,
int  dest 
)
inlinevirtual

Implements hdf_bin.

Definition at line 415 of file hdf_bin.h.

◆ create()

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

Implements hdf_bin.

Definition at line 1147 of file bin_io.cpp.

◆ get_beg()

int64_t get_beg ( )
inlinevirtual

Implements hdf_bin.

Definition at line 306 of file hdf_bin.h.

◆ get_bin_num()

int64_t get_bin_num ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 361 of file hdf_bin.h.

◆ get_data_table()

hid_t get_data_table ( int  i)
inlinevirtual

Implements hdf_bin.

Definition at line 353 of file hdf_bin.h.

◆ get_ext()

int get_ext ( )
inlinevirtual

Implements hdf_bin.

Definition at line 310 of file hdf_bin.h.

◆ get_grp0()

hid_t get_grp0 ( )
inline

Definition at line 357 of file hdf_bin.h.

◆ get_index_table()

hid_t get_index_table ( )
inlinevirtual

Implements hdf_bin.

Definition at line 345 of file hdf_bin.h.

◆ get_list_table()

hid_t get_list_table ( )
inlinevirtual

Implements hdf_bin.

Definition at line 349 of file hdf_bin.h.

◆ get_nobs()

int get_nobs ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 365 of file hdf_bin.h.

◆ get_nscenes()

int get_nscenes ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 369 of file hdf_bin.h.

◆ get_time_rec()

float get_time_rec ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 377 of file hdf_bin.h.

◆ get_weights()

float get_weights ( int  kbin)
inlinevirtual

Implements hdf_bin.

Definition at line 373 of file hdf_bin.h.

◆ has_qual()

bool has_qual ( )
inlinevirtual

Implements hdf_bin.

Definition at line 341 of file hdf_bin.h.

◆ inc_nobs()

int inc_nobs ( int  offset,
int  nobs 
)
inlinevirtual

Implements hdf_bin.

Definition at line 386 of file hdf_bin.h.

◆ inc_nscenes()

int inc_nscenes ( int  offset,
int  nscenes 
)
inlinevirtual

Implements hdf_bin.

Definition at line 391 of file hdf_bin.h.

◆ inc_time_rec()

int inc_time_rec ( int  offset,
float  time_rec 
)
inlinevirtual

Implements hdf_bin.

Definition at line 406 of file hdf_bin.h.

◆ inc_weights()

int inc_weights ( int  offset,
float  weights 
)
inlinevirtual

Implements hdf_bin.

Definition at line 396 of file hdf_bin.h.

◆ incNumRec()

int incNumRec ( int  n_write)
inlinevirtual

Implements hdf_bin.

Definition at line 430 of file hdf_bin.h.

◆ open()

int open ( const char *  l3b_filename)
virtual

Implements hdf_bin.

Definition at line 1172 of file bin_io.cpp.

◆ readBinIndex()

int readBinIndex ( int  row_num_to_read)
virtual

Implements hdf_bin.

Definition at line 1312 of file bin_io.cpp.

◆ readBinList() [1/3]

int readBinList ( )
virtual

Implements hdf_bin.

Definition at line 1443 of file bin_io.cpp.

◆ readBinList() [2/3]

int readBinList ( int  nbins_to_read)
virtual

Implements hdf_bin.

Definition at line 1371 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 1429 of file bin_io.cpp.

◆ readQual() [1/2]

int readQual ( unsigned char *  qual,
int32_t  nbins_to_read 
)

Definition at line 1450 of file bin_io.cpp.

◆ readQual() [2/2]

int readQual ( unsigned char *  qual,
int32_t  nbins_to_read,
int32_t  row_num_to_read 
)

Definition at line 1455 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 1527 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 1463 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 381 of file hdf_bin.h.

◆ set_weights()

int set_weights ( int  offset,
float  weights 
)
inlinevirtual

Implements hdf_bin.

Definition at line 401 of file hdf_bin.h.

◆ setDataPtr()

int setDataPtr ( int  nbins_to_read)
inlinevirtual

Implements hdf_bin.

Definition at line 420 of file hdf_bin.h.

◆ setDataPtrAbsolute()

int setDataPtrAbsolute ( int32_t  recordNum)
inlinevirtual

Implements hdf_bin.

Definition at line 425 of file hdf_bin.h.

◆ write()

int write ( const char *  product_list,
hsize_t  nwrite,
float *  data,
binListStruct_hdf5 binList 
)

Definition at line 1595 of file bin_io.cpp.

◆ writeBinList()

int writeBinList ( int32_t  nbins_to_write)
virtual

Implements hdf_bin.

Definition at line 1780 of file bin_io.cpp.

◆ writeQual()

int writeQual ( uint8_t *  qual,
int32_t  nbins_to_write 
)
inlinevirtual

Implements hdf_bin.

Definition at line 333 of file hdf_bin.h.

◆ writeSums()

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

Implements hdf_bin.

Definition at line 1866 of file bin_io.cpp.

Member Data Documentation

◆ binDataPtr

hsize_t binDataPtr

Definition at line 435 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