#include <MisrError.h>
#include <MisrSetRegion.h>
#include <MisrUtil.h>

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)

MTKt_status	MtkReadBlockRange (const char filename, const char gridname, const char fieldname, int startblock, int endblock, MTKt_DataBuffer3D databuf)
	Read range of blocks of data into a 3-dimensional array. More...

MTKt_status	MtkReadBlockRangeNC (const char filename, const char gridname, const char fieldname, int startblock, int endblock, MTKt_DataBuffer3D databuf)

MTKt_status	MtkReadBlockRangeHDF (const char filename, const char gridname, const char fieldname, int startblock, int endblock, MTKt_DataBuffer3D databuf)

MTKt_status	MtkReadBlockRangeFid (int32 fid, const char gridname, const char fieldname, int startblock, int endblock, MTKt_DataBuffer3D *databuf)
	Version of MtkReadBlockRange that takes an HDF-EOS file identifier rather than a filename. More...

MTKt_status	MtkReadBlockRangeNcid (int ncid, const char gridname, const char fieldname, int startblock, int endblock, MTKt_DataBuffer3D *databuf)

MTKt_status	MtkReadConv (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)
	Reads any grid/field from a MISR conventional product file. More...

MTKt_status	MtkReadConvFid (int32 fid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadConv that takes an HDF-EOS file identifier rather than a filename. More...

MTKt_status	MtkReadData (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)
	Reads any grid/field from any MISR product file and performs unpacking or unscaling. It also reads any MISR conventional product file. More...

MTKt_status	MtkReadDataHDF (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)

MTKt_status	MtkReadDataNC (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)

MTKt_status	MtkReadDataFid (int32 fid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadData that takes an HDF-EOS file identifier rather than a filename. More...

MTKt_status	MtkReadDataNcid (int ncid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadData that takes a netCDF file identifier rather than a filename. More...

MTKt_status	MtkReadRaw (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)
	Reads any native grid/field from a MISR product file without unpacking or unscaling. More...

MTKt_status	MtkReadRawNC (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)

MTKt_status	MtkReadRawHDF (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)

MTKt_status	MtkReadRawFid (int32 fid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadRaw that takes an HDF-EOS file identifier rather than a filename. More...

MTKt_status	MtkReadRawNcid (int ncid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadRaw that takes an HDF-EOS file identifier rather than a filename. More...

MTKt_status	MtkReadL1B2 (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)
	Reads, unpacks and unscales any L1B2 grid/field from a MISR L1B2 product file. More...

MTKt_status	MtkReadL1B2Fid (int32 Fid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadL1B2 that takes an HDF-EOS file identifier rather than a filename. MISR L1B2 product file. More...

MTKt_status	MtkReadL2Land (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)
	Reads, unpacks and unscales any L2 Land grid/field from a MISR L2 AS Land product file. More...

MTKt_status	MtkReadL2LandNC (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)

MTKt_status	MtkReadL2LandHDF (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)

MTKt_status	MtkReadL2LandFid (int32 fid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadL2Land that takes and HDF-EOS file identifier rather than a filename. More...

MTKt_status	MtkReadL2LandNcid (int ncid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)

MTKt_status	MtkReadL2TCCloud (const char filename, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo *mapinfo)
	Reads, unpacks and unscales TC_CLOUD grid/fields from a MISR L2 TC_CLOUD product file. More...

MTKt_status	MtkReadL2TCCloudFid (int32 fid, const char gridname, const char fieldname, MTKt_Region region, MTKt_DataBuffer databuf, MTKt_MapInfo mapinfo)
	Version of MtkReadL2TCCloud that takes and HDF-EOS file identifier rather than a filename. More...

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.

◆ MtkReadBlockRange()

MTKt_status MtkReadBlockRange	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		int	startblock,
		int	endblock,
		MTKt_DataBuffer3D *	databuf
	)

Read range of blocks of data into a 3-dimensional array.

Returns: MTK_SUCCESS if successful.

Example:: In this example, we read blocks 26 through 40 for the field AveSceneElev in the grid Standard in the file MISR_AM1_AGP_P037_F01_24.hdf

MTKt_DataBuffer3D databuf = MTKT_DATABUFFER3D_INIT;

status = MtkReadBlockRange("MISR_AM1_AGP_P037_F01_24.hdf", "Standard", "AveSceneElev", 26, 40, &databuf);

Note: The caller is responsible for using MtkDataBufferFree3D() 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]	startblock	Start block number
[in]	endblock	Stop block number
[out]	databuf	3-dimensional Data buffer

Definition at line 51 of file MtkReadBlockRange.c.

◆ MtkReadBlockRangeFid()

MTKt_status MtkReadBlockRangeFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		int	startblock,
		int	endblock,
		MTKt_DataBuffer3D *	databuf
	)

Version of MtkReadBlockRange 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]	startblock	Start block number
[in]	endblock	Stop block number
[out]	databuf	3-dimensional Data buffer

Definition at line 146 of file MtkReadBlockRange.c.

◆ MtkReadBlockRangeHDF()

MTKt_status MtkReadBlockRangeHDF	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		int	startblock,
		int	endblock,
		MTKt_DataBuffer3D *	databuf
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	startblock	Start block number
[in]	endblock	Stop block number
[out]	databuf	3-dimensional Data buffer

Definition at line 106 of file MtkReadBlockRange.c.

◆ MtkReadBlockRangeNC()

MTKt_status MtkReadBlockRangeNC	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		int	startblock,
		int	endblock,
		MTKt_DataBuffer3D *	databuf
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	startblock	Start block number
[in]	endblock	Stop block number
[out]	databuf	3-dimensional Data buffer

Definition at line 67 of file MtkReadBlockRange.c.

◆ MtkReadBlockRangeNcid()

MTKt_status MtkReadBlockRangeNcid	(	int	ncid,
		const char *	gridname,
		const char *	fieldname,
		int	startblock,
		int	endblock,
		MTKt_DataBuffer3D *	databuf
	)

Parameters

[in]	ncid	netCDF file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	startblock	Start block number
[in]	endblock	Stop block number
[out]	databuf	3-dimensional Data buffer

Definition at line 232 of file MtkReadBlockRange.c.

◆ MtkReadConv()

MTKt_status MtkReadConv	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Reads any grid/field from a MISR conventional product file.

Returns: MTK_SUCCESS if successful.

Special Note: Typically this function is not called directly. Instead use MtkReadData().

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 37 of file MtkReadConv.c.

◆ MtkReadConvFid()

MTKt_status MtkReadConvFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadConv 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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 76 of file MtkReadConv.c.

◆ MtkReadData()

MTKt_status MtkReadData	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Reads any grid/field from any MISR product file and performs unpacking or unscaling. It also reads any MISR conventional product file.

Returns: MTK_SUCCESS if successful.

Example:: In this example, we read a region centered at lat 35.0, lon -115.0 with a lat extent of 110.0km and lon extent 110.0km. We read from the field AveSceneElev in the grid Standard in the file MISR_AM1_AGP_P037_F01_24.hdf

char *error_mesg[] = MTK_ERR_DESC;
MTKt_Region region = MTKT_REGION_INIT;
MTKt_DataBuffer databuf = MTKT_DATABUFFER_INIT;
MTKt_MapInfo mapinfo = MTKT_MAPINFO_INIT;
status = MtkSetRegionByLatLonExtent(35.0, -115.0, 110.0, 110.0, "km", &region);
status = MtkReadData("MISR_AM1_AGP_P037_F01_24.hdf", "Standard", "AveSceneElev", region, &databuf, &mapinfo);
if (status != MTK_SUCCESS) {
    printf("%s\n",error_mesg[status]);
}

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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 62 of file MtkReadData.c.

◆ MtkReadDataFid()

MTKt_status MtkReadDataFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadData 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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 157 of file MtkReadData.c.

◆ MtkReadDataHDF()

MTKt_status MtkReadDataHDF	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 78 of file MtkReadData.c.

◆ MtkReadDataNC()

MTKt_status MtkReadDataNC	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 113 of file MtkReadData.c.

◆ MtkReadDataNcid()

MTKt_status MtkReadDataNcid	(	int	ncid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadData that takes a netCDF file identifier rather than a filename.

Returns: MTK_SUCCESS if successful.

Parameters

[in]	ncid	HDF-EOS file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 261 of file MtkReadData.c.

◆ MtkReadL1B2()

MTKt_status MtkReadL1B2	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Reads, unpacks and unscales any L1B2 grid/field from a MISR L1B2 product file.

Returns: MTK_SUCCESS if successful.

Special Note: Typically this function is not called directly. Instead use MtkReadData().

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 41 of file MtkReadL1B2.c.

◆ MtkReadL1B2Fid()

MTKt_status MtkReadL1B2Fid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadL1B2 that takes an HDF-EOS file identifier rather than a filename. MISR L1B2 product file.

Returns: MTK_SUCCESS if successful.

Parameters

[in]	fid	HDF-EOS file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 81 of file MtkReadL1B2.c.

◆ MtkReadL2Land()

MTKt_status MtkReadL2Land	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Reads, unpacks and unscales any L2 Land grid/field from a MISR L2 AS Land product file.

Returns: MTK_SUCCESS if successful.

Special Note: Typically this function is not called directly. Instead use MtkReadData().

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 39 of file MtkReadL2Land.c.

◆ MtkReadL2LandFid()

MTKt_status MtkReadL2LandFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadL2Land that takes and 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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 132 of file MtkReadL2Land.c.

◆ MtkReadL2LandHDF()

MTKt_status MtkReadL2LandHDF	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 93 of file MtkReadL2Land.c.

◆ MtkReadL2LandNC()

MTKt_status MtkReadL2LandNC	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 55 of file MtkReadL2Land.c.

◆ MtkReadL2LandNcid()

MTKt_status MtkReadL2LandNcid	(	int	ncid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	ncid	netCDF file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 474 of file MtkReadL2Land.c.

◆ MtkReadL2TCCloud()

MTKt_status MtkReadL2TCCloud	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Reads, unpacks and unscales TC_CLOUD grid/fields from a MISR L2 TC_CLOUD product file.

Returns: MTK_SUCCESS if successful.

Special Note: Typically this function is not called directly. Instead use MtkReadData().

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 39 of file MtkReadL2TCCloud.c.

◆ MtkReadL2TCCloudFid()

MTKt_status MtkReadL2TCCloudFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadL2TCCloud that takes and 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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 78 of file MtkReadL2TCCloud.c.

◆ MtkReadRaw()

MTKt_status MtkReadRaw	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Reads any native grid/field from a MISR product file without unpacking or unscaling.

Returns: MTK_SUCCESS if successful.

Special Note:: Typically this function is not called directly. Instead use MtkReadData().

Note: 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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 49 of file MtkReadRaw.c.

◆ MtkReadRawFid()

MTKt_status MtkReadRawFid	(	int32	fid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Version of MtkReadRaw 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]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 141 of file MtkReadRaw.c.

◆ MtkReadRawHDF()

MTKt_status MtkReadRawHDF	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 65 of file MtkReadRaw.c.

◆ MtkReadRawNC()

MTKt_status MtkReadRawNC	(	const char *	filename,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

Parameters

[in]	filename	File name
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 99 of file MtkReadRaw.c.

◆ MtkReadRawNcid()

MTKt_status MtkReadRawNcid	(	int	ncid,
		const char *	gridname,
		const char *	fieldname,
		MTKt_Region	region,
		MTKt_DataBuffer *	databuf,
		MTKt_MapInfo *	mapinfo
	)

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

Returns: MTK_SUCCESS if successful.

Parameters

[in]	ncid	netcdf file identifier
[in]	gridname	Grid name
[in]	fieldname	Field name
[in]	region	Region
[out]	databuf	Data buffer
[out]	mapinfo	Mapinfo

Definition at line 248 of file MtkReadRaw.c.

Functions

Function Documentation

◆ MtkReadBlock()

◆ MtkReadBlockFid()

◆ MtkReadBlockHDF()

◆ MtkReadBlockNC()

◆ MtkReadBlockNcid()

◆ MtkReadBlockRange()

◆ MtkReadBlockRangeFid()

◆ MtkReadBlockRangeHDF()

◆ MtkReadBlockRangeNC()

◆ MtkReadBlockRangeNcid()

◆ MtkReadConv()

◆ MtkReadConvFid()

◆ MtkReadData()

◆ MtkReadDataFid()

◆ MtkReadDataHDF()

◆ MtkReadDataNC()

◆ MtkReadDataNcid()

◆ MtkReadL1B2()

◆ MtkReadL1B2Fid()

◆ MtkReadL2Land()

◆ MtkReadL2LandFid()

◆ MtkReadL2LandHDF()

◆ MtkReadL2LandNC()

◆ MtkReadL2LandNcid()

◆ MtkReadL2TCCloud()

◆ MtkReadL2TCCloudFid()

◆ MtkReadRaw()

◆ MtkReadRawFid()

◆ MtkReadRawHDF()

◆ MtkReadRawNC()

◆ MtkReadRawNcid()