itkMacro.h File Reference

Go to the source code of this file.

Namespaces
namespace	itk
Defines
#define	itkNotUsed(x)
#define	itkStaticConstMacro(name, type, value)   static const type name = value
#define	itkGetStaticConstMacro(name)   (Self::name)
#define	itkGetStringMacro(name)
#define	itkGetVectorMacro(name, type, count)
#define	itkTypeMacro(thisClass, superclass)
#define	itkGenericExceptionMacro(x)
#define	itkGenericOutputMacro(x)

---

Define Documentation

#define itkBooleanMacro (  name    )

Value: virtual void name##On () { this->Set##name(true);} \ virtual void name##Off () { this->Set##name(false);} Create members "name"On() and "name"Off() (e.g., DebugOn() DebugOff()). Set method must be defined to use this macro. Definition at line 261 of file itkMacro.h.

#define itkDebugMacro (  x    )

Value: { if (this->GetDebug() && itk::Object::GetGlobalWarningDisplay()) \ { ::itk::OStringStream itkmsg; \ itkmsg << "Debug: In " __FILE__ ", line " << __LINE__ << "\n" \ << this->GetNameOfClass() << " (" << this << "): " x \ << "\n\n"; \ ::itk::OutputWindowDisplayDebugText(itkmsg.str().c_str());} \ } 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 362 of file itkMacro.h.

#define itkExceptionMacro (  x    )

Value: { \ ::itk::OStringStream message; \ message << "itk::ERROR: " << this->GetNameOfClass() \ << "(" << this << "): " x; \ throw ::itk::ExceptionObject(__FILE__, __LINE__, message.str().c_str()); \ } The exception macro is used to print error information (i.e., usually a condition that results in program failure). Example usage looks like: itkExceptionMacro(<< "this is error info" << this->SomeVariable); Definition at line 447 of file itkMacro.h. Referenced by itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetNumberOfWeights(), itk::Transform< TScalarType, 3, 2 >::GetParameters(), itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField >::SetInitialDeformationField(), itk::WatershedImageFilter< TInputImage >::SetInput(), and itk::Transform< TScalarType, 3, 2 >::SetParameters().

#define itkFactorylessNewMacro (  x    )

Value: static Pointer New(void) \ { \ Pointer smartPtr; \ x *rawPtr = new x; \ smartPtr = rawPtr; \ rawPtr->UnRegister(); \ return smartPtr; \ } Define the virtual constructor without object factory creation method. This routine assigns the raw pointer to a smart pointer and then calls UnRegister() on the rawPtr to compensate for LightObject's constructor initializing an object's reference count to 1 (needed for proper initialization of process objects and data objects cycles). Definition at line 322 of file itkMacro.h.

#define itkGenericExceptionMacro (  x    )

Value: { \ ::itk::OStringStream message; \ message << "itk::ERROR: " x; \ throw ::itk::ExceptionObject(__FILE__, __LINE__, message.str().c_str()); \ } Definition at line 456 of file itkMacro.h.

#define itkGenericOutputMacro (  x    )

Value: { if (::itk::Object::GetGlobalWarningDisplay()) \ { ::itk::OStringStream itkmsg; \ itkmsg << "WARNING: In " __FILE__ ", line " << __LINE__ << "\n" \ x << "\n\n"; \ itk::OutputWindowDisplayGenericOutputText(itkmsg.str().c_str());} \ } Definition at line 466 of file itkMacro.h. Referenced by itk::ConstRandomAccessNeighborhoodIterator< TImage >::ConstRandomAccessNeighborhoodIterator(), itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >::ConstSmartNeighborhoodIterator(), itk::RandomAccessNeighborhoodIterator< TImage >::RandomAccessNeighborhoodIterator(), and itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >::SmartNeighborhoodIterator().

#define itkGetConstMacro (  name, type    )

Value: virtual type Get##name () const \ { \ itkDebugMacro("returning " << #name " of " << this->m_##name ); \ return this->m_##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 132 of file itkMacro.h.

#define itkGetConstObjectMacro (  name, type    )

Value: virtual const type * Get##name () const \ { \ itkDebugMacro("returning " #name " address " << this->m_##name ); \ return this->m_##name.GetPointer(); \ } Get a smart const pointer to an object. Creates the member Get"name"() (e.g., GetPoints()). Definition at line 241 of file itkMacro.h.

#define itkGetConstReferenceMacro (  name, type    )

Value: virtual const type & Get##name () const \ { \ itkDebugMacro("returning " << #name " of " << this->m_##name ); \ return this->m_##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 144 of file itkMacro.h.

#define itkGetConstReferenceObjectMacro (  name, type    )

Value: virtual const typename type::Pointer & Get##name () const \ { \ itkDebugMacro("returning " #name " address " << this->m_##name ); \ return this->m_##name; \ } Get a const reference to a smart pointer to an object. Creates the member Get"name"() (e.g., GetPoints()). Definition at line 251 of file itkMacro.h.

#define itkGetMacro (  name, type    )

Value: virtual type Get##name () \ { \ itkDebugMacro("returning " << #name " of " << this->m_##name ); \ return this->m_##name; \ } Get built-in type. Creates member Get"name"() (e.g., GetVisibility()); Definition at line 121 of file itkMacro.h.

#define itkGetObjectMacro (  name, type    )

Value: virtual type * Get##name () \ { \ itkDebugMacro("returning " #name " address " << this->m_##name ); \ return this->m_##name.GetPointer(); \ } Get a smart pointer to an object. Creates the member Get"name"() (e.g., GetPoints()). Definition at line 214 of file itkMacro.h.

#define itkGetStaticConstMacro (  name    )     (Self::name)

