Clarification on Input/Output File Formats

[adamchlus]

The documentation does not specify the expected input and output file formats for the cloud detection algorithm. Specifically, the format requirements for the following parameters should be made explicit:

• OUTFP
• OBSFP
• RDNFP

Additionally, please consider using ENVI binary files for OBSFP and RDNFP inputs instead of header files. This would better align with the input expectations of other software using ENVI files.

[jakehlee]

@adamchlus Thanks for the issue, we'll clarify in the documentation that:

• OUTFP should be any .tif filepath to write to
• OBSFP should be: <fid>_l1b_obs_*.hdr
• RDNFP should be: <fid>_l1b_rdn_*.hdr

Regarding using the binary files instead of header files, I believe this discrepancy is because we're using spectral.io.envi to read our files (ref), as defined here:

SpecTf/spectf/toa.py

Lines 33 to 46 in 6330f7d

	# open radiance
	rad_header = envi.open(rdnfp)
	rad = rad_header.open_memmap(interleave='bip')
	banddef = [name_to_nm(name) for name in rad_header.metadata['wavelength']]
	banddef = np.array(banddef, dtype=float)
	# To-sun zenith (0 to 90 degrees from zenith)
	obs = envi.open(obsfp).open_memmap(interleave='bip')
	zen = obs[:,:,4]
	zen = np.deg2rad(zen)
	# Earth-sun distance (AU)
	es_distance = obs[:,:,10]
	es_distance = np.average(es_distance)

I've briefly discussed changing this to a faster file reading method (presumably one that expects .img), any chance you have an example of it on-hand?

EDIT: minor words

[jakehlee]

Will implement

https://github.com/emit-sds/emit-utils/blob/f87027d6e0f88046dc9d501f787c7bd8978fef54/emit_utils/file_checks.py#L140-L161

[jakehlee]

Closed by #85