MisrOrbitPath.h File Reference

#include "MisrSetRegion.h"
#include "MisrError.h"

Go to the source code of this file.

Macros
#define	MISR_ORBIT_REF_995   2451599.189583333 /* 995 24 Feb 2000 16:33:00 */
#define	MISR_ORBIT_REF_DT   1000
#define	MISR_ORBIT_REF

Functions
MTKt_status	MtkLatLonToPathList (double lat_dd, double lon_dd, int *pathcnt, int **pathlist)
	Get list of paths that cover a particular latitude and longitude. More...
MTKt_status	MtkRegionToPathList (MTKt_Region region, int *pathcnt, int **pathlist)
	Get list of paths that cover a particular region. More...
MTKt_status	MtkRegionPathToBlockRange (MTKt_Region region, int path, int *start_block, int *end_block)
	Get start and end block numbers of a path over a particular region. More...
MTKt_status	MtkOrbitToPath (int orbit, int *path)
	Given orbit number return path number. More...
MTKt_status	MtkTimeToOrbitPath (const char *datetime, int *orbit, int *path)
	Given time return orbit number and path number. More...
MTKt_status	MtkTimeRangeToOrbitList (const char *start_time, const char *end_time, int *orbitcnt, int **orbitlist)
	Given start time and end time return list of orbits. More...
MTKt_status	MtkPathTimeRangeToOrbitList (int path, const char *start_time, const char *end_time, int *orbitcnt, int **orbitlist)
	Given path and time range return list of orbits on path. More...
MTKt_status	MtkOrbitToTimeRange (int orbit, char start_time[MTKd_DATETIME_LEN], char end_time[MTKd_DATETIME_LEN])
	Given a orbit number return time. More...

Macro Definition Documentation

MISR_ORBIT_REF

#define MISR_ORBIT_REF

Definition at line 40 of file MisrOrbitPath.h.

MISR_ORBIT_REF_995

#define MISR_ORBIT_REF_995   2451599.189583333 /* 995 24 Feb 2000 16:33:00 */

Definition at line 38 of file MisrOrbitPath.h.

MISR_ORBIT_REF_DT

#define MISR_ORBIT_REF_DT   1000

Definition at line 39 of file MisrOrbitPath.h.

Function Documentation

MtkLatLonToPathList()

MTKt_status MtkLatLonToPathList	(	double	lat_dd,
		double	lon_dd,
		int *	pathcnt,
		int **	pathlist
	)

Get list of paths that cover a particular latitude and longitude.

Returns

MTK_SUCCESS if successful.

Example:

In this example, we get the list of paths covering decimal degrees latitude -75.345 and longitude 169.89.

status = MtkLatLonToPathList(-75.345, 169.89, &pathcnt, &pathlist);

Note

The caller is responsible for freeing the memory used by pathlist

Parameters

[in]	lat_dd	Latitude
[in]	lon_dd	Longitude
[out]	pathcnt	Path Count
[out]	pathlist	Path List

Definition at line 38 of file MtkLatLonToPathList.c.

MtkOrbitToPath()

MTKt_status MtkOrbitToPath	(	int	orbit,
		int *	path
	)

Given orbit number return path number.

Returns

MTK_SUCCESS if successful.

Example:

In this example, we get the path number of orbit 12115.

status = MtkOrbitToPath(12115, &path);

Parameters

[in]	orbit	Orbit Number
[out]	path	Path Number

Definition at line 135 of file MtkOrbitToPath.c.

MtkOrbitToTimeRange()

MTKt_status MtkOrbitToTimeRange	(	int	orbit,
		char	start_time[MTKd_DATETIME_LEN],
		char	end_time[MTKd_DATETIME_LEN]
	)

Given a orbit number return time.

Returns

MTK_SUCCESS if successful.

Time Format: YYYY-MM-DDThh:mm:ssZ (ISO 8601)

Example:

In this example, we get the time for orbit number 26000

status = MtkOrbitToTimeRange(26000, start_time, end_time);

Parameters

[in]	orbit	Orbit Number
[out]	start_time	Start Time
[out]	end_time	End Time

