MtkReadBlock.c File Reference

#include "MisrReadData.h"
#include "MisrUtil.h"
#include "MisrError.h"
#include <stdlib.h>
#include <mfhdf.h>
#include <HdfEosDef.h>

Go to the source code of this file.

Functions
MTKt_status	MtkReadBlock (const char *filename, const char *gridname, const char *fieldname, int block, MTKt_DataBuffer *databuf)
	Read block of data. More...
MTKt_status	MtkReadBlockNC (const char *filename, const char *gridname, const char *fieldname, int block, MTKt_DataBuffer *databuf)
MTKt_status	MtkReadBlockHDF (const char *filename, const char *gridname, const char *fieldname, int block, MTKt_DataBuffer *databuf)
MTKt_status	MtkReadBlockFid (int32 fid, const char *gridname, const char *fieldname, int block, MTKt_DataBuffer *databuf)
	Version of MtkReadBlock that takes an HDF-EOS file identifier rather than a filename. More...
MTKt_status	MtkReadBlockNcid (int ncid, const char *gridname, const char *fieldname, int block, MTKt_DataBuffer *databuf)

Function Documentation

MtkReadBlock()

MTKt_status MtkReadBlock	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		int	block,
		MTKt_DataBuffer *	databuf
	)

Read block of data.

Returns

MTK_SUCCESS if successful.

Example:

In this example, we read block 26 for the field AveSceneElev in the grid Standard in the file MISR_AM1_AGP_P037_F01_24.hdf

MTKt_DataBuffer databuf = MTK_DATABUFFER_INIT;
status = MtkReadBlock("MISR_AM1_AGP_P037_F01_24.hdf", "Standard", "AveSceneElev", 26, &databuf);

Note

The caller is responsible for using MtkDataBufferFree() to free the memory used by databuf

The MISR Toolkit read functions always return a 2-D data plane buffer. Some fields in the MISR data products are multi-dimensional. In order to read one of these fields, the slice to read needs to be specified. A bracket notation on the fieldname is used for this purpose. For example fieldname = "RetrAppMask[0][5]".

Additional dimensions can be determined by the routine MtkFileGridFieldToDimlist() or by the MISR Data Product Specification (DPS) Document. The actually definition of the indices are not described in the MISR product files and thus not described by the MISR Toolkit. These will have to be looked up in the MISR DPS. All indices are 0-based.

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	block	Block number
[out]	databuf	Data buffer

Definition at line 51 of file MtkReadBlock.c.

MtkReadBlockFid()

MTKt_status MtkReadBlockFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		int	block,
		MTKt_DataBuffer *	databuf
	)

Version of MtkReadBlock that takes an HDF-EOS file identifier rather than a filename.

Returns

MTK_SUCCESS if successful.

Parameters

[in]	fid	HDF-EOS file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	block	Block number
[out]	databuf	Data buffer

Definition at line 141 of file MtkReadBlock.c.

MtkReadBlockHDF()

MTKt_status MtkReadBlockHDF	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		int	block,
		MTKt_DataBuffer *	databuf
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	block	Block number
[out]	databuf	Data buffer

Definition at line 103 of file MtkReadBlock.c.

MtkReadBlockNC()

MTKt_status MtkReadBlockNC	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		int	block,
		MTKt_DataBuffer *	databuf
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	block	Block number
[out]	databuf	Data buffer

Definition at line 66 of file MtkReadBlock.c.

MtkReadBlockNcid()

MTKt_status MtkReadBlockNcid	(	int	ncid,
		const char *	gridname,
		const char *	fieldname,
		int	block,
		MTKt_DataBuffer *	databuf
	)

Parameters

[in]	ncid	netCDF file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	block	Block number
[out]	databuf	Data buffer

Definition at line 220 of file MtkReadBlock.c.