Skip to content

GitLab

otb
otb
Commit a26e9300 authored by Julien Osman's avatar Julien Osman
Browse files
Options

DOC: Deprecate methods that will be removed in OTB 8.0.0

parent 48c6e94a
Hide whitespace changes
Inline Side-by-side
Showing with 497 additions and 165 deletions
Modules/Core/Metadata/include/otbDefaultImageMetadataInterface.h
View file @ a26e9300
......@@ -55,91 +55,121 @@ public:
typedef Superclass::VariableLengthVectorType VariableLengthVectorType;
typedef Superclass::ImageKeywordlistType ImageKeywordlistType;
/** Get the radiometric bias from the ossim metadata */
/** Get the radiometric bias from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalBias() const
{
itkExceptionMacro("GetPhysicalBias not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the radiometric gain from the ossim metadata */
/** Get the radiometric gain from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalGain() const
{
itkExceptionMacro("GetPhysicalGain not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the solar irradiance from the ossim metadata */
/** Get the solar irradiance from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetSolarIrradiance() const
{
itkExceptionMacro("GetSolarIrradiance not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition day from the ossim metadata */
/** Get the imaging acquisition day from the ossim metadata
* \deprecated
*/
int GetDay() const override
{
itkExceptionMacro("GetDay not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition month from the ossim metadata */
/** Get the imaging acquisition month from the ossim metadata
* \deprecated
*/
int GetMonth() const override
{
itkExceptionMacro("GetMonth not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition year from the ossim metadata */
/** Get the imaging acquisition year from the ossim metadata
* \deprecated
*/
int GetYear() const override
{
itkExceptionMacro("GetYear not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition hour from the ossim metadata */
/** Get the imaging acquisition hour from the ossim metadata
* \deprecated
*/
int GetHour() const override
{
itkExceptionMacro("GetHour not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition minute from the ossim metadata */
/** Get the imaging acquisition minute from the ossim metadata
* \deprecated
*/
int GetMinute() const override
{
itkExceptionMacro("GetMinute not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging production day from the ossim metadata */
/** Get the imaging production day from the ossim metadata
* \deprecated
*/
int GetProductionDay() const override
{
itkExceptionMacro("GetProductionDay not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging production month from the ossim metadata */
/** Get the imaging production month from the ossim metadata
* \deprecated
*/
int GetProductionMonth() const override
{
itkExceptionMacro("GetProductionMonth not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging production year from the ossim metadata */
/** Get the imaging production year from the ossim metadata
* \deprecated
*/
int GetProductionYear() const override
{
itkExceptionMacro("GetProductionYear not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the sat elevation from the ossim metadata */
/** Get the sat elevation from the ossim metadata
* \deprecated
*/
double GetSatElevation() const
{
itkExceptionMacro("GetSatElevation not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the sat azimuth from the ossim metadata */
/** Get the sat azimuth from the ossim metadata
* \deprecated
*/
double GetSatAzimuth() const
{
itkExceptionMacro("GetSatElevation not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the first wavelength for the spectral band definition */
/** Get the first wavelength for the spectral band definition
* \deprecated
*/
VariableLengthVectorType GetFirstWavelengths() const
{
itkExceptionMacro("GetFirstWavelengths not implemented in DefaultImageMetadataInterface, no captor type found");
}
/** Get the last wavelength for the spectral band definition */
/** Get the last wavelength for the spectral band definition
* \deprecated
*/
VariableLengthVectorType GetLastWavelengths() const
{
itkExceptionMacro("GetLastWavelengths not implemented in DefaultImageMetadataInterface, no captor type found");
......
Modules/Core/Metadata/include/otbFormosatImageMetadataInterface.h
View file @ a26e9300
......@@ -53,43 +53,69 @@ public:
typedef Superclass::VariableLengthVectorType VariableLengthVectorType;
typedef Superclass::ImageKeywordlistType ImageKeywordlistType;
/** Get the radiometric bias from the ossim metadata */
/** Get the radiometric bias from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalBias() const override;
/** Get the radiometric gain from the ossim metadata */
/** Get the radiometric gain from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalGain() const override;
/** Get the solar irradiance from the ossim metadata */
/** Get the solar irradiance from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetSolarIrradiance() const override;
/** Get the imaging acquisition day from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition day from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetDay() const override;
/** Get the imaging acquisition month from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition month from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetMonth() const override;
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetYear() const override;
/** Get the imaging acquisition hour from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition hour from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetHour() const override;
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetMinute() const override;
/** Get the imaging production day from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable */
/** Get the imaging production day from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable
* \deprecated
*/
int GetProductionDay() const override;
/** Get the imaging production month from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable */
/** Get the imaging production month from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable
* \deprecated
*/
int GetProductionMonth() const override;
/** Get the imaging production year from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable */
/** Get the imaging production year from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable
* \deprecated
*/
int GetProductionYear() const override;
/** Get the sat elevation from the ossim metadata */
/** Get the sat elevation from the ossim metadata
* \deprecated
*/
double GetSatElevation() const override;
/** Get the sat azimuth from the ossim metadata */
/** Get the sat azimuth from the ossim metadata
* \deprecated
*/
double GetSatAzimuth() const override;
/** Get the first wavelength for the spectral band definition */
......
Modules/Core/Metadata/include/otbIkonosImageMetadataInterface.h
View file @ a26e9300
......@@ -52,43 +52,69 @@ public:
typedef Superclass::VariableLengthVectorType VariableLengthVectorType;
typedef Superclass::ImageKeywordlistType ImageKeywordlistType;
/** Get the radiometric bias from the ossim metadata */
/** Get the radiometric bias from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalBias() const override;
/** Get the radiometric gain from the ossim metadata */
/** Get the radiometric gain from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalGain() const override;
/** Get the solar irradiance from the ossim metadata */
/** Get the solar irradiance from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetSolarIrradiance() const override;
/** Get the imaging acquisition day from the ossim metadata : "Acquisition Date/Time" metadata variable */
/** Get the imaging acquisition day from the ossim metadata : "Acquisition Date/Time" metadata variable
* \deprecated
*/
int GetDay() const override;
/** Get the imaging acquisition month from the ossim metadata : "Acquisition Date/Time" metadata variable */
/** Get the imaging acquisition month from the ossim metadata : "Acquisition Date/Time" metadata variable
* \deprecated
*/
int GetMonth() const override;
/** Get the imaging acquisition year from the ossim metadata : "Acquisition Date/Time" metadata variable */
/** Get the imaging acquisition year from the ossim metadata : "Acquisition Date/Time" metadata variable
* \deprecated
*/
int GetYear() const override;
/** Get the imaging acquisition hour from the ossim metadata : "Acquisition Date/Time" metadata variable */
/** Get the imaging acquisition hour from the ossim metadata : "Acquisition Date/Time" metadata variable
* \deprecated
*/
int GetHour() const override;
/** Get the imaging acquisition year from the ossim metadata : "Acquisition Date/Time" metadata variable */
/** Get the imaging acquisition year from the ossim metadata : "Acquisition Date/Time" metadata variable
* \deprecated
*/
int GetMinute() const override;
/** Get the imaging production day from the ossim metadata : "Creation Date" metadata variable */
/** Get the imaging production day from the ossim metadata : "Creation Date" metadata variable
* \deprecated
*/
int GetProductionDay() const override;
/** Get the imaging production month from the ossim metadata : "Creation Date" metadata variable */
/** Get the imaging production month from the ossim metadata : "Creation Date" metadata variable
* \deprecated
*/
int GetProductionMonth() const override;
/** Get the imaging production year from the ossim metadata : "Creation Date" metadata variable */
/** Get the imaging production year from the ossim metadata : "Creation Date" metadata variable
* \deprecated
*/
int GetProductionYear() const override;
/** Get the sat elevation from the ossim metadata */
/** Get the sat elevation from the ossim metadata
* \deprecated
*/
double GetSatElevation() const override;
/** Get the sat azimuth from the ossim metadata */
/** Get the sat azimuth from the ossim metadata
* \deprecated
*/
double GetSatAzimuth() const override;
/** Get the first wavelength for the spectral band definition */
......
Modules/Core/Metadata/include/otbImageMetadataInterfaceBase.h
View file @ a26e9300
......@@ -147,16 +147,22 @@ public:
Please use bool GetSensorID(std::string& ) **/
std::string const GetSensorID() const;
/** Get the sensor ID from the ossim metadata */
/** Get the sensor ID from the ossim metadata
* \deprecated
*/
bool GetSensorID(std::string& sensorId) const;
// otbMetadataGetMacro(SensorID, std::string);
/** Get the number of bands from the ossim metadata */
/** Get the number of bands from the ossim metadata
* \deprecated
*/
UnsignedIntType GetNumberOfBands() const;
// otbMetadataGetMacro(NumberOfBands, unsigned int);
/** Get the band name from the ossim metadata */
/** Get the band name from the ossim metadata
* \deprecated
*/
StringVectorType GetBandName() const;
// otbMetadataGetMacro(BandName, std::vector<std::string>);
......@@ -168,39 +174,57 @@ public:
double GetYPixelSpacing() const;
// otbMetadataGetMacro(YPixelSpacing, double);
/** Get the imaging acquisition day from the ossim metadata */
/** Get the imaging acquisition day from the ossim metadata
* \deprecated
*/
virtual int GetDay() const = 0;
// otbMetadataGetMacro(Day, int);
/** Get the imaging acquisition month from the ossim metadata */
/** Get the imaging acquisition month from the ossim metadata
* \deprecated
*/
virtual int GetMonth() const = 0;
// otbMetadataGetMacro(Month, int);
/** Get the imaging acquisition year from the ossim metadata */
/** Get the imaging acquisition year from the ossim metadata
* \deprecated
*/
virtual int GetYear() const = 0;
// otbMetadataGetMacro(Year, int);
/** Get the imaging acquisition hour from the ossim metadata */
/** Get the imaging acquisition hour from the ossim metadata
* \deprecated
*/
virtual int GetHour() const = 0;
// otbMetadataGetMacro(Hour, int);
/** Get the imaging acquisition minute from the ossim metadata */
/** Get the imaging acquisition minute from the ossim metadata
* \deprecated
*/
virtual int GetMinute() const = 0;
// otbMetadataGetMacro(Minute, int);
/** Get the imaging production day from the ossim metadata */
/** Get the imaging production day from the ossim metadata
* \deprecated
*/
virtual int GetProductionDay() const = 0;
// otbMetadataGetMacro(ProductionDay, int);
/** Get the imaging production month from the ossim metadata */
/** Get the imaging production month from the ossim metadata
* \deprecated
*/
virtual int GetProductionMonth() const = 0;
// otbMetadataGetMacro(ProductionMonth, int);
/** Get the imaging production year from the ossim metadata */
/** Get the imaging production year from the ossim metadata
* \deprecated
*/
virtual int GetProductionYear() const = 0;
// otbMetadataGetMacro(ProductionYear, int);
/** Convert the band names provided by ossim to the official band names */
/** Convert the band names provided by ossim to the official band names
* \deprecated
*/
virtual StringVectorType GetEnhancedBandNames() const = 0;
/** Get the 3 spectral band numbers corresponding to the default display for visualization,
......
Modules/Core/Metadata/include/otbNoDataHelper.h
View file @ a26e9300
......@@ -37,12 +37,14 @@ namespace otb
/**
* Reads no data flag from the MetaDataDictionary dict to flags and values
* vectors. Returns true upon success.
* \deprecated
*/
bool OTBMetadata_EXPORT ReadNoDataFlags(const itk::MetaDataDictionary& dict, std::vector<bool>& flags, std::vector<double>& values);
/**
* Write no data flags to the MetaDataDictionary dict from flags and values
* vectors. Returns true upon success.
* \deprecated
*/
void OTBMetadata_EXPORT WriteNoDataFlags(const std::vector<bool>& flags, const std::vector<double>& values, itk::MetaDataDictionary& dict);
......
Modules/Core/Metadata/include/otbOpticalDefaultImageMetadataInterface.h
View file @ a26e9300
......@@ -55,79 +55,105 @@ public:
typedef Superclass::VariableLengthVectorType VariableLengthVectorType;
typedef Superclass::ImageKeywordlistType ImageKeywordlistType;
/** Get the radiometric bias from the ossim metadata */
/** Get the radiometric bias from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalBias() const override
{
itkExceptionMacro("GetPhysicalBias not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the radiometric gain from the ossim metadata */
/** Get the radiometric gain from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalGain() const override
{
itkExceptionMacro("GetPhysicalGain not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the solar irradiance from the ossim metadata */
/** Get the solar irradiance from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetSolarIrradiance() const override
{
itkExceptionMacro("GetSolarIrradiance not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition day from the ossim metadata */
/** Get the imaging acquisition day from the ossim metadata
* \deprecated
*/
int GetDay() const override
{
itkExceptionMacro("GetDay not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition month from the ossim metadata */
/** Get the imaging acquisition month from the ossim metadata
* \deprecated
*/
int GetMonth() const override
{
itkExceptionMacro("GetMonth not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition year from the ossim metadata */
/** Get the imaging acquisition year from the ossim metadata
* \deprecated
*/
int GetYear() const override
{
itkExceptionMacro("GetYear not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition hour from the ossim metadata */
/** Get the imaging acquisition hour from the ossim metadata
* \deprecated
*/
int GetHour() const override
{
itkExceptionMacro("GetHour not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging acquisition minute from the ossim metadata */
/** Get the imaging acquisition minute from the ossim metadata
* \deprecated
*/
int GetMinute() const override
{
itkExceptionMacro("GetMinute not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging production day from the ossim metadata */
/** Get the imaging production day from the ossim metadata
* \deprecated
*/
int GetProductionDay() const override
{
itkExceptionMacro("GetProductionDay not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging production month from the ossim metadata */
/** Get the imaging production month from the ossim metadata
* \deprecated
*/
int GetProductionMonth() const override
{
itkExceptionMacro("GetProductionMonth not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the imaging production year from the ossim metadata */
/** Get the imaging production year from the ossim metadata
* \deprecated
*/
int GetProductionYear() const override
{
itkExceptionMacro("GetProductionYear not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the sat elevation from the ossim metadata */
/** Get the sat elevation from the ossim metadata
* \deprecated
*/
double GetSatElevation() const override
{
itkExceptionMacro("GetSatElevation not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
}
/** Get the sat azimuth from the ossim metadata */
/** Get the sat azimuth from the ossim metadata
* \deprecated
*/
double GetSatAzimuth() const override
{
itkExceptionMacro("GetSatElevation not implemented in OpticalDefaultImageMetadataInterface, no captor type found");
......
Modules/Core/Metadata/include/otbOpticalImageMetadataInterface.h
View file @ a26e9300
......@@ -57,25 +57,39 @@ public:
typedef otb::ObjectList<FilterFunctionValuesType> InternalWavelengthSpectralBandVectorType;
typedef InternalWavelengthSpectralBandVectorType::Pointer WavelengthSpectralBandVectorType;
/** Get the sun elevation from the ossim metadata */
/** Get the sun elevation from the ossim metadata
* \deprecated
*/
double GetSunElevation() const;
/** Get the sun azimuth from the ossim metadata */
/** Get the sun azimuth from the ossim metadata
* \deprecated
*/
double GetSunAzimuth() const;
/** Get the sat elevation from the ossim metadata */
/** Get the sat elevation from the ossim metadata
* \deprecated
*/
virtual double GetSatElevation() const = 0;
/** Get the sat azimuth from the ossim metadata */
/** Get the sat azimuth from the ossim metadata
* \deprecated
*/
virtual double GetSatAzimuth() const = 0;
/** Get the radiometric bias from the ossim metadata */
/** Get the radiometric bias from the ossim metadata
* \deprecated
*/
virtual VariableLengthVectorType GetPhysicalBias() const = 0;
/** Get the radiometric gain from the ossim metadata */
/** Get the radiometric gain from the ossim metadata
* \deprecated
*/
virtual VariableLengthVectorType GetPhysicalGain() const = 0;
/** Get the solar irradiance from the ossim metadata */
/** Get the solar irradiance from the ossim metadata
* \deprecated
*/
virtual VariableLengthVectorType GetSolarIrradiance() const = 0;
/** Get the first wavelength for the spectral band definition */
......
Modules/Core/Metadata/include/otbPleiadesImageMetadataInterface.h
View file @ a26e9300
......@@ -53,43 +53,69 @@ public:
typedef Superclass::VariableLengthVectorType VariableLengthVectorType;
typedef Superclass::ImageKeywordlistType ImageKeywordlistType;
/** Get the radiometric bias from the ossim metadata */
/** Get the radiometric bias from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalBias() const override;
/** Get the radiometric gain from the ossim metadata */
/** Get the radiometric gain from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetPhysicalGain() const override;
/** Get the solar irradiance from the ossim metadata */
/** Get the solar irradiance from the ossim metadata
* \deprecated
*/
VariableLengthVectorType GetSolarIrradiance() const override;
/** Get the imaging acquisition day from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition day from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetDay() const override;
/** Get the imaging acquisition month from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition month from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetMonth() const override;
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetYear() const override;
/** Get the imaging acquisition hour from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition hour from the ossim metadata : IMAGING_DATE metadata variable
* \deprecated
*/
int GetHour() const override;
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable */
/** Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable