/******************************************************************************
METHOD: cfmask
PURPOSE: the main routine for fmask in C
RETURN VALUE:
Type = int
Value Description
----- -----------
ERROR An error occurred during processing of the cfmask
SUCCESS Processing was successful
PROJECT: Land Satellites Data System Science Research and Development (LSRD)
at the USGS EROS
HISTORY:
Date Programmer Reason
-------- --------------- -------------------------------------
3/15/2013 Song Guo Original Development
5/14/2013 Song Guo Added in Polar Stereographic support
7/17/2013 Song Guo Added in Map info
8/15/2013 Song Guo Modified to use TOA reflectance file
as input instead of metadata file
NOTES: type ./cfmask --help for information to run the code
******************************************************************************/
int main (int argc, char *argv[])
{
char errstr[MAX_STR_LEN]; /* error string */
char lndth_name[MAX_STR_LEN]; /* ledaps Brightness Temperature file */
char fmask_name[MAX_STR_LEN]; /* output fmask binary file name */
char fmask_header[MAX_STR_LEN]; /* output fmask binary file header */
char fmask_hdf_name[MAX_STR_LEN]; /* output fmask HDF file name */
char fmask_hdf_hdr[MAX_STR_LEN]; /* output fmask HDF file header */
char *lndcal_name = NULL; /* input lndcal data filename */
char directory[MAX_STR_LEN]; /* input/output data directory */
char extension[MAX_STR_LEN]; /* input TOA file extension */
int ib; /* band counters */
char sds_names[NBAND_REFL_MAX][MAX_STR_LEN]; /* array of image SDS names */
Input_t *input = NULL; /* input data and meta data */
char scene_name[MAX_STR_LEN]; /* input data scene name */
char *hdf_grid_name = "Grid"; /* name of the grid for HDF-EOS */
unsigned char **cloud_mask; /* cloud pixel mask */
unsigned char **shadow_mask; /* shadow pixel mask */
unsigned char **snow_mask; /* snow pixel mask */
unsigned char **water_mask; /* water pixel mask */
int status; /* return value from function call */
FILE *fd = NULL; /* file pointer */
float ptm; /* percent of clear-sky pixels */
float t_templ = 0.0; /* percentile of low background temperature */
float t_temph = 0.0; /* percentile of high background temperature */
int out_sds_types[NUM_OUT_SDS]; /* array of image SDS types */
char *sds_name="fmask_band"; /* Fmask hdf SDS name */
Output_t *output = NULL; /* output structure and metadata */
bool verbose; /* verbose flag for printing messages */
bool write_binary; /* should we write raw binary output? */
bool no_hdf_output; /* should we don't write HDF4 output file? */
int cldpix = 2; /* Default buffer for cloud pixel dilate */
int sdpix = 2; /* Default buffer for shadow pixel dilate */
float cloud_prob; /* Default cloud probability */
Space_def_t space_def; /* spatial definition information */
float sun_azi_temp = 0.0;/* Keep the original sun azimuth angle */
time_t now;
time(&now);
printf("CFmask start_time=%s\n",ctime(&now));
/* Read the command-line arguments, including the name of the input
Landsat TOA reflectance product and the DEM */
status = get_args (argc, argv, &lndcal_name, &cloud_prob, &cldpix,
&sdpix, &write_binary, &no_hdf_output, &verbose);
if (status != SUCCESS)
{
sprintf (errstr, "calling get_args");
ERROR (errstr, "main");
}
split_filename(lndcal_name, directory, scene_name, extension);
if (verbose)
printf("directory, scene_name, extension=%s,%s,%s\n",
directory, scene_name, extension);
sprintf(lndcal_name, "%slndcal.%s.hdf", directory, scene_name);
sprintf(lndth_name, "%slndth.%s.hdf", directory, scene_name);
sprintf(fmask_name, "%sfmask.%s.img", directory, scene_name);
sprintf(fmask_header, "%sfmask.%s.img.hdr", directory, scene_name);
sprintf(fmask_hdf_name, "%sfmask.%s.hdf", directory, scene_name);
if (verbose)
{
printf("lndcal_name, lndth_name = %s, %s\n", lndcal_name, lndth_name);
printf("fmask_name, fmask_header, fmask_hdf_name = %s, %s, %s\n",
fmask_name, fmask_header, fmask_hdf_name);
}
/* Open input file, read metadata, and set up buffers */
input = OpenInput(lndth_name, lndcal_name);
if (input == NULL)
{
sprintf (errstr, "opening the input files: %s & %s", lndth_name,
lndcal_name);
ERROR (errstr, "main");
}
/* Get the projection and spatial information from the input TOA
reflectance product */
status = get_space_def_hdf(&space_def, lndcal_name, hdf_grid_name);
if (status != SUCCESS)
{
sprintf(errstr, "Reading spatial metadata from the HDF file: %s",
lndcal_name);
ERROR (errstr, "main");
}
input->meta.zone = space_def.zone;
if (verbose)
{
/* Print some info to show how the input metadata works */
printf ("DEBUG: Number of input TOA bands: %d\n", input->nband);
printf ("DEBUG: Number of input thermal bands: %d\n", 1);
printf ("DEBUG: Number of input lines: %d\n", input->size.l);
printf ("DEBUG: Number of input samples: %d\n", input->size.s);
printf ("DEBUG: Number of input TOA lines: %d\n", input->toa_size.l);
printf ("DEBUG: Number of input TOA samples: %d\n", input->toa_size.s);
printf ("DEBUG: Provider is %s\n", input->meta.provider);
printf ("DEBUG: Satellite is %s\n", input->meta.sat);
printf ("DEBUG: Instrument is %s\n", input->meta.inst);
printf ("DEBUG: ACQUISITION_DATE.DOY is %d\n", input->meta.acq_date.doy);
printf ("DEBUG: WRS system is %s\n", input->meta.wrs_sys);
printf ("DEBUG: Path is %d\n", input->meta.path);
printf ("DEBUG: Row is %d\n", input->meta.row);
printf ("DEBUG: Fill value is %d\n", input->meta.fill);
for (ib = 0; ib < input->nband; ib++)
{
printf ("DEBUG: Band %d-->\n", ib);
printf ("DEBUG: SDS name is %s\n", input->sds[ib].name);
printf ("DEBUG: SDS rank: %d\n", input->sds[ib].rank);
printf ("DEBUG: band satu_value_ref: %d\n",
input->meta.satu_value_ref[ib]);
printf ("DEBUG: band satu_value_max: %d\n",
input->meta.satu_value_max[ib]);
printf ("DEBUG: band gains: %f, band biases: %f\n",
input->meta.gain[ib], input->meta.bias[ib]);
}
printf ("DEBUG: Thermal Band -->\n");
printf ("DEBUG: SDS name is %s\n", input->therm_sds.name);
printf ("DEBUG: SDS rank: %d\n", input->therm_sds.rank);
printf ("DEBUG: therm_satu_value_ref: %d\n",
input->meta.therm_satu_value_ref);
printf ("DEBUG: therm_satu_value_max: %d\n",
input->meta.therm_satu_value_max);
printf ("DEBUG: therm_gain: %f, therm_bias: %f\n",
input->meta.gain_th, input->meta.bias_th);
printf("DEBUG: ROW is %d\n", input->meta.row);
printf("DEBUG: PATH is %d\n", input->meta.path);
printf("DEBUG: SUN AZIMUTH is %f\n", input->meta.sun_az);
printf("DEBUG: SUN ZENITH is %f\n", input->meta.sun_zen);
printf("DEBUG: Projection Zone is %d\n", input->meta.zone);
printf("DEBUG: unit_ref is %s\n", input->meta.unit_ref);
printf("DEBUG: valid_range_ref is %f & %f\n",
input->meta.valid_range_ref[0],
input->meta.valid_range_ref[1]);
}
/* If the scene is an ascending polar scene (flipped upside down), then
the solar azimuth needs to be adjusted by 180 degrees. The scene in
this case would be north down and the solar azimuth is based on north
being up clock-wise direction. Flip the south to be up will not change
the actual sun location, with the below relations, the solar azimuth
angle will need add in 180.0 for correct sun location */
if (input->meta.ul_corner.is_fill &&
input->meta.lr_corner.is_fill &&
(input->meta.ul_corner.lat - input->meta.lr_corner.lat) < MINSIGMA)
{
/* Keep the original solar azimuth angle */
sun_azi_temp = input->meta.sun_az;
input->meta.sun_az += 180.0;
if ((input->meta.sun_az - 360.0) > MINSIGMA)
input->meta.sun_az -= 360.0;
if (verbose)
printf (" Polar or ascending scene. Readjusting solar azimuth by "
"180 degrees.\n New value: %f degrees\n", input->meta.sun_az);
}
/* Copy the SDS names and QA SDS names from the input structure for the
output structure, since we are simply duplicating the input */
for (ib = 0; ib < input->nband; ib++)
strcpy (&sds_names[ib][0], input->sds[ib].name);
/* Dynamic allocate the 2d mask memory */
cloud_mask = (unsigned char **)allocate_2d_array(input->size.l,
input->size.s, sizeof(unsigned char));
shadow_mask = (unsigned char **)allocate_2d_array(input->size.l,
input->size.s, sizeof(unsigned char));
snow_mask = (unsigned char **)allocate_2d_array(input->size.l,
input->size.s, sizeof(unsigned char));
water_mask = (unsigned char **)allocate_2d_array(input->size.l,
input->size.s, sizeof(unsigned char));
if (cloud_mask == NULL || shadow_mask == NULL || snow_mask == NULL
|| water_mask == NULL)
{
sprintf (errstr, "Allocating mask memory");
ERROR (errstr, "main");
}
/* Build the potential cloud, shadow, snow, water mask */
status = potential_cloud_shadow_snow_mask(input, cloud_prob, &ptm,
&t_templ, &t_temph, cloud_mask, shadow_mask, snow_mask,
water_mask, verbose);
if (status != SUCCESS)
{
sprintf (errstr, "processing potential_cloud_shadow_snow_mask");
ERROR (errstr, "main");
}
printf("Pcloud done, starting cloud/shadow match\n");
/* Build the final cloud shadow based on geometry matching and
combine the final cloud, shadow, snow, water masks into fmask */
status = object_cloud_shadow_match(input, ptm, t_templ, t_temph,
cldpix, sdpix, cloud_mask, shadow_mask, snow_mask, water_mask,
verbose);
if (status != SUCCESS)
{
sprintf (errstr, "processing object_cloud_and_shadow_match");
ERROR (errstr, "main");
}
status = free_2d_array((void **)shadow_mask);
if (status != SUCCESS)
{
sprintf (errstr, "Freeing mask memory");
ERROR (errstr, "main");
}
status = free_2d_array((void **)snow_mask);
if (status != SUCCESS)
{
sprintf (errstr, "Freeing mask memory");
ERROR (errstr, "main");
}
status = free_2d_array((void **)water_mask);
if (status != SUCCESS)
{
sprintf (errstr, "Freeing mask memory");
ERROR (errstr, "main");
}
/* Reassign solar azimuth angle for output purpose if south up north
down scene is involved */
if (input->meta.ul_corner.is_fill &&
input->meta.lr_corner.is_fill &&
(input->meta.ul_corner.lat - input->meta.lr_corner.lat) < MINSIGMA)
input->meta.sun_az = sun_azi_temp;
if (write_binary)
{
/* Create an ENVI header file for the binary fmask */
status = write_envi_hdr(fmask_header, BINARY_FILE, input, &space_def);
if (status != SUCCESS)
{
sprintf(errstr, "Creating ENVI header for binary fmask");
ERROR (errstr, "main");
}
/* Open the mask file for writing */
fd = fopen(fmask_name, "w");
if (fd == NULL)
{
sprintf(errstr, "Opening report file: %s", fmask_name);
ERROR (errstr, "main");
}
/* Write out the mask file */
status = fwrite(&cloud_mask[0][0], sizeof(unsigned char),
input->size.l * input->size.s, fd);
if (status != input->size.l * input->size.s)
{
sprintf(errstr, "Writing to %s", fmask_name);
ERROR (errstr, "main");
}
/* Close the mask file */
status = fclose(fd);
if (status)
{
sprintf(errstr, "Closing file %s", fmask_name);
ERROR (errstr, "main");
}
}
if (!no_hdf_output)
{
/* Create and open fmask HDF output file */
if (!CreateOutput(fmask_hdf_name))
{
sprintf(errstr, "Creating HDF fmask output file");
ERROR (errstr, "main");
}
output = OpenOutput (fmask_hdf_name, sds_name, &input->size);
if (output == NULL)
{
sprintf (errstr, "opening output file - %s", fmask_hdf_name);
ERROR(errstr, "main");
}
if (!PutOutput(output, cloud_mask))
{
sprintf (errstr, "Writing output fmask in HDF files\n");
ERROR (errstr, "main");
}
if (!PutMetadata(output, input))
{
sprintf (errstr, "Writing output fmask metadata in HDF files\n");
ERROR (errstr, "main");
}
/* Close the output file and free the structure */
if (!CloseOutput (output))
{
sprintf (errstr, "closing output file - %s", fmask_hdf_name);
ERROR(errstr, "main");
}
if (!FreeOutput (output))
{
sprintf (errstr, "freeing output file - %s", fmask_hdf_name);
ERROR(errstr, "main");
}
/* Write the spatial information, after the file has been closed */
out_sds_types[0] = DFNT_UINT8;
status = put_space_def_hdf (&space_def, fmask_hdf_name, NUM_OUT_SDS,
out_sds_names, out_sds_types, hdf_grid_name);
if (status != SUCCESS)
{
sprintf("Putting spatial metadata to the HDF file: "
"%s", lndcal_name);
ERROR (errstr, "main");
}
/* Write CFmask HDF header to add in envi map info */
sprintf (fmask_hdf_hdr, "%s.hdr", fmask_hdf_name);
status = write_envi_hdr (fmask_hdf_hdr, HDF_FILE, input, &space_def);
if (status != SUCCESS)
{
sprintf(errstr, "Error writing the ENVI header for CFmask HDF hdr");
ERROR (errstr, "main");
}
}
/* Free the final output cloud_mask */
status = free_2d_array((void **)cloud_mask);
if (status != SUCCESS)
{
sprintf (errstr, "Freeing mask memory");
ERROR (errstr, "main");
}
/* Close the input file and free the structure */
CloseInput (input);
FreeInput (input);
free(lndcal_name);
printf ("Processing complete.\n");
time(&now);
printf("CFmask end_time=%s\n",ctime(&now));
return (SUCCESS);
}
int main (int argc, const char **argv) {
Param_t *param;
Input_t *input;
Input_t *input_th;
Lut_t *lut;
Output_t *output;
int i,odometer_flag=0;
/* Space info */
Space_def_t space_def;
Space_t *space;
char *grid_name = "Grid";
char *sds_names[NSDS];
int sds_types[NSDS];
printf ("\nRunning lndcsm ...\n");
for (i=1; i<argc; i++)if ( !strcmp(argv[i],"-o") )odometer_flag=1;
param = GetParam(argc, argv);
if (param == (Param_t *)NULL) ERROR("getting runtime parameters", "main");
/* Open input file */
input = OpenInput(param->input_file_name);
if (input == (Input_t *)NULL) ERROR("bad input file", "main");
/* Get space definition from HDF */
if (!GetSpaceDefHDF(&space_def, param->input_file_name, grid_name))
ERROR("getting definition from file", "main");
/* Setup Space */
space = SetupSpace(&space_def);
if (space == (Space_t *)NULL) ERROR("setting up space", "main");
/* Open input thermal file */
if ( param->therm_flag )
{
input_th = OpenInput(param->input_therm_file_name);
if (input_th == (Input_t *)NULL) ERROR("bad thermal input file", "main");
if ( input_th->size.s != input->size.s || input_th->size.l != input->size.l )
ERROR("mismatch size on inputs (reflective vs thermal)", "main");
}
/* Get Lookup table */
lut = GetLut(param->lut_file_name, input->nband, &input->meta);
if (lut == (Lut_t *)NULL) ERROR("bad lut file", "main");
/* Create and open output file */
if (!CreateOutput(param->output_file_name))
ERROR("creating output file", "main");
output = OpenOutput( param->output_file_name, &input->size );
if (output == (Output_t *)NULL) ERROR("opening output file", "main");
/******************************************************************/
/* call snow mask */
/******************************************************************/
if ( !CloudMask(
input
, input_th
, output
, lut
, param
, odometer_flag
) )
ERROR("In Cloud/Snow Mask Computation","main");
if (!PutMetadata(output, &input->meta,lut, param) )
ERROR("writing the metadata", "main");
if (!CloseInput(input)) ERROR("closing input file", "main");
if (!CloseOutput(output)) ERROR("closing output file", "main");
sds_names[0] = output->sds_csm[0].name;
sds_types[0] = output->sds_csm[0].type;
if (!PutSpaceDefHDF(&space_def, param->output_file_name, 1,
sds_names, sds_types, grid_name))
ERROR("putting space metadata in HDF file", "main");
if (!FreeInput(input))
ERROR("freeing input file stucture", "main");
if (!FreeLut(lut))
ERROR("freeing lut file stucture", "main");
if (!FreeOutput(output))
ERROR("freeing output file stucture", "main");
/* All done */
printf ("lndcsm complete.\n");
return (EXIT_SUCCESS);
}
/******************************************************************************
METHOD: l8cfmask
PURPOSE: the main routine for fmask in C
RETURN VALUE:
Type = int
Value Description
----- -----------
ERROR An error occurred during processing of the l8cfmask
SUCCESS Processing was successful
PROJECT: Land Satellites Data System Science Research and Development (LSRD)
at the USGS EROS
HISTORY:
Date Programmer Reason
-------- --------------- -------------------------------------
3/15/2013 Song Guo Original Development
5/14/2013 Song Guo Added in Polar Stereographic support
7/17/2013 Song Guo Added in Map info
8/15/2013 Song Guo Modified to use TOA reflectance file
as input instead of metadata file
Oct/2014 Ron Dilley Modified to utilize the ESPA internal raw binary
file format
NOTES: type ./l8cfmask --help for information to run the code
******************************************************************************/
int
main (int argc, char *argv[])
{
char errstr[MAX_STR_LEN]; /* error string */
char *cptr = NULL; /* pointer to the file extension */
char *xml_name = NULL; /* input XML filename */
char directory[MAX_STR_LEN]; /* input/output data directory */
char extension[MAX_STR_LEN]; /* input TOA file extension */
int ib; /* band counters */
Input_t *input = NULL; /* input data and meta data */
char envi_file[MAX_STR_LEN]; /* output ENVI file name */
char scene_name[MAX_STR_LEN]; /* input data scene name */
unsigned char **pixel_mask; /* pixel mask */
unsigned char **conf_mask; /* confidence mask */
int status; /* return value from function call */
float clear_ptm; /* percent of clear-sky pixels */
float t_templ = 0.0; /* percentile of low background temperature */
float t_temph = 0.0; /* percentile of high background temperature */
Output_t *output = NULL; /* output structure and metadata */
bool verbose; /* verbose flag for printing messages */
bool use_l8_cirrus; /* should we use L8 cirrus cloud bit results? */
int cldpix = 2; /* Default buffer for cloud pixel dilate */
int sdpix = 2; /* Default buffer for shadow pixel dilate */
float cloud_prob; /* Default cloud probability */
float sun_azi_temp = 0.0; /* Keep the original sun azimuth angle */
int max_cloud_pixels; /* Maximum cloud pixel number in cloud division */
Espa_internal_meta_t xml_metadata; /* XML metadata structure */
Envi_header_t envi_hdr; /* output ENVI header information */
time_t now;
time (&now);
printf ("CFmask start_time=%s\n", ctime (&now));
/* Read the command-line arguments, including the name of the input
Landsat TOA reflectance product and the DEM */
status = get_args (argc, argv, &xml_name, &cloud_prob, &cldpix,
&sdpix, &max_cloud_pixels, &use_l8_cirrus, &verbose);
if (status != SUCCESS)
{
sprintf (errstr, "calling get_args");
CFMASK_ERROR (errstr, "main");
}
/* Validate the input metadata file */
if (validate_xml_file (xml_name) != SUCCESS)
{ /* Error messages already written */
CFMASK_ERROR (errstr, "main");
}
/* Initialize the metadata structure */
init_metadata_struct (&xml_metadata);
/* Parse the metadata file into our internal metadata structure; also
allocates space as needed for various pointers in the global and band
metadata */
if (parse_metadata (xml_name, &xml_metadata) != SUCCESS)
{ /* Error messages already written */
CFMASK_ERROR (errstr, "main");
}
/* Verify supported satellites */
if (strcmp (xml_metadata.global.satellite, "LANDSAT_8") != 0)
{
sprintf (errstr, "Unsupported satellite sensor");
CFMASK_ERROR (errstr, "main");
}
/* Split the filename to obtain the directory, scene name, and extension */
split_filename (xml_name, directory, scene_name, extension);
if (verbose)
printf ("directory, scene_name, extension=%s,%s,%s\n",
directory, scene_name, extension);
/* Open input file, read metadata, and set up buffers */
input = OpenInput (&xml_metadata);
if (input == NULL)
{
sprintf (errstr, "opening the TOA and brightness temp files in: %s",
xml_name);
CFMASK_ERROR (errstr, "main");
}
if (verbose)
{
/* Print some info to show how the input metadata works */
printf ("DEBUG: Number of input TOA bands: %d\n", input->nband);
printf ("DEBUG: Number of input thermal bands: %d\n", 1);
printf ("DEBUG: Number of input TOA lines: %d\n", input->size.l);
printf ("DEBUG: Number of input TOA samples: %d\n", input->size.s);
printf ("DEBUG: ACQUISITION_DATE.DOY is %d\n",
input->meta.acq_date.doy);
printf ("DEBUG: Fill value is %d\n", input->meta.fill);
for (ib = 0; ib < input->nband; ib++)
{
printf ("DEBUG: Band %d-->\n", ib);
printf ("DEBUG: band satu_value_ref: %d\n",
input->meta.satu_value_ref[ib]);
printf ("DEBUG: band satu_value_max: %d\n",
input->meta.satu_value_max[ib]);
printf ("DEBUG: band gains: %f, band biases: %f\n",
input->meta.gain[ib], input->meta.bias[ib]);
}
printf ("DEBUG: Thermal Band (Band 10) -->\n");
printf ("DEBUG: therm_satu_value_ref: %d\n",
input->meta.therm_satu_value_ref);
printf ("DEBUG: therm_satu_value_max: %d\n",
input->meta.therm_satu_value_max);
printf ("DEBUG: therm_gain: %f, therm_bias: %f\n",
input->meta.gain_th, input->meta.bias_th);
printf ("DEBUG: SUN AZIMUTH is %f\n", input->meta.sun_az);
printf ("DEBUG: SUN ZENITH is %f\n", input->meta.sun_zen);
}
/* If the scene is an ascending polar scene (flipped upside down), then
the solar azimuth needs to be adjusted by 180 degrees. The scene in
this case would be north down and the solar azimuth is based on north
being up clock-wise direction. Flip the south to be up will not change
the actual sun location, with the below relations, the solar azimuth
angle will need add in 180.0 for correct sun location */
if (input->meta.ul_corner.is_fill &&
input->meta.lr_corner.is_fill &&
(input->meta.ul_corner.lat - input->meta.lr_corner.lat) < MINSIGMA)
{
/* Keep the original solar azimuth angle */
sun_azi_temp = input->meta.sun_az;
input->meta.sun_az += 180.0;
if ((input->meta.sun_az - 360.0) > MINSIGMA)
input->meta.sun_az -= 360.0;
if (verbose)
printf (" Polar or ascending scene."
" Readjusting solar azimuth by 180 degrees.\n"
" New value: %f degrees\n", input->meta.sun_az);
}
/* Dynamic allocate the 2d mask memory */
pixel_mask = (unsigned char **) allocate_2d_array (input->size.l,
input->size.s,
sizeof (unsigned char));
if (pixel_mask == NULL)
{
sprintf (errstr, "Allocating pixel mask memory");
CFMASK_ERROR (errstr, "main");
}
conf_mask = (unsigned char **) allocate_2d_array (input->size.l,
input->size.s,
sizeof (unsigned char));
if (conf_mask == NULL)
{
sprintf (errstr, "Allocating confidence mask memory");
CFMASK_ERROR (errstr, "main");
}
/* Initialize the mask to clear data */
int row, col;
for (row = 0; row < input->size.l; row++)
for (col = 0; col < input->size.s; col++)
{
pixel_mask[row][col] = MASK_CLEAR_LAND;
conf_mask[row][col] = CLOUD_CONFIDENCE_NONE;
}
/* Build the potential cloud, shadow, snow, water mask */
status = potential_cloud_shadow_snow_mask (input, cloud_prob, &clear_ptm,
&t_templ, &t_temph, pixel_mask,
conf_mask, use_l8_cirrus,
verbose);
if (status != SUCCESS)
{
sprintf (errstr, "processing potential_cloud_shadow_snow_mask");
CFMASK_ERROR (errstr, "main");
}
printf ("Pcloud done, starting cloud/shadow match\n");
/* Build the final cloud shadow based on geometry matching and
combine the final cloud, shadow, snow, water masks into fmask
the pixel_mask is a bit mask as input and a value mask as output */
status = object_cloud_shadow_match (input, clear_ptm, t_templ, t_temph,
cldpix, sdpix, max_cloud_pixels,
pixel_mask, verbose);
if (status != SUCCESS)
{
sprintf (errstr, "processing object_cloud_and_shadow_match");
CFMASK_ERROR (errstr, "main");
}
/* Reassign solar azimuth angle for output purpose if south up north
down scene is involved */
if (input->meta.ul_corner.is_fill &&
input->meta.lr_corner.is_fill &&
(input->meta.ul_corner.lat - input->meta.lr_corner.lat) < MINSIGMA)
input->meta.sun_az = sun_azi_temp;
/* Open the output file */
output = OpenOutput (&xml_metadata, input);
if (output == NULL)
{ /* error message already printed */
sprintf (errstr, "Opening output file");
CFMASK_ERROR (errstr, "main");
}
if (!PutOutput (output, pixel_mask))
{
sprintf (errstr, "Writing output fmask files\n");
CFMASK_ERROR (errstr, "main");
}
/* Close the output file */
if (!CloseOutput (output))
{
sprintf (errstr, "closing output file");
CFMASK_ERROR (errstr, "main");
}
/* Create the ENVI header file this band */
if (create_envi_struct (&output->metadata.band[0], &xml_metadata.global,
&envi_hdr) != SUCCESS)
{
sprintf (errstr, "Creating ENVI header structure.");
CFMASK_ERROR (errstr, "main");
}
/* Write the ENVI header */
strcpy (envi_file, output->metadata.band[0].file_name);
cptr = strchr (envi_file, '.');
if (cptr == NULL)
{
sprintf (errstr, "error in ENVI header filename");
CFMASK_ERROR (errstr, "main");
}
strcpy (cptr, ".hdr");
if (write_envi_hdr (envi_file, &envi_hdr) != SUCCESS)
{
sprintf (errstr, "Writing ENVI header file.");
CFMASK_ERROR (errstr, "main");
}
/* Append the cfmask band to the XML file */
if (append_metadata (output->nband, output->metadata.band, xml_name)
!= SUCCESS)
{
sprintf (errstr, "Appending spectral index bands to XML file.");
CFMASK_ERROR (errstr, "main");
}
/* Free the structure */
if (!FreeOutput (output))
{
sprintf (errstr, "freeing output file structure");
CFMASK_ERROR (errstr, "main");
}
output = OpenOutputConfidence (&xml_metadata, input);
if (output == NULL)
{ /* error message already printed */
sprintf (errstr, "Opening output file");
CFMASK_ERROR (errstr, "main");
}
if (!PutOutput (output, conf_mask))
{
sprintf (errstr, "Writing output fmask files\n");
CFMASK_ERROR (errstr, "main");
}
/* Close the output file */
if (!CloseOutput (output))
{
sprintf (errstr, "closing output file");
CFMASK_ERROR (errstr, "main");
}
/* Create the ENVI header file this band */
if (create_envi_struct (&output->metadata.band[0], &xml_metadata.global,
&envi_hdr) != SUCCESS)
{
sprintf (errstr, "Creating ENVI header structure.");
CFMASK_ERROR (errstr, "main");
}
/* Write the ENVI header */
strcpy (envi_file, output->metadata.band[0].file_name);
cptr = strchr (envi_file, '.');
if (cptr == NULL)
{
sprintf (errstr, "error in ENVI header filename");
CFMASK_ERROR (errstr, "main");
}
strcpy (cptr, ".hdr");
if (write_envi_hdr (envi_file, &envi_hdr) != SUCCESS)
{
sprintf (errstr, "Writing ENVI header file.");
CFMASK_ERROR (errstr, "main");
}
/* Append the cfmask band to the XML file */
if (append_metadata (output->nband, output->metadata.band, xml_name)
!= SUCCESS)
{
sprintf (errstr, "Appending spectral index bands to XML file.");
CFMASK_ERROR (errstr, "main");
}
/* Free the structure */
if (!FreeOutput (output))
{
sprintf (errstr, "freeing output file structure");
CFMASK_ERROR (errstr, "main");
}
/* Free the metadata structure */
free_metadata (&xml_metadata);
/* Free the pixel mask */
status = free_2d_array ((void **) pixel_mask);
if (status != SUCCESS)
{
sprintf (errstr, "Freeing pixel mask memory");
CFMASK_ERROR (errstr, "main");
}
status = free_2d_array ((void **) conf_mask);
if (status != SUCCESS)
{
sprintf (errstr, "Freeing confidence mask memory");
CFMASK_ERROR (errstr, "main");
}
/* Close the input file and free the structure */
CloseInput (input);
FreeInput (input);
free (xml_name);
printf ("Processing complete.\n");
time (&now);
printf ("CFmask end_time=%s\n", ctime (&now));
return SUCCESS;
}
int main (int argc, const char **argv) {
Param_t *param = NULL;
Input_t *input = NULL;
Lut_t *lut = NULL;
Output_t *output = NULL;
Output_t *output_th = NULL;
int iline, isamp,oline, ib, jb, iz, val;
unsigned char *line_in = NULL;
unsigned char *line_in_thz = NULL;
unsigned char *line_out_qa = NULL;
int16 *line_out = NULL;
int16 *line_out_th = NULL;
int16 *line_out_thz = NULL;
Cal_stats_t cal_stats;
Cal_stats6_t cal_stats6;
int nps,nls, nps6, nls6;
int zoomx, zoomy;
int i,odometer_flag=0;
char msgbuf[1024];
char envi_file[STR_SIZE]; /* name of the output ENVI header file */
char *cptr=NULL; /* pointer to the file extension */
size_t input_psize;
int qa_band = QA_BAND_NUM;
int nband_refl = NBAND_REFL_MAX;
int ifill, num_zero;
int maxth=0;
int mss_flag=0;
Espa_internal_meta_t xml_metadata; /* XML metadata structure */
Envi_header_t envi_hdr; /* output ENVI header information */
printf ("\nRunning lndcal ...\n");
for (i=1; i<argc; i++)if ( !strcmp(argv[i],"-o") )odometer_flag=1;
/* Read the parameters from the input parameter file */
param = GetParam(argc, argv);
if (param == (Param_t *)NULL) EXIT_ERROR("getting runtime parameters",
"main");
/* Validate the input metadata file */
if (validate_xml_file (param->input_xml_file_name) != SUCCESS)
{ /* Error messages already written */
EXIT_ERROR("Failure validating XML file", "main");
}
/* Initialize the metadata structure */
init_metadata_struct (&xml_metadata);
/* Parse the metadata file into our internal metadata structure; also
allocates space as needed for various pointers in the global and band
metadata */
if (parse_metadata (param->input_xml_file_name, &xml_metadata) != SUCCESS)
{ /* Error messages already written */
EXIT_ERROR("parsing XML file", "main");
}
/* Check to see if the gain and bias values were specified */
if (!existRadGB (&xml_metadata))
EXIT_ERROR("Gains and biases don't exist in XML file (TOA radiance gain "
"and bias fields) for each band. Make sure to utilize the latest LPGS "
"MTL file for conversion to the ESPA internal raw binary format as the "
"gains and biases should be in that file.", "main");
/* Open input file */
input = OpenInput (&xml_metadata);
if (input == (Input_t *)NULL)
EXIT_ERROR("setting up input from XML structure", "main");
/* Get Lookup table */
lut = GetLut(param, input->nband, input);
if (lut == (Lut_t *)NULL) EXIT_ERROR("bad lut file", "main");
nps6= input->size_th.s;
nls6= input->size_th.l;
nps = input->size.s;
nls = input->size.l;
zoomx= nint( (float)nps / (float)nps6 );
zoomy= nint( (float)nls / (float)nls6 );
for (ib = 0; ib < input->nband; ib++)
cal_stats.first[ib] = true;
cal_stats6.first = true;
if (input->meta.inst == INST_MSS)mss_flag=1;
/* Open the output files. Raw binary band files will be be opened. */
output = OpenOutput(&xml_metadata, input, param, lut, false /*not thermal*/,
mss_flag);
if (output == NULL) EXIT_ERROR("opening output file", "main");
/* Allocate memory for the input buffer, enough for all reflectance bands */
input_psize = sizeof(unsigned char);
line_in = calloc (input->size.s * nband_refl, input_psize);
if (line_in == NULL)
EXIT_ERROR("allocating input line buffer", "main");
/* Create and open output thermal band, if one exists */
if ( input->nband_th > 0 ) {
output_th = OpenOutput (&xml_metadata, input, param, lut, true /*thermal*/,
mss_flag);
if (output_th == NULL)
EXIT_ERROR("opening output therm file", "main");
/* Allocate memory for the thermal input and output buffer, only holds
one band */
line_out_th = calloc(input->size_th.s, sizeof(int16));
if (line_out_th == NULL)
EXIT_ERROR("allocating thermal output line buffer", "main");
if (zoomx == 1) {
line_out_thz = line_out_th;
line_in_thz = line_in;
}
else {
line_out_thz = calloc (input->size.s, sizeof(int16));
if (line_out_thz == NULL)
EXIT_ERROR("allocating thermal zoom output line buffer", "main");
line_in_thz = calloc (input->size.s, input_psize);
if (line_in_thz == NULL)
EXIT_ERROR("allocating thermal zoom input line buffer", "main");
}
} else {
printf("*** no output thermal file ***\n");
}
/* Allocate memory for output lines for both the image and QA data */
line_out = calloc (input->size.s, sizeof (int16));
if (line_out == NULL)
EXIT_ERROR("allocating output line buffer", "main");
line_out_qa = calloc (input->size.s, sizeof(unsigned char));
if (line_out_qa == NULL)
EXIT_ERROR("allocating qa output line buffer", "main");
memset (line_out_qa, 0, input->size.s * sizeof(unsigned char));
/* Do for each THERMAL line */
oline= 0;
if (input->nband_th > 0) {
ifill= (int)lut->in_fill;
for (iline = 0; iline < input->size_th.l; iline++) {
ib=0;
if (!GetInputLineTh(input, iline, line_in))
EXIT_ERROR("reading input data for a line", "main");
if ( odometer_flag && ( iline==0 || iline ==(nls-1) || iline%100==0 ) ){
if ( zoomy == 1 )
printf("--- main loop BAND6 Line %d --- \r",iline);
else
printf("--- main loop BAND6 Line in=%d out=%d --- \r",iline,oline);
fflush(stdout);
}
memset(line_out_qa, 0, input->size.s*sizeof(unsigned char));
if (!Cal6(lut, input, line_in, line_out_th, line_out_qa, &cal_stats6,
iline))
EXIT_ERROR("doing calibration for a line", "main");
if ( zoomx>1 ) {
zoomIt(line_out_thz, line_out_th, nps/zoomx, zoomx );
zoomIt8(line_in_thz, line_in, nps/zoomx, zoomx );
}
for ( iz=0; iz<zoomy; iz++ ) {
for (isamp = 0; isamp < input->size.s; isamp++) {
val= getValue(line_in_thz, isamp);
if ( val> maxth) maxth=val;
if ( val==ifill) line_out_qa[isamp] = lut->qa_fill;
else if ( val>=SATU_VAL6 ) line_out_qa[isamp] = ( 0x000001 << 6 );
}
if ( oline<nls ) {
if (!PutOutputLine(output_th, ib, oline, line_out_thz)) {
sprintf(msgbuf,"write thermal error ib=%d oline=%d iline=%d",ib,
oline,iline);
EXIT_ERROR(msgbuf, "main");
}
if (input->meta.inst != INST_MSS)
if (!PutOutputLine(output_th, ib+1, oline, line_out_qa)) {
sprintf(msgbuf,"write thermal QA error ib=%d oline=%d iline=%d",
ib+1,oline,iline);
EXIT_ERROR(msgbuf, "main");
}
}
oline++;
}
} /* end loop for each thermal line */
}
if (odometer_flag) printf("\n");
if (input->nband_th > 0)
if (!CloseOutput(output_th))
EXIT_ERROR("closing output thermal file", "main");
/* Do for each REFLECTIVE line */
ifill= (int)lut->in_fill;
for (iline = 0; iline < input->size.l; iline++){
/* Do for each band */
if ( odometer_flag && ( iline==0 || iline ==(nls-1) || iline%100==0 ) )
{printf("--- main reflective loop Line %d ---\r",iline); fflush(stdout);}
memset(line_out_qa, 0, input->size.s*sizeof(unsigned char));
for (ib = 0; ib < input->nband; ib++) {
if (!GetInputLine(input, ib, iline, &line_in[ib*nps]))
EXIT_ERROR("reading input data for a line", "main");
}
for (isamp = 0; isamp < input->size.s; isamp++){
num_zero=0;
for (ib = 0; ib < input->nband; ib++) {
jb= (ib != 5 ) ? ib+1 : ib+2;
val= getValue((unsigned char *)&line_in[ib*nps], isamp);
if ( val==ifill )num_zero++;
if ( val==SATU_VAL[ib] ) line_out_qa[isamp]|= ( 0x000001 <<jb );
}
/* Feng fixed bug by changing "|=" to "=" below (4/17/09) */
if ( num_zero > 0 )line_out_qa[isamp] = lut->qa_fill;
}
for (ib = 0; ib < input->nband; ib++) {
if (!Cal(lut, ib, input, &line_in[ib*nps], line_out, line_out_qa,
&cal_stats,iline))
EXIT_ERROR("doing calibraton for a line", "main");
if (!PutOutputLine(output, ib, iline, line_out))
EXIT_ERROR("reading input data for a line", "main");
} /* End loop for each band */
if (input->meta.inst != INST_MSS)
if (!PutOutputLine(output, qa_band, iline, line_out_qa))
EXIT_ERROR("writing qa data for a line", "main");
} /* End loop for each line */
if ( odometer_flag )printf("\n");
for (ib = 0; ib < input->nband; ib++) {
printf(
" band %d rad min %8.5g max %8.4f | ref min %8.5f max %8.4f\n",
input->meta.iband[ib], cal_stats.rad_min[ib], cal_stats.rad_max[ib],
cal_stats.ref_min[ib], cal_stats.ref_max[ib]);
}
if ( input->nband_th > 0 )
printf(
" band %d rad min %8.5g max %8.4f | tmp min %8.5f max %8.4f\n", 6,
cal_stats6.rad_min, cal_stats6.rad_max,
cal_stats6.temp_min, cal_stats6.temp_max);
/* Close input and output files */
if (!CloseInput(input)) EXIT_ERROR("closing input file", "main");
if (!CloseOutput(output)) EXIT_ERROR("closing input file", "main");
/* Write the ENVI header for reflectance files */
for (ib = 0; ib < output->nband; ib++) {
/* Create the ENVI header file this band */
if (create_envi_struct (&output->metadata.band[ib], &xml_metadata.global,
&envi_hdr) != SUCCESS)
EXIT_ERROR("Creating the ENVI header structure for this file.", "main");
/* Write the ENVI header */
strcpy (envi_file, output->metadata.band[ib].file_name);
cptr = strchr (envi_file, '.');
strcpy (cptr, ".hdr");
if (write_envi_hdr (envi_file, &envi_hdr) != SUCCESS)
EXIT_ERROR("Writing the ENVI header file.", "main");
}
/* Write the ENVI header for thermal files */
for (ib = 0; ib < output_th->nband; ib++) {
/* Create the ENVI header file this band */
if (create_envi_struct (&output_th->metadata.band[ib], &xml_metadata.global,
&envi_hdr) != SUCCESS)
EXIT_ERROR("Creating the ENVI header structure for this file.", "main");
/* Write the ENVI header */
strcpy (envi_file, output_th->metadata.band[ib].file_name);
cptr = strchr (envi_file, '.');
strcpy (cptr, ".hdr");
if (write_envi_hdr (envi_file, &envi_hdr) != SUCCESS)
EXIT_ERROR("Writing the ENVI header file.", "main");
}
/* Append the reflective and thermal bands to the XML file */
if (append_metadata (output->nband, output->metadata.band,
param->input_xml_file_name) != SUCCESS)
EXIT_ERROR("appending reflectance and QA bands", "main");
if (input->nband_th > 0) {
if (append_metadata (output_th->nband, output_th->metadata.band,
param->input_xml_file_name) != SUCCESS)
EXIT_ERROR("appending thermal and QA bands", "main");
}
/* Free the metadata structure */
free_metadata (&xml_metadata);
/* Free memory */
if (!FreeParam(param))
EXIT_ERROR("freeing parameter stucture", "main");
if (!FreeInput(input))
EXIT_ERROR("freeing input file stucture", "main");
if (!FreeLut(lut))
EXIT_ERROR("freeing lut file stucture", "main");
if (!FreeOutput(output))
EXIT_ERROR("freeing output file stucture", "main");
free(line_out);
line_out = NULL;
free(line_in);
line_in = NULL;
free(line_out_qa);
line_out_qa = NULL;
free(line_out_th);
line_out_th = NULL;
if (zoomx != 1) {
free(line_in_thz);
free(line_out_thz);
}
line_in_thz = NULL;
line_out_thz = NULL;
/* All done */
printf ("lndcal complete.\n");
return (EXIT_SUCCESS);
}
/*****************************************************************************
METHOD: cfmask
PURPOSE: The main routine for fmask written in C
RETURN VALUE: Type = int
Value Description
----- -----------
ERROR An error occurred during processing of cfmask
SUCCESS Processing was successful
*****************************************************************************/
int
main (int argc, char *argv[])
{
char *FUNC_NAME = "main";
char *ext = NULL; /* pointer to the file extension */
char *xml_name = NULL; /* input XML filename */
char envi_file[MAX_STR_LEN]; /* output ENVI file name */
char temp_file[MAX_STR_LEN]; /* temp file name */
int status;
int band_index;
bool verbose; /* verbose flag for printing messages */
bool use_cirrus; /* should we use Cirrus during determination? */
bool use_thermal; /* should we use Thermal during determination? */
Input_t *input = NULL; /* input data and meta data */
Output_t *output = NULL; /* output structure and metadata */
Espa_internal_meta_t xml_metadata; /* XML metadata structure */
Envi_header_t envi_hdr; /* output ENVI header information */
unsigned char *pixel_mask = NULL; /* pixel mask */
unsigned char *conf_mask = NULL; /* confidence mask */
float clear_ptm; /* percent of clear-sky pixels */
float t_templ = 0.0; /* percentile of low background temperature */
float t_temph = 0.0; /* percentile of high background temperature */
int cldpix = 2; /* Default buffer for cloud pixel dilate */
int sdpix = 2; /* Default buffer for shadow pixel dilate */
float cloud_prob; /* Default cloud probability */
float sun_azi_temp = 0.0; /* Keep the original sun azimuth angle */
int pixel_count;
int pixel_index;
time_t now;
time(&now);
/* Read the command-line arguments, including the name of the input
Landsat TOA reflectance product and the DEM */
status = get_args(argc, argv, &xml_name, &cloud_prob, &cldpix,
&sdpix, &use_cirrus, &use_thermal, &verbose);
if (status != SUCCESS)
{
RETURN_ERROR("calling get_args", FUNC_NAME, EXIT_FAILURE);
}
printf("CFmask start_time=%s\n", ctime(&now));
/* Validate the input metadata file */
if (validate_xml_file(xml_name) != SUCCESS)
{
RETURN_ERROR("XML validation error", FUNC_NAME, EXIT_FAILURE);
}
/* Initialize the metadata structure */
init_metadata_struct(&xml_metadata);
/* Parse the metadata file into our internal metadata structure; also
allocates space as needed for various pointers in the global and band
metadata */
if (parse_metadata(xml_name, &xml_metadata) != SUCCESS)
{
RETURN_ERROR("XML parsing error", FUNC_NAME, EXIT_FAILURE);
}
/* Open input file, read metadata, and set up buffers */
input = OpenInput(&xml_metadata, use_thermal);
if (input == NULL)
{
RETURN_ERROR("opening input data specified in input XML",
FUNC_NAME, EXIT_FAILURE);
}
if (verbose)
{
/* Print some info to show how the input metadata works */
printf("Number of input TOA bands: %d\n", input->num_toa_bands);
printf("Number of input thermal bands: %d\n", 1);
printf("Number of input TOA lines: %d\n", input->size.l);
printf("Number of input TOA samples: %d\n", input->size.s);
printf("Fill value is %d\n", input->meta.fill);
for (band_index = 0; band_index < MAX_BAND_COUNT; band_index++)
{
printf("Band %d-->\n", band_index);
if (input->satellite != IS_LANDSAT_8)
{
/* Landsat 8 doesn't have saturation issues */
printf(" band satu_value_ref: %d\n",
input->meta.satu_value_ref[band_index]);
printf(" band satu_value_max: %d\n",
input->meta.satu_value_max[band_index]);
}
printf(" band gain: %f, band bias: %f\n",
input->meta.gain[band_index], input->meta.bias[band_index]);
}
printf("SUN AZIMUTH is %f\n", input->meta.sun_az);
printf("SUN ZENITH is %f\n", input->meta.sun_zen);
}
/* If the scene is an ascending polar scene (flipped upside down), then
the solar azimuth needs to be adjusted by 180 degrees. The scene in
this case would be north down and the solar azimuth is based on north
being up clock-wise direction. Flip the south to be up will not change
the actual sun location, with the below relations, the solar azimuth
angle will need add in 180.0 for correct sun location */
if (input->meta.ul_corner.lat < input->meta.lr_corner.lat)
{
/* Keep the original solar azimuth angle */
sun_azi_temp = input->meta.sun_az;
input->meta.sun_az += 180.0;
if (input->meta.sun_az > 360.0)
{
input->meta.sun_az -= 360.0;
}
if (verbose)
{
printf("Polar or ascending scene."
" Readjusting solar azimuth by 180 degrees.\n"
" New value: %f degrees\n", input->meta.sun_az);
}
}
pixel_count = input->size.l * input->size.s;
/* Dynamic allocate the 2d mask memory */
pixel_mask = calloc(pixel_count, sizeof(unsigned char));
if (pixel_mask == NULL)
{
RETURN_ERROR("Allocating pixel mask memory", FUNC_NAME, EXIT_FAILURE);
}
conf_mask = calloc(pixel_count, sizeof(unsigned char));
if (conf_mask == NULL)
{
RETURN_ERROR("Allocating confidence mask memory",
FUNC_NAME, EXIT_FAILURE);
}
/* Initialize the mask to clear data */
for (pixel_index = 0; pixel_index < pixel_count; pixel_index++)
{
pixel_mask[pixel_index] = CF_NO_BITS;
conf_mask[pixel_index] = CLOUD_CONFIDENCE_NONE;
}
/* Build the potential cloud, shadow, snow, water mask */
status = potential_cloud_shadow_snow_mask(input, cloud_prob, &clear_ptm,
&t_templ, &t_temph, pixel_mask,
conf_mask, use_cirrus,
use_thermal, verbose);
if (status != SUCCESS)
{
RETURN_ERROR("processing potential_cloud_shadow_snow_mask",
FUNC_NAME, EXIT_FAILURE);
}
printf("Potential Cloud Shadow: Done\n");
/* Build the final cloud shadow based on geometry matching and
combine the final cloud, shadow, snow, water masks into fmask
the pixel_mask is a bit mask as input and a value mask as output */
int data_count = 0;
status = object_cloud_shadow_match(input, clear_ptm, t_templ, t_temph,
cldpix, sdpix, pixel_mask, &data_count,
use_thermal, verbose);
if (status != SUCCESS)
{
RETURN_ERROR("processing object_cloud_and_shadow_match",
FUNC_NAME, EXIT_FAILURE);
}
printf("Object Cloud Shadow Matching: Done\n");
/* Convert the pixel_mask to a value mask
Also retrieve and report statistics */
float clear_percent = 0; /* Percent of clear pixels in the image data */
float cloud_percent = 0; /* Percent of cloud pixels in the image data */
float cloud_shadow_percent = 0; /* Percent of cloud shadow pixels in the
image data */
float water_percent = 0; /* Percent of water pixels in the image data */
float snow_percent = 0; /* Percent of snow pixels in the image data */
convert_and_generate_statistics(verbose, pixel_mask,
input->size.l * input->size.s,
data_count, &clear_percent,
&cloud_percent, &cloud_shadow_percent,
&water_percent, &snow_percent);
printf("Statistics Generation: Done\n");
/* Reassign solar azimuth angle for output purpose if south up north
down scene is involved */
if (input->meta.ul_corner.lat < input->meta.lr_corner.lat)
{
input->meta.sun_az = sun_azi_temp;
}
/* Open the output file */
output = OpenOutputCFmask(&xml_metadata, input, clear_percent,
cloud_percent, cloud_shadow_percent,
water_percent, snow_percent);
if (output == NULL)
{
RETURN_ERROR("Opening output file", FUNC_NAME, EXIT_FAILURE);
}
if (!PutOutput(output, pixel_mask))
{
RETURN_ERROR("Writing output fmask files", FUNC_NAME, EXIT_FAILURE);
}
/* Close the output file */
if (!CloseOutput(output))
{
RETURN_ERROR("closing output file", FUNC_NAME, EXIT_FAILURE);
}
/* Create the ENVI header file this band */
if (create_envi_struct(&output->metadata.band[0], &xml_metadata.global,
&envi_hdr) != SUCCESS)
{
RETURN_ERROR("Creating ENVI header structure.", FUNC_NAME,
EXIT_FAILURE);
}
/* Write the ENVI header */
snprintf(temp_file, sizeof(temp_file), "%s",
output->metadata.band[0].file_name);
ext = strrchr(temp_file, '.');
if (ext == NULL)
{
RETURN_ERROR("error in ENVI header filename", FUNC_NAME, EXIT_FAILURE);
}
ext[0] = '\0';
snprintf(envi_file, sizeof(envi_file), "%s.hdr", temp_file);
if (write_envi_hdr(envi_file, &envi_hdr) != SUCCESS)
{
RETURN_ERROR("Writing ENVI header file.", FUNC_NAME, EXIT_FAILURE);
}
/* Append the cfmask band to the XML file */
if (append_metadata(output->nband, output->metadata.band, xml_name)
!= SUCCESS)
{
RETURN_ERROR("Appending spectral index bands to XML file.",
FUNC_NAME, EXIT_FAILURE);
}
/* Free the structure */
if (!FreeOutput(output))
{
RETURN_ERROR("freeing output file structure", FUNC_NAME, EXIT_FAILURE);
}
output = OpenOutputConfidence(&xml_metadata, input);
if (output == NULL)
{
RETURN_ERROR("Opening output file", FUNC_NAME, EXIT_FAILURE);
}
if (!PutOutput(output, conf_mask))
{
RETURN_ERROR("Writing output fmask files", FUNC_NAME, EXIT_FAILURE);
}
/* Close the output file */
if (!CloseOutput(output))
{
RETURN_ERROR("closing output file", FUNC_NAME, EXIT_FAILURE);
}
/* Create the ENVI header file this band */
if (create_envi_struct(&output->metadata.band[0], &xml_metadata.global,
&envi_hdr) != SUCCESS)
{
RETURN_ERROR("Creating ENVI header structure.", FUNC_NAME,
EXIT_FAILURE);
}
/* Write the ENVI header */
snprintf(temp_file, sizeof(temp_file), "%s",
output->metadata.band[0].file_name);
ext = strrchr(temp_file, '.');
if (ext == NULL)
{
RETURN_ERROR("error in ENVI header filename", FUNC_NAME, EXIT_FAILURE);
}
ext[0] = '\0';
snprintf(envi_file, sizeof(envi_file), "%s.hdr", temp_file);
if (write_envi_hdr(envi_file, &envi_hdr) != SUCCESS)
{
RETURN_ERROR("Writing ENVI header file.", FUNC_NAME, EXIT_FAILURE);
}
/* Append the cfmask band to the XML file */
if (append_metadata(output->nband, output->metadata.band,
xml_name) != SUCCESS)
{
RETURN_ERROR("Appending spectral index bands to XML file.",
FUNC_NAME, EXIT_FAILURE);
}
/* Free the structure */
if (!FreeOutput(output))
{
RETURN_ERROR("freeing output file structure", FUNC_NAME, EXIT_FAILURE);
}
/* Free the metadata structure */
free_metadata(&xml_metadata);
/* Free the pixel mask */
free(pixel_mask);
pixel_mask = NULL;
free(conf_mask);
conf_mask = NULL;
/* Close the input file and free the structure */
CloseInput(input);
FreeInput(input);
free(xml_name);
xml_name = NULL;
printf("Processing complete.\n");
time(&now);
printf("CFmask end_time=%s\n", ctime(&now));
return SUCCESS;
}
int main (int argc, const char **argv)
/*
!C******************************************************************************
!Description: 'main' is the main function for the 'resamp' program.
!Input Parameters:
argc number of run-time (command line) arguments
argv list of run-time argument values
!Output Parameters:
(returns) status:
'EXIT_SUCCESS' = okay
'EXIT_FAILURE' = fatal error
!Team Unique Header:
! Design Notes:
1. See 'USAGE' in 'parser.h' for information on how to use the program.
2. An error status is returned when:
a. there is a problem getting runtime parameters
b. there is a bad input image, geolocation or kernel file
c. unable to set up the input grid, scan data structure,
or the output space
d. unable to generate kernel
f. unable to free memory for data structures
g. unable to set up intermediate patches data structure
h. there is an error reading geolocation for a scan
i. there is an error mapping a scan
j. there is an error generating geolocation for a scan
k. there is an error copying a scan
l. there is an error extending the scan
m. there is an error reading input data for a scan
n. there is an error resampling a scan
o. there is an error writting patches to disk
p. there is an error closing input image, geolocation, kernel or
output files
q. there is an error untouching patches
r. there is an error creating output image file
s. there is an error opening output file
t. there is an error unscrambling the output file
u. there is an error writing metadata.
3. Errors are handled with the 'LOG_ERROR' macro.
!END****************************************************************************
*/
{
int i,j,k;
int curr_sds, curr_band; /* current SDS and current band in SDS */
char tmp_sds_name[MAX_STR_LEN];
char errstr[M_MSG_LEN+1]; /* error string for OpenInput */
char sdsname[256]; /* SDS name without '/'s */
char msg[M_MSG_LEN+1];
Param_t *param = NULL;
Param_t *param_save = NULL;
Geoloc_t *geoloc = NULL;
Kernel_t *kernel = NULL;
Input_t *input = NULL;
Scan_t *scan = NULL;
Space_t *output_space = NULL;
Patches_t *patches = NULL;
int iscan, kscan;
int il, nl;
Output_t *output = NULL;
Img_coord_double_t img;
Geo_coord_t geo;
FILE_ID *MasterGeoMem; /* Output GeoTiff file */
FILE *rbfile = NULL; /* Output Raw Binary file */
char HDF_File[1024], CharThisPid[256], FinalFileName[1024];
Output_t output_mem; /* Contains output HDF file */
int32 exec_resamp, ThisPid;
char filename[1024]; /* name of raw binary file to be written to */
time_t startdate, enddate; /* start and end date struct */
bool file_created; /* was the current HDF file created? */
/* Initialize the log file */
InitLogHandler();
/* Print the MRTSwath header */
LogInfomsg(
"*******************************************************************"
"***********\n");
sprintf(msg, "%s (%s)\n", RESAMPLER_NAME, RESAMPLER_VERSION);
LogInfomsg(msg);
startdate = time(NULL);
sprintf(msg, "Start Time: %s", ctime(&startdate));
LogInfomsg(msg);
LogInfomsg(
"------------------------------------------------------------------\n");
/* Get runtime parameters */
if (NeedHelp(argc, argv))
exit(EXIT_SUCCESS);
param_save = GetParam(argc, argv);
if (param_save == (Param_t *)NULL)
LOG_ERROR("getting runtime parameters", "main");
/* Print out the user-specified processing information */
PrintParam(param_save);
/* Loop through all the SDSs */
for (curr_sds = 0; curr_sds < param_save->num_input_sds; curr_sds++)
{
/* Loop through all the bands in the current SDS */
for (curr_band = 0; curr_band < param_save->input_sds_nbands[curr_sds];
curr_band++)
{
/* Is this band one that should be processed? */
if (!param_save->input_sds_bands[curr_sds][curr_band])
continue;
/* Assume the HDF file does not need to be created */
file_created = false;
/* Get a copy of the user parameters */
param = CopyParam(param_save);
if (param == (Param_t *)NULL)
LOG_ERROR("copying runtime parameters", "main");
/* Create the input_sds_name which is "SDSname, band" */
if (param->input_sds_nbands[curr_sds] == 1)
{
/* 2D product so the band number is not needed */
sprintf(tmp_sds_name, "%s", param->input_sds_name_list[curr_sds]);
}
else
{
/* 3D product so the band number is required */
sprintf(tmp_sds_name, "%s, %d", param->input_sds_name_list[curr_sds],
curr_band);
}
param->input_sds_name = strdup (tmp_sds_name);
if (param->input_sds_name == NULL)
LOG_ERROR("error creating input SDS band name", "main");
sprintf(msg, "\nProcessing %s ...\n", param->input_sds_name);
LogInfomsg(msg);
/* Update the system to process the current SDS and band */
if (!update_sds_info(curr_sds, param))
LOG_ERROR("error updating SDS information", "main");
/* Open input file for the specified SDS and band */
input = OpenInput(param->input_file_name, param->input_sds_name,
param->iband, param->rank[curr_sds], param->dim[curr_sds], errstr);
if (input == (Input_t *)NULL) {
/* This is an invalid SDS for our processing so skip to the next
SDS. We will only process SDSs that are at the 1km, 500m, or
250m resolution (i.e. a factor of 1, 2, or 4 compared to the
1km geolocation lat/long data). We also only process CHAR8,
INT8, UINT8, INT16, and UINT16 data types. */
LOG_WARNING(errstr, "main");
LOG_WARNING("not processing SDS/band", "main");
break;
}
/* Setup kernel */
kernel = GenKernel(param->kernel_type);
if (kernel == (Kernel_t *)NULL)
LOG_ERROR("generating kernel", "main");
/* Open geoloc file */
geoloc = OpenGeolocSwath(param->geoloc_file_name);
if (geoloc == (Geoloc_t *)NULL)
LOG_ERROR("bad geolocation file", "main");
/* Setup input scan */
scan = SetupScan(geoloc, input, kernel);
if (scan == (Scan_t *)NULL)
LOG_ERROR("setting up scan data structure", "main");
/* Set up the output space, using the current pixel size and
number of lines and samples based on the current SDS (pixel size
and number of lines and samples are the same for all the bands
in the SDS) */
param->output_space_def.img_size.l = param->output_img_size[curr_sds].l;
param->output_space_def.img_size.s = param->output_img_size[curr_sds].s;
param->output_space_def.pixel_size = param->output_pixel_size[curr_sds];
sprintf(msg, " output lines/samples: %d %d\n",
param->output_space_def.img_size.l, param->output_space_def.img_size.s);
LogInfomsg(msg);
if (param->output_space_def.proj_num == PROJ_GEO)
{
sprintf(msg, " output pixel size: %.4f\n",
param->output_space_def.pixel_size * DEG);
LogInfomsg(msg);
}
else
{
sprintf(msg, " output pixel size: %.4f\n",
param->output_space_def.pixel_size);
LogInfomsg(msg);
}
LogInfomsg(" output data type: ");
switch (param->output_data_type)
{
case DFNT_CHAR8:
LogInfomsg("CHAR8\n");
break;
case DFNT_UINT8:
LogInfomsg("UINT8\n");
break;
case DFNT_INT8:
LogInfomsg("INT8\n");
break;
case DFNT_UINT16:
LogInfomsg("UINT16\n");
break;
case DFNT_INT16:
LogInfomsg("INT16\n");
break;
case DFNT_UINT32:
LogInfomsg("UINT32\n");
break;
case DFNT_INT32:
LogInfomsg("INT32\n");
break;
default:
LogInfomsg("same as input\n");
break;
}
output_space = SetupSpace(¶m->output_space_def);
if (output_space == (Space_t *)NULL)
LOG_ERROR("setting up output space", "main");
/* Compute and print out the corners */
img.is_fill = false;
img.l = img.s = 0.0;
if (!FromSpace(output_space, &img, &geo))
{
LOG_WARNING("unable to compute upper left corner", "main");
}
else
{
sprintf(msg,
" output upper left corner: lat %13.8f long %13.8f\n",
(DEG * geo.lat), (DEG * geo.lon));
LogInfomsg(msg);
}
img.is_fill = false;
img.l = output_space->def.img_size.l - 1;
img.s = output_space->def.img_size.s - 1;
if (!FromSpace(output_space, &img, &geo))
{
LOG_WARNING("unable to compute lower right corner", "main");
}
else
{
sprintf(msg,
" output lower right corner: lat %13.8f long %13.8f\n",
(DEG * geo.lat), (DEG * geo.lon));
LogInfomsg(msg);
}
/* If output data type not specified, then set to input data type
(changes from SDS to SDS) */
if (param->output_data_type == -1)
param->output_data_type = input->sds.type;
/* Save the data type of this SDS for output to the metadata */
param_save->output_dt_arr[curr_sds] = param->output_data_type;
/* Setup intermediate patches. Setup as the input data type. Then we
will convert to the output data type later. */
patches = SetupPatches(¶m->output_space_def.img_size,
param->patches_file_name, input->sds.type, input->fill_value, input->factor, input->offset);
if (patches == (Patches_t *)NULL)
LOG_ERROR("setting up intermediate patches data structure","main");
if (param->input_space_type != SWATH_SPACE)
LOG_ERROR("input space type is not SWATH", "main");
sprintf(msg, " input lines/samples: %d %d\n", input->size.l,
input->size.s);
LogInfomsg(msg);
sprintf(msg, " input scale factor: %g\n", input->factor);
LogInfomsg(msg);
sprintf(msg, " input offset: %lg\n", input->offset);
LogInfomsg(msg);
switch (input->ires)
{
case 1:
LogInfomsg(" input resolution: 1 km\n");
break;
case 2:
LogInfomsg(" input resolution: 500 m\n");
break;
case 4:
LogInfomsg(" input resolution: 250 m\n");
break;
}
LogInfomsg(" %% complete: 0%");
/* For each input scan */
kscan = 0;
for (iscan = 0; iscan < geoloc->nscan; iscan++)
{
/* Update status? */
if (100 * iscan / geoloc->nscan > kscan)
{
kscan = 100 * iscan / geoloc->nscan;
if (kscan % 10 == 0)
{
sprintf(msg, " %d%%", kscan);
LogInfomsg(msg);
}
}
/* Read the geolocation data for the scan and map to output space */
if (!GetGeolocSwath(geoloc, output_space, iscan))
LOG_ERROR("reading geolocation for a scan", "main");
/* Map scan to input resolution */
if (!MapScanSwath(scan, geoloc))
LOG_ERROR("mapping a scan (swath)", "main");
/* Extend the scan */
if (!ExtendScan(scan)) LOG_ERROR("extending the scan", "main");
/* Read input scan data into extended scan */
il = iscan * input->scan_size.l;
nl = input->scan_size.l;
if (il + nl > input->size.l)
nl = input->size.l - il;
if (!GetScanInput(scan, input, il, nl))
LOG_ERROR("reading input data for a scan", "main");
/* Resample all of the points in the extended scan */
if (!ProcessScan(scan, kernel, patches, nl, param->kernel_type))
LOG_ERROR("resampling a scan", "main");
/* Toss patches that were not touched */
if (!TossPatches(patches, param->output_data_type))
LOG_ERROR("writting patches to disk", "main");
} /* End loop for each input scan */
/* Finish the status message */
LogInfomsg(" 100%\n");
/* Save the background fill value from the patches data structure for
output to the metadata */
param_save->fill_value[curr_sds] = patches->fill_value;
/* If output is raw binary, then we need the patches information
so write the header before deleting the patches info */
if (param->output_file_format == RB_FMT)
{ /* Output is raw binary */
/* Create the raw binary header file */
if (!WriteHeaderFile (param, patches))
LOG_ERROR("writing raw binary header file", "main");
}
/* Done with scan and kernel strutures */
if (!FreeScan(scan))
LOG_ERROR("freeing scan structure", "main");
if (!FreeKernel(kernel))
LOG_ERROR("freeing kernel structure", "main");
/* Close geolocation file */
if (!CloseGeoloc(geoloc))
LOG_ERROR("closing geolocation file", "main");
/* Close input file */
if (!CloseInput(input)) LOG_ERROR("closing input file", "main");
/* Free the output space structure */
if (!FreeSpace(output_space))
LOG_ERROR("freeing output space structure", "main");
/* Write remaining patches in memory to disk */
if (!UntouchPatches(patches))
LOG_ERROR("untouching patches", "main");
if (!TossPatches(patches, param->output_data_type))
LOG_ERROR("writting remaining patches to disk", "main");
if (!FreePatchesInMem(patches))
LOG_ERROR("freeing patches data structure in memory", "main");
/* Output format can be HDF, GeoTiff, raw binary, or both HDF and
GeoTiff */
if (param->output_file_format == HDF_FMT ||
param->output_file_format == BOTH)
{ /* Output is HDF */
/* Create output file. If the output has multiple resolutions, then
the resolution value will be used as an extension to the basename.
Otherwise no resolution extension will be used. */
if (param->multires)
{
if (param->output_space_def.proj_num != PROJ_GEO)
/* Output the pixel size with only two decimal places, since
the pixel size will be in meters */
sprintf(HDF_File, "%s_%dm.hdf", param->output_file_name,
(int) param->output_pixel_size[curr_sds]);
else
/* Output the pixel size with four decimal places, since the
pixel size will be in degrees (need to convert from radians) */
sprintf(HDF_File, "%s_%.04fd.hdf", param->output_file_name,
param->output_pixel_size[curr_sds] * DEG);
}
else
{
sprintf(HDF_File, "%s.hdf", param->output_file_name);
}
/* Does the HDF file need to be created? */
if (param->create_output[curr_sds])
{
/* Create the output HDF file */
if (!CreateOutput(HDF_File))
LOG_ERROR("creating output image file", "main");
file_created = true;
/* Loop through the rest of the SDSs and unmark the ones of the same
resolution, since they will be output to this same HDF file
and therefore do not need to be recreated. */
for (k = curr_sds; k < param_save->num_input_sds; k++)
{
if (param->output_pixel_size[k] ==
param->output_pixel_size[curr_sds])
param_save->create_output[k] = false;
}
}
/* Open output file */
output = OutputFile(HDF_File, param->output_sds_name,
param->output_data_type, ¶m->output_space_def);
if (output == (Output_t *)NULL)
LOG_ERROR("opening output HDF file", "main");
}
if (param->output_file_format == GEOTIFF_FMT ||
param->output_file_format == BOTH)
{ /* Output is geotiff */
/* Attach the SDS name to the output file name */
if (param->output_file_format == GEOTIFF_FMT)
{
output = &output_mem;
output->size.l = param->output_space_def.img_size.l;
output->size.s = param->output_space_def.img_size.s;
output->open = true;
}
/* Open and initialize the GeoTiff File */
MasterGeoMem = Open_GEOTIFF(param);
if( ! MasterGeoMem ) {
LOG_ERROR("allocating GeoTiff file id structure", "main");
} else if( MasterGeoMem->error ) {
LOG_ERROR(MasterGeoMem->error_msg, "main");
}
/* Remove due to clash of tiff and hdf header files.
* if (!OpenGeoTIFFFile (param, &MasterGeoMem))
* LOG_ERROR("opening and initializing GeoTiff file", "main");
*/
}
if (param->output_file_format == RB_FMT)
{ /* Output is raw binary */
output = &output_mem;
output->size.l = param->output_space_def.img_size.l;
output->size.s = param->output_space_def.img_size.s;
output->open = true;
/* Get the size of the data type */
switch (param->output_data_type)
{
case DFNT_INT8:
case DFNT_UINT8:
/* one byte in size */
output->output_dt_size = 1;
break;
case DFNT_INT16:
case DFNT_UINT16:
/* two bytes in size */
output->output_dt_size = 2;
break;
case DFNT_INT32:
case DFNT_UINT32:
case DFNT_FLOAT32:
/* four bytes in size */
output->output_dt_size = 4;
break;
}
/* Copy the SDS name and remove any '/'s in the SDSname */
j = 0;
for (i = 0; i < (int)strlen(param->output_sds_name); i++)
{
if (param->output_sds_name[i] != '/' &&
param->output_sds_name[i] != '\\')
{
sdsname[j++] = param->output_sds_name[i];
}
sdsname[j] = '\0';
}
/* Remove any spaces (from the SDS name) from the name */
k = 0;
while (sdsname[k])
{
if (isspace(sdsname[k]))
sdsname[k] = '_';
k++;
}
/* Add the SDS band name and dat extension to the filename */
sprintf(filename, "%s_%s.dat", param->output_file_name,
sdsname);
rbfile = fopen(filename, "wb");
if (rbfile == NULL)
LOG_ERROR("opening output raw binary file", "main");
}
/* Read patches (in input data type) and write to output file (in
output data type). If NN kernel, then fill any holes left from the
resampling process. */
if (!UnscramblePatches(patches, output, param->output_file_format,
MasterGeoMem, rbfile, param->output_data_type, param->kernel_type))
LOG_ERROR("unscrambling the output file", "main");
/* Done with the patches */
if (!FreePatches(patches))
LOG_ERROR("freeing patches", "main");
/* Close output HDF file */
if (param->output_file_format == HDF_FMT ||
param->output_file_format == BOTH)
{
if (!CloseOutput(output))
LOG_ERROR("closing output file", "main");
/* If not appending, write metadata to output HDF file */
if (file_created)
{
if (!WriteMeta(output->file_name, ¶m->output_space_def))
LOG_ERROR("writing metadata", "main");
}
}
/* Close output GeoTiff file */
if (param->output_file_format == GEOTIFF_FMT ||
param->output_file_format == BOTH)
{
Close_GEOTIFF( MasterGeoMem );
/* CloseGeoTIFFFile(&MasterGeoMem); */
output->open = false;
}
/* Close output raw binary file */
if (param->output_file_format == RB_FMT)
{
fclose(rbfile);
output->open = false;
}
/* Free remaining memory */
if (!FreeGeoloc(geoloc))
LOG_ERROR("freeing geoloc file stucture", "main");
if (!FreeInput(input))
LOG_ERROR("freeing input file stucture", "main");
if (param->output_file_format == HDF_FMT ||
param->output_file_format == BOTH) {
if (!FreeOutput(output))
LOG_ERROR("freeing output file stucture", "main");
}
/* Get rid of patches file */
ThisPid = getpid();
sprintf(CharThisPid,"%d",(int)ThisPid);
strcpy(FinalFileName,param->patches_file_name);
strcat(FinalFileName,CharThisPid);
exec_resamp = remove(FinalFileName);
if(exec_resamp == -1)
{
LOG_ERROR("Something bad happened deleting patches file", "main");
}
/* Free the parameter structure */
if (!FreeParam(param))
LOG_ERROR("freeing user parameter structure", "main");
} /* loop through bands in the current SDS */
} /* loop through SDSs */
/* If output format is HDF then append the metadata, for all resolutions */
if (param_save->output_file_format == HDF_FMT ||
param_save->output_file_format == BOTH)
{
/* Initialize the create_output structure again for all the SDSs. This
will be used to determine if the metadata needs to be appended. */
for (curr_sds = 0; curr_sds < param_save->num_input_sds; curr_sds++)
param_save->create_output[curr_sds] = true;
/* Loop through all the SDSs */
for (curr_sds = 0; curr_sds < param_save->num_input_sds; curr_sds++)
{
/* Do we need to append the metadata or has it already been done for
the current SDSs HDF file? */
if (!param_save->create_output[curr_sds])
continue;
/* Determine the name of the output HDF file */
if (param_save->multires)
{
if (param_save->output_space_def.proj_num != PROJ_GEO)
/* Output the pixel size with only two decimal places, since
the pixel size will be in meters */
sprintf(HDF_File, "%s_%dm.hdf", param_save->output_file_name,
(int) param_save->output_pixel_size[curr_sds]);
else
/* Output the pixel size with four decimal places, since the
pixel size will be in degrees (need to convert from radians) */
sprintf(HDF_File, "%s_%.04fd.hdf", param_save->output_file_name,
param_save->output_pixel_size[curr_sds] * DEG);
}
else
{
sprintf(HDF_File, "%s.hdf", param_save->output_file_name);
}
/* Append the metadata for this HDF file, only for the SDSs of the
current resolution */
if (!AppendMetadata(param_save, HDF_File, param_save->input_file_name,
curr_sds))
{
/* NOTE: We won't flag this as an error, since in some cases the
resolution file may not exist. For example, if a MOD02HKM is
specified and the Latitude or Longitude data is specified, then
that data is at a different resolution (1000m) than the rest of
the image SDS data (500m). The software will think that there
should be a 1000m product, however the Latitude and Longitude
data didn't actually get processed .... since it is float data.
So, AppendMetadata will flag an error since that HDF file will
not really exist. */
/* LOG_ERROR("appending metadata to the output HDF file","main"); */
}
/* Loop through the rest of the SDSs and unmark the ones of the same
resolution, since they will be output to this same HDF file
and therefore do not need to be recreated. */
for (k = curr_sds; k < param_save->num_input_sds; k++)
{
if (param_save->output_pixel_size[k] ==
param_save->output_pixel_size[curr_sds])
param_save->create_output[k] = false;
}
}
}
/* Free the saved parameter structure */
if (!FreeParam(param_save))
LOG_ERROR("freeing saved user parameter structure", "main");
/* Stop timer and print elapsed time */
enddate = time(NULL);
sprintf(msg, "\nEnd Time: %s", ctime(&enddate));
LogInfomsg(msg);
LogInfomsg("Finished processing!\n");
LogInfomsg(
"*********************************************************************"
"*********\n");
/* Close the log file */
CloseLogHandler();
/* All done */
exit (EXIT_SUCCESS);
}
/******************************************************************************
!Description: 'OutputFile' sets up the 'output' data structure, opens the
output file for write access, and creates the output Science Data Set (SDS).
!Input Parameters:ds_output
file_name output file name
nband number of image bands (SDSs) to be created
nband_qa number of QA bands (SDSs) to be created
sds_names array of SDS names for each image band
qa_sds_names array of SDS names for each QA band
size SDS size
!Output Parameters:
(returns) 'output' data structure or NULL when an error occurs
!Team Unique Header:
!Design Notes:
*****************************************************************************/
Output_t *OpenOutput(char *file_name, int nband, int nband_qa,
char sds_names[NBAND_REFL_MAX_OUT][MAX_STR_LEN],
char qa_sds_names[NUM_QA_BAND][MAX_STR_LEN], Img_coord_int_t *size)
{
Output_t *ds_output = NULL;
char *error_string = NULL;
Myhdf_dim_t *dim[MYHDF_MAX_RANK];
Myhdf_sds_t *sds = NULL;
int ir, ib;
//float *buf = NULL;
int16 *buf = NULL;
uint8 *qa_buf = NULL;
/* Check parameters */
if (size->l < 1)
RETURN_ERROR("invalid number of output lines", "OpenOutput", NULL);
if (size->s < 1)
RETURN_ERROR("invalid number of samples per output line", "OpenOutput",
NULL);
if (nband < 1 || nband > NBAND_REFL_MAX_OUT)
RETURN_ERROR("invalid number of bands", "OpenOutput", NULL);
/* Create the Output data structure */
ds_output = (Output_t *)malloc(sizeof(Output_t));
if (ds_output == NULL)
RETURN_ERROR("allocating Output data structure", "OpenOutput", NULL);
/* Populate the data structure */
ds_output->file_name = DupString(file_name);
if (ds_output->file_name == (char *)NULL) {
free(ds_output);
RETURN_ERROR("duplicating file name", "OpenOutput", NULL);
}
ds_output->open = false;
ds_output->nband = nband;
ds_output->nqa_band = nband_qa;
ds_output->size.l = size->l;
ds_output->size.s = size->s;
for (ib = 0; ib < ds_output->nband; ib++) {
ds_output->sds[ib].name = NULL;
ds_output->sds[ib].dim[0].name = NULL;
ds_output->sds[ib].dim[1].name = NULL;
ds_output->buf[ib] = NULL;
}
for (ib = 0; ib < ds_output->nqa_band; ib++) {
ds_output->qa_sds[ib].name = NULL;
ds_output->qa_sds[ib].dim[0].name = NULL;
ds_output->qa_sds[ib].dim[1].name = NULL;
ds_output->qa_buf[ib] = NULL;
}
/* Open file for SD access */
ds_output->sds_file_id = SDstart((char *)file_name, DFACC_RDWR);
if (ds_output->sds_file_id == HDF_ERROR) {
free(ds_output->file_name);
free(ds_output);
RETURN_ERROR("opening output file for SD access", "OpenOutput", NULL);
}
ds_output->open = true;
/* Set up the image SDSs */
for (ib = 0; ib < ds_output->nband; ib++) {
sds = &ds_output->sds[ib];
sds->rank = 2;
sds->type = DFNT_INT16;
sds->name = DupString(sds_names[ib]);
if (sds->name == NULL) {
error_string = "duplicating sds name";
RETURN_ERROR(error_string, "CreateOutput", false);
}
dim[0] = &sds->dim[0];
dim[1] = &sds->dim[1];
dim[0]->nval = ds_output->size.l;
dim[1]->nval = ds_output->size.s;
dim[0]->type = dim[1]->type = sds->type;
dim[0]->name = DupString("YDim_Grid");
if (dim[0]->name == NULL) {
error_string = "duplicating dim name (l)";
RETURN_ERROR(error_string, "CreateOutput", false);
}
dim[1]->name = DupString("XDim_Grid");
if (dim[1]->name == NULL) {
error_string = "duplicating dim name (s)";
RETURN_ERROR(error_string, "CreateOutput", false);
}
if (!PutSDSInfo(ds_output->sds_file_id, sds)) {
error_string = "setting up the SDS";
RETURN_ERROR(error_string, "CreateOutput", false);
}
for (ir = 0; ir < sds->rank; ir++) {
if (!PutSDSDimInfo(sds->id, dim[ir], ir)) {
error_string = "setting up the dimension";
RETURN_ERROR(error_string, "CreateOutput", false);
}
}
} /* end for image bands */
/* Set up the QA SDSs */
for (ib = 0; ib < ds_output->nqa_band; ib++) {
sds = &ds_output->qa_sds[ib];
sds->rank = 2;
sds->type = DFNT_UINT8;
sds->name = DupString(qa_sds_names[ib]);
if (sds->name == NULL) {
error_string = "duplicating sds name";
RETURN_ERROR(error_string, "CreateOutput", false);
}
dim[0] = &sds->dim[0];
dim[1] = &sds->dim[1];
dim[0]->nval = ds_output->size.l;
dim[1]->nval = ds_output->size.s;
dim[0]->type = dim[1]->type = sds->type;
dim[0]->name = DupString("YDim_Grid");
if (dim[0]->name == NULL) {
error_string = "duplicating dim name (l)";
RETURN_ERROR(error_string, "CreateOutput", false);
}
dim[1]->name = DupString("XDim_Grid");
if (dim[1]->name == NULL) {
error_string = "duplicating dim name (s)";
RETURN_ERROR(error_string, "CreateOutput", false);
}
if (!PutSDSInfo(ds_output->sds_file_id, sds)) {
error_string = "setting up the SDS";
RETURN_ERROR(error_string, "CreateOutput", false);
}
for (ir = 0; ir < sds->rank; ir++) {
if (!PutSDSDimInfo(sds->id, dim[ir], ir)) {
error_string = "setting up the dimension";
RETURN_ERROR(error_string, "CreateOutput", false);
}
}
} /* end for QA bands */
/* Allocate output buffers */
// buf = (float *)calloc((size_t)(ds_output->size.s * ds_output->nband), sizeof(float));
buf = (int16 *)calloc((size_t)(ds_output->size.s * ds_output->nband), sizeof(int16));
if (buf == NULL)
error_string = "allocating output buffer";
else {
ds_output->buf[0] = buf;
for (ib = 1; ib < ds_output->nband; ib++)
ds_output->buf[ib] = ds_output->buf[ib - 1] + ds_output->size.s;
}
qa_buf = (uint8 *)calloc((size_t)(ds_output->size.s * ds_output->nqa_band),
sizeof(uint8));
if (qa_buf == NULL)
error_string = "allocating output QA buffer";
else {
ds_output->qa_buf[0] = qa_buf;
for (ib = 1; ib < ds_output->nqa_band; ib++)
ds_output->qa_buf[ib] = ds_output->qa_buf[ib - 1] + ds_output->size.s;
}
if (error_string != NULL) {
FreeOutput (ds_output);
CloseOutput (ds_output);
RETURN_ERROR(error_string, "OpenOutput", (Output_t *)NULL);
}
return ds_output;
}
/******************************************************************************
METHOD: lst
PURPOSE: The main routine for scene based LST (Land Surface Temperature).
RETURN VALUE:
Type = int
Value Description
----- -----------
ERROR An error occurred during processing of the scene_based_lst
SUCCESS Processing was successful
PROJECT: Land Satellites Data System Science Research and Development (LSRD)
at the USGS EROS
******************************************************************************/
int
main (int argc, char *argv[])
{
char FUNC_NAME[] = "main";
Espa_internal_meta_t xml_metadata; /* XML metadata structure */
char msg_str[MAX_STR_LEN];
char xml_filename[PATH_MAX]; /* input XML filename */
char dem_filename[PATH_MAX]; /* input DEM filename */
char emissivity_filename[PATH_MAX]; /* input Emissivity filename */
char command[PATH_MAX];
Input_t *input = NULL; /* input data and meta data */
// Output_t *output = NULL; /* output structure and metadata */
bool use_tape6; /* Use the tape6 output */
bool verbose; /* verbose flag for printing messages */
bool debug; /* debug flag for debug output */
int modtran_run;
double alb = 0.1;
double **modtran_results = NULL;
char *tmp_env = NULL;
REANALYSIS_POINTS points;
time_t now;
/* Display the starting time of the application */
time (&now);
snprintf (msg_str, sizeof(msg_str),
"LST start_time [%s]", ctime (&now));
LOG_MESSAGE (msg_str, FUNC_NAME);
/* Read the command-line arguments, including the name of the input
Landsat TOA reflectance product and the DEM */
if (get_args (argc, argv, xml_filename, dem_filename, emissivity_filename,
&use_tape6, &verbose, &debug) != SUCCESS)
{
RETURN_ERROR ("calling get_args", FUNC_NAME, EXIT_FAILURE);
}
/* Verify the existence of required environment variables */
/* Grab the environment path to the LST_DATA_DIR */
tmp_env = getenv ("LST_DATA_DIR");
if (tmp_env == NULL)
{
RETURN_ERROR ("LST_DATA_DIR environment variable is not set",
FUNC_NAME, EXIT_FAILURE);
}
/* Validate the input metadata file */
if (validate_xml_file (xml_filename) != SUCCESS)
{
/* Error messages already written */
return EXIT_FAILURE;
}
/* Initialize the metadata structure */
init_metadata_struct (&xml_metadata);
/* Parse the metadata file into our internal metadata structure; also
allocates space as needed for various pointers in the global and band
metadata */
if (parse_metadata (xml_filename, &xml_metadata) != SUCCESS)
{
/* Error messages already written */
return EXIT_FAILURE;
}
/* Open input file, read metadata, and set up buffers */
input = OpenInput (&xml_metadata);
if (input == NULL)
{
RETURN_ERROR ("opening input files", FUNC_NAME, EXIT_FAILURE);
}
if (verbose)
{
/* Print some info to show how the input metadata works */
printf ("Satellite: %d\n", input->meta.satellite);
printf ("Instrument: %d\n", input->meta.instrument);
printf ("Number of input lines: %d\n", input->thermal.size.l);
printf ("Number of input samples: %d\n", input->thermal.size.s);
printf ("Fill value is %d\n", input->thermal.fill_value);
printf ("Thermal Band -->\n");
printf (" therm_gain: %f\n therm_bias: %f\n",
input->thermal.rad_gain, input->thermal.rad_bias);
printf ("Year, Month, Day, Hour, Minute, Second:"
" %d, %d, %d, %d, %d, %f\n",
input->meta.acq_date.year, input->meta.acq_date.month,
input->meta.acq_date.day, input->meta.acq_date.hour,
input->meta.acq_date.minute, input->meta.acq_date.second);
printf ("ACQUISITION_DATE.DOY is %d\n",
input->meta.acq_date.doy);
printf ("UL_MAP_CORNER: %f, %f\n", input->meta.ul_map_corner.x,
input->meta.ul_map_corner.y);
printf ("LR_MAP_CORNER: %f, %f\n", input->meta.lr_map_corner.x,
input->meta.lr_map_corner.y);
printf ("UL_GEO_CORNER: %f, %f\n",
input->meta.ul_geo_corner.lat, input->meta.ul_geo_corner.lon);
printf ("LR_GEO_CORNER: %f, %f\n",
input->meta.lr_geo_corner.lat, input->meta.lr_geo_corner.lon);
}
/* Build the points that will be used */
if (build_points (input, &points) != SUCCESS)
{
RETURN_ERROR ("Building POINTS input\n", FUNC_NAME, EXIT_FAILURE);
}
if (verbose)
{
printf ("Number of Points: %d\n", points.num_points);
}
/* Call build_modtran_input to generate the tape5 file input and
the MODTRAN commands for each point and height */
if (build_modtran_input (input, &points, verbose, debug)
!= SUCCESS)
{
RETURN_ERROR ("Building MODTRAN input\n", FUNC_NAME, EXIT_FAILURE);
}
/* Perform MODTRAN runs by calling each command */
for (modtran_run = 0; modtran_run < points.num_modtran_runs; modtran_run++)
{
snprintf (msg_str, sizeof(msg_str),
"Executing MODTRAN [%s]",
points.modtran_runs[modtran_run].command);
LOG_MESSAGE (msg_str, FUNC_NAME);
#if RUN_MODTRAN
if (system (points.modtran_runs[modtran_run].command) != SUCCESS)
{
RETURN_ERROR ("Error executing MODTRAN", FUNC_NAME,
EXIT_FAILURE);
}
#endif
}
/* PARSING MODTRAN RESULTS:
for each case in caseList (for each modtran run),
parse wavelength and total radiance from tape6 file into parsed */
for (modtran_run = 0; modtran_run < points.num_modtran_runs; modtran_run++)
{
if (use_tape6)
{
/* Use modtran generated tape6 output */
snprintf (command, sizeof (command),
"lst_extract_modtran_results.py"
" --tape6"
" --input-path %s"
" --output-path %s",
points.modtran_runs[modtran_run].path,
points.modtran_runs[modtran_run].path);
}
else
{
/* Use modtran generated pltout.asc output */
snprintf (command, sizeof (command),
"lst_extract_modtran_results.py"
" --pltout"
" --input-path %s"
" --output-path %s",
points.modtran_runs[modtran_run].path,
points.modtran_runs[modtran_run].path);
}
snprintf (msg_str, sizeof(msg_str), "Executing [%s]", command);
LOG_MESSAGE (msg_str, FUNC_NAME);
#if EXTRACT_TAPE6_RESULTS
if (system (command) != SUCCESS)
{
RETURN_ERROR ("Failed executing lst_extract_tape6_results.py",
FUNC_NAME, EXIT_FAILURE);
}
#endif
}
/* Allocate memory for MODTRAN results */
modtran_results =
(double **) allocate_2d_array (points.num_points * NUM_ELEVATIONS,
MGPE_NUM_ELEMENTS, sizeof (double));
if (modtran_results == NULL)
{
RETURN_ERROR ("Allocating MODTRAN results memory", FUNC_NAME,
EXIT_FAILURE);
}
/* Generate parameters for each height and NARR point */
if (calculate_point_atmospheric_parameters (input, &points, alb,
modtran_results, verbose)
!= SUCCESS)
{
RETURN_ERROR ("Calculating point atmospheric parameters\n",
FUNC_NAME, EXIT_FAILURE);
}
/* Generate parameters for each Landsat pixel */
if (calculate_pixel_atmospheric_parameters (input, &points,
xml_filename,
dem_filename,
emissivity_filename,
modtran_results, verbose)
!= SUCCESS)
{
RETURN_ERROR ("Calculating per/pixel atmospheric parameters\n",
FUNC_NAME, EXIT_FAILURE);
}
/* Free memory allocation */
free_points_memory (&points);
#if NOT_TESTED
/* Open the output file */
output = OpenOutput (&xml_metadata, input);
if (output == NULL)
{ /* error message already printed */
RETURN_ERROR ("Opening output file", FUNC_NAME, EXIT_FAILURE);
}
if (!PutOutput (output, pixel_mask))
{
RETURN_ERROR ("Writing output LST in HDF files\n", FUNC_NAME,
EXIT_FAILURE);
}
/* Close the output file */
if (!CloseOutput (output))
{
RETURN_ERROR ("closing output file", FUNC_NAME, EXIT_FAILURE);
}
/* Create the ENVI header file this band */
if (create_envi_struct (&output->metadata.band[0], &xml_metadata.global,
&envi_hdr) != SUCCESS)
{
RETURN_ERROR ("Creating ENVI header structure.", FUNC_NAME,
EXIT_FAILURE);
}
/* Write the ENVI header */
strcpy (envi_file, output->metadata.band[0].file_name);
cptr = strchr (envi_file, '.');
if (cptr == NULL)
{
RETURN_ERROR ("error in ENVI header filename", FUNC_NAME,
EXIT_FAILURE);
}
strcpy (cptr, ".hdr");
if (write_envi_hdr (envi_file, &envi_hdr) != SUCCESS)
{
RETURN_ERROR ("Writing ENVI header file.", FUNC_NAME, EXIT_FAILURE);
}
/* Append the LST band to the XML file */
if (append_metadata (output->nband, output->metadata.band, xml_filename)
!= SUCCESS)
{
RETURN_ERROR ("Appending spectral index bands to XML file.",
FUNC_NAME, EXIT_FAILURE);
}
/* Free the structure */
if (!FreeOutput (output))
{
RETURN_ERROR ("freeing output file structure", FUNC_NAME,
EXIT_FAILURE);
}
#endif
/* Free the metadata structure */
free_metadata (&xml_metadata);
/* Close the input file and free the structure */
CloseInput (input);
FreeInput (input);
/* Free memory allocations */
if (free_2d_array ((void **) modtran_results) != SUCCESS)
{
RETURN_ERROR ("Freeing memory: MODTRAN results\n", FUNC_NAME,
EXIT_FAILURE);
}
if (!debug)
{
/* Delete temporary file */
if (unlink ("atmospheric_parameters.txt") != SUCCESS)
{
RETURN_ERROR ("Deleting atmospheric_parameters.txt files\n",
FUNC_NAME, EXIT_FAILURE);
}
if (unlink ("base_head.txt") != SUCCESS)
{
RETURN_ERROR ("Deleting baseHead.txt files\n", FUNC_NAME,
EXIT_FAILURE);
}
if (unlink ("new_tail.txt") != SUCCESS)
{
RETURN_ERROR ("Deleting newTail.txt files\n", FUNC_NAME,
EXIT_FAILURE);
}
if (unlink ("temp_layers.txt") != SUCCESS)
{
RETURN_ERROR ("Deleting tempLayers.txt file\n", FUNC_NAME,
EXIT_FAILURE);
}
if (unlink ("used_points.txt") != SUCCESS)
{
RETURN_ERROR ("Deleting used_points.txt file\n", FUNC_NAME,
EXIT_FAILURE);
}
}
time (&now);
snprintf (msg_str, sizeof(msg_str),
"scene_based_lst end_time=%s\n", ctime (&now));
LOG_MESSAGE (msg_str, FUNC_NAME);
return EXIT_SUCCESS;
}
