MISR Toolkit

https://nasa.github.io/MISR-Toolkit/html/
Admin
The MISR Toolkit is a programming interface that simplifies access to and processing of MISR...
Tokens:5,132,558
Snippets:44,155
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### MISR Toolkit Command-Line Utility Examples

Source: https://nasa.github.io/MISR-Toolkit/html/index

Examples demonstrating the usage of various MISR Toolkit command-line utilities, including converting latitude/longitude to path lists, orbit numbers to time ranges, and HDF files to ENVI format.

```Shell
source <HDFEOSDIR>/bin/<ARCH>/hdfeos_env.csh
source $MTK_INSTALLDIR/bin/Mtk_c_env.csh
MtkLatLonToPathList --dd=-75.345,169.89
```

```Shell
MtkOrbitToTimeRange 29058
```

```Shell
MtkMisrToEnvi --entire-file --hdffilename=../Mtk_testdata/in/MISR_AM1_GRP_ELLIPSOID_GM_P037_O029058_AA_F03_0024.hdf \
--gridname=BlueBand --fieldname="Blue Brf" --envifilename=out
```

--------------------------------

### Build, Test, and Install All MISR Toolkit Components

Source: https://nasa.github.io/MISR-Toolkit/html/index

Compiles, tests, and installs the entire MISR Toolkit, including the C library, command-line utilities, and IDL and Python bindings. This is the most comprehensive build option. Root privileges are typically required for installation into system directories.

```Shell
make
make testall
sudo make install
```

--------------------------------

### Install and Configure Python Documentation Tools

Source: https://nasa.github.io/MISR-Toolkit/html/index

Steps to download and install the `mkhowto` tool and set the `PYDOCDIR` environment variable for generating Python documentation. Includes commands for both csh and bash shells.

```Shell
cd $MTK_INSTALLDIR
scripts/download_mkhowto
scripts/install_mkhowto
```

```Shell
setenv PYDOCDIR <your-path>/Mtk_thirdparty/pythonDocTools
```

```Shell
export PYDOCDIR=<your-path>/Mtk_thirdparty/pythonDocTools
```

--------------------------------

### MisrToolkit Orbit and Time Range Query Example Output

Source: https://nasa.github.io/MISR-Toolkit/html/index

This example illustrates the output of a MisrToolkit query for orbits within a specified time range across multiple paths, listing relevant orbit numbers for each path.

```Text
        Example2:
        starttime = 2002-02-02T02:00:00Z
        endtime = 2002-05-02T02:00:00Z
        Pathlist = 35 36 37 38 39
        Orbitlist for Path 35 = 11379 11612 11845 12078 12311 12544
        Orbitlist for Path 36 = 11481 11714 11947 12180 12413
        Orbitlist for Path 37 = 11350 11583 11816 12049 12282 12515
        Orbitlist for Path 38 = 11452 11685 11918 12151 12384
        Orbitlist for Path 39 = 11321 11554 11787 12020 12253 12486
```

--------------------------------

### Build, Test, and Install MISR Toolkit IDL Library

Source: https://nasa.github.io/MISR-Toolkit/html/index

Compiles, tests, and installs only the IDL bindings for the MISR Toolkit. This option is for users who primarily work with IDL. Root privileges are typically required for installation.

```Shell
make idl
make testidl
sudo make install
```

--------------------------------

### Build, Test, and Install MISR Toolkit C Library and Command-Line Utilities

Source: https://nasa.github.io/MISR-Toolkit/html/index

Compiles, tests, and installs only the core C library and command-line utilities of the MISR Toolkit. This option is suitable if you do not require the IDL or Python bindings. Root privileges are typically required for installation.

```Shell
make lib
make cmdutil
make test
sudo make install
```

--------------------------------

### Create and Navigate to Temporary Working Directory

Source: https://nasa.github.io/MISR-Toolkit/html/index

Initializes the installation process by creating a dedicated temporary directory for the MISR Toolkit source and build files. All subsequent steps will be performed within this directory to keep the system clean.

```Shell
mkdir Mtk_tmp
cd Mtk_tmp
```

--------------------------------

### Install MISR Toolkit Python Bindings to Site-Packages

Source: https://nasa.github.io/MISR-Toolkit/html/index

Optionally installs the MISR Toolkit's Python bindings directly into the system's Python site-packages directory

--------------------------------

### Build, Test, and Install MISR Toolkit Python Library

Source: https://nasa.github.io/MISR-Toolkit/html/index

Compiles, tests, and installs only the Python bindings for the MISR Toolkit. This option is for users who primarily work with Python. Root privileges are typically required for installation.

```Shell
make python
make testpython
sudo make install
```

--------------------------------

### Initialize Python MisrToolkit environment

Source: https://nasa.github.io/MISR-Toolkit/html/index

This snippet shows how to set up the Python environment for MisrToolkit by sourcing the environment script and importing the necessary modules, 'MisrToolkit' as 'Mtk' and 'os'.

```Python
$ source $MTK_INSTALLDIR/bin/Mtk_python_env.sh
        $ python
        >>> import MisrToolkit as Mtk
        >>> import os

```

--------------------------------

### Compile and Link C MisrToolkit Library