Definition at line 38 of file MtkOrbitToTimeRange.c.

MtkPathTimeRangeToOrbitList()

MTKt_status MtkPathTimeRangeToOrbitList	(	int	path,
		const char *	start_time,
		const char *	end_time,
		int *	orbitcnt,
		int **	orbitlist
	)

Given path and time range return list of orbits on path.

Returns

MTK_SUCCESS if successful.

Time Format: YYYY-MM-DDThh:mm:ssZ (ISO 8601)

Example:

In this example, we get the list of orbits covering path 78 from 2002-02-02 02:00:00 UTC to 2002-05-02 02:00:00 UTC

status = MtkPathTimeRangeToOrbitList(78, "2002-02-02T02:00:00Z", "2002-05-02T02:00:00Z", &orbitcnt, &orbitlist);

Note

The caller is responsible for freeing the memory used by orbitlist

Parameters

[in]	path	Path
[in]	start_time	Start Time
[in]	end_time	End Time
[out]	orbitcnt	Orbit Count
[out]	orbitlist	Orbit List

Definition at line 40 of file MtkPathTimeRangeToOrbitList.c.

MtkRegionPathToBlockRange()

MTKt_status MtkRegionPathToBlockRange	(	MTKt_Region	region,
		int	path,
		int *	start_block,
		int *	end_block
	)

Get start and end block numbers of a path over a particular region.

Returns

MTK_SUCCESS if successful.

Example:

In this example, we get the start and end block numbers of path 78 for a particular region of interest.

status = MtkRegionPathToBlockRange(region, 78, &start_block, &end_block);

Parameters

[in]	region	Region
[in]	path	Path
[out]	start_block	Start Block
[out]	end_block	End Block

Definition at line 38 of file MtkRegionPathToBlockRange.c.

MtkRegionToPathList()

MTKt_status MtkRegionToPathList	(	MTKt_Region	region,
		int *	pathcnt,
		int **	pathlist
	)

Get list of paths that cover a particular region.

Returns

MTK_SUCCESS if successful.

Example:

In this example, we get the list of paths covering a particular region of interest.

status = MtkRegionToPathList(region, &pathcnt, &pathlist);

Note

The caller is responsible for freeing the memory used by pathlist

Parameters

[in]	region	Region
[out]	pathcnt	Path Count
[out]	pathlist	Path List

Definition at line 38 of file MtkRegionToPathList.c.

MtkTimeRangeToOrbitList()

MTKt_status MtkTimeRangeToOrbitList	(	const char *	start_time,
		const char *	end_time,
		int *	orbitcnt,
		int **	orbitlist
	)

Given start time and end time return list of orbits.

Returns

MTK_SUCCESS if successful.

Time Format: YYYY-MM-DDThh:mm:ssZ (ISO 8601)

Example:

In this example, we get the list of orbits from 2002-02-02 02:00:00 UTC to 2002-05-02 02:00:00 UTC

status = MtkTimeRangeToOrbitList("2002-02-02T02:00:00Z", "2002-05-02T02:00:00Z", &orbitcnt, &orbitlist);

Note

The caller is responsible for freeing the memory used by orbitlist

Parameters

[in]	start_time	Start Time
[in]	end_time	End Time
[out]	orbitcnt	Orbit Count
[out]	orbitlist	Orbit List

Definition at line 38 of file MtkTimeRangeToOrbitList.c.

MtkTimeToOrbitPath()

MTKt_status MtkTimeToOrbitPath	(	const char *	datetime,
		int *	orbit,
		int *	path
	)

Given time return orbit number and path number.

Returns

MTK_SUCCESS if successful.

Time Format: YYYY-MM-DDThh:mm:ssZ (ISO 8601)

Example:

In this example, we get the orbit and path numbers for the time 2002-05-02 02:00:00 UTC

status = MtkTimeToOrbitPath("2002-05-02T02:00:00Z", &orbit, &path);

Parameters

[in]	datetime	Date Time
[out]	orbit	Orbit Number
[out]	path	Path

Definition at line 38 of file MtkTimeToOrbitPath.c.