ARCSI Run

Module that contains the ARCSIRun class.

class arcsilib.arcsirun.ARCSIParamsObj
arcsilib.arcsirun.calcTOAReflectance(paramsObj)
arcsilib.arcsirun.calcThermalBrightness(paramsObj)
arcsilib.arcsirun.calcTopoShadowMask(paramsObj)
arcsilib.arcsirun.calculateSREF(paramsObj)
arcsilib.arcsirun.calculateStandarisedSREF(paramsObj)
arcsilib.arcsirun.checkForValidInput(paramsObj)
arcsilib.arcsirun.convertInputImageToRadiance(paramsObj)
arcsilib.arcsirun.createFootprint(paramsObj)
arcsilib.arcsirun.createSaturatedImage(paramsObj)
arcsilib.arcsirun.createValidMaskViewAngle(paramsObj)
arcsilib.arcsirun.estimateSceneAOT(paramsObj)
arcsilib.arcsirun.exportMetaData(paramsObj)
arcsilib.arcsirun.mosaicInputImages(paramsObj)
arcsilib.arcsirun.performClearSkyMasking(paramsObj)
arcsilib.arcsirun.performCloudMasking(paramsObj)
arcsilib.arcsirun.performDOS(paramsObj)
arcsilib.arcsirun.prepParametersObj(inputHeader, inputImage, cloudMaskUsrImg, sensorStr, inWKTFile, outFormat, outFilePath, outBaseName, outWKTFile, outProj4File, projAbbv, xPxlResUsr, yPxlResUsr, productsStr, calcStatsPy, aeroProfileOption, atmosProfileOption, aeroProfileOptionImg, atmosProfileOptionImg, grdReflOption, surfaceAltitude, atmosOZoneVal, atmosWaterVal, atmosOZoneWaterSpecified, aeroWaterVal, aeroDustVal, aeroOceanicVal, aeroSootVal, aeroComponentsSpecified, aotVal, visVal, tmpPath, minAOT, maxAOT, lowAOT, upAOT, demFile, demNoDataUsrVal, aotFile, globalDOS, dosOutRefl, simpleDOS, debugMode, scaleFactor, interpAlgor, interpAlgorResample, initClearSkyRegionDist, initClearSkyRegionMinSize, finalClearSkyRegionDist, clearSkyMorphSize, fullImgOuts, checkOutputs, classmlclouds, cloudtrainclouds, cloudtrainother, resample2LowResImg, fileEnding2Keep)
arcsilib.arcsirun.prepareDEM(paramsObj)
arcsilib.arcsirun.print2ConsoleListEnvVars()

A function which lists the available environmental variables for ARCSI.

arcsilib.arcsirun.print2ConsoleListProductDescription(product)

A function which lists the currently supported products and describes what that are and the parameters they require.

arcsilib.arcsirun.print2ConsoleListSensors()

A function which lists the currently supported sensors and the names by which they should be specified to the ARCSI command line argument.

arcsilib.arcsirun.resampleBands(paramsObj)
arcsilib.arcsirun.runARCSI(inputHeader, inputImage, cloudMaskUsrImg, sensorStr, inWKTFile, outFormat, outFilePath, outBaseName, outWKTFile, outProj4File, projAbbv, xPxlResUsr, yPxlResUsr, productsStr, calcStatsPy, aeroProfileOption, atmosProfileOption, aeroProfileOptionImg, atmosProfileOptionImg, grdReflOption, surfaceAltitude, atmosOZoneVal, atmosWaterVal, atmosOZoneWaterSpecified, aeroWaterVal, aeroDustVal, aeroOceanicVal, aeroSootVal, aeroComponentsSpecified, aotVal, visVal, tmpPath, minAOT, maxAOT, lowAOT, upAOT, demFile, demNoDataUsrVal, aotFile, globalDOS, dosOutRefl, simpleDOS, debugMode, scaleFactor, interpAlgor, interpAlgorResample, initClearSkyRegionDist, initClearSkyRegionMinSize, finalClearSkyRegionDist, clearSkyMorphSize, fullImgOuts, checkOutputs, classmlclouds, cloudtrainclouds, cloudtrainother, resample2LowResImg, fileEnding2Keep)

A function contains the main flow of the software

arcsilib.arcsirun.runARCSIMulti(inputHeaders, sensorStr, inWKTFile, outFormat, outFilePath, outBaseName, outWKTFile, outProj4File, projAbbv, xPxlResUsr, yPxlResUsr, productsStr, calcStatsPy, aeroProfileOption, atmosProfileOption, aeroProfileOptionImg, atmosProfileOptionImg, grdReflOption, surfaceAltitude, atmosOZoneVal, atmosWaterVal, atmosOZoneWaterSpecified, aeroWaterVal, aeroDustVal, aeroOceanicVal, aeroSootVal, aeroComponentsSpecified, aotVal, visVal, tmpPath, minAOT, maxAOT, lowAOT, upAOT, demFile, demNoDataUsrVal, aotFile, globalDOS, dosOutRefl, simpleDOS, debugMode, scaleFactor, interpAlgor, interpAlgorResample, initClearSkyRegionDist, initClearSkyRegionMinSize, finalClearSkyRegionDist, clearSkyMorphSize, fullImgOuts, checkOutputs, classmlclouds, cloudtrainclouds, cloudtrainother, resample2LowResImg, ncores, fileEnding2Keep)

A function contains the main flow of the software