Source: https://nasa.github.io/MISR-Toolkit/html/index

This snippet provides the shell commands to compile and link C source files (foo.c, bar.c, biz.c) using `gcc` and the MisrToolkit (MTK) environment variables. It demonstrates setting up the environment, compiling object files, linking them into an executable, and running the program.

```Shell
        $ source <HDFEOSDIR>/bin/<ARCH>/hdfeos_env.csh
        $ source $MTK_INSTALLDIR/bin/Mtk_c_env.csh
        $ gcc $MTK_CFLAGS -c foo.c
        $ gcc $MTK_CFLAGS -c bar.c
        $ gcc $MTK_CFLAGS -c biz.c
        $ gcc -o baz foo.o bar.o biz.o $MTK_LDFLAGS
        $./baz
```

--------------------------------

### MISR Toolkit Build Management Commands

Source: https://nasa.github.io/MISR-Toolkit/html/index

Provides utility commands for managing the MISR Toolkit build process. 'make help' displays available build targets, and 'make clean' removes compiled objects and temporary files, useful for a fresh build.

```Shell
make help
make clean
```

--------------------------------

### Extract MISR Toolkit Source Archive

Source: https://nasa.github.io/MISR-Toolkit/html/index

Unpacks the main source code archive for the MISR Toolkit. This step makes the source files available for compilation and installation.

```Shell
tar xzvf Mtk-src-1.5.X.tar.gz
```

--------------------------------

### Install HDF-EOS and Dependent Libraries

Source: https://nasa.github.io/MISR-Toolkit/html/index

Installs the previously downloaded HDF-EOS/HDF, JPEG, and ZLIB libraries to a system-wide location, typically /usr/local/hdfeoslibs. This step often requires root privileges and applies necessary patches for compatibility with various operating systems like Mac Universal Binaries and Linux.

```Shell
sudo scripts/install_hdf+hdfeos
```

--------------------------------

### Define MISR Toolkit Installation Path

Source: https://nasa.github.io/MISR-Toolkit/html/index

Specifies the target installation directory for the MISR Toolkit using the MTK_INSTALLDIR environment variable. This variable guides where the compiled toolkit components will be placed. Commands are provided for both csh and bash shells.

```csh
setenv MTK_INSTALLDIR <your-path>/Mtk-1.5.X
```

```bash
export MTK_INSTALLDIR=<your-path>/Mtk-1.5.X
```

--------------------------------

### Get help on MisrToolkit objects in Python

Source: https://nasa.github.io/MISR-Toolkit/html/index

This snippet shows how to use the 'help()' function in Python to retrieve detailed documentation and usage information for MisrToolkit objects, including the data object ('d'), the numpy array ('n'), and the map information ('m').

```Python
>>> help(d)
        >>> help(n)
        >>> help(m)


```

--------------------------------

### MisrToolkit Region Definition Example Output

Source: https://nasa.github.io/MISR-Toolkit/html/index

This example demonstrates the output defining a geographic region by its center latitude/longitude and its extent in meters, likely used for data subsetting.

```Text
        Example 3:
        region center lat/lon (dd) = (32.200000, -114.500000)
                 region extent (m) = (200000.000000, 100000.000000)
```

--------------------------------

### C Function Signature and Example for MtkGCTPProjInfo

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_g_c_t_p_proj_info_8c

Demonstrates the C function signature for MtkGCTPProjInfo, which initializes a GCTP projection information structure, and provides a basic example of its usage.

```C
MTKt_status MtkGCTPProjInfo (int Proj_code, int Sphere_code, int Zone_code, double Proj_param[15], MTKt_GCTPProjInfo *Proj_info)

status = MtkGCTPProjInfo()
```

--------------------------------

### MisrToolkit Geographic Coordinate Conversion Example Output

Source: https://nasa.github.io/MISR-Toolkit/html/index

This example shows the output of a MisrToolkit operation, likely converting block/line/sample coordinates to geographic latitude/longitude and vice-versa, along with different formats for coordinates.

```Text
        Example 1:
        path = 37
        resolution = 275
        block, line, sample = 60,  256.0, 1024.0
        lat_dd, lon_dd = 38.130890, -110.848247
        lat deg, min, sec = 38:07:51.21
        lon deg, min, sec = -110:50:53.69
        b, l, s = 60,  256.0, 1024.0
```

--------------------------------

### start Array Definition

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2hproto_8h_source

Fortran common block array 'start'.

```APIDOC
HDFFCLIBAPI intf intf start[]
```

--------------------------------

### Download HDF-EOS and Dependent Libraries

Source: https://nasa.github.io/MISR-Toolkit/html/index

Navigates into the MISR Toolkit source directory and executes a script to download required external libraries, including HDF-EOS/HDF, JPEG, and ZLIB. These libraries are crucial dependencies for the toolkit's functionality.

```Shell
cd Mtk-src-1.5.X
scripts/download_libraries
```

--------------------------------

### Initialize and use IDL MisrToolkit to list files by time range

Source: https://nasa.github.io/MISR-Toolkit/html/index

This snippet demonstrates how to set up the IDL environment for MisrToolkit, load the library, and use the 'filelist_by_timerange' function to retrieve a list of MISR data files within a specified time window. It shows the interactive IDL session and the output format including orbit and path information.

