itk::ThreadLogger Class Reference

Class ThreadLogger is meant for providing logging service as a separate thread. More...

#include <itkThreadLogger.h>

Inheritance diagram for itk::ThreadLogger:

Collaboration diagram for itk::ThreadLogger:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
enum	OperationType {   SET_PRIORITY_LEVEL,   SET_LEVEL_FOR_FLUSHING,   ADD_LOG_OUTPUT,   WRITE,   FLUSH }
typedef Logger::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Logger::PriorityLevelType	PriorityLevelType
typedef ThreadLogger	Self
typedef Logger	Superclass
enum	TimeStampFormatType {   REALVALUE = 0,   HUMANREADABLE }

Public Member Functions
virtual void	AddLogOutput (OutputType *output)
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual std::string	BuildFormattedEntry (PriorityLevelType level, std::string const &content)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	Critical (std::string const &message)
void	Debug (std::string const &message)
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	Error (std::string const &message)
void	Fatal (std::string const &message)
virtual void	Flush ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const char *	GetHumanReadableFormat () const
virtual PriorityLevelType	GetLevelForFlushing () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetName () const
virtual const char *	GetNameOfClass () const
virtual PriorityLevelType	GetPriorityLevel () const
virtual int	GetReferenceCount () const
virtual const TimeStampFormatType &	GetTimeStampFormat ()
bool	HasObserver (const EventObject &event) const
void	Info (std::string const &message)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetHumanReadableFormat (const char *_arg)
virtual void	SetLevelForFlushing (PriorityLevelType level)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetName (const char *_arg)
virtual void	SetPriorityLevel (PriorityLevelType level)
virtual void	SetReferenceCount (int)
virtual void	SetTimeStampFormat (TimeStampFormatType _arg)
virtual void	UnRegister () const
void	Warning (std::string const &message)
virtual void	Write (PriorityLevelType level, std::string const &content)

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ThreadLogger ()
virtual	~ThreadLogger ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreadFunction (void *)

Protected Attributes
RealTimeClock::Pointer	m_Clock
std::string	m_HumanReadableFormat
PriorityLevelType	m_LevelForFlushing
MultipleLogOutput::Pointer	m_Output
PriorityLevelType	m_PriorityLevel
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TimeStampFormatType	m_TimeStampFormat

Private Types
typedef std::queue < PriorityLevelType >	LevelContainerType
typedef std::queue< std::string >	MessageContainerType
typedef std::queue< OperationType >	OperationContainerType
typedef std::queue < OutputType::Pointer >	OutputContainerType

Private Attributes
LevelContainerType	m_LevelQ
MessageContainerType	m_MessageQ
SimpleFastMutexLock	m_Mutex
OperationContainerType	m_OperationQ
OutputContainerType	m_OutputQ
MultiThreader::Pointer	m_Threader
int	m_ThreadID
SimpleFastMutexLock	m_WaitMutex

---

Detailed Description

Class ThreadLogger is meant for providing logging service as a separate thread.

Author:

Hee-Su Kim, Compute Science Dept. Kyungpook National University, ISIS Center, Georgetown University.

Definition at line 43 of file itkThreadLogger.h.

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::ThreadLogger::ConstPointer

Reimplemented from itk::Logger.

Definition at line 51 of file itkThreadLogger.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

typedef std::queue<PriorityLevelType> itk::ThreadLogger::LevelContainerType

private

Definition at line 113 of file itkThreadLogger.h.

typedef std::queue<std::string> itk::ThreadLogger::MessageContainerType

private

Definition at line 111 of file itkThreadLogger.h.

typedef std::queue<OperationType> itk::ThreadLogger::OperationContainerType

private

Definition at line 109 of file itkThreadLogger.h.

typedef std::queue<OutputType::Pointer> itk::ThreadLogger::OutputContainerType

private

Definition at line 115 of file itkThreadLogger.h.

typedef Logger::OutputType itk::ThreadLogger::OutputType

Reimplemented from itk::LoggerBase.

Definition at line 57 of file itkThreadLogger.h.

typedef SmartPointer<Self> itk::ThreadLogger::Pointer

Reimplemented from itk::Logger.

Definition at line 50 of file itkThreadLogger.h.

typedef Logger::PriorityLevelType itk::ThreadLogger::PriorityLevelType

Definition of types of messages. These codes will be used to regulate the level of detail of messages reported to the final outputs

Reimplemented from itk::LoggerBase.

Definition at line 61 of file itkThreadLogger.h.

typedef ThreadLogger itk::ThreadLogger::Self

Smart pointer typedef support.

Reimplemented from itk::Logger.

Definition at line 48 of file itkThreadLogger.h.

