Request for changes-113: rename optical calibration filters

[Request for Changes - 113] Rename optical calibration filters

Status

• Authors: Rémi Cresson, Julien Michel
• Submitted on 31.08.2017
• Proposed target release: 6.2
• Adopted : +3 from Victor, Rémi, Guillaume
• git branches:
  • otb: https://git.orfeo-toolbox.org/otb.git/shortlog/refs/heads/rename_opticcal_filters
  • otb-data: https://git.orfeo-toolbox.org/otb-data.git/shortlog/refs/heads/rename_opticcal_filters
• Merged : f73f652ef6705a8c686059b8b1923241112eada5

Summary

This RFC address the renaming of the following classes:

• ReflectanceToLuminanceImageFilter into ReflectanceToRadianceImageFilter
• LuminanceToImageImageFilter into RadianceToImageImageFilter

Rationale

This cames from the mistranslation of French Luminance énergétique which corresponds to Radiance in English. In English, Luminance refers to a photometric measure of the luminous intensity per unit area of light travelling in a given direction. It describes the amount of light that passes through, is emitted or reflected from a particular area, and falls within a given solid angle. The SI unit for luminance is candela per square metre (cd/m2), which is not the appropriate translation. The english Radiance is the radiant flux emitted, reflected, transmitted or received by a given surface, per unit solid angle per unit projected area.[...] The SI unit of radiance is the watt per steradian per square metre (W·sr−1·m−2). (Source: wikipedia).

Consequently, we have to correct this typo.

Implementation details

Create aliases for old classes to replace, and mark as deprecated.

Classes and files

Every occurrence of Luminance has been replaced with Radiance (and also luminance with radiance).

Following classes have been renamed (Luminance replaced with Radiance):

Examples/Radiometry/test/CMakeLists.txt
Examples/Radiometry/AtmosphericCorrectionSequencement.cxx
Modules/Radiometry/Simulation/include/otbSurfaceReflectanceToReflectanceFilter.h
Modules/Radiometry/Simulation/include/otbReduceSpectralResponse.txx
Modules/Radiometry/OpticalCalibration/test/otbImageToLuminanceImageFilter.cxx
Modules/Radiometry/OpticalCalibration/test/otbImageToLuminanceImageFilterAuto.cxx
Modules/Radiometry/OpticalCalibration/test/otbLuminanceToImageImageFilter.cxx
Modules/Radiometry/OpticalCalibration/test/otbReflectanceToLuminanceImageFilterAuto.cxx
Modules/Radiometry/OpticalCalibration/test/otbOpticalCalibrationTestDriver.cxx
Modules/Radiometry/OpticalCalibration/test/CMakeLists.txt
Modules/Radiometry/OpticalCalibration/test/otbReflectanceToLuminanceImageFilter.cxx
Modules/Radiometry/OpticalCalibration/test/otbAtmosphericCorrectionSequencement.cxx
Modules/Radiometry/OpticalCalibration/test/otbLuminanceToReflectanceImageFilterNew.cxx
Modules/Radiometry/OpticalCalibration/test/otbLuminanceToReflectanceImageFilterAuto.cxx
Modules/Radiometry/OpticalCalibration/test/otbImageToLuminanceImageFilterNew.cxx
Modules/Radiometry/OpticalCalibration/test/otbLuminanceToImageImageFilterAuto.cxx
Modules/Radiometry/OpticalCalibration/test/otbReflectanceToImageImageFilter.cxx
Modules/Radiometry/OpticalCalibration/test/otbReflectanceToLuminanceImageFilterNew.cxx
Modules/Radiometry/OpticalCalibration/test/otbLuminanceToReflectanceImageFilter.cxx
Modules/Radiometry/OpticalCalibration/test/otbLuminanceToImageImageFilterNew.cxx
Modules/Radiometry/OpticalCalibration/include/otbReflectanceToLuminanceImageFilter.h
Modules/Radiometry/OpticalCalibration/include/otbReflectanceToSurfaceReflectanceImageFilter.h
Modules/Radiometry/OpticalCalibration/include/otbLuminanceToReflectanceImageFilter.h
Modules/Radiometry/OpticalCalibration/include/otbLuminanceToImageImageFilter.h
Modules/Radiometry/OpticalCalibration/include/otbImageToLuminanceImageFilter.h
Modules/Radiometry/OpticalCalibration/include/otbImageToReflectanceImageFilter.h
Modules/Radiometry/OpticalCalibration/include/otbReflectanceToImageImageFilter.h
Modules/Applications/AppOpticalCalibration/test/CMakeLists.txt
Modules/Applications/AppOpticalCalibration/app/otbOpticalCalibration.cxx

And also in data:

${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoQuickbirdXS.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoQuickbirdPAN.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoWV2PAN.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoSpot5.img
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoIkonos.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoWV2Multi.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoQuickbirdXS.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterAutoFormosat.img
${BASELINE}/raTvLuminanceToReflectanceImageFilterDayMonth.tif
${BASELINE}/raTvLuminanceToReflectanceImageFilterDsol.tif
${BASELINE}/raTvImageToLuminanceImageFilterAutoFormosat.img
${BASELINE}/raTvImageToLuminanceImageFilterAutoIkonos.tif
${BASELINE}/raTvImageToLuminanceImageFilterAutoQuickbirdXS.tif
${BASELINE}/raTvImageToLuminanceImageFilterAutoQuickbirdPAN.tif
${BASELINE}/raTvImageToLuminanceImageFilterAutoWV2Multi.tif
${BASELINE}/raTvImageToLuminanceImageFilterAutoSpot5.img
${BASELINE}/raTvImageToLuminanceImageFilterAutoWV2PAN.tif
${BASELINE}/raTvImageToLuminanceImageFilter.tif

Applications

OpticalCalibration must be modified.

Documentation

Work in progress