```IDL
$ source $MTK_INSTALLDIR/bin/Mtk_idl_env.sh
        $ idl
        IDL> help,/dlm
            ....
            MTK - MISR Toolkit (not loaded)
            Version: 1.2.0, Build Date: Nov 08 2006, Source: Jet Propulsion Laboratory
            ....
        IDL> filelist_by_timerange,'2005-01-01T00:00:00','2005-01-01T00:59:59'
              Start time = 2005-01-01T00:00:00
                End time = 2005-01-01T00:59:59
        Number of orbits =            2
              Orbit list =        26804       26805
               0
        orbit =        26804 path =           88
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_DA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_CA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_BA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_AA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_AN_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_AF_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_BF_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_CF_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P088_O026804_DF_F03_0023.hdf
        MISR_AM1_GP_GMP_P088_O026804_F03_0013.hdf
        MISR_AM1_TC_STEREO_P088_O026804_F07_0012.hdf
               1
        orbit =        26805 path =          104
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_DA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_CA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_BA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_AA_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_AN_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_AF_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_BF_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_CF_F03_0023.hdf
        MISR_AM1_GRP_ELLIPSOID_GM_P104_O026805_DF_F03_0023.hdf
        MISR_AM1_GP_GMP_P104_O026805_F03_0013.hdf
        MISR_AM1_TC_STEREO_P104_O026805_F07_0012.hdf
        IDL> help,/dlm
            ....
            MTK - MISR Toolkit (loaded)
            Version: 1.2.0, Build Date: Nov 08 2006, Source: Jet Propulsion Laboratory
            ....

```

--------------------------------

### MisrToolkit HDF File Reading and Data Extraction Example Output (SubregParamsLnd)

Source: https://nasa.github.io/MISR-Toolkit/html/index

This example demonstrates the output from reading another MISR HDF file, extracting data from the 'SubregParamsLnd' grid and 'LandHDRF' field. It provides similar details to the previous example, including file path, grid/field names, dimensions, input coordinates, calculated line/sample, extracted value, block/line/sample, and SOM coordinates.

```Text
                      Reading file = /Users/ber/Development/Toolkit/Mtk/../Mtk_testdata/in/MISR_AM1_AS_LAND_P037_O029058_F06_0017.hdf
                      Reading grid = SubregParamsLnd
                     Reading field = LandHDRF[3][4]
           number of lines/samples = (192, 96)
                input lat/lon (dd) = (32.200000, -114.500000)
                       line/sample = (95.198349, 47.108253)
                      HDRF[95][47] = 0.208766
                 block/line/sample = (65, 52.198242, 103.108246)
                      lat/lon (dd) = (32.200000, -114.500000)
                     lat/lon (dms) = (32:11:59.999887, -114:30:0.000085)
                           SOM x/y = (16529918.184044, 307019.077821)
```

--------------------------------

### C: `deflateInit` Macro for Basic Zlib Compression Initialization

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f5__1_88_821_2include_2zlib_8h_source

A convenience macro that calls `deflateInit_` with default parameters for version and stream size. It simplifies the initialization of a zlib compression stream.

```C
#define deflateInit(strm, level) \
 deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
```

--------------------------------

### C API: Function Prototypes for MtkL2ASCloudMaskReproject

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_l2_a_s_cloud_mask_reproject_8c

API documentation for the key functions implemented in `MtkL2ASCloudMaskReproject.c`. This includes the program's entry point (`main`), a utility for processing command-line arguments (`process_args`), and a function to display usage instructions (`usage`).

```APIDOC
int process_args (int argc, char *argv[], argr_type *argr)
int main (int argc, char *argv[])
void usage (char *func)
```

--------------------------------

### GRgetchunkinfo Example

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2hproto_8h_source

Pseudo-C example demonstrating how to use GRgetchunkinfo to retrieve chunking information and flags for an HDF GR image. It shows passing a HDF_CHUNK_DEF structure to get chunk lengths and an integer to get the chunking flags.

```C
{
  int32 rcdims[3];
  HDF_CHUNK_DEF rchunk_def;
  int32 cflags;
  ...
  rchunk_def.chunk_lengths = rcdims;
  GRgetchunkinfo(riid, &rchunk_def, &cflags);
  ...
}
```

--------------------------------

### MisrToolkit HDF File Reading and Data Extraction Example Output (RedBand)

Source: https://nasa.github.io/MISR-Toolkit/html/index

This example shows the output from reading a MISR HDF file, specifically extracting data from the 'RedBand' grid and 'Red Brf' field. It includes details like file path, grid/field names, dimensions, input coordinates, calculated line/sample, extracted value, block/line/sample, and SOM coordinates, along with pixel time.

```Text
                      Reading file = /Users/ber/Development/Toolkit/Mtk/../Mtk_testdata/in/MISR_AM1_GRP_ELLIPSOID_GM_P037_O029058_AA_F03_0024.hdf
                      Reading grid = RedBand
                     Reading field = Red Brf
           number of lines/samples = (768, 384)
                input lat/lon (dd) = (32.200000, -114.500000)
                       line/sample = (383.293396, 191.933014)
                     Brf[383][192] = 0.357760
                 block/line/sample = (65, 210.292969, 413.932983)
                      lat/lon (dd) = (32.200000, -114.500000)
                     lat/lon (dms) = (32:11:59.999887, -114:30:0.000085)
                           SOM x/y = (16529918.187500, 307019.078125)
              pixel time[383][192] = 2005-06-04T18:21:45.415768Z
```