typedef Logger itk::ThreadLogger::Superclass

Reimplemented from itk::Logger.

Definition at line 49 of file itkThreadLogger.h.

---

Member Enumeration Documentation

enum itk::ThreadLogger::OperationType

Definition of types of operations for ThreadLogger.

Enumerator:

SET_PRIORITY_LEVEL
SET_LEVEL_FOR_FLUSHING
ADD_LOG_OUTPUT
WRITE
FLUSH

Definition at line 64 of file itkThreadLogger.h.

enum itk::LoggerBase::TimeStampFormatType

inherited

Select the type of format for reporting time stamps

Enumerator:

REALVALUE
HUMANREADABLE

Definition at line 70 of file itkLoggerBase.h.

---

Constructor & Destructor Documentation

itk::ThreadLogger::ThreadLogger ( )

protected

Constructor

Definition at line 132 of file itkThreadLogger.cxx.

References itk::SimpleFastMutexLock::Lock(), m_Threader, m_ThreadID, m_WaitMutex, New(), and ThreadFunction().

itk::ThreadLogger::~ThreadLogger ( )

protectedvirtual

Destructor

Definition at line 141 of file itkThreadLogger.cxx.

References m_Threader, m_ThreadID, m_WaitMutex, and itk::SimpleFastMutexLock::Unlock().

---

Member Function Documentation

void itk::ThreadLogger::AddLogOutput ( OutputType *  output )

virtual

Registers another output stream with the multiple output.

Adds an output stream to the MultipleLogOutput for writing.

Reimplemented from itk::LoggerBase.

Definition at line 69 of file itkThreadLogger.cxx.

References ADD_LOG_OUTPUT, itk::SimpleFastMutexLock::Lock(), m_Mutex, m_OperationQ, m_OutputQ, m_WaitMutex, and itk::SimpleFastMutexLock::Unlock().

unsigned long itk::Object::AddObserver ( const EventObject &  event, Command *  cmd  )

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver ( const EventObject &  event, Command *  cmd  ) const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

std::string itk::LoggerBase::BuildFormattedEntry ( PriorityLevelType  level, std::string const &  content  )

virtualinherited

Provides a default formatted log entry

Definition at line 65 of file itkLoggerBase.cxx.

Referenced by itk::LoggerBase::Write().

virtual::itk::LightObject::Pointer itk::ThreadLogger::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Logger.

void itk::LoggerBase::Critical ( std::string const &  message )

inlineinherited

Definition at line 147 of file itkLoggerBase.h.

References itk::LoggerBase::CRITICAL.

void itk::LoggerBase::Debug ( std::string const &  message )

inlineinherited

Helper methods

Definition at line 135 of file itkLoggerBase.h.

References itk::LoggerBase::DEBUG.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

void itk::LoggerBase::Error ( std::string const &  message )

inlineinherited

Definition at line 151 of file itkLoggerBase.h.

References itk::LoggerBase::CRITICAL.

void itk::LoggerBase::Fatal ( std::string const &  message )

inlineinherited

Definition at line 155 of file itkLoggerBase.h.

References itk::LoggerBase::FATAL.

void itk::ThreadLogger::Flush ( void  )

virtual

Reimplemented from itk::LoggerBase.

Definition at line 91 of file itkThreadLogger.cxx.

References ADD_LOG_OUTPUT, FLUSH, itk::SimpleFastMutexLock::Lock(), itk::LoggerBase::m_LevelForFlushing, m_LevelQ, m_MessageQ, m_Mutex, m_OperationQ, itk::LoggerBase::m_Output, m_OutputQ, itk::LoggerBase::m_PriorityLevel, SET_LEVEL_FOR_FLUSHING, SET_PRIORITY_LEVEL, itk::SimpleFastMutexLock::Unlock(), WRITE, and Write().

Command * itk::Object::GetCommand ( unsigned long  tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

virtual const char* itk::LoggerBase::GetHumanReadableFormat ( ) const

virtualinherited

Referenced by itk::LoggerBase::PrintSelf().

Logger::PriorityLevelType itk::ThreadLogger::GetLevelForFlushing ( ) const

virtual

Reimplemented from itk::LoggerBase.

Definition at line 60 of file itkThreadLogger.cxx.

References itk::SimpleFastMutexLock::Lock(), itk::LoggerBase::m_LevelForFlushing, m_Mutex, and itk::SimpleFastMutexLock::Unlock().

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )

inherited

Returns:

A reference to this objects MetaDataDictionary.

Warning:

This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const

inherited

Returns:

A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void  ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* itk::LoggerBase::GetName ( ) const

virtualinherited

Referenced by itk::LoggerBase::PrintSelf().

virtual const char* itk::ThreadLogger::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Logger.

