ARCSI Sensor¶
Module that contains the ARCSIAbstractSensor class.
- class arcsilib.arcsisensor.ARCSIAbstractSensor(debugMode, inputImage)¶
An abstract class which represents a sensor and allows the various opperations required to be applied and standard variables (e.g., acqusiation date) stored and retrieved.
- abstract applyImageDataMask(inputHeader, inputImage, outputPath, outputMaskName, outputImgName, outFormat, outWKTFile)¶
- buildElevation6SCoeffLUT(aeroProfile, atmosProfile, grdRefl, aotVal, useBRDF, surfaceAltitudeMin, surfaceAltitudeMax)¶
- buildElevationAOT6SCoeffLUT(aeroProfile, atmosProfile, grdRefl, useBRDF, surfaceAltitudeMin, surfaceAltitudeMax, aotMin, aotMax)¶
- abstract calc6SCoefficients(aeroProfile, atmosProfile, grdRefl, surfaceAltitude, aotVal, useBRDF)¶
- calcDarkTargetOffsetsForBand(inputTOAImage, offsetImage, band, outFormat, histBinWidth, minObjSize, darkPxlPercentile, tmpDarkPxlsImg, tmpDarkPxlsClumpsImg, tmpDarkPxlsClumpsRMSmallImg, tmpDarkObjsImg)¶
- checkInputImageValid()¶
- cleanFollowProcessing(outputDIR=None, fileEnding2Keep=None)¶
- abstract cleanLocalFollowProcessing()¶
- convertImageBandToReflectanceSimpleDarkSubtract(inputTOAImage, outputPath, outputName, outFormat, dosOutRefl, imgBand)¶
- abstract convertImageToRadiance(outputPath, outputReflName, outputThermalName, outFormat)¶
- convertImageToReflectanceSimpleDarkSubtract(inputTOAImage, outputPath, outputName, outFormat, dosOutRefl, offsetsList=None)¶
- abstract convertImageToSurfaceReflAOTDEMElevLUT(inputRadImage, inputDEMFile, inputAOTImage, outputPath, outputName, outFormat, aeroProfile, atmosProfile, grdRefl, useBRDF, surfaceAltitudeMin, surfaceAltitudeMax, aotMin, aotMax, scaleFactor, elevAOTCoeffs=None)¶
- abstract convertImageToSurfaceReflDEMElevLUT(inputRadImage, inputDEMFile, outputPath, outputName, outFormat, aeroProfile, atmosProfile, grdRefl, aotVal, useBRDF, surfaceAltitudeMin, surfaceAltitudeMax, scaleFactor, elevCoeffs=None)¶
- abstract convertImageToSurfaceReflSglParam(inputRadImage, outputPath, outputName, outFormat, aeroProfile, atmosProfile, grdRefl, surfaceAltitude, aotVal, useBRDF, scaleFactor)¶
- abstract convertImageToTOARefl(inputRadImage, outputPath, outputName, outFormat, scaleFactor)¶
- convertSREF2StdisedSREF(inputSREFImage, inputSREFWholeImage, inputDEMFile, inputTopoShadowMask, outputPath, outputName, outputWholeName, outFormat, tmpPath, sixsLUTCoeffs, aotLUT, scaleFactor, brdfBeta=1, outIncidenceAngle=0, outExitanceAngle=0)¶
- abstract convertThermalToBrightness(inputRadImage, outputPath, outputName, outFormat, scaleFactor)¶
- abstract createCloudMaskDataArray(inImgDataArr)¶
- defaultGenBaseOutFileName()¶
A function to generate a generic standard file base name which will be sensible.
It is expected that individual sensors may override this function.
- abstract defineDarkShadowImageBand()¶
- abstract estimateImageToAODUsingDDV(inputRADImage, inputTOAImage, inputDEMFile, shadowMask, outputPath, outputName, outFormat, tmpPath, aeroProfile, atmosProfile, grdRefl, aotValMin, aotValMax)¶
- abstract estimateImageToAODUsingDOS(inputRADImage, inputTOAImage, inputDEMFile, shadowMask, outputPath, outputName, outFormat, tmpPath, aeroProfile, atmosProfile, grdRefl, aotValMin, aotValMax, globalDOS, simpleDOS, dosOutRefl)¶
- abstract estimateSingleAOTFromDOS(radianceImage, toaImage, inputDEMFile, tmpPath, outputName, outFormat, aeroProfile, atmosProfile, grdRefl, minAOT, maxAOT, dosOutRefl)¶
- estimateSingleAOTFromDOSBandImpl(radianceImage, toaImage, inputDEMFile, tmpPath, outputName, outFormat, aeroProfile, atmosProfile, grdRefl, aotValMin, aotValMax, dosOutRefl, imgBand)¶
- abstract expectedImageDataPresent()¶
- abstract extractHeaderParameters(inputHeader, wktStr)¶
- abstract findDDVTargets(inputTOAImage, outputPath, outputName, outFormat, tmpPath)¶
- findDOSLocalDarkTargets(inputTOAImage, darkTargetImage, blockSize, outFormat, histBinWidth, darkPxlPercentile)¶
- findPerBandDarkTargetsOffsets(inputTOAImage, numBands, outputPath, outputName, outFormat, tmpPath, minObjSize, darkPxlPercentile)¶
- findPerBandLocalDarkTargetsOffsets(inputTOAImage, numBands, outputPath, outputName, outFormat, tmpPath, blockSize, minObjSize, darkPxlPercentile)¶
- generateClearSkyMask(cloudsImg, inputValidImg, outputPath, outputName, outFormat, tmpPath, initClearSkyRegionDist=3000, initClearSkyRegionMinSize=3000, finalClearSkyRegionDist=1000, morphSize=21)¶
- abstract generateCloudMask(inputReflImage, inputSatImage, inputThermalImage, inputViewAngleImg, inputValidImg, outputPath, outputName, outFormat, tmpPath, scaleFactor, cloud_msk_methods=None)¶
- generateImageFootprint(validMaskImage, outputPath, outputName)¶
- abstract generateImageSaturationMask(outputPath, outputName, outFormat)¶
- generateMetaDataFile(outputPath, outputFileName, productsStr, validMaskImage='', footprintCalc=False, calcdValuesDict=None, outFilesDict=None)¶
Provides a default implementation for generating file metadata.
- generateOutputBaseName()¶
Provides a default implementation for generating file name.
- generateTopoDirectShadowMask(inputDEMImage, outputPath, outputName, outFormat, tmpPath)¶
- abstract generateValidImageDataMask(outputPath, outputMaskName, viewAngleImg, outFormat)¶
- getBBOX()¶
- Returns
(MinX, MaxX, MinY, MaxY)
- getBBOXLatLon()¶
- Returns
(MinLon, MaxLon, MinLat, MaxLat)
- getJSONDictDefaultMetaData(productsStr, validMaskImage='', footprintCalc=False, calcdValuesDict=None, outFilesDict=None)¶
- getReProjBBOX(wktFile, proj4File, useWKT2Reproject, xPxlRes, yPxlRes, snap2Grid)¶
- getReProjectOutputs(reproj=False)¶
- abstract getSensorViewGeom()¶
- abstract getSolarIrrStdSolarGeom()¶
- hasThermal()¶
- imgNeedMosaicking()¶
- inImgsDiffRes()¶
- interpolateImageFromPointData(templateInImage, xVals, yVals, zVals, outputImage, outFormat, smoothingParam, notNegOut, notNegMinVal)¶
- maskInputImages()¶
- abstract mosaicImageTiles(outputPath)¶
- performDOSOnSingleBand(inputTOAImage, band, outputPath, tmpBaseName, bandName, outFormat, tmpPath, minObjSize, darkPxlPercentile, dosOutRefl)¶
- performLocalDOSOnSingleBand(inputTOAImage, band, outputPath, tmpBaseName, bandName, outFormat, tmpPath, minObjSize, darkPxlPercentile, blockSize, dosOutRefl)¶
- abstract resampleImgRes(outputPath, resampleToLowResImg, resampleMethod='cubic', multicore=False)¶
- abstract setBandNames(imageFile)¶
- setReProjectOutputs(reproj=False)¶
- abstract sharpenLowResRadImgBands(inputImg, outputImage, outFormat)¶