--------------------------------

### C: `deflateInit2` Macro for Extended Zlib Compression Initialization

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f5__1_88_821_2include_2zlib_8h_source

A convenience macro that calls `deflateInit2_` with default parameters for version and stream size. It simplifies the initialization of a zlib compression stream with extended options.

```C
#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\n (strategy), ZLIB_VERSION, (int)sizeof(z_stream))
```

--------------------------------

### Get HDF Chunk Information Example in C

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2mfhdf_8h_source

Provides a pseudo-C example for retrieving chunking information from an HDF SDS using `SDgetchunkinfo`. It shows how to pass a `HDF_CHUNK_DEF` structure and a flags variable to get details about chunk lengths and compression status.

```C
int32 rcdims[3];
HDF_CHUNK_DEF rchunk_def;
int32 cflags;
...
rchunk_def.chunk_lengths = rcdims;
SDgetchunkinfo(sdsid, &rchunk_def, &cflags);
...
```

--------------------------------

### C: Setup MISR Data File and Read Initial Data

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_toolkit_test_8c_source

This C code snippet illustrates how to set up file paths and parameters for reading MISR data. It shows the process of constructing a full file path and then using `MtkReadData` to load data from a specified filename, gridname, and fieldname. It also includes an initial coordinate conversion.

```C
  MtkDataBufferFree(&brf_databuf);

  /* --------------------------------------------------------- */
  /* Read data in the region from filename/gridname/fieldname */
  /* with extra dimensions, do some coordinate conversions and */
  /* query data buffer */
  /* --------------------------------------------------------- */

  //strcpy(filename, getenv("MTKHOME"));
  strcpy(filename,"");
  strcat(filename, "C:\\Mtk_testdata\\in\\");
  strcat(filename, "MISR_AM1_AS_LAND_P037_O029058_F06_0017.hdf");
  strcpy(gridname, "SubregParamsLnd");
  strcpy(fieldname, "LandHDRF[3][4]");

  status = MtkReadData(filename, gridname, fieldname, region,
  &hdrf_databuf, &hdrf_mapinfo);
  MTK_ERR_COND_JUMP(status);

  status = MtkLatLonToLS(hdrf_mapinfo, lat_dd, lon_dd, &line, &sample);
  MTK_ERR_COND_JUMP(status);

  l = (int)round(line);
  s = (int)round(sample);

  status = MtkFileToPath(filename, &path);

```

--------------------------------

### Example Usage of MtkFindFileList in C

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_find_file_list_8c

This C code snippet illustrates how to invoke the MtkFindFileList function. It demonstrates searching for GRP files associated with the 'DF' camera within the 'misr_products' directory, using wildcard regular expressions for path, orbit, and version. The example shows how to pass input parameters and receive the output file count and filenames.

```C
status = MtkFindFileList("misr_products", "GRP.*", "DF", ".*", ".*", ".*", &filecnt, &filenames);
```

--------------------------------

### C Example: Calling MtkUpsampleMask

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_upsample_mask_8c

A practical C code example demonstrating how to invoke the MtkUpsampleMask function with appropriate arguments to perform mask upsampling.

```C
status = MtkUpsampleMask(&source_mask, size_factor, &result_mask);
```

--------------------------------

### start

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2mfhdf_8h_source

A Fortran-compatible array or pointer named 'start'.

```Fortran
HDFFCLIBAPI intf intf start[]
```

--------------------------------

### HTPstart Function Signature

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2hfile_8h

Documents the HTPstart function, detailing its return type and parameters for initiating operations on a file record.

```APIDOC
intn HTPstart(filerec_t *file_rec)
```

--------------------------------

### Example Usage of MtkOrbitToTimeRange in C

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_orbit_to_time_range_8c

A C code example demonstrating how to call the `MtkOrbitToTimeRange` function with a specific orbit number (26000) to retrieve its start and end times.

```C
status = MtkOrbitToTimeRange(26000, start_time, end_time);
```

--------------------------------

### Setup Data Element List (dfgroup.c)

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2hproto_8h_source

Initializes and sets up a data element list with a specified maximum size. This function, from `dfgroup.c`, prepares a list for adding or managing data elements.

```C
int32 DFdisetup (int maxsize);
```

--------------------------------

### C Example: Get Projection Parameters for Path and Resolution

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_coord_query_8h

This example demonstrates how to use MtkPathToProjParam to obtain the projection parameters for path 1 at 1100 meter resolution.

```C
MTKt_MisrProjParam pp = MTKT_MISRPROJPARAM_INIT;
status = MtkPathToProjParam(1, 1100, &pp);
```

--------------------------------

### start Fortran Interface Definition

Source: https://nasa.github.io/MISR-Toolkit/html/_h5_spkg_8h_source

This is a Fortran interface definition. It declares a `start` function, likely part of the HDF5 Fortran bindings, used for initialization or starting a process.