Definition at line 103 of file itkMacro.h. Referenced by itk::Statistics::GaussianGoodnessOfFitComponent< TInputSample >::GetNumberOfParameters().

#define itkGetStringMacro (  name    )

Value: virtual const char* Get##name () const \ { \ return this->m_##name.c_str(); \ } Get character string. Creates member Get"name"() (e.g., SetFilename(char *)). The macro assumes that the class member (name) is declared a type std::string. Definition at line 175 of file itkMacro.h.

#define itkGetVectorMacro (  name, type, count    )

Value: virtual type *Get##name () const \ { \ return this->m_##name; \ } Get vector macro. Returns pointer to type (i.e., array of type). This is for efficiency. Definition at line 284 of file itkMacro.h.

#define itkNewMacro (  x    )

Value: static Pointer New(void) \ { \ Pointer smartPtr; \ x *rawPtr = ::itk::ObjectFactory<x>::Create(); \ if(rawPtr == NULL) \ { \ rawPtr = new x; \ } \ smartPtr = rawPtr; \ rawPtr->UnRegister(); \ return smartPtr; \ } Define the standard object factory creation method. This macro simply takes the type for which the New() method is being defined. This creation method first tries asking the object factory to create an instance, and then defaults to the standard "new" operator if the factory fails. This routine assigns the raw pointer to a smart pointer and then calls UnRegister() on the rawPtr to compensate for LightObject's constructor initializing an object's reference count to 1 (needed for proper initialization of process objects and data objects cycles). Definition at line 301 of file itkMacro.h.

#define itkNotUsed (  x    )

A convenience macro marks variables as not being used by a method, avoiding compile-time warnings. Definition at line 64 of file itkMacro.h.

#define itkSetClampMacro (  name, type, min, max    )

Value: virtual void Set##name (type _arg) \ { \ itkDebugMacro("setting " << #name " to " << _arg ); \ if (this->m_##name != (_arg<min?min:(_arg>max?max:_arg))) \ { \ this->m_##name = (_arg<min?min:(_arg>max?max:_arg)); \ this->Modified(); \ } \ } Set built-in type where value is constrained between min/max limits. Create member Set"name"() (e.q., SetRadius()). defines are convienience for clamping open-ended values. Definition at line 184 of file itkMacro.h.

#define itkSetConstObjectMacro (  name, type    )

Value: virtual void Set##name (const type* _arg) \ { \ itkDebugMacro("setting " << #name " to " << _arg ); \ if (this->m_##name != _arg) \ { \ this->m_##name = _arg; \ this->Modified(); \ } \ } Set const pointer to object; uses Object reference counting methodology. Creates method Set"name"() (e.g., SetPoints()). Note that using smart pointers requires using real pointers when setting input, but returning smart pointers on output. Definition at line 226 of file itkMacro.h.

#define itkSetMacro (  name, type    )

Value: virtual void Set##name (const type _arg) \ { \ itkDebugMacro("setting " #name " to " << _arg); \ if (this->m_##name != _arg) \ { \ this->m_##name = _arg; \ this->Modified(); \ } \ } Set built-in type. Creates member Set"name"() (e.g., SetVisibility()); Definition at line 108 of file itkMacro.h.

#define itkSetObjectMacro (  name, type    )

Value: virtual void Set##name (type* _arg) \ { \ itkDebugMacro("setting " << #name " to " << _arg ); \ if (this->m_##name != _arg) \ { \ this->m_##name = _arg; \ this->Modified(); \ } \ } Set pointer to object; uses Object reference counting methodology. Creates method Set"name"() (e.g., SetPoints()). Note that using smart pointers requires using real pointers when setting input, but returning smart pointers on output. Definition at line 200 of file itkMacro.h.

#define itkSetStringMacro (  name    )

Value: virtual void Set##name (const char* _arg) \ { \ if ( _arg && (_arg == this->m_##name) ) { return;} \ if (_arg) \ { \ this->m_##name = _arg;\ } \ else \ { \ this->m_##name = ""; \ } \ this->Modified(); \ } Set character string. Creates member Set"name"() (e.g., SetFilename(char *)). The macro assumes that the class member (name) is declared a type std::string. Definition at line 155 of file itkMacro.h.

#define itkSetVectorMacro (  name, type, count    )

Value: virtual void Set##name(type data[]) \ { \ unsigned int i; \ for (i=0; i<count; i++) { if ( data[i] != this->m_##name[i] ) { break; }} \ if ( i < count ) \ { \ this->Modified(); \ for (i=0; i<count; i++) { this->m_##name[i] = data[i]; }\ } \ } General set vector macro creates a single method that copies specified number of values into object. Examples: void SetColor(c,3) Definition at line 269 of file itkMacro.h.

#define itkStaticConstMacro (  name, type, value    )     static const type name = value

Macro to initialize static constants. This is used frequently to replace the use of enum's within a class. Some compilers do not allow an enum of one class to be passed as template argument to another class. Other uses of this macro as possible. This is based (verbatim) on the BOOST_STATIC_CONSTANT macro. The original Boost documentation is below. BOOST_STATIC_CONSTANT workaround --------------------------------------- // On compilers which don't allow in-class initialization of static integral constant members, we must use enums as a workaround if we want the constants to be available at compile-time. This macro gives us a convenient way to declare such constants. Definition at line 97 of file itkMacro.h.

#define itkTypeMacro (  thisClass, superclass    )

Value: virtual const char *GetNameOfClass() const \ {return #thisClass;} Macro used to add standard methods to all classes, mainly type information. Definition at line 335 of file itkMacro.h.

#define itkWarningMacro (  x    )

Value: { if (itk::Object::GetGlobalWarningDisplay()) \ { ::itk::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 380 of file itkMacro.h.

---