Namespaces
namespace	otb
	The "otb" namespace contains all Orfeo Toolbox (OTB) classes There are several nested namespaces withing the otb:: namespace.

Macros
#define	otbControlConditionTestMacro(condition, message)
#define	otbDebugMacro(x) itkDebugMacro(x)
#define	otbGenericExceptionMacro(T, x)
#define	otbGenericMsgDebugMacro(x)
#define	otbGenericMsgTestingMacro(x)
#define	otbGenericWarningMacro(x)
#define	otbGetObjectMemberConstMacro(object, name, type)
#define	otbGetObjectMemberConstReferenceMacro(object, name, type)
#define	otbGetObjectMemberMacro(object, name, type)
#define	otbMsgDebugMacro(x)
#define	otbMsgDevMacro(x)
#define	otbSetObjectMemberMacro(object, name, type)
#define	otbTestingCheckNotValidCommand(command)
#define	otbTestingCheckValidCommand(command)
#define	otbWarningMacro(x)

Macro Definition Documentation

#define otbControlConditionTestMacro	(	condition,
		message
	)

Value:

{ \
    if ((condition)) itkGenericExceptionMacro(<< message); \
    }

This macro is used to control condition. It use ONLY by the OTB developers

Definition at line 124 of file otbMacro.h.

#define otbDebugMacro ( x ) itkDebugMacro(x)

This macro is used to print debug (or other information). They are also used to catch errors, etc. Example usage looks like: itkDebugMacro(<< "this is debug info" << this->SomeVariable);

Definition at line 44 of file otbMacro.h.

Referenced by otb::HooverInstanceFilter< TLabelMap >::AfterThreadedGenerateData(), otb::PointSetFileReader< TOutputPointSet >::GenerateData(), otb::PointSetFileReader< TOutputPointSet >::GenerateOutputInformation(), and otb::Wrapper::Application::IsApplicationReady().

#define otbGenericExceptionMacro	(	T,
		x
	)

Value:

{ \
  ::itk::OStringStream message; \
  message << "otb::ERROR: " x; \
  T e_(__FILE__, __LINE__, message.str(),ITK_LOCATION); \
  throw e_;\
}

Definition at line 188 of file otbMacro.h.

#define otbGenericMsgDebugMacro ( x )

Value:

{  \
    if (::itk::Object::GetGlobalWarningDisplay())   \
      { \
      std::ostringstream itkmsg; \
      itkmsg << " Generic Msg Debug: " x << "\n"; \
      ::itk::OutputWindowDisplayDebugText(itkmsg.str().c_str()); \
      } \
    }

Definition at line 65 of file otbMacro.h.

#define otbGenericMsgTestingMacro ( x )

Value:

{  \
    std::cout x << std::endl; \
    }

Definition at line 78 of file otbMacro.h.

#define otbGenericWarningMacro ( x )

Value:

{ \
    if (itk::Object::GetGlobalWarningDisplay()) \
      { \
      std::ostringstream itkmsg; \
      itkmsg << "WARNING: In " __FILE__ ", line " << __LINE__ << ": " x <<"\n";\
      itk::OutputWindowDisplayWarningText(itkmsg.str().c_str()); \
      } \
    }

Definition at line 111 of file otbMacro.h.

Referenced by otb::RPCSolverAdapter::Solve().

#define otbGetObjectMemberConstMacro	(	object,
		name,
		type
	)

Value:

virtual type Get ## name () const \
    { \
    itkDebugMacro("returning " << # name " of " << this->m_ ## object->Get ## name()); \
    return this->m_ ## object->Get ## name(); \
    }

Get built-in type. Creates member Get"name"() (e.g., GetVisibility()); This is the "const" form of the itkGetMacro. It should be used unless the member can be changed through the "Get" access routine.

Definition at line 149 of file otbMacro.h.

#define otbGetObjectMemberConstReferenceMacro	(	object,
		name,
		type
	)

Value:

virtual const type &Get ## name () const \
    { \
    itkDebugMacro("returning " << # name " of " << this->m_ ## object->Get ## name()); \
    return this->m_ ## object->Get ## name(); \
    }

Get built-in type. Creates member Get"name"() (e.g., GetVisibility()); This is the "const" form of the itkGetMacro. It should be used unless the member can be changed through the "Get" access routine. This versions returns a const reference to the variable.

Definition at line 160 of file otbMacro.h.

#define otbGetObjectMemberMacro	(	object,
		name,
		type
	)

Value:

virtual type Get ## name () \
    { \
    itkDebugMacro("returning " << # name " of " << this->m_ ## object->Get ## name()); \
    return this->m_ ## object->Get ## name(); \
    }

Get built-in type. Creates member Get"name"() (e.g., GetVisibility());

Definition at line 139 of file otbMacro.h.

#define otbMsgDebugMacro ( x )

Value:

{ \
    if (this->GetDebug() && ::itk::Object::GetGlobalWarningDisplay())   \
      { \
      std::ostringstream itkmsg; \
      itkmsg << " Msg Debug: " x << "\n"; \
      ::itk::OutputWindowDisplayDebugText(itkmsg.str().c_str()); \
      } \
    }

Definition at line 53 of file otbMacro.h.

#define otbMsgDevMacro ( x )

Definition at line 93 of file otbMacro.h.

#define otbSetObjectMemberMacro	(	object,
		name,
		type
	)

Value:

virtual void Set ## name (const type _arg) \
    { \
    itkDebugMacro("setting member " # name " to " << _arg); \
    this->m_ ## object->Set ## name(_arg); \
    this->Modified(); \
    }

Set built-in type. Creates member Set"name"() (e.g., SetVisibility());

Definition at line 130 of file otbMacro.h.

#define otbTestingCheckNotValidCommand ( command )

Value:

{ \
    int result(1); \
    try \
      { \
      command; \
      } \
    catch (std::bad_alloc& err)     { \
      throw err; } \
    catch (itk::ExceptionObject&) { std::cout << "Checking not valid Command " << # command " ok." << std::endl; \
                                    result = 0; } \
    catch (const std::exception& stde)   { \
      throw stde; } \
    catch (...) \
      { \
      std::ostringstream message; \
      message << "otb::ERROR Unknow error while running " << # command << " (catch(...) )"; \
      ::itk::ExceptionObject e_(__FILE__, __LINE__, message.str().c_str(), ITK_LOCATION); \
      throw e_; \
      } \
    if (result == 1) \
      { \
      std::ostringstream message; \
      message << "otb::ERROR: " << # command << " should be throwing an exception."; \
      ::itk::ExceptionObject e_(__FILE__, __LINE__, message.str().c_str(), ITK_LOCATION); \
      throw e_; \
      } \
    }

Definition at line 196 of file otbMacro.h.

#define otbTestingCheckValidCommand ( command )

Value:

{ \
    try \
      { \
      command; \
      } \
    catch (const std::exception&)   { \
      throw; } \
    catch (...) \
      { \
      std::ostringstream message; \
      message << "otb::ERROR Unknow error while running " << # command << " (catch(...) )"; \
      ::itk::ExceptionObject e_(__FILE__, __LINE__, message.str().c_str(), ITK_LOCATION); \
      throw e_; \
      } \
    std::cout << " Checking valid command " << # command " ok." << std::endl; \
    }

Testing macro. This macro doesn't throw a exception if the called command generate a itk::ExceptionObject object. For alls others use cases, the macro generate a exception.

Definition at line 170 of file otbMacro.h.

#define otbWarningMacro ( x )

Value:

{ \
    if (itk::Object::GetGlobalWarningDisplay()) \
      { \
      std::ostringstream itkmsg; \
      itkmsg << "WARNING: In " __FILE__ ", line " << __LINE__ << "\n" \
             << this->GetNameOfClass() << " (" << this << "): " x  \
             << "\n\n"; \
      itk::OutputWindowDisplayWarningText(itkmsg.str().c_str()); \
      } \
    }

This macro is used to print warning information (i.e., unusual circumstance but not necessarily fatal.) Example usage looks like: itkWarningMacro(<< "this is warning info" << this->SomeVariable);

Definition at line 99 of file otbMacro.h.

Referenced by otb::BandMathImageFilter< TImage >::AfterThreadedGenerateData(), otb::HooverInstanceFilter< TLabelMap >::BeforeThreadedGenerateData(), otb::OGRIOHelper::ConvertOGRLayerToDataTreeNode(), otb::OGRLayerStreamStitchingFilter< TInputImage >::ProcessStreamingLine(), otb::JPEG2000ImageIO::ReadImageInformation(), otb::LabelMapToAttributeImageFilter< TInputImage, TOutputImage, TAttributeAccessor >::SetAttributeForNthChannel(), otb::HooverInstanceFilter< TLabelMap >::ThreadedProcessLabelObject(), and otb::ImageFileWriter< TInputImage >::Update().

Namespaces

Macros

Macro Definition Documentation