```APIDOC
HDFFCLIBAPI intf intf start[]
Definition: hproto_fortran.h:428
```

--------------------------------

### C Code for Data Buffer Initialization and Return

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_data_buffer_import_8c_source

This C code snippet demonstrates the final steps of initializing a data buffer structure, hooking the data pointer to the actual data, assigning the populated buffer, and handling success or error returns within a function. It shows typical error handling flow using a `goto` statement.

```C
dbuf.data.v = dbuf.vdata;
/* Hook the data pointer to the data */
dbuf.dataptr = dbuf.vdata[0];

*databuf = dbuf;

return MTK_SUCCESS;

ERROR_HANDLE:
return status_code;
}
```

--------------------------------

### Example Usage of MtkPathToProjParam in C

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_path_to_proj_param_8c

This example demonstrates how to call MtkPathToProjParam to get projection parameters for MISR path 1 at 1100 meter resolution, initializing the MTKt_MisrProjParam structure.

```C
MTKt_MisrProjParam pp = MTKT_MISRPROJPARAM_INIT;

status = MtkPathToProjParam(1, 1100, &pp);
```

--------------------------------

### Example: Get Resolution of BlueBand Grid (C)

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_file_query_8h

This C code example demonstrates how to use MtkFileGridToResolution to obtain the resolution of the 'BlueBand' grid from a specific MISR HDF file.

```C
status = MtkFileGridToResolution("MISR_AM1_GRP_TERRAIN_GM_P161_O012115_DF_F03_0021.hdf", "BlueBand", &resolution);
```

--------------------------------

### deflateInit2() Function API Reference

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f5__1_88_821_2include_2zlib_8h_source

API reference for the deflateInit2() function, an advanced version of deflateInit with more compression options. It details parameters like `level`, `method`, `windowBits`, `memLevel`, and `strategy`, explaining their impact on compression ratio, speed, memory usage, and output format (zlib, raw deflate, gzip).

```C
ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
 int level,
 int method,
 int windowBits,
 int memLevel,
 int strategy));
```

```APIDOC
This is another version of deflateInit with more compression options. The
fields next_in, zalloc, zfree and opaque must be initialized before by the
caller.

The method parameter is the compression method. It must be Z_DEFLATED in
this version of the library.

The windowBits parameter is the base two logarithm of the window size
(the size of the history buffer). It should be in the range 8..15 for this
version of the library. Larger values of this parameter result in better
compression at the expense of memory usage. The default value is 15 if
deflateInit is used instead.

windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
determines the window size. deflate() will then generate raw deflate data
with no zlib header or trailer, and will not compute an adler32 check value.

windowBits can also be greater than 15 for optional gzip encoding. Add
16 to windowBits to write a simple gzip header and trailer around the
compressed data instead of a zlib wrapper. The gzip header will have no
file name, no extra data, no comment, no modification time (set to zero), no
header crc, and the operating system will be set to 255 (unknown). If a
gzip stream is being written, strm->adler is a crc32 instead of an adler32.

The memLevel parameter specifies how much memory should be allocated
for the internal compression state. memLevel=1 uses minimum memory but is
slow and reduces compression ratio; memLevel=9 uses maximum memory for
optimal speed. The default value is 8. See zconf.h for total memory usage
as a function of windowBits and memLevel.
```

--------------------------------

### DFdisetup: Setup HDF Data Interface

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2hproto_8h

This HDF library function initializes or sets up the data interface. It takes a maximum size parameter.

```APIDOC
HDFLIBAPI int32 DFdisetup(
  maxsize: int
)
```

--------------------------------

### ANstart: Start Annotation Access

Source: https://nasa.github.io/MISR-Toolkit/html/hproto__fortran_8h

Initializes and starts access to the annotation interface for a specified file ID. This function must be called before performing any annotation operations on a file.

```APIDOC
HDFLIBAPI int32 ANstart(int32 file_id)
```

--------------------------------

### C Example: Get MISR Paths by Latitude and Longitude

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_lat_lon_to_path_list_8c

An example demonstrating how to use the MtkLatLonToPathList function in C to retrieve the list of MISR paths that intersect a specific geographic point (latitude and longitude). This snippet shows a typical function call with example input values.

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

--------------------------------

### C Example: Get Block Corners for Path and Block Range

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_coord_query_8h

This example demonstrates how to use MtkPathBlockRangeToBlockCorners to retrieve the block corner coordinates for path 37 and blocks 25 to 50.

```C
status = MtkPathBlockRangeToBlockCorners(37, 25, 50, &block_corners);
```

--------------------------------

### Setup directory information (DFdisetup)

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2hproto_8h_source

Initializes or sets up directory information with a specified maximum size. This prepares the system for managing directory entries.

```C
int32 DFdisetup (int maxsize);
```

--------------------------------

### MtkL1B2Reproject.c Function Documentation

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_l1_b2_reproject_8c

Detailed API documentation for key functions implemented in MtkL1B2Reproject.c. This includes the main entry point of the program, a function for processing command-line arguments, and a utility function to display program usage information.