Logger::PriorityLevelType itk::ThreadLogger::GetPriorityLevel ( ) const

virtual

Get the priority level for the current logger. Only messages that have priorities equal or greater than the one set here will be posted to the current outputs

Reimplemented from itk::LoggerBase.

Definition at line 41 of file itkThreadLogger.cxx.

References itk::SimpleFastMutexLock::Lock(), m_Mutex, itk::LoggerBase::m_PriorityLevel, and itk::SimpleFastMutexLock::Unlock().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const TimeStampFormatType& itk::LoggerBase::GetTimeStampFormat ( )

virtualinherited

Referenced by itk::LoggerBase::PrintSelf().

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject &  event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::LoggerBase::Info ( std::string const &  message )

inlineinherited

Definition at line 139 of file itkLoggerBase.h.

References itk::LoggerBase::INFO.

void itk::Object::InvokeEvent ( const EventObject &  event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject &  event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void  ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Reimplemented in otb::SVMModel< TValue, TLabel >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

static Pointer itk::ThreadLogger::New ( )

static

New macro for creation of through a Smart Pointer

Reimplemented from itk::Logger.

Referenced by ThreadLogger().

void itk::LightObject::Print ( std::ostream &  os, Indent  indent = 0  ) const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader ( std::ostream &  os, Indent  indent  ) const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers ( std::ostream &  os, Indent  indent  ) const

protectedinherited

Definition at line 478 of file itkObject.cxx.

void itk::ThreadLogger::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Print contents of a ThreadLogger

Reimplemented from itk::LoggerBase.

Definition at line 219 of file itkThreadLogger.cxx.

References m_LevelQ, m_MessageQ, m_OperationQ, m_OutputQ, m_ThreadID, and itk::LoggerBase::PrintSelf().

void itk::LightObject::PrintTrailer ( std::ostream &  os, Indent  indent  ) const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long  tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::Object::SetDebug ( bool  debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool  val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::LoggerBase::SetHumanReadableFormat ( const char *  _arg )

virtualinherited

Set/Get the specific text format to use when the time stamp format type is set to HUMANREADABLE. For a description of the acceptable formats please look at the man page of the strftime() method. The default is set to "%Y %b %d %H:%M:%S"

See also:

SetTimeStampFormat

void itk::ThreadLogger::SetLevelForFlushing ( PriorityLevelType  level )

virtual

Reimplemented from itk::LoggerBase.

Definition at line 49 of file itkThreadLogger.cxx.

References itk::SimpleFastMutexLock::Lock(), itk::LoggerBase::m_LevelForFlushing, m_LevelQ, m_Mutex, m_OperationQ, m_WaitMutex, SET_LEVEL_FOR_FLUSHING, and itk::SimpleFastMutexLock::Unlock().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary &  rhs )

inherited

Returns:

Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

virtual void itk::LoggerBase::SetName ( const char *  _arg )

virtualinherited

void itk::ThreadLogger::SetPriorityLevel ( PriorityLevelType  level )

virtual

Set the priority level for the current logger. Only messages that have priorities equal or greater than the one set here will be posted to the current outputs

Reimplemented from itk::LoggerBase.

Definition at line 28 of file itkThreadLogger.cxx.

References itk::SimpleFastMutexLock::Lock(), m_LevelQ, m_Mutex, m_OperationQ, m_WaitMutex, SET_PRIORITY_LEVEL, and itk::SimpleFastMutexLock::Unlock().

void itk::Object::SetReferenceCount ( int  ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void itk::LoggerBase::SetTimeStampFormat ( TimeStampFormatType  _arg )

virtualinherited

Set/Get the type of format used for reporting the time stamp of a given log message. The main options are REALVALUE and HUMANREADABLE. REALVALUE will report the time in seconds as a double number. HUMANREADABLE will report the time in formatted text such as '2007 May 7 09:23:14'

See also:

SetHumanReadableFormat()

ITK_THREAD_RETURN_TYPE itk::ThreadLogger::ThreadFunction ( void *  pInfoStruct )

staticprotected

Definition at line 151 of file itkThreadLogger.cxx.

References itk::MultiThreader::ThreadInfoStruct::ActiveFlag, itk::MultiThreader::ThreadInfoStruct::ActiveFlagLock, ADD_LOG_OUTPUT, FLUSH, ITK_THREAD_RETURN_VALUE, itk::SimpleFastMutexLock::Lock(), itk::LoggerBase::m_LevelForFlushing, m_LevelQ, m_MessageQ, m_Mutex, m_OperationQ, itk::LoggerBase::m_Output, m_OutputQ, itk::LoggerBase::m_PriorityLevel, m_WaitMutex, NULL, SET_LEVEL_FOR_FLUSHING, SET_PRIORITY_LEVEL, itk::SimpleFastMutexLock::Unlock(), itk::MultiThreader::ThreadInfoStruct::UserData, and WRITE.

Referenced by ThreadLogger().

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::LoggerBase::Warning ( std::string const &  message )

inlineinherited

Definition at line 143 of file itkLoggerBase.h.

References itk::LoggerBase::WARNING.

void itk::ThreadLogger::Write ( PriorityLevelType  level, std::string const &  content  )

virtual

Reimplemented from itk::LoggerBase.

Definition at line 79 of file itkThreadLogger.cxx.

References itk::SimpleFastMutexLock::Lock(), m_LevelQ, m_MessageQ, m_Mutex, m_OperationQ, m_WaitMutex, itk::SimpleFastMutexLock::Unlock(), and WRITE.

Referenced by Flush().

---

Member Data Documentation

RealTimeClock::Pointer itk::LoggerBase::m_Clock

protectedinherited

Definition at line 181 of file itkLoggerBase.h.

Referenced by itk::LoggerBase::LoggerBase().

std::string itk::LoggerBase::m_HumanReadableFormat

protectedinherited

Definition at line 185 of file itkLoggerBase.h.

Referenced by itk::LoggerBase::LoggerBase().

PriorityLevelType itk::LoggerBase::m_LevelForFlushing

protectedinherited

Definition at line 177 of file itkLoggerBase.h.

Referenced by Flush(), GetLevelForFlushing(), itk::LoggerBase::LoggerBase(), SetLevelForFlushing(), ThreadFunction(), and itk::LoggerBase::Write().

LevelContainerType itk::ThreadLogger::m_LevelQ

private

Definition at line 125 of file itkThreadLogger.h.

Referenced by Flush(), PrintSelf(), SetLevelForFlushing(), SetPriorityLevel(), ThreadFunction(), and Write().

MessageContainerType itk::ThreadLogger::m_MessageQ

private

Definition at line 123 of file itkThreadLogger.h.

Referenced by Flush(), PrintSelf(), ThreadFunction(), and Write().

SimpleFastMutexLock itk::ThreadLogger::m_Mutex

private

Definition at line 129 of file itkThreadLogger.h.

Referenced by AddLogOutput(), Flush(), GetLevelForFlushing(), GetPriorityLevel(), SetLevelForFlushing(), SetPriorityLevel(), ThreadFunction(), and Write().

OperationContainerType itk::ThreadLogger::m_OperationQ

private

Definition at line 121 of file itkThreadLogger.h.

Referenced by AddLogOutput(), Flush(), PrintSelf(), SetLevelForFlushing(), SetPriorityLevel(), ThreadFunction(), and Write().

MultipleLogOutput::Pointer itk::LoggerBase::m_Output

protectedinherited

Definition at line 179 of file itkLoggerBase.h.

Referenced by itk::LoggerBase::AddLogOutput(), Flush(), itk::LoggerBase::Flush(), itk::LoggerBase::LoggerBase(), ThreadFunction(), and itk::LoggerBase::Write().

OutputContainerType itk::ThreadLogger::m_OutputQ

private

Definition at line 127 of file itkThreadLogger.h.

Referenced by AddLogOutput(), Flush(), PrintSelf(), and ThreadFunction().

PriorityLevelType itk::LoggerBase::m_PriorityLevel

protectedinherited

Definition at line 175 of file itkLoggerBase.h.

Referenced by Flush(), GetPriorityLevel(), itk::LoggerBase::LoggerBase(), ThreadFunction(), and itk::LoggerBase::Write().

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

MultiThreader::Pointer itk::ThreadLogger::m_Threader

private

Definition at line 117 of file itkThreadLogger.h.

Referenced by ThreadLogger(), and ~ThreadLogger().

int itk::ThreadLogger::m_ThreadID

private

Definition at line 119 of file itkThreadLogger.h.

Referenced by PrintSelf(), ThreadLogger(), and ~ThreadLogger().

TimeStampFormatType itk::LoggerBase::m_TimeStampFormat

protectedinherited

Definition at line 183 of file itkLoggerBase.h.

Referenced by itk::LoggerBase::LoggerBase().

SimpleFastMutexLock itk::ThreadLogger::m_WaitMutex

private

Definition at line 131 of file itkThreadLogger.h.

Referenced by AddLogOutput(), SetLevelForFlushing(), SetPriorityLevel(), ThreadFunction(), ThreadLogger(), Write(), and ~ThreadLogger().

---

The documentation for this class was generated from the following files:

• itkThreadLogger.h
• itkThreadLogger.cxx