From 8d4bc7d77a62558458f7d7e635af0e8e0f0ec65b Mon Sep 17 00:00:00 2001
From: Victor Poughon <victor.poughon@cnes.fr>
Date: Tue, 16 May 2017 19:03:46 +0200
Subject: [PATCH] WIP: Better error messages (RFC-91)
---
.../IO/ImageIO/include/otbImageFileReader.h | 15 +-
.../IO/ImageIO/include/otbImageFileReader.txx | 124 ++++-------
.../IO/ImageIO/include/otbImageFileWriter.txx | 15 +-
Modules/IO/ImageIO/src/otbImageIOFactory.cxx | 33 ++-
.../ApplicationEngine/include/otbLogger.h | 50 +++++
.../include/otbWrapperApplication.h | 30 ++-
.../include/otbWrapperInputImageParameter.txx | 9 +-
.../include/otbWrapperMacros.h | 13 +-
.../ApplicationEngine/src/CMakeLists.txt | 1 +
.../ApplicationEngine/src/otbLogger.cxx | 61 ++++++
.../src/otbWrapperApplication.cxx | 11 +-
.../otbWrapperInputFilenameListParameter.cxx | 43 +---
.../src/otbWrapperInputImageListParameter.cxx | 57 ++---
.../src/otbWrapperInputImageParameter.cxx | 25 +--
.../src/otbWrapperCommandLineLauncher.cxx | 194 +++++++++---------
15 files changed, 337 insertions(+), 344 deletions(-)
create mode 100644 Modules/Wrappers/ApplicationEngine/include/otbLogger.h
create mode 100644 Modules/Wrappers/ApplicationEngine/src/otbLogger.cxx
diff --git a/Modules/IO/ImageIO/include/otbImageFileReader.h b/Modules/IO/ImageIO/include/otbImageFileReader.h
index daf6c58e80..c6553512d8 100644
--- a/Modules/IO/ImageIO/include/otbImageFileReader.h
+++ b/Modules/IO/ImageIO/include/otbImageFileReader.h
@@ -54,19 +54,14 @@ public:
/** Constructor. */
ImageFileReaderException(const char *file, unsigned int line,
- const char* message = "Error in IO",
- const char* loc = "Unknown") :
- ExceptionObject(file, line, message, loc)
+ const std::string& desc = "",
+ const std::string& filename = "") :
+ ExceptionObject(file, line, desc),
+ m_Filename(filename)
{
}
- /** Constructor. */
- ImageFileReaderException(const std::string &file, unsigned int line,
- const char* message = "Error in IO",
- const char* loc = "Unknown") :
- ExceptionObject(file, line, message, loc)
- {
- }
+ std::string m_Filename;
};
/** \class ImageFileReader
diff --git a/Modules/IO/ImageIO/include/otbImageFileReader.txx b/Modules/IO/ImageIO/include/otbImageFileReader.txx
index 8f529967ad..900d1e9562 100644
--- a/Modules/IO/ImageIO/include/otbImageFileReader.txx
+++ b/Modules/IO/ImageIO/include/otbImageFileReader.txx
@@ -65,7 +65,6 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
m_UserSpecifiedImageIO(false),
m_FileName(""),
m_UseStreaming(true),
- m_ExceptionMessage(""),
m_ActualIORegion(),
m_FilenameHelper(FNameHelperType::New()),
m_AdditionalNumber(0),
@@ -242,8 +241,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
}
else
{
- throw otb::ImageFileReaderException(__FILE__, __LINE__,
- "Invalid output object type");
+ throw otb::ImageFileReaderException(__FILE__, __LINE__, "Invalid output object type");
}
}
}
@@ -259,11 +257,10 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
itkDebugMacro(<< "Reading file for GenerateOutputInformation()" << this->m_FileName);
// Check to see if we can read the file given the name or prefix
- //
if (this->m_FileName == "")
- {
- throw otb::ImageFileReaderException(__FILE__, __LINE__, "FileName must be specified");
- }
+ {
+ throw otb::ImageFileReaderException(__FILE__, __LINE__, "Filename must be specified.");
+ }
// Find real image file name
// !!!! Update FileName
@@ -271,56 +268,25 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
bool found = GetGdalReadImageFileName(this->m_FileName, lFileName);
if (found == false)
{
- otbMsgDebugMacro(<< "Filename was NOT unknown. May be recognized by a Image factory ! ");
+ otbMsgDebugMacro(<< "Filename was NOT unknown. May be recognized by a Image factory!");
}
// Update FileName
this->m_FileName = lFileName;
// Test if the file exists and if it can be opened.
// An exception will be thrown otherwise.
- // We catch the exception because some ImageIO's may not actually
- // open a file. Still reports file error if no ImageIO is loaded.
-
- try
- {
- m_ExceptionMessage = "";
- this->TestFileExistenceAndReadability();
- }
- catch (itk::ExceptionObject & err)
- {
- m_ExceptionMessage = err.GetDescription();
- }
-
+ this->TestFileExistenceAndReadability();
+
if (this->m_UserSpecifiedImageIO == false) //try creating via factory
- {
+ {
this->m_ImageIO = ImageIOFactory::CreateImageIO(this->m_FileName.c_str(), otb::ImageIOFactory::ReadMode);
- }
-
- if (this->m_ImageIO.IsNull())
- {
- //this->Print(std::cerr);
- otb::ImageFileReaderException e(__FILE__, __LINE__);
- std::ostringstream msg;
- msg << " Could not create IO object for file "
- << this->m_FileName.c_str() << std::endl;
- msg << " Tried to create one of the following:" << std::endl;
- std::list<itk::LightObject::Pointer> allobjects =
- itk::ObjectFactoryBase::CreateAllInstance("otbImageIOBase");
- for (std::list<itk::LightObject::Pointer>::iterator i = allobjects.begin();
- i != allobjects.end(); ++i)
- {
- otb::ImageIOBase* io = dynamic_cast<otb::ImageIOBase*>(i->GetPointer());
- // IO should never be null, but we would better check for it
- if(io)
- msg << " " << io->GetNameOfClass() << std::endl;
- }
- msg << " You probably failed to set a file suffix, or" << std::endl;
- msg << " set the suffix to an unsupported type." << std::endl;
- e.SetDescription(msg.str().c_str());
- throw e;
- return;
- }
+ }
+ // Throw error if the image wasn't loaded
+ if (this->m_ImageIO.IsNull())
+ {
+ throw otb::ImageFileReaderException(__FILE__, __LINE__, "Cannot read image (probably unsupported or incorrect filename extension).", this->m_FileName);
+ }
// Get the ImageIO MetaData Dictionary
itk::MetaDataDictionary& dict = this->m_ImageIO->GetMetaDataDictionary();
@@ -331,7 +297,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
bool lVectorImage = false;
if (strcmp(output->GetNameOfClass(), "VectorImage") == 0)
lVectorImage= true;
-
+
this->m_ImageIO->SetOutputImagePixelType(PixelIsComplex(dummy),lVectorImage);
// Pass the dataset number (used for hdf files for example)
@@ -435,9 +401,9 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
if(!m_KeywordListUpToDate && !m_FilenameHelper->GetSkipGeom())
{
-
+
std::string lFileNameOssimKeywordlist = GetDerivedDatasetSourceFileName(m_FileName);
-
+
// Update otb Keywordlist
ImageKeywordlist otb_kwl;
if (!m_FilenameHelper->ExtGEOMFileNameIsSet())
@@ -450,7 +416,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
otb_kwl = ReadGeometryFromGEOMFile(m_FilenameHelper->GetExtGEOMFileName());
otbMsgDevMacro(<< "Loading external kwl");
}
-
+
// Don't add an empty ossim keyword list
if(!otb_kwl.Empty())
{
@@ -511,7 +477,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
}
-
+
// If Skip ProjectionRef is activated, remove ProjRef from dict
if (m_FilenameHelper->GetSkipCarto())
{
@@ -576,9 +542,9 @@ std::string
ImageFileReader<TOutputImage, ConvertPixelTraits>
::GetDerivedDatasetSourceFileName(const std::string & filename) const
{
-
+
const size_t dsds_pos = filename.find(DerivedSubdatasetPrefix);
-
+
if(dsds_pos != std::string::npos)
{
// Derived subdataset from gdal
@@ -605,40 +571,26 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
}
std::string fileToCheck = GetDerivedDatasetSourceFileName(m_FileName);
-
+
// Test if the file exists.
if (!itksys::SystemTools::FileExists(fileToCheck.c_str()))
- {
- otb::ImageFileReaderException e(__FILE__, __LINE__);
- std::ostringstream msg;
- msg << "The file doesn't exist. "
- << std::endl << "Filename = " << fileToCheck
- << std::endl;
- e.SetDescription(msg.str().c_str());
- throw e;
- return;
- }
+ {
+ throw otb::ImageFileReaderException (__FILE__, __LINE__, "The file does not exist.", fileToCheck);
+ }
// Test if the file can be open for reading access.
//Only if m_FileName specify a filename (not a dirname)
if (itksys::SystemTools::FileExists(fileToCheck.c_str(), true))
- {
+ {
std::ifstream readTester;
readTester.open(fileToCheck.c_str());
if (readTester.fail())
- {
+ {
readTester.close();
- std::ostringstream msg;
- msg << "The file couldn't be opened for reading. "
- << std::endl << "Filename: " << fileToCheck
- << std::endl;
- otb::ImageFileReaderException e(__FILE__, __LINE__, msg.str().c_str(), ITK_LOCATION);
- throw e;
- return;
-
- }
- readTester.close();
+ throw otb::ImageFileReaderException(__FILE__, __LINE__, "The file cannot be opened for reading.", fileToCheck);
}
+ readTester.close();
+ }
}
template <class TOutputImage, class ConvertPixelTraits>
@@ -695,7 +647,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
}
fic_trouve = true;
}
-
+
otbMsgDevMacro(<< "lFileNameGdal : " << GdalFileName.c_str());
otbMsgDevMacro(<< "fic_trouve : " << fic_trouve);
return (fic_trouve);
@@ -716,12 +668,12 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
{
const std::string skip_geom_key = "skipgeom";
const std::string geom_key = "geom";
-
+
if (in)
{
// First, see if the simple filename has changed
typename FNameHelperType::Pointer helper = FNameHelperType::New();
-
+
helper->SetExtendedFileName(in);
std::string simpleFileName = helper->GetSimpleFileName();
@@ -735,7 +687,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
if(oldMap.size() != newMap.size() || !std::equal(oldMap.begin(),oldMap.end(),newMap.begin()))
{
this->Modified();
-
+
// Now check if keywordlist needs to be generated again
// Condition is: one of the old or new map has the skip_geom
// key and the other does not
@@ -759,7 +711,7 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
m_KeywordListUpToDate = false;
this->Modified();
}
-
+
m_FilenameHelper = helper;
}
}
@@ -781,15 +733,15 @@ ImageFileReader<TOutputImage, ConvertPixelTraits>
return this->m_ImageIO->GetOverviewsCount();
}
-
-
+
+
template <class TOutputImage, class ConvertPixelTraits>
std::vector<std::string>
ImageFileReader<TOutputImage, ConvertPixelTraits>
::GetOverviewsInfo()
{
this->UpdateOutputInformation();
-
+
return this->m_ImageIO->GetOverviewsInfo();
}
diff --git a/Modules/IO/ImageIO/include/otbImageFileWriter.txx b/Modules/IO/ImageIO/include/otbImageFileWriter.txx
index 3224f5a386..9531c69244 100644
--- a/Modules/IO/ImageIO/include/otbImageFileWriter.txx
+++ b/Modules/IO/ImageIO/include/otbImageFileWriter.txx
@@ -448,20 +448,7 @@ ImageFileWriter<TInputImage>
{
itk::ImageFileWriterException e(__FILE__, __LINE__);
std::ostringstream msg;
- msg << " Could not create IO object for file "
- << m_FileName.c_str() << std::endl;
- msg << " Tried to create one of the following:" << std::endl;
- std::list<itk::LightObject::Pointer> allobjects =
- itk::ObjectFactoryBase::CreateAllInstance("otbImageIOBase");
- for (std::list<itk::LightObject::Pointer>::iterator i = allobjects.begin();
- i != allobjects.end(); ++i)
- {
- otb::ImageIOBase* io = dynamic_cast<otb::ImageIOBase*>(i->GetPointer());
- if(io)
- msg << " " << io->GetNameOfClass() << std::endl;
- }
- msg << " You probably failed to set a file suffix, or" << std::endl;
- msg << " set the suffix to an unsupported type." << std::endl;
+ msg << "Cannot write file " << m_FileName.c_str() << " (probably unsupported or incorrect filename extension).";
e.SetDescription(msg.str().c_str());
e.SetLocation(ITK_LOCATION);
throw e;
diff --git a/Modules/IO/ImageIO/src/otbImageIOFactory.cxx b/Modules/IO/ImageIO/src/otbImageIOFactory.cxx
index 671a62d39c..1f084b6afd 100644
--- a/Modules/IO/ImageIO/src/otbImageIOFactory.cxx
+++ b/Modules/IO/ImageIO/src/otbImageIOFactory.cxx
@@ -48,38 +48,35 @@ ImageIOFactory::CreateImageIO(const char* path, FileModeType mode)
itk::ObjectFactoryBase::CreateAllInstance("otbImageIOBase");
for(std::list<itk::LightObject::Pointer>::iterator i = allobjects.begin();
i != allobjects.end(); ++i)
- {
+ {
otb::ImageIOBase* io = dynamic_cast<otb::ImageIOBase*>(i->GetPointer());
if(io)
- {
+ {
possibleImageIO.push_back(io);
- }
- else
- {
- std::cerr << "Error ImageIO factory did not return an ImageIOBase: "
- << (*i)->GetNameOfClass()
- << std::endl;
- }
}
- for(std::list<otb::ImageIOBase::Pointer>::iterator k = possibleImageIO.begin();
- k != possibleImageIO.end(); ++k)
+ else
{
+ itkGenericExceptionMacro(<< "ImageIO factory did not return an ImageIOBase but a " << (*i)->GetNameOfClass());
+ }
+ }
+
+ for(std::list<otb::ImageIOBase::Pointer>::iterator k = possibleImageIO.begin(); k != possibleImageIO.end(); ++k)
+ {
if( mode == ReadMode )
- {
+ {
if((*k)->CanReadFile(path))
- {
+ {
return *k;
- }
}
+ }
else if( mode == WriteMode )
- {
+ {
if((*k)->CanWriteFile(path))
- {
+ {
return *k;
- }
-
}
}
+ }
return ITK_NULLPTR;
}
diff --git a/Modules/Wrappers/ApplicationEngine/include/otbLogger.h b/Modules/Wrappers/ApplicationEngine/include/otbLogger.h
new file mode 100644
index 0000000000..c7a3b65b10
--- /dev/null
+++ b/Modules/Wrappers/ApplicationEngine/include/otbLogger.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2005-2017 Centre National d'Etudes Spatiales (CNES)
+ *
+ * This file is part of Orfeo Toolbox
+ *
+ * https://www.orfeo-toolbox.org/
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef otbLogger_h
+#define otbLogger_h
+
+#include "itkLoggerBase.h"
+#include "itkLogger.h"
+
+namespace otb {
+
+class Logger : public itk::Logger
+{
+public:
+ typedef Logger Self;
+ typedef itk::Logger Superclass;
+ typedef itk::SmartPointer< Self > Pointer;
+ typedef itk::SmartPointer< const Self > ConstPointer;
+
+ itkTypeMacro(Logger, Object);
+ itkNewMacro(Self);
+
+ // Overwrite this to provide custom formatting of log entries
+ std::string BuildFormattedEntry(itk::Logger::PriorityLevelType, std::string const&);
+
+protected:
+ Logger();
+ virtual ~Logger();
+}; // class Logger
+
+} // namespace otb
+
+#endif // otbLogger_h
diff --git a/Modules/Wrappers/ApplicationEngine/include/otbWrapperApplication.h b/Modules/Wrappers/ApplicationEngine/include/otbWrapperApplication.h
index 741f5c4e80..97ade53dc2 100644
--- a/Modules/Wrappers/ApplicationEngine/include/otbWrapperApplication.h
+++ b/Modules/Wrappers/ApplicationEngine/include/otbWrapperApplication.h
@@ -26,7 +26,7 @@
#include "otbWrapperTags.h"
#include "otbWrapperParameterGroup.h"
-#include "itkLogger.h"
+#include "otbLogger.h"
#include "itkTimeProbe.h"
#include "otbWrapperMacros.h"
#include "otbWrapperInputImageParameter.h"
@@ -40,6 +40,30 @@
namespace otb
{
+
+class ApplicationException : public itk::ExceptionObject
+{
+public:
+ /** Run-time information. */
+ itkTypeMacro( ApplicationException, ExceptionObject );
+
+ /** Constructor. */
+ ApplicationException(const char *file, unsigned int line,
+ const char* message = "Application error.",
+ const char* loc = "Unknown") :
+ ExceptionObject(file, line, message, loc)
+ {
+ }
+
+ /** Constructor. */
+ ApplicationException(const std::string &file, unsigned int line,
+ const char* message = "Application error.",
+ const char* loc = "Unknown") :
+ ExceptionObject(file, line, message, loc)
+ {
+ }
+};
+
namespace Wrapper
{
@@ -70,6 +94,7 @@ public:
m_Name = name;
GetDocExample()->SetApplicationName(name);
this->Modified();
+ m_Logger->SetName(name);
}
itkGetStringMacro(Name);
@@ -916,7 +941,6 @@ protected:
}
}
-
private:
/* Implement this method to add parameters */
virtual void DoInit() = 0;
@@ -938,7 +962,7 @@ private:
std::string m_Name;
std::string m_Description;
ParameterGroup::Pointer m_ParameterList;
- itk::Logger::Pointer m_Logger;
+ otb::Logger::Pointer m_Logger;
itk::ProcessObject::Pointer m_ProgressSource;
std::string m_ProgressSourceDescription;
diff --git a/Modules/Wrappers/ApplicationEngine/include/otbWrapperInputImageParameter.txx b/Modules/Wrappers/ApplicationEngine/include/otbWrapperInputImageParameter.txx
index f8aa185ced..64a620f706 100644
--- a/Modules/Wrappers/ApplicationEngine/include/otbWrapperInputImageParameter.txx
+++ b/Modules/Wrappers/ApplicationEngine/include/otbWrapperInputImageParameter.txx
@@ -56,14 +56,7 @@ InputImageParameter::GetImage()
typename ReaderType::Pointer reader = ReaderType::New();
reader->SetFileName(m_FileName);
- try
- {
- reader->UpdateOutputInformation();
- }
- catch (itk::ExceptionObject &)
- {
- this->ClearValue();
- }
+ reader->UpdateOutputInformation();
m_Image = reader->GetOutput();
m_Reader = reader;
diff --git a/Modules/Wrappers/ApplicationEngine/include/otbWrapperMacros.h b/Modules/Wrappers/ApplicationEngine/include/otbWrapperMacros.h
index 49da20449c..39e4c57d93 100644
--- a/Modules/Wrappers/ApplicationEngine/include/otbWrapperMacros.h
+++ b/Modules/Wrappers/ApplicationEngine/include/otbWrapperMacros.h
@@ -24,10 +24,15 @@
#define otbAppLogFATAL(x) \
{ \
- std::ostringstream msg; \
- msg << "" x << std::endl; \
- this->GetLogger()->Write( itk::LoggerBase::FATAL, msg.str() ); \
- itkGenericExceptionMacro(<< "Fatal error caught. Aborting..."); \
+ std::ostringstream msg; \
+ msg << "" x << std::endl; \
+ this->GetLogger()->Fatal(msg.str()); \
+ { \
+ std::ostringstream message; \
+ message << "otb::ApplicationException " x; \
+ ::otb::ApplicationException e_(__FILE__, __LINE__, message.str().c_str(), ITK_LOCATION); \
+ throw e_; /* Explicit naming to work around Intel compiler bug. */ \
+ } \
}
#define otbAppLogCRITICAL(x) \
diff --git a/Modules/Wrappers/ApplicationEngine/src/CMakeLists.txt b/Modules/Wrappers/ApplicationEngine/src/CMakeLists.txt
index 6bfea3af16..3251a05d8e 100644
--- a/Modules/Wrappers/ApplicationEngine/src/CMakeLists.txt
+++ b/Modules/Wrappers/ApplicationEngine/src/CMakeLists.txt
@@ -48,6 +48,7 @@ set(OTBApplicationEngine_SRC
otbWrapperApplicationRegistry.cxx
otbWrapperApplicationFactoryBase.cxx
otbWrapperCompositeApplication.cxx
+ otbLogger.cxx
)
add_library(OTBApplicationEngine ${OTBApplicationEngine_SRC})
diff --git a/Modules/Wrappers/ApplicationEngine/src/otbLogger.cxx b/Modules/Wrappers/ApplicationEngine/src/otbLogger.cxx
new file mode 100644
index 0000000000..da3e0e6a6e
--- /dev/null
+++ b/Modules/Wrappers/ApplicationEngine/src/otbLogger.cxx
@@ -0,0 +1,61 @@
+/*
+ * Copyright (C) 2005-2017 Centre National d'Etudes Spatiales (CNES)
+ *
+ * This file is part of Orfeo Toolbox
+ *
+ * https://www.orfeo-toolbox.org/
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "otbLogger.h"
+#include "itksys/SystemTools.hxx"
+
+namespace otb
+{
+
+Logger::Logger() :
+ itk::Logger::Logger()
+{
+}
+
+Logger::~Logger()
+{
+}
+
+std::string Logger::BuildFormattedEntry(itk::Logger::PriorityLevelType level, std::string const & content)
+{
+ static std::string m_LevelString[] = { "(MUSTFLUSH)", "(FATAL)", "(CRITICAL)",
+ "(WARNING)", "(INFO)", "(DEBUG)", "(NOTSET)" };
+ std::ostringstream s;
+
+ switch ( this->m_TimeStampFormat )
+ {
+ case REALVALUE:
+ {
+ s.precision(30);
+ s << m_Clock->GetTimeInSeconds();
+ break;
+ }
+ case HUMANREADABLE:
+ {
+ s << itksys::SystemTools::GetCurrentDateTime( this->m_HumanReadableFormat.c_str() );
+ break;
+ }
+ }
+ s << " " << m_LevelString[level] << ": " << content;
+
+ return s.str();
+}
+
+} // namespace otb
diff --git a/Modules/Wrappers/ApplicationEngine/src/otbWrapperApplication.cxx b/Modules/Wrappers/ApplicationEngine/src/otbWrapperApplication.cxx
index 9ad9107432..a8a6d3ff59 100644
--- a/Modules/Wrappers/ApplicationEngine/src/otbWrapperApplication.cxx
+++ b/Modules/Wrappers/ApplicationEngine/src/otbWrapperApplication.cxx
@@ -53,7 +53,7 @@ namespace Wrapper
Application::Application()
: m_Name(""),
m_Description(""),
- m_Logger(itk::Logger::New()),
+ m_Logger(otb::Logger::New()),
m_ProgressSourceDescription(""),
m_DocName(""),
m_DocLongDescription(""),
@@ -68,7 +68,12 @@ Application::Application()
{
// Don't call Init from the constructor, since it calls a virtual method !
m_Logger->SetName("Application.logger");
+#if OTB_DEBUG
m_Logger->SetPriorityLevel(itk::LoggerBase::DEBUG);
+#else
+ m_Logger->SetPriorityLevel(itk::LoggerBase::INFO);
+#endif
+
m_Logger->SetLevelForFlushing(itk::LoggerBase::CRITICAL);
}
@@ -199,9 +204,7 @@ void Application::SetParameterString(std::string parameter, std::string value, b
else if (dynamic_cast<InputImageParameter*>(param))
{
InputImageParameter* paramDown = dynamic_cast<InputImageParameter*>(param);
- if ( !paramDown->SetFromFileName(value) )
- otbAppLogCRITICAL( <<"Invalid image filename " << value <<".");
-
+ paramDown->SetFromFileName(value);
}
else if (dynamic_cast<ComplexInputImageParameter*>(param))
{
diff --git a/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputFilenameListParameter.cxx b/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputFilenameListParameter.cxx
index eb91c4e568..d04f55061c 100644
--- a/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputFilenameListParameter.cxx
+++ b/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputFilenameListParameter.cxx
@@ -43,38 +43,21 @@ InputFilenameListParameter::SetListFromFileName(const std::vector<std::string> &
// First clear previous file chosen
this->ClearValue();
- bool isOk = true;
for(unsigned int i=0; i<filenames.size(); i++)
{
std::string filename = filenames[i];
- // TODO : when the logger will be available, redirect the exception
- // in the logger (like what is done in MsgReporter)
// File existence checked by the reader
if (!filename.empty())
{
StringParameter::Pointer strParameter = StringParameter::New();
strParameter->SetValue(filename);
- try
- {
- strParameter->HasValue();
- }
- catch(itk::ExceptionObject & /*err*/)
- {
- this->ClearValue();
- isOk = false;
- break;
- }
+ strParameter->HasValue();
// everything went fine, store the object reference
m_FilenameList->PushBack(strParameter);
}
}
- if( !isOk )
- {
- return false;
- }
-
SetActive(true);
this->Modified();
return true;
@@ -92,22 +75,12 @@ InputFilenameListParameter::AddNullElement()
bool
InputFilenameListParameter::AddFromFileName(const std::string & filename)
{
- // TODO : when the logger will be available, redirect the exception
- // in the logger (like what is done in MsgReporter)
// File existence checked by the reader
if (!filename.empty())
{
StringParameter::Pointer strParameter = StringParameter::New();
strParameter->SetValue(filename);
- try
- {
- strParameter->HasValue();
- }
- catch(itk::ExceptionObject & /*err*/)
- {
- this->ClearValue();
- return false;
- }
+ strParameter->HasValue();
// everything went fine, store the object references
m_FilenameList->PushBack(strParameter);
@@ -127,22 +100,12 @@ InputFilenameListParameter::SetNthFileName( const unsigned int id, const std::st
itkExceptionMacro(<< "No file "<<id<<". Only "<<m_FilenameList->Size()<<" filenames available.");
}
- // TODO : when the logger will be available, redirect the exception
- // in the logger (like what is done in MsgReporter)
// File existence checked by the reader
if (!filename.empty())
{
StringParameter::Pointer strParameter = StringParameter::New();
strParameter->SetValue(filename);
- try
- {
- strParameter->HasValue();
- }
- catch(itk::ExceptionObject &)
- {
- this->ClearValue();
- return false;
- }
+ strParameter->HasValue();
m_FilenameList->SetNthElement(id, strParameter);
diff --git a/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageListParameter.cxx b/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageListParameter.cxx
index 01be700ea7..1e0dc32da9 100644
--- a/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageListParameter.cxx
+++ b/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageListParameter.cxx
@@ -202,19 +202,10 @@ void
InputImageListParameter::SetImageList(FloatVectorImageListType* imList)
{
// Check input availability
- // TODO : when the logger will be available, redirect the exception
- // in the logger (like what is done in MsgReporter)
- try
- {
- for(unsigned int i=0; i<imList->Size(); i++)
- {
- imList->GetNthElement( i )->UpdateOutputInformation();
- }
- }
- catch(itk::ExceptionObject &)
- {
- return;
- }
+ for(unsigned int i = 0; i < imList->Size(); i++)
+ {
+ imList->GetNthElement(i)->UpdateOutputInformation();
+ }
// Clear previous values
this->ClearValue();
@@ -223,13 +214,13 @@ InputImageListParameter::SetImageList(FloatVectorImageListType* imList)
{
// Try to build a new ParameterInputImage
InputImageParameter::Pointer tmpInputImageParameter = InputImageParameter::New();
-
+
tmpInputImageParameter->SetImage(imList->GetNthElement(i));
-
+
m_InputImageParameterVector.push_back(tmpInputImageParameter);
m_ImageList->PushBack(tmpInputImageParameter->GetFloatVectorImage());
}
-
+
SetActive(true);
this->Modified();
}
@@ -237,21 +228,16 @@ InputImageListParameter::SetImageList(FloatVectorImageListType* imList)
void InputImageListParameter::SetNthImage(unsigned int i, ImageBaseType * img)
{
if(m_ImageList->Size()<i)
- {
+ {
itkExceptionMacro(<< "No image "<<i<<". Only "<<m_ImageList->Size()<<" images available.");
- }
- try
- {
- img->UpdateOutputInformation();
- }
- catch(itk::ExceptionObject &)
- {
- return;
- }
-
+ }
+
+ // Check input availability
+ img->UpdateOutputInformation();
+
// Try to build a new ParameterInputImage
InputImageParameter::Pointer tmpInputImageParameter = InputImageParameter::New();
-
+
tmpInputImageParameter->SetImage(img);
m_InputImageParameterVector[i] = tmpInputImageParameter;
@@ -263,21 +249,12 @@ void
InputImageListParameter::AddImage(ImageBaseType* image)
{
// Check input availability
- // TODO : when the logger will be available, redirect the exception
- // in the logger (like what is done in MsgReporter)
- try
- {
- image->UpdateOutputInformation();
- }
- catch(itk::ExceptionObject &)
- {
- return;
- }
+ image->UpdateOutputInformation();
InputImageParameter::Pointer tmpInputImageParameter = InputImageParameter::New();
-
+
tmpInputImageParameter->SetImage(image);
-
+
m_InputImageParameterVector.push_back(tmpInputImageParameter);
m_ImageList->PushBack(tmpInputImageParameter->GetFloatVectorImage());
diff --git a/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageParameter.cxx b/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageParameter.cxx
index dcd9d21528..08c0e1c362 100644
--- a/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageParameter.cxx
+++ b/Modules/Wrappers/ApplicationEngine/src/otbWrapperInputImageParameter.cxx
@@ -53,27 +53,10 @@ InputImageParameter::SetFromFileName(const std::string& filename)
// - Done in the reader
// - allow appending additional information to the filename
// myfile.tif:2 for example, or myfile.tif:nocarto
- if (!filename.empty())
- {
- FloatVectorReaderType::Pointer reader = FloatVectorReaderType::New();
-
- try
- {
- reader->SetFileName(filename);
- reader->UpdateOutputInformation();
- }
- catch(itk::ExceptionObject & /*err*/)
- {
- return false;
- }
-
- // the specified filename is valid => store the value
- m_FileName = filename;
- m_UseFilename = true;
- SetActive(true);
- return true;
- }
- return false;
+ m_FileName = filename;
+ m_UseFilename = true;
+ SetActive(true);
+ return true;
}
diff --git a/Modules/Wrappers/CommandLine/src/otbWrapperCommandLineLauncher.cxx b/Modules/Wrappers/CommandLine/src/otbWrapperCommandLineLauncher.cxx
index d1cc388ebd..fa1ec13636 100644
--- a/Modules/Wrappers/CommandLine/src/otbWrapperCommandLineLauncher.cxx
+++ b/Modules/Wrappers/CommandLine/src/otbWrapperCommandLineLauncher.cxx
@@ -49,6 +49,8 @@
#include <string>
#include <iostream>
+using std::string;
+
namespace otb
{
namespace Wrapper
@@ -96,18 +98,19 @@ bool CommandLineLauncher::Load()
{
if (m_VExpression.empty())
{
- itkExceptionMacro("No expression specified...");
+ std::cerr << "ERROR: No expression specified." << std::endl;
+ return false;
}
if (this->CheckParametersPrefix() == false)
{
- std::cerr << "ERROR: Parameter keys have to set using \"-\", not \"--\"" << std::endl;
+ std::cerr << "ERROR: Parameter keys have to set using \"-\", not \"--\"." << std::endl;
return false;
}
if (this->CheckUnicity() == false)
{
- std::cerr << "ERROR: At least one key is not unique in the expression..." << std::endl;
+ std::cerr << "ERROR: At least one key is not unique in the expression." << std::endl;
return false;
}
@@ -116,7 +119,7 @@ bool CommandLineLauncher::Load()
if (m_Parser->GetPathsAsString(m_VExpression).size() != 0)
{
std::cerr << "ERROR: At least one specified path within \"" << m_Parser->GetPathsAsString(m_VExpression)
- << "\" is invalid or doesn't exist..." << std::endl;
+ << "\" is invalid or doesn't exist." << std::endl;
return false;
}
}
@@ -145,31 +148,54 @@ bool CommandLineLauncher::Execute()
bool CommandLineLauncher::ExecuteAndWriteOutput()
{
try
- {
+ {
if (this->BeforeExecute() == false)
- {
+ {
return false;
- }
+ }
if( m_Application->ExecuteAndWriteOutput() == 0 )
- {
+ {
this->DisplayOutputParameters();
- }
+ }
else
+ {
return false;
}
+ }
+ catch(otb::ApplicationException& err)
+ {
+ // These are thrown with otbAppLogFATAL, a macro which logs a user
+ // friendly error message before throwing. So log exception details only
+ // in debug.
+ m_Application->GetLogger()->Debug("Caught otb::ApplicationException during application execution:\n");
+ m_Application->GetLogger()->Debug(string(err.what()) + "\n");
+ return false;
+ }
+ catch(otb::ImageFileReaderException& err)
+ {
+ m_Application->GetLogger()->Debug("Caught otb::ImageFileReaderException during application execution:\n");
+ m_Application->GetLogger()->Debug(string(err.what()) + "\n");
+ m_Application->GetLogger()->Fatal(string("Cannot open file ") + err.m_Filename + string(". ") + err.GetDescription() + string("\n"));
+ return false;
+ }
+ catch(itk::ExceptionObject& err)
+ {
+ m_Application->GetLogger()->Debug("Caught itk::ExceptionObject during application execution:\n");
+ m_Application->GetLogger()->Debug(string(err.what()) + "\n");
+ m_Application->GetLogger()->Fatal(string(err.GetDescription()) + "\n");
+ return false;
+ }
catch(std::exception& err)
- {
- std::ostringstream message;
- message << "The following error occurred during application execution : " << err.what() << std::endl;
- m_Application->GetLogger()->Write( itk::LoggerBase::FATAL, message.str() );
+ {
+ m_Application->GetLogger()->Fatal(std::string("Caught std::exception during application execution: ") + err.what() + "\n");
return false;
- }
+ }
catch(...)
- {
- m_Application->GetLogger()->Write( itk::LoggerBase::FATAL, "An unknown exception has been raised during application execution" );
+ {
+ m_Application->GetLogger()->Fatal("Caught unknown exception during application execution.\n");
return false;
- }
+ }
return true;
}
@@ -177,10 +203,10 @@ bool CommandLineLauncher::ExecuteAndWriteOutput()
bool CommandLineLauncher::BeforeExecute()
{
if (m_Application.IsNull())
- {
- std::cerr << "ERROR: No loaded application..." << std::endl;
+ {
+ std::cerr << "ERROR: No loaded application." << std::endl;
return false;
- }
+ }
// Check if there's keys in the expression if the application takes
// at least 1 mandatory parameter
@@ -189,7 +215,7 @@ bool CommandLineLauncher::BeforeExecute()
if( appKeyList.size()!=0 && keyList.size()==0 )
{
- std::cerr << "ERROR: Waiting for at least one parameter..." << std::endl;
+ std::cerr << "ERROR: Waiting for at least one parameter." << std::endl;
this->DisplayHelp();
return false;
}
@@ -218,64 +244,21 @@ bool CommandLineLauncher::BeforeExecute()
std::string unknownKey;
if (this->CheckKeyValidity(unknownKey) == false)
{
- std::cerr << "ERROR: option -"<<unknownKey<<" does not exist in the application." << std::endl;
- this->DisplayHelp();
+ std::cerr << "ERROR: Parameter -" << unknownKey <<" does not exist in the application." << std::endl;
return false;
}
- try
- {
- if (this->LoadParameters() != OKPARAM)
- {
- std::cerr << "ERROR: Troubles loading parameter, please check your line argument..." << std::endl;
- // Force to reload the application, the LoadParameters can change wrong values
- this->LoadApplication();
- m_Application->Init();
- this->DisplayHelp();
- return false;
- }
- }
- catch (itk::ExceptionObject& err)
- {
- std::cerr << "ERROR: Troubles in parameter setting, please check your line argument..." << std::endl;
- std::cerr << err.GetDescription() << std::endl;
- // Force to reload the application, the LoadParameters can change wrong values
- this->LoadApplication();
- m_Application->Init();
- this->DisplayHelp();
+ ParamResultType result = this->LoadParameters();
+ if (result == MISSINGMANDATORYPARAMETER)
+ {
+ this->DisplayHelp();
return false;
- }
-
- // Check for the progress report
- if (m_Parser->IsAttributExists("-progress", m_VExpression) == true)
- {
- std::vector<std::string> val;
- val = m_Parser->GetAttribut("-progress", m_VExpression);
- if (val.size() != 1)
- {
- std::cerr << "ERROR: Invalid progress argument, must be unique value..." << std::endl;
- return false;
- }
- if (val[0] == "1" || val[0] == "true")
- {
- m_ReportProgress = true;
- }
- else
- if (val[0] == "0" || val[0] == "false")
- {
- m_ReportProgress = false;
- }
- else
- {
- std::cerr << "ERROR: Invalid progress argument, must be 0, 1, false or true..." << std::endl;
- // Force to reload the application, the LoadParameters can change wrong values
- this->LoadApplication();
- this->DisplayHelp();
-
- return false;
- }
- }
+ }
+ else if (result != OKPARAM)
+ {
+ return false;
+ }
return true;
}
@@ -307,7 +290,7 @@ void CommandLineLauncher::LoadApplication()
//if (m_Parser->GetModuleName(moduleName, m_Expression) != CommandLineParser::OK)
if (m_Parser->GetModuleName(moduleName, m_VExpression) != CommandLineParser::OK)
{
- std::cerr << "ERROR: LoadApplication, no module found..." << std::endl;
+ std::cerr << "ERROR: LoadApplication, no module found." << std::endl;
return;
}
@@ -338,6 +321,7 @@ void CommandLineLauncher::LoadApplication()
{
// Attach log output to the Application logger
m_Application->GetLogger()->SetTimeStampFormat(itk::LoggerBase::HUMANREADABLE);
+ m_Application->GetLogger()->SetHumanReadableFormat("%Y-%m-%d %H:%M:%S");
m_Application->GetLogger()->AddLogOutput(m_LogOutput);
// Add an observer to the AddedProcess event
@@ -367,6 +351,25 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
m_Application->UpdateParameters();
}
+ // Check for the progress report parameter
+ if (m_Parser->IsAttributExists("-progress", m_VExpression) == true)
+ {
+ std::vector<std::string> val = m_Parser->GetAttribut("-progress", m_VExpression);
+ if (val.size() == 1 && (val[0] == "1" || val[0] == "true"))
+ {
+ m_ReportProgress = true;
+ }
+ else if (val.size() == 1 && (val[0] == "0" || val[0] == "false"))
+ {
+ m_ReportProgress = false;
+ }
+ else
+ {
+ std::cerr << "ERROR: Invalid value for parameter -progress. It must be 0, 1, false or true." << std::endl;
+ return WRONGPARAMETERVALUE;
+ }
+ }
+
const std::vector<std::string> appKeyList = m_Application->GetParametersKeys(true);
// Loop over each parameter key declared in the application
// FIRST PASS : set parameter values
@@ -393,8 +396,7 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
// Check if there is a value associated to the attribute
if ( values.empty() )
{
- std::cerr << "ERROR: No value associated to the parameter : \"" << paramKey
- << "\", invalid number of values " << values.size() << std::endl;
+ std::cerr << "ERROR: No value associated to parameter -" << paramKey << "." << std::endl;
return INVALIDNUMBEROFVALUE;
}
@@ -449,16 +451,16 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
else if (values[1] == "double")
outPixType = ImagePixelType_double;
else
- {
+ {
+ std::cerr << "ERROR: Invalid output type for parameter -" << paramKey << ": " << values[1] << "." << std::endl;
return WRONGPARAMETERVALUE;
- }
+ }
dynamic_cast<OutputImageParameter *> (param.GetPointer())->SetPixelType(outPixType);
}
else
- if (values.size() != 1 && values.size() != 2)
+ if (values.size() > 2)
{
- std::cerr << "ERROR: Invalid number of value for: \"" << paramKey
- << "\", invalid number of values " << values.size() << std::endl;
+ std::cerr << "ERROR: Too many values for parameter -" << paramKey << " (expected 2 or less, got " << values.size() << ")." << std::endl;
return INVALIDNUMBEROFVALUE;
}
}
@@ -474,9 +476,10 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
else if (values[1] == "cdouble")
outPixType = ComplexImagePixelType_double;
else
- {
+ {
+ std::cerr << "ERROR: Invalid output type for parameter -" << paramKey << ": " << values[1] << "." << std::endl;
return WRONGPARAMETERVALUE;
- }
+ }
dynamic_cast<ComplexOutputImageParameter *> (param.GetPointer())->SetComplexPixelType(outPixType);
}
else
@@ -551,7 +554,7 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
}
else
{
- std::cerr << "ERROR: Wrong parameter value: " << paramKey << std::endl;
+ std::cerr << "ERROR: Wrong value for parameter -" << paramKey << "." << std::endl;
return WRONGPARAMETERVALUE;
}
}
@@ -614,27 +617,26 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
}
if( mustBeSet )
- {
+ {
if (!paramExists)
- {
+ {
// If key doesn't exist and parameter hasn't default value set...
if (!hasValue)
- {
- std::cerr << "ERROR: Missing mandatory parameter: " << paramKey << " " << m_Application->HasValue(paramKey)
- << std::endl;
+ {
+ std::cerr << "ERROR: Missing mandatory parameter -" << paramKey << "." << std::endl;
return MISSINGMANDATORYPARAMETER;
- }
}
+ }
else
- {
+ {
values = m_Parser->GetAttribut(std::string("-").append(paramKey), m_VExpression);
if (values.size() == 0 && !m_Application->HasValue(paramKey))
- {
- std::cerr << "ERROR: Missing mandatory parameter: " << paramKey << std::endl;
+ {
+ std::cerr << "ERROR: Missing mandatory parameter -" << paramKey << "." << std::endl;
return MISSINGPARAMETERVALUE;
- }
}
}
+ }
// Check if non mandatory parameter have values
else
{
@@ -643,7 +645,7 @@ CommandLineLauncher::ParamResultType CommandLineLauncher::LoadParameters()
values = m_Parser->GetAttribut(std::string("-").append(paramKey), m_VExpression);
if (values.size() == 0)
{
- std::cerr << "ERROR: Missing non-mandatory parameter: " << paramKey << std::endl;
+ std::cerr << "ERROR: Missing non-mandatory parameter -" << paramKey << "." << std::endl;
return MISSINGPARAMETERVALUE;
}
}
--
GitLab