```APIDOC
main(int argc, char *argv[]): int
  Program entry point.
  Parameters:
    argc: The number of command-line arguments.
    argv: An array of command-line argument strings.
  Returns: int (exit status)
  Definition at line 54 of file MtkL1B2Reproject.c.
process_args(int argc, char *argv[], argr_type *argr): int
  Processes command-line arguments.
  Parameters:
    argc: The number of command-line arguments.
    argv: An array of command-line argument strings.
    argr: Pointer to an argr_type structure to store parsed arguments.
  Returns: int (status code)
  Definition at line 547 of file MtkL1B2Reproject.c.
usage(char *func): void
  Displays program usage information.
  Parameters:
    func: The name of the function or program for which to display usage.
  Returns: void
  Definition at line 441 of file MtkL1B2Reproject.c.
```

--------------------------------

### Configure MISR Toolkit Python Environment Variables

Source: https://nasa.github.io/MISR-Toolkit/html/index

Sets up the environment variables required to use the Python bindings of the MISR Toolkit. This step ensures that Python can locate and import the installed toolkit components, unless installed directly into site-packages. Commands are provided for both csh and bash shells.

```csh
source $MTK_INSTALLDIR/bin/Mtk_python_env.csh
```

```bash
. $MTK_INSTALLDIR/bin/Mtk_python_env.sh
```

--------------------------------

### Zlib Stream Initialization Macros

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2zlib_8h_source

These C preprocessor macros provide convenient wrappers for initializing Zlib compression (`deflate`) and decompression (`inflate`) streams. They automatically pass the `ZLIB_VERSION` and the size of `z_stream` to the underlying `_` suffixed functions, simplifying stream setup for various compression levels, methods, and window parameters.

```C
#define deflateInit(strm, level) \
 deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
#define inflateInit(strm) \
 inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\n (strategy), ZLIB_VERSION, (int)sizeof(z_stream))
#define inflateInit2(strm, windowBits) \
 inflateInit2_((strm), (windowBits), ZLIB_VERSION, \
 (int)sizeof(z_stream))
#define inflateBackInit(strm, windowBits, window) \
 inflateBackInit_((strm), (windowBits), (window), \
 ZLIB_VERSION, (int)sizeof(z_stream))
```

--------------------------------

### Get HDF SDS Chunk Information Example

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2mfhdf_8h_source

This snippet provides a pseudo-C example for using `SDgetchunkinfo` to retrieve chunking details and flags for an SDS. It shows how to prepare the `HDF_CHUNK_DEF` structure and variables to receive the output.

```C
int32 rcdims[3];
HDF_CHUNK_DEF rchunk_def;
int32 cflags;
...
rchunk_def.chunk_lengths = rcdims;
SDgetchunkinfo(sdsid, &rchunk_def, &cflags);
```

--------------------------------

### HDF API: Setup Directory List (DFdisetup)

Source: https://nasa.github.io/MISR-Toolkit/html/win32_2_h_d_f-_e_o_s5_includes_2hproto_8h

Initializes and sets up a new directory list with a specified maximum size. This prepares a structure for managing a collection of HDF objects.

```C
int32 DFdisetup (int maxsize)
```

--------------------------------

### Example: Get 'Camera' Attribute from HDF File (C)

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_file_query_8h

This example demonstrates how to use the MtkFileAttrGet function to retrieve the "Camera" attribute from a specific HDF file. It shows the basic syntax for calling the function.

```C
status = MtkFileAttrGet("MISR_AM1_GRP_TERRAIN_GM_P161_O012115_DF_F03_0021.hdf", "Camera", &attrbuf);
```

--------------------------------

### usage Function

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_resample_geom_8c_source

Displays usage instructions for a command-line tool, typically showing available arguments, their descriptions, and example syntax.

```C
void usage(char *func)
```

--------------------------------

### C: `inflateInit` Macro for Basic Zlib Decompression Initialization

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f5__1_88_821_2include_2zlib_8h_source

A convenience macro that calls `inflateInit_` with default parameters for version and stream size. It simplifies the initialization of a zlib decompression stream.

```C
#define inflateInit(strm) \
 inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
```

--------------------------------

### Get Vgroup References (Vgetvgroups)

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2hproto_8h_source

Retrieves references to Vgroups within a file, starting from a specified index.

```APIDOC
Vgetvgroups:
  Parameters:
    id: int32 - The file ID.
    start_vg: uintn - The starting index for Vgroup retrieval.
    n_vgs: uintn - The number of Vgroups to retrieve.
    refarray: uint16* - Array to store the Vgroup references.
  Returns:
    intn - Success or failure indicator.
```

--------------------------------

### DeflateInit2 Function API Reference

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2zlib_8h_source

Provides detailed API documentation for `deflateInit2`, an advanced version of `deflateInit` with more compression options. It explains parameters like `level`, `method`, `windowBits`, `memLevel`, and `strategy`, including their valid ranges, effects on compression, and special behaviors for gzip or raw deflate output.

```C
ZEXTERN int ZEXPORT deflateInit2 OF((
  z_streamp strm,
  int level,
  int method,
  int windowBits,
  int memLevel,
  int strategy
));
```

```APIDOC
deflateInit2(z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy):
  Description: Another version of deflateInit with more compression options. next_in, zalloc, zfree and opaque must be initialized before by the caller.
  Parameters:
    strm: Pointer to the z_stream structure.
    level: Compression level.
    method: Compression method. Must be Z_DEFLATED.
    windowBits: Base two logarithm of the window size (history buffer). Range 8..15 for zlib. -8..-15 for raw deflate (no zlib header/trailer, no adler32). Add 16 for gzip encoding (simple gzip header/trailer, crc32 instead of adler32).
    memLevel: Memory allocation for internal compression state. 1 (min memory, slow, low ratio) to 9 (max memory, optimal speed). Default is 8.
    strategy: Tunes compression algorithm.
      Z_DEFAULT_STRATEGY: Normal data.
      Z_FILTERED: Data produced by a filter/predictor (more Huffman coding, less string matching).
      Z_HUFFMAN_ONLY: Force Huffman encoding only (no string match).
      Z_RLE: Limit match distances to one (run-length encoding). Fast, good for PNG.
```

--------------------------------

### Function Signature: main

Source: https://nasa.github.io/MISR-Toolkit/html/misrcoordex_8c_source

The main entry point of the program, taking command-line arguments.

```APIDOC
int main(int argc, char *argv[])
```

--------------------------------

### VSgetvdatas Function

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2hproto_8h_source

API function to get Vdata references, starting from a specified offset and for a given array size.

```C
HDFLIBAPI intn VSgetvdatas(int32 id, uintn start_vd, uintn array_size, uint16 *refarray)
```

--------------------------------

### Configure MISR Toolkit IDL Environment Variables

Source: https://nasa.github.io/MISR-Toolkit/html/index

Sets up the environment variables required to use the IDL bindings of the MISR Toolkit. This step ensures that IDL can locate and interact with the installed toolkit components. Commands are provided for both csh and bash shells.

```csh
source $MTK_INSTALLDIR/bin/Mtk_idl_env.csh
```

```bash
. $MTK_INSTALLDIR/bin/Mtk_idl_env.sh
```

--------------------------------

### Configure IDL Directory Environment Variable

Source: https://nasa.github.io/MISR-Toolkit/html/index

Optionally sets the IDL_DIR environment variable if you plan to build or use the IDL bindings for the MISR Toolkit. This helps the build system locate your IDL installation. Commands are provided for both csh and bash shells.

```csh
setenv IDL_DIR <path-to-idl>/harris/idl
```

```bash
export IDL_DIR=<path-to-idl>/harris/idl
```

--------------------------------

### C Example: Calling MtkGCTPProjInfoRead

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_g_c_t_p_proj_info_read_8c

Demonstrates a basic call to the MtkGCTPProjInfoRead function. The function returns a status indicating success or failure.

```C
status = MtkGCTPProjInfoRead()
```

--------------------------------

### deflateInit2 Strategy and Return Values

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f5__1_88_821_2include_2zlib_8h_source

Explains the 'strategy' parameter for deflateInit2 and its impact on compression, along with the possible return codes for the function. This function initializes the stream but does not perform compression.

```APIDOC
deflateInit2:
  Parameters:
    strategy: Used to tune the compression algorithm.
      Values:
        Z_DEFAULT_STRATEGY: For normal data.
        Z_FILTERED: For data produced by a filter (or predictor); forces more Huffman coding and less string matching.
        Z_HUFFMAN_ONLY: Forces Huffman encoding only (no string match).
        Z_RLE: Limits match distances to one (run-length encoding); designed for PNG image data.
        Z_FIXED: Prevents the use of dynamic Huffman codes.
  Returns:
    Z_OK: Success.
    Z_MEM_ERROR: Not enough memory.
    Z_STREAM_ERROR: Invalid parameter (e.g., invalid method).
    Z_VERSION_ERROR: Zlib library version incompatible.
    msg: Set to null if no error message.
  Note: Does not perform compression; compression is done by deflate().
```

--------------------------------

### Configure HDF/HDFEOS Environment Variables

Source: https://nasa.github.io/MISR-Toolkit/html/index

Sets up the necessary environment variables for the HDF and HDF-EOS libraries. This step is crucial for the MISR Toolkit's build process to locate the installed dependencies correctly. Separate commands are provided for csh and bash shells.

```csh
source <your-step5-path>/bin/hdfeos_env.csh
```

```bash
source <your-step5-path>/bin/hdfeos_env.sh
```

--------------------------------

### C: `deflateInit2_` Function for Zlib Compression Initialization

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f5__1_88_821_2include_2zlib_8h_source

Initializes the zlib compression stream with extended parameters. This function is typically used for fine-grained control over the compression process, including method, window bits, memory level, and strategy.

```C
int deflateInit2_((z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size));
```

--------------------------------

### Retrieve HDF-EOS GR Chunk Information Example

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2hproto_8h_source

This pseudo-C example demonstrates how to use `GRgetchunkinfo` to retrieve chunking and compression information for a HDF-EOS GR. It shows how to pass a `HDF_CHUNK_DEF` structure and a flags variable to get details like chunk lengths and compression status.

```C
int32 rcdims[3];
HDF_CHUNK_DEF rchunk_def;
int32 cflags;
// ...
rchunk_def.chunk_lengths = rcdims;
GRgetchunkinfo(riid, &rchunk_def, &cflags);
```

--------------------------------

### Configure MISR Toolkit C Environment Variables

Source: https://nasa.github.io/MISR-Toolkit/html/index

Sets up the environment variables required to use the C library and command-line utilities of the MISR Toolkit. This step ensures that the system can locate the installed C components. Commands are provided for both csh and bash shells.

```csh
source $MTK_INSTALLDIR/bin/Mtk_c_env.csh
```

```bash
. $MTK_INSTALLDIR/bin/Mtk_c_env.sh
```

--------------------------------

### API Reference: H5R_init Function

Source: https://nasa.github.io/MISR-Toolkit/html/_h5_rpkg_8h

Documents the `H5R_init` function, which initializes the HDF5 Reference package. This function must be called before any other HDF5 Reference functions are used to ensure proper setup.

```APIDOC
H5_DLL herr_t H5R_init ( void )
```

--------------------------------

### Get Time Range for Orbit

Source: https://nasa.github.io/MISR-Toolkit/html/functable

Retrieves the start and end time range corresponding to a specified MISR orbit number.

```APIDOC
MtkOrbitToTimeRange()
  Description: Given a orbit number return time.
```

--------------------------------

### H5F_init() API Documentation

Source: https://nasa.github.io/MISR-Toolkit/html/_h5_fpkg_8h

API documentation for the HDF5 H5F_init function, detailing its parameters and return type. This function initializes the HDF5 file interface.

```APIDOC
herr_t H5F_init(void)
```

--------------------------------

### API Documentation: Directory and System Definitions

Source: https://nasa.github.io/MISR-Toolkit/html/dirent_8c_source

Reference for various C definitions, macros, and structures related to directory handling and system constants.

```APIDOC
len:
  Type: HDFFCLIBAPI intf *
  Source: hproto_fortran.h:318
FALSE:
  Type: #define
  Source: odldef.h:53
ENOTDIR:
  Type: #define
  Source: dirent.c:55
_dircontents::_d_next:
  Type: struct _dircontents *
  Source: dirent_win32.h:50
_dircontents:
  Type: struct
  Source: dirent_win32.h:48
ENABLE_HARD_ERRORS:
  Type: #define
  Source: dirent.c:42
closedir:
  Signature: int closedir(DIR *dirp)
  Source: dirent.c:225
dirent:
  Type: struct
  Source: dirent_win32.h:17
OS_CloseFH:
  Type: #define
  Signature: OS_CloseFH(a)
```

--------------------------------

### Get Block Range for Region and Path

Source: https://nasa.github.io/MISR-Toolkit/html/functable

Retrieves the start and end block numbers for a specific region and MISR path.

```APIDOC
MtkRegionPathToBlockRange()
  Description: Get start and end block numbers of a path over a particular region.
```

--------------------------------

### Example: Get MISR File Version

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_file_query_8h

Demonstrates how to use MtkFileVersion to retrieve the version string from a specified MISR HDF file.

```C
status = MtkFileVersion("MISR_AM1_GRP_TERRAIN_GM_P161_O012115_DF_F03_0021.hdf", fileversion);
```

--------------------------------

### Get Orbit List by Time Range

Source: https://nasa.github.io/MISR-Toolkit/html/functable

Retrieves a list of MISR orbits that fall within a specified start and end time range.

```APIDOC
MtkTimeRangeToOrbitList()
  Description: Given start time and end time return list of orbits.
```

--------------------------------

### C Example: Basic Call to MtkGCTPCreateLatLon

Source: https://nasa.github.io/MISR-Toolkit/html/_misr_map_query_8h

A concise C code snippet demonstrating a basic invocation of the MtkGCTPCreateLatLon function. This example serves as a minimal illustration of how to call the function to generate latitude and longitude arrays from map and projection data.

```C
status = MtkGCTPCreateLatLon()
```

--------------------------------

### tbbtfirst - Get First TBBT Node

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2tbbt_8h

Retrieves the first (leftmost) node in the Threaded Binary B-Tree, starting from the given root. This is useful for initiating an in-order traversal.

```C
HDFLIBAPI TBBT_NODE * tbbtfirst(TBBT_NODE *root)
```

--------------------------------

### tbbtlast - Get Last TBBT Node

Source: https://nasa.github.io/MISR-Toolkit/html/win64_2_h_d_f__4_82_814_2include_2tbbt_8h

Retrieves the last (rightmost) node in the Threaded Binary B-Tree, starting from the given root. This is useful for initiating a reverse in-order traversal.

```C
HDFLIBAPI TBBT_NODE * tbbtlast(TBBT_NODE *root)
```

--------------------------------

### C Example: Get Grid Resolution by Filename

Source: https://nasa.github.io/MISR-Toolkit/html/_mtk_file_grid_to_resolution_8c

Demonstrates how to use the `MtkFileGridToResolution` function to obtain the resolution of a grid named 'BlueBand' from a specific MISR HDF file.

```C
status = MtkFileGridToResolution("MISR_AM1_GRP_TERRAIN_GM_P161_O012115_DF_F03_0021.hdf", "BlueBand", &resolution);
```
Tokens:
Raw