Performs a mathematical operation on the input images according to the formula specified by the user. More...

#include <otbBandMathImageFilter.h>

Inheritance diagram for otb::BandMathImageFilter< TImage >:

Collaboration diagram for otb::BandMathImageFilter< TImage >:

Public Types
typedef BandMathImageFilter < TImage >	Self
	Standard class typedefs.
typedef itk::InPlaceImageFilter < TImage >	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef TImage	ImageType
	Some convenient typedefs.
typedef ImageType::ConstPointer	ImagePointer
typedef ImageType::RegionType	ImageRegionType
typedef ImageType::PixelType	PixelType
typedef ImageType::IndexType	IndexType
typedef ImageType::PointType	OrigineType
typedef ImageType::SpacingType	SpacingType
typedef Parser	ParserType
typedef Superclass::OutputImageType	OutputImageType
	Superclass typedefs.
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
	Superclass typedefs.
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef TImage	InputImageType
	Some convenient typedefs.
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef DataObject::Pointer	DataObjectPointer
	Smart Pointer type to a DataObject.
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
	STL Array of SmartPointers to DataObjects.
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
	Size type of an std::vector.
Public Member Functions
virtual const char *	GetNameOfClass () const
	Run-time type information (and related methods).
void	SetNthInput (unsigned int idx, const ImageType *image)
	Set the nth filter input with or without a specified associated variable name.
void	SetNthInput (unsigned int idx, const ImageType *image, const std::string &varName)
void	SetNthInputName (unsigned int idx, const std::string &expression)
	Change the nth filter input associated variable name.
void	SetExpression (const std::string &expression)
	Set the expression to be parsed.
std::string	GetExpression () const
	Return the expression to be parsed.
std::string	GetNthInputName (unsigned int idx) const
	Return the nth filter input associated variable name.
ImageType *	GetNthInput (unsigned int idx)
	Return a pointer on the nth filter input.
virtual void	SetInPlace (bool _arg)
	In place operation can be turned on and off.
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
virtual bool	CanRunInPlace () const
	Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type.
virtual void	SetInput (const InputImageType *image)
	Set/Get the image input of this process object.
virtual void	SetInput (unsigned int, const TImage *image)
const InputImageType *	GetInput (void)
const InputImageType *	GetInput (unsigned int idx)
	Method used internally for getting an input.
virtual void	PushBackInput (const InputImageType *image)
	Push/Pop the input of this process object.
virtual void	PopBackInput ()
	Model a stack on the input list by providing a pop back.
virtual void	PushFrontInput (const InputImageType *image)
virtual void	PopFrontInput ()
OutputImageType *	GetOutput (void)
	Get the output data of this process object.
OutputImageType *	GetOutput (unsigned int idx)
	Method used internally for getting an output.
virtual void	GraftOutput (DataObject *output)
	Graft the specified DataObject onto this ProcessObject's output.
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
	Graft the specified data object onto this ProcessObject's idx'th output.
virtual DataObjectPointer	MakeOutput (unsigned int idx)
	Make a DataObject of the correct type to used as the specified output.
DataObjectPointerArray &	GetInputs ()
	Return an array with all the inputs of this process object.
DataObjectPointerArraySizeType	GetNumberOfInputs () const
	Get the size of the input vector.
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
	Get the number of valid inputs.
DataObjectPointerArray &	GetOutputs ()
	Return an array with all the outputs of this process object.
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual void	SetAbortGenerateData (bool _arg)
	Set the AbortGenerateData flag for the process object.
virtual const bool &	GetAbortGenerateData ()
	Get the AbortGenerateData flag for the process object.
virtual void	AbortGenerateDataOn ()
	Turn on and off the AbortGenerateData flag.
virtual void	AbortGenerateDataOff ()
virtual void	SetProgress (float _arg)
	Set the execution progress of a process object.
virtual const float &	GetProgress ()
	Get the execution progress of a process object.
void	UpdateProgress (float amount)
	Update the progress of the process object.
virtual void	Update ()
	Bring this filter up-to-date.
virtual void	UpdateLargestPossibleRegion ()
	Like Update(), but sets the output requested region to the largest possible region for the output.
virtual void	UpdateOutputInformation ()
	Update the information decribing the output data.
virtual void	PropagateRequestedRegion (DataObject *output)
	Send the requested region information back up the pipeline (to the filters that preceed this one).
virtual void	UpdateOutputData (DataObject *output)
	Actually generate new output.
virtual void	EnlargeOutputRequestedRegion (DataObject *)
	Give the process object a chance to indictate that it will produce more output than it was requested to produce.
virtual void	ResetPipeline ()
	Reset the pipeline.
virtual void	SetReleaseDataFlag (bool flag)
	Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject.
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
	Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update().
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (int _arg)
	Get/Set the number of threads to create when executing.
virtual const int &	GetNumberOfThreads ()
MultiThreader *	GetMultiThreader ()
	Return the multithreader used by this class.
virtual void	PrepareOutputs ()
	An opportunity to deallocate a ProcessObject's bulk data storage.
virtual LightObject::Pointer	CreateAnother () const
	Create an object from an instance, potentially deferring to a factory.
virtual void	DebugOn () const
	Turn debugging output on.
virtual void	DebugOff () const
	Turn debugging output off.
bool	GetDebug () const
	Get the value of the debug flag.
void	SetDebug (bool debugFlag) const
	Set the value of the debug flag.
virtual unsigned long	GetMTime () const
	Return this objects modified time.
virtual void	Modified () const
	Update the modification time for this object.
virtual void	Register () const
	Increase the reference count (mark as used by another object).
virtual void	UnRegister () const
	Decrease the reference count (release by another object).
virtual void	SetReferenceCount (int)
	Sets the reference count (use with care).
unsigned long	AddObserver (const EventObject &event, Command *)
	Allow people to add/remove/invoke observers (callbacks) to any ITK object.
unsigned long	AddObserver (const EventObject &event, Command *) const
Command *	GetCommand (unsigned long tag)
	Get the command associated with the given tag.
void	InvokeEvent (const EventObject &)
	Call Execute on all the Commands observing this event id.
void	InvokeEvent (const EventObject &) const
	Call Execute on all the Commands observing this event id.
void	RemoveObserver (unsigned long tag)
	Remove the observer with this tag value.
void	RemoveAllObservers ()
	Remove all observers .
bool	HasObserver (const EventObject &event) const
	Return true if an observer is registered for this event.
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	Delete ()
	Delete an itk object.
void	Print (std::ostream &os, Indent indent=0) const
	Cause the object to print itself out.
virtual int	GetReferenceCount () const
	Gets the reference count on this object.
Static Public Member Functions
static Pointer	New ()
	Method for creation through the object factory.
static void	SetGlobalWarningDisplay (bool flag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static bool	GetGlobalWarningDisplay ()
	Get the value of the global debug output control flag.
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	BreakOnError ()
	This method is called when itkExceptionMacro executes.
Static Public Attributes
static const unsigned int	InputImageDimension
	ImageDimension constants.
static const unsigned int	OutputImageDimension
	ImageDimension constant.
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType
	Typedef for the region copier function object that converts an input region to an output region.
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType
	Typedef for the region copier function object that converts an output region to an input region.
typedef int	InternalReferenceCountType
	Define the type of the reference count according to the target.
Protected Member Functions
	BandMathImageFilter ()
	Constructor.
virtual	~BandMathImageFilter ()
	Destructor.
virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const
	Methods invoked by Print() to print information about the object including superclasses.
void	BeforeThreadedGenerateData ()
	If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData().
void	ThreadedGenerateData (const ImageRegionType &outputRegionForThread, int threadId)
void	AfterThreadedGenerateData ()
	If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData().
virtual void	AllocateOutputs ()
	The GenerateData method normally allocates the buffers for all of the outputs of a filter.
virtual void	ReleaseInputs ()
	InPlaceImageFilter may transfer ownership of the input bulk data to the output object.
const DataObject *	GetInput (unsigned int idx) const
void	PushBackInput (const DataObject *input)
	PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter.
void	PushFrontInput (const DataObject *input)
virtual void	GenerateInputRequestedRegion ()
	What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region.
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	This function calls the actual region copier to do the mapping from output image space to input image space.
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
	This function calls the actual region copier to do the mapping from input image space to output image space.
const DataObject *	GetOutput (unsigned int idx) const
virtual void	GenerateData ()
	A version of GenerateData() specific for image processing filters.
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
	If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData().
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
	Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion".
virtual void	SetNthInput (unsigned int num, DataObject *input)
	Protected methods for setting inputs.
virtual void	AddInput (DataObject *input)
	Adds an input to the first null position in the input list.
virtual void	RemoveInput (DataObject *input)
	Remove an input.
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
void	SetNumberOfInputs (unsigned int num)
	Called to allocate the input array.
virtual void	SetNthOutput (unsigned int num, DataObject *output)
	Protected methods for setting outputs.
virtual void	AddOutput (DataObject *output)
	Adds an output to the first null position in the output list.
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
void	SetNumberOfOutputs (unsigned int num)
	Called to allocate the output array.
virtual void	GenerateOutputRequestedRegion (DataObject *output)
	Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region.
virtual void	GenerateOutputInformation ()
	Generate the information decribing the output data.
virtual void	PropagateResetPipeline ()
	Called to allocate the input array.
virtual void	CacheInputReleaseDataFlags ()
	Cache the state of any ReleaseDataFlag's on the inputs.
virtual void	RestoreInputReleaseDataFlags ()
	Restore the cached input ReleaseDataFlags.
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintHeader (std::ostream &os, Indent indent) const
	Define a default print header for all objects.
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	Define a default print trailer for all objects.
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	Static function used as a "callback" by the MultiThreader.
Protected Attributes
bool	m_Updating
	These ivars are made protected so filters like itkStreamingImageFilter can access them directly.
TimeStamp	m_OutputInformationMTime
	Time when GenerateOutputInformation was last called.
InternalReferenceCountType	m_ReferenceCount
	Number of uses of this object by other objects.
SimpleFastMutexLock	m_ReferenceCountLock
	Mutex lock to protect modification to the reference count.
Private Member Functions
	BandMathImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
std::string	m_Expression
std::vector< ParserType::Pointer >	m_VParser
std::vector< std::vector < double > >	m_AImage
std::vector< std::string >	m_VVarName
unsigned int	m_NbVar
SpacingType	m_Spacing
OrigineType	m_Origin
long	m_UnderflowCount
long	m_OverflowCount
itk::Array< long >	m_ThreadUnderflow
itk::Array< long >	m_ThreadOverflow

Detailed Description

template<class TImage>
class otb::BandMathImageFilter< TImage >

Performs a mathematical operation on the input images according to the formula specified by the user.

This filter is based on the mathematical parser library muParser. The built in functions and operators list is available at: http://muparser.sourceforge.net/mup_features.html#idDef2

OTB additional functions: ndvi(r, niri)

OTB additional constants: e - log2e - log10e - ln2 - ln10 - pi - euler

In order to use this filter, at least one input image is to be set. An associated variable name can be specified or not by using the corresponding SetNthInput method. For the nth input image, if no associated variable name has been spefified, a default variable name is given by concatenating the letter "b" (for band) and the corresponding input index. Next step is to set the expression according to the variable names. For example, in the default case with three input images the following expression is valid : "ndvi(b1, b2)*b3"

As an additional functionality, the filter also granted access to indexes information under special virtual bands named idxX, idxY for the images indexes and idxPhyX, idxPhyY for the physical indexes. It allows the user to perform, for example a spatial processing aiming to suppress a determined area : "if(sqrt((idxPhyX-105.3)*(idxPhyX-105.3)+ (idxPhyY-207.1)*(idxPhyY-207.1))>100, b1, 0)" This expression replace the physical zone around the point of physical index (105.3; 207.1) by a black area This functionality assumes that all the band involved have the same spacing and origin.

See also:: Parser

Definition at line 79 of file otbBandMathImageFilter.h.

Member Typedef Documentation

typedef DataObject::Pointer itk::ImageSource< TImage >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Reimplemented in otb::PersistentImageToVectorDataFilter< TImage, TOutputVectorData >.

Definition at line 62 of file itkImageSource.h.

template<class TImage >

typedef TImage otb::BandMathImageFilter< TImage >::ImageType

Some convenient typedefs.

Definition at line 93 of file otbBandMathImageFilter.h.

typedef TImage itk::InPlaceImageFilter< TImage , TImage >::InputImageType [inherited]

Some convenient typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 82 of file itkInPlaceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TImage , TImage >::InputToOutputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 161 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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 Superclass::OutputImageRegionType itk::InPlaceImageFilter< TImage , TImage >::OutputImageRegionType [inherited]

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 78 of file itkInPlaceImageFilter.h.

typedef Superclass::OutputImageType itk::InPlaceImageFilter< TImage , TImage >::OutputImageType [inherited]

Superclass typedefs.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 73 of file itkInPlaceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TImage , TImage >::OutputToInputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 166 of file itkImageToImageFilter.h.

template<class TImage >

typedef BandMathImageFilter< TImage > otb::BandMathImageFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceImageFilter< TImage >.

Definition at line 84 of file otbBandMathImageFilter.h.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

Adds an input to the first null position in the input list.

Expands the list memory if necessary

Reimplemented in otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >, and otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >.

Definition at line 144 of file itkProcessObject.cxx.

{
  DataObjectPointerArraySizeType idx;
  
  this->Modified();
  
  for (idx = 0; idx < m_Inputs.size(); ++idx)
    {
    if (!m_Inputs[idx])
      {
      m_Inputs[idx] = input;
      return;
      }
    }
  
  this->SetNumberOfInputs( static_cast<int>( m_Inputs.size() + 1 ) );
  m_Inputs[ static_cast<int>( m_Inputs.size() ) - 1] = input;
}

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.

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

{
  if (!this->m_SubjectImplementation)
    {
    this->m_SubjectImplementation = new SubjectImplementation;
    }
  return this->m_SubjectImplementation->AddObserver(event,cmd);
}

void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

Adds an output to the first null position in the output list.

Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

{
  unsigned int idx;
  
  for (idx = 0; idx < m_Outputs.size(); ++idx)
    {
    if ( m_Outputs[idx].IsNull() )
      {
      m_Outputs[idx] = output;

      if (output)
        {
        output->ConnectSource(this, idx);
        }
      this->Modified();
  
      return;
      }
    }
  
  this->SetNumberOfOutputs( static_cast<int>( m_Outputs.size() ) + 1);
  m_Outputs[ static_cast<int>( m_Outputs.size() ) - 1] = output;
  if (output)
    {
    output->ConnectSource(this, static_cast<int>( m_Outputs.size() ) - 1 );
    }
  this->Modified();
}

template<typename TImage >

void otb::BandMathImageFilter< TImage >::AfterThreadedGenerateData ( ) [protected, virtual]

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData().

The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 220 of file otbBandMathImageFilter.txx.

{
  unsigned int nbThreads = this->GetNumberOfThreads();
  unsigned int i;
  
  m_UnderflowCount = 0;
  m_OverflowCount = 0;

  // Accumulate counts for each thread
  for(i = 0; i < nbThreads; ++i)
    {
    m_UnderflowCount += m_ThreadUnderflow[i];
    m_OverflowCount += m_ThreadOverflow[i];
    }

  if((m_UnderflowCount != 0) || (m_OverflowCount!=0))
    otbWarningMacro(<< std::endl
        << "The Following Parsed Expression  :  "
        << this->GetExpression()                                 << std::endl
        << "Generated " << m_UnderflowCount << " Underflow(s) "
        << "And " << m_OverflowCount        << " Overflow(s) "   << std::endl
        << "The Parsed Expression, The Inputs And The Output "
        << "Type May Be Incompatible !");
}

virtual void itk::InPlaceImageFilter< TImage , TImage >::AllocateOutputs ( ) [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter.

Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TImage >.

template<typename TImage >

void otb::BandMathImageFilter< TImage >::BeforeThreadedGenerateData ( void ) [protected, virtual]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData().

The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 147 of file otbBandMathImageFilter.txx.

{
  typename std::vector<ParserType::Pointer>::iterator        itParser;
  typename std::vector< std::vector<PixelType> >::iterator   itVImage;
  unsigned int nbThreads = this->GetNumberOfThreads();
  unsigned int nbInputImages = this->GetNumberOfInputs();
  unsigned int nbAccessIndex = 4; //to give access to image and physical index
  unsigned int i, j;
  unsigned int inputSize[2];
  std::vector< std::string > tmpIdxVarNames;

  tmpIdxVarNames.resize(nbAccessIndex);
  tmpIdxVarNames.at(0) = "idxX";
  tmpIdxVarNames.at(1) = "idxY";
  tmpIdxVarNames.at(2) = "idxPhyX";
  tmpIdxVarNames.at(3) = "idxPhyY";

  // Check if input image dimensions matches
  inputSize[0] = this->GetNthInput(0)->GetLargestPossibleRegion().GetSize(0);
  inputSize[1] = this->GetNthInput(0)->GetLargestPossibleRegion().GetSize(1);

  for(unsigned int p = 1; p < nbInputImages; p++)
    {
    if((inputSize[0] != this->GetNthInput(p)->GetLargestPossibleRegion().GetSize(0))
       || (inputSize[1] != this->GetNthInput(p)->GetLargestPossibleRegion().GetSize(1)))
      {
      itkExceptionMacro(<< "Input images must have the same dimensions." << std::endl
                        << "band #1 is [" << inputSize[0] << ";" << inputSize[1] << "]" << std::endl
                        << "band #" << p+1 << " is ["
                        << this->GetNthInput(p)->GetLargestPossibleRegion().GetSize(0) << ";"
                        << this->GetNthInput(p)->GetLargestPossibleRegion().GetSize(1) << "]");
      }
    }

  // Store images specs
  m_Spacing = this->GetNthInput(0)->GetSpacing();
  m_Origin = this->GetNthInput(0)->GetOrigin();

  // Allocate and initialize the thread temporaries
  m_ThreadUnderflow.SetSize(nbThreads);
  m_ThreadUnderflow.Fill(0);
  m_ThreadOverflow.SetSize(nbThreads);
  m_ThreadOverflow.Fill(0);
  m_VParser.resize(nbThreads);
  m_AImage.resize(nbThreads);
  m_NbVar = nbInputImages+nbAccessIndex;
  m_VVarName.resize(m_NbVar);
  
  for(itParser = m_VParser.begin(); itParser < m_VParser.end(); itParser++)
    {
    *itParser = ParserType::New();
    }

  for(i = 0; i < nbThreads; ++i)
    {
    m_AImage.at(i).resize(m_NbVar);
    m_VParser.at(i)->SetExpr(m_Expression);
  
    for(j=0; j < nbInputImages; ++j)
      {
      m_VParser.at(i)->DefineVar(m_VVarName.at(j), &(m_AImage.at(i).at(j)));
      }

    for(j=nbInputImages; j < nbInputImages+nbAccessIndex; ++j)
      {
      m_VVarName.at(j) = tmpIdxVarNames.at(j-nbInputImages);
      m_VParser.at(i)->DefineVar(m_VVarName.at(j), &(m_AImage.at(i).at(j)));
      }
    }
}

void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes.

It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

{
  ;  
}

void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs.

While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Definition at line 1050 of file itkProcessObject.cxx.

{
  unsigned int idx;
  
  m_CachedInputReleaseDataFlags.resize( m_Inputs.size() );
  for (idx = 0; idx < m_Inputs.size(); ++idx)
    {
    if (m_Inputs[idx])
      {
      m_CachedInputReleaseDataFlags[idx]=m_Inputs[idx]->GetReleaseDataFlag();
      m_Inputs[idx]->ReleaseDataFlagOff();
      }
    else
      {
      m_CachedInputReleaseDataFlags[idx] = false;
      }
    }
}

virtual void itk::ImageToImageFilter< TImage , TImage >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from input image space to output image space.

It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

virtual void itk::ImageToImageFilter< TImage , TImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from output image space to input image space.

It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

virtual bool itk::InPlaceImageFilter< TImage , TImage >::CanRunInPlace ( ) const [inline, virtual, inherited]

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type.

This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true. CanRunInPlace may also be overridded by InPlaceImageFilter subclasses to fine tune its behavior.

Definition at line 111 of file itkInPlaceImageFilter.h.

    {
    return (typeid(TInputImage) == typeid(TOutputImage));
    }

LightObject::Pointer itk::Object::CreateAnother ( void ) const [virtual, inherited]

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::LightObject.

Definition at line 231 of file itkObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

Referenced by itk::StreamingImageIOBase::GetActualNumberOfSplitsForWriting().

{
  return Object::New().GetPointer();
}

void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

{
  m_Debug = false;
}

void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

{
  m_Debug = true;
}

void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object.

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.

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.

{
  this->UnRegister();
}

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce.

For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 224 of file itkProcessObject.h.

{};

virtual void itk::ImageSource< TImage >::GenerateData ( void ) [protected, virtual, inherited]

A version of GenerateData() specific for image processing filters.

This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:: ThreadedGenerateData()

Reimplemented from itk::ProcessObject.

virtual void itk::ImageToImageFilter< TImage , TImage >::GenerateInputRequestedRegion ( void ) [protected, virtual, inherited]

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region.

If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

void itk::ProcessObject::GenerateOutputInformation ( void ) [protected, virtual, inherited]

Generate the information decribing the output data.

Default implementation - copy information from first input to all outputs.

The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Definition at line 1095 of file itkProcessObject.cxx.

Referenced by otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >::GenerateOutputInformation(), otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::FORWARD >::GenerateOutputInformation(), otb::VCAImageFilter< TVectorImage >::GenerateOutputInformation(), otb::MatrixImageFilter< TInputImage, TOutputImage, TMatrix >::GenerateOutputInformation(), itk::FFTComplexToComplexImageFilter< TPixel, NDimension >::GenerateOutputInformation(), itk::DirectFourierReconstructionImageToImageFilter< TInputPixelType, TOutputPixelType >::GenerateOutputInformation(), and itk::FFTComplexConjugateToRealImageFilter< TPixel, VDimension >::GenerateOutputInformation().

{
  DataObjectPointer input, output;

  if (m_Inputs.size() && m_Inputs[0])
    {
    input = m_Inputs[0];

    for (unsigned int idx = 0; idx < m_Outputs.size(); ++idx)
      {
      output = this->GetOutput(idx);
      if (output)
        {
        output->CopyInformation(input);
        }  
      }
    }
}

void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual, inherited]

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region.

By default we set all the output requested regions to be the same.

If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.

Definition at line 846 of file itkProcessObject.cxx.

{
  DataObjectPointerArraySizeType idx;
  for (idx = 0; idx < m_Outputs.size(); ++idx)
    {
    if (m_Outputs[idx] && m_Outputs[idx] != output)
      {
      m_Outputs[idx]->SetRequestedRegion(output);
      }
    }  
}

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object.

Process objects may handle premature termination of execution in different ways.

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().

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

{
  if (this->m_SubjectImplementation)
    {
    return this->m_SubjectImplementation->GetCommand(tag);
    }
  return NULL;
}

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

{
  return m_Debug;
}

const InputImageType* itk::ImageToImageFilter< TImage , TImage >::GetInput ( unsigned int idx ) [inherited]

Method used internally for getting an input.

Reimplemented from itk::ProcessObject.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

Return an array with all the inputs of this process object.

This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

    {return m_Inputs;}

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.

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(), otb::VectorImage< TPixel, VImageDimension >::GetImageKeywordlist(), otb::Image< TPixel, VImageDimension >::GetImageKeywordlist(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetValueFromTag(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), otb::VectorImage< TPixel, VImageDimension >::PrintSelf(), otb::Image< TPixel, VImageDimension >::PrintSelf(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

{
  if(m_MetaDataDictionary==NULL)
    {
    m_MetaDataDictionary=new MetaDataDictionary;
    }
  return *m_MetaDataDictionary;
}

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.

{
  if(m_MetaDataDictionary==NULL)
    {
    m_MetaDataDictionary=new MetaDataDictionary;
    }
  return *m_MetaDataDictionary;
}

unsigned long itk::Object::GetMTime ( void ) const [virtual, inherited]

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

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

{
  return m_MTime.GetMTime();
}

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

    {return m_Threader;}

template<class TImage >

virtual const char* otb::BandMathImageFilter< TImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TImage >.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

Get the size of the input vector.

This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive(), otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >::GenerateInputRequestedRegion(), otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >::GenerateOutputInformation(), otb::ModulusAndDirectionImageToImageFilter< TInputImage, TInputImageDirection, TOutputImage >::GetInput(), and otb::ModulusAndDirectionImageToImageFilter< TInputImage, TInputImageDirection, TOutputImage >::GetInputDirection().

    {return m_Inputs.size();}

ProcessObject::DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid inputs.

Get the number of specified inputs.

This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

Definition at line 112 of file itkProcessObject.cxx.

{
  DataObjectPointerArraySizeType num;
  if (m_NumberOfRequiredInputs < m_Inputs.size())
    {
    num = m_NumberOfRequiredInputs;
    }
  else
    {
    num = m_Inputs.size();
    }
  // count the number of non-null inputs
  // this used to use std::count_if, but that function object
  // did not work correctly with SunPro CC 5.6.
  int count = 0;
  for(std::vector<DataObjectPointer>::const_iterator i = m_Inputs.begin();
      i < (m_Inputs.begin() + num); ++i)
    {
    if((*i).IsNotNull())
      {
      count++;
      }
    }
  return count;
}

OutputImageType* itk::ImageSource< TImage >::GetOutput ( unsigned int idx ) [inherited]

Method used internally for getting an output.

Reimplemented from itk::ProcessObject.

OutputImageType* itk::ImageSource< TImage >::GetOutput ( void ) [inherited]

Get the output data of this process object.

The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Referenced by otb::LabelObjectOpeningMuParserFilter< TImage, TFunction >::AllocateOutputs(), and otb::LabelObjectOpeningMuParserFilter< TImage, TFunction >::GenerateData().

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Return an array with all the outputs of this process object.

This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

    { return m_Outputs; }

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object.

The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

    {return static_cast<int>(m_ReferenceCount);}

virtual void itk::ImageSource< TImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

Graft the specified data object onto this ProcessObject's idx'th output.

This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

virtual void itk::ImageSource< TImage >::GraftOutput ( DataObject * output ) [virtual, inherited]

Graft the specified DataObject onto this ProcessObject's output.

This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );
   
    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Referenced by otb::LabelObjectOpeningMuParserFilter< TImage, TFunction >::AllocateOutputs().

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.

{
  if (this->m_SubjectImplementation)
    {
    return this->m_SubjectImplementation->HasObserver(event);
    }
  return false;
}

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 itk::VTKImageExportBase::UpdateDataCallback().

{
  if (this->m_SubjectImplementation)
    {
    this->m_SubjectImplementation->InvokeEvent(event,this);
    }
}

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.

{
  if (this->m_SubjectImplementation)
    {
    this->m_SubjectImplementation->InvokeEvent(event,this);
    }
}

virtual DataObjectPointer itk::ImageSource< TImage >::MakeOutput ( unsigned int idx ) [virtual, inherited]

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

void itk::Object::Modified ( void ) const [virtual, inherited]

Update the modification time for this object.

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

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

Definition at line 297 of file itkObject.cxx.

{
  m_MTime.Modified();
  InvokeEvent( ModifiedEvent() );
}

template<class TImage >

static Pointer otb::BandMathImageFilter< TImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

An opportunity to deallocate a ProcessObject's bulk data storage.

Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

Definition at line 864 of file itkProcessObject.cxx.

{  
  unsigned int idx;
  
  if (this->GetReleaseDataBeforeUpdateFlag())
    {
    for (idx = 0; idx < m_Outputs.size(); idx++)
      {
      if (m_Outputs[idx])
        {
        m_Outputs[idx]->PrepareForNewData(); 
        }
      }
    }
}

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<<(), and itk::WeakPointer< ProcessObject >::Print().

{
  this->PrintHeader(os, indent); 
  this->PrintSelf(os, indent.GetNextIndent());
  this->PrintTrailer(os, indent);
}

template<class TImage >

void otb::BandMathImageFilter< TImage >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)			const `[protected, virtual]`

Methods invoked by Print() to print information about the object including superclasses.

Chaining method to print an object's instance variables, as well as its superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::InPlaceImageFilter< TImage >.

Definition at line 63 of file otbBandMathImageFilter.txx.

{
  Superclass::PrintSelf(os, indent);

  os << indent << "Expression: "      << m_Expression                  << std::endl;
  os << indent << "Computed values follow:"                            << std::endl;
  os << indent << "UnderflowCount: "  << m_UnderflowCount              << std::endl;
  os << indent << "OverflowCount: "   << m_OverflowCount               << std::endl;
  os << indent << "itk::NumericTraits<PixelType>::NonpositiveMin()  :  "
               << itk::NumericTraits<PixelType>::NonpositiveMin()      << std::endl;
  os << indent << "itk::NumericTraits<PixelType>::max()  :             "
         << itk::NumericTraits<PixelType>::max()                 << std::endl;
}

void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

check flag to avoid executing forever if there is a loop

Give the subclass a chance to indicate that it will provide more data then required for the output. This can happen, for example, when a source can only produce the whole output. Although this is being called for a specific output, the source may need to enlarge all outputs.

Give the subclass a chance to define how to set the requested regions for each of its outputs, given this output's requested region. The default implementation is to make all the output requested regions the same. A subclass may need to override this method if each output is a different resolution.

Give the subclass a chance to request a larger requested region on the inputs. This is necessary when, for example, a filter requires more data at the "internal" boundaries to produce the boundary values - such as an image filter that derives a new pixel value by applying some operation to a neighborhood of surrounding original values.

Now that we know the input requested region, propagate this through all the inputs.

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.

Definition at line 766 of file itkProcessObject.cxx.

{
  if (m_Updating)
    {
    return;
    }

  this->EnlargeOutputRequestedRegion( output );

  this->GenerateOutputRequestedRegion( output );
  
  this->GenerateInputRequestedRegion();

  m_Updating = true;
  DataObjectPointerArraySizeType idx;
  for (idx = 0; idx < m_Inputs.size(); ++idx)
    {
    if (m_Inputs[idx])
      {
      m_Inputs[idx]->PropagateRequestedRegion();
      }
    }
  m_Updating = false;
}

void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Called to allocate the input array.

Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

{
  // 
  // Reset this object.
  //
  // Clear the updating flag.
  m_Updating = 0;

  //
  // Loop through the inputs
  //
  unsigned int idx;
  DataObject::Pointer input;
  for (idx = 0; idx < m_Inputs.size(); ++idx)
    {
    if (m_Inputs[idx])
      {
      input = m_Inputs[idx];

      input->PropagateResetPipeline();
      }
    }
}

virtual void itk::ImageToImageFilter< TImage , TImage >::PushBackInput ( const InputImageType * image ) [virtual, inherited]

Push/Pop the input of this process object.

These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

void itk::ImageToImageFilter< TImage , TImage >::PushBackInput ( const DataObject * input ) [inline, protected, virtual, inherited]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter.

However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 248 of file itkImageToImageFilter.h.

    { Superclass::PushBackInput(input); }

void itk::Object::Register ( ) const [virtual, inherited]

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().

{
  itkDebugMacro(<< "Registered, "
                << "ReferenceCount = " << (m_ReferenceCount+1));

  // call the parent
  Superclass::Register();
}

virtual void itk::InPlaceImageFilter< TImage , TImage >::ReleaseInputs ( ) [protected, virtual, inherited]

InPlaceImageFilter may transfer ownership of the input bulk data to the output object.

Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See also:: ProcessObject::ReleaseInputs()

Reimplemented from itk::ProcessObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

Definition at line 435 of file itkObject.cxx.

{
  if (this->m_SubjectImplementation)
    {
    this->m_SubjectImplementation->RemoveAllObservers();
    }
}

void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

Remove an input.

Removes the first occurence of the given OutputObject from the inputs to this ProcessObject. If it's the last object on the list, shortens the list.

Definition at line 173 of file itkProcessObject.cxx.

{
  if (!input)
    {
    return;
    }
  
  // find the input in the list of inputs
  DataObjectPointerArray::iterator pos = 
    std::find(m_Inputs.begin(), m_Inputs.end(), input);

  if(pos == m_Inputs.end())
    {
    itkDebugMacro("tried to remove an input that was not in the list");
    return;
    }

  // Set the position in the m_Inputs containing input to 0
  *pos = 0;

  // if that was the last input, then shrink the list
  if (pos == m_Inputs.end() - 1 )
    {
    this->SetNumberOfInputs( static_cast<int>( m_Inputs.size() ) - 1);
    }

  this->Modified();
}

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::StreamingImageFileWriter< TInputImage >::UpdateOutputData().

{
  if (this->m_SubjectImplementation)
    {
    this->m_SubjectImplementation->RemoveObserver(tag);
    }
}

void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline.

If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 621 of file itkProcessObject.cxx.

{
  if (this->GetOutput(0))
    {
    this->GetOutput(0)->ResetPipeline();
    }
}

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object.

Process objects may handle premature termination of execution in different ways.

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.

{
  m_Debug = debugFlag;
}

void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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.

{
  m_GlobalWarningDisplay = val;
}

virtual void itk::InPlaceImageFilter< TImage , TImage >::SetInPlace ( bool _arg ) [virtual, inherited]

In place operation can be turned on and off.

Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

virtual void itk::ImageToImageFilter< TImage , TImage >::SetInput ( const InputImageType * image ) [virtual, inherited]

Set/Get the image input of this process object.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

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

{
  if(m_MetaDataDictionary==NULL)
    {
    m_MetaDataDictionary=new MetaDataDictionary;
    }
  *m_MetaDataDictionary=rhs;
}

void itk::ProcessObject::SetNthInput	(	unsigned int	idx,
		DataObject *	input
	)			`[protected, virtual, inherited]`

Protected methods for setting inputs.

Set an Input of this filter.

Subclasses make use of them for setting input.

This method does Register()/UnRegister() manually to deal with the fact that smart pointers aren't around to do the reference counting.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

{
  // does this change anything?
  if ( idx < m_Inputs.size() && m_Inputs[idx] == input )
    {
    return;
    }
  
  // Expand array if necessary.
  if (idx >= m_Inputs.size())
    {
    this->SetNumberOfInputs(idx + 1);
    }
  
  m_Inputs[idx] = input;

  this->Modified();
}

void itk::ProcessObject::SetNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[protected, virtual, inherited]`

Protected methods for setting outputs.

Set an output of this filter.

Subclasses make use of them for getting output.

This method specifically does not do a Register()/UnRegister() because of the desire to break the reference counting loop.

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

Referenced by itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::SimplexMeshToTriangleMeshFilter< TInputMesh, TOutputMesh >::CreateTriangles(), otb::FillGapsFilter::FillGapsFilter(), itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod(), itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectRegistrationMethod(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::InsertNewCells(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MultiResolutionImageRegistrationMethod(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >::PointSetToImageRegistrationMethod(), itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >::PointSetToPointSetRegistrationMethod(), otb::ProspectModel::ProspectModel(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), otb::SailModel::SailModel(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::FORWARD >::WaveletFilterBank(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform().

{
  // does this change anything?
  if ( idx < m_Outputs.size() && output == m_Outputs[idx])
    {
    return;
    }

  // Expand array if necessary.
  if (idx >= m_Outputs.size())
    {
    this->SetNumberOfOutputs(idx + 1);
    }

  // Keep a handle to the original output and disconnect the old output from
  // the pipeline
  DataObjectPointer oldOutput;
  if ( m_Outputs[idx] )
    {
    oldOutput = m_Outputs[idx];
    m_Outputs[idx]->DisconnectSource(this, idx);
    }

  if (output)
    {
    output->ConnectSource(this, idx);
    }
  // save the current reference (which releases the previous reference)
  m_Outputs[idx] = output;

  // if we are clearing an output, we need to create a new blank output
  // so we are prepared for the next Update(). this copies the requested
  // region ivar
  if (!m_Outputs[idx])
    {
    itkDebugMacro( " creating new output object." );
    DataObjectPointer newOutput = this->MakeOutput(idx);
    this->SetNthOutput(idx, newOutput);

    // If we had an output object before, copy the requested region
    // ivars and release data flag to the the new output
    if (oldOutput)
      {
      newOutput->SetRequestedRegion( oldOutput );
      newOutput->SetReleaseDataFlag( oldOutput->GetReleaseDataFlag() );
      }
    }

  this->Modified();
}

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array.

Called by constructor to set up input array.

Copies old inputs.

Definition at line 96 of file itkProcessObject.cxx.

Referenced by otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::FORWARD >::WaveletFilterBank(), otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >::WaveletFilterBank(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform().

{
  // in case nothing has changed.
  if (num == m_Inputs.size())
    {
    return;
    }
  m_Inputs.resize(num);
  this->Modified();
}

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array.

Called by constructor to set up output array.

Copies old outputs.

Definition at line 424 of file itkProcessObject.cxx.

Referenced by otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::FORWARD >::WaveletFilterBank(), otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >::WaveletFilterBank(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform().

{

  // in case nothing has changed.
  if (num == m_Outputs.size())
    {
    return;
    }
  m_Outputs.resize(num);
  this->Modified();
}

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

Get/Set the number of threads to create when executing.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivative(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePos(), itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange(), and otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >::WaveletFilterBank().

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object.

The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

void itk::Object::SetReferenceCount ( int ref ) [virtual, inherited]

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.

{
  itkDebugMacro(<< "Reference Count set to " << ref);

  // ReferenceCount in now unlocked.  We may have a race condition to
  // to delete the object.
  if( ref <= 0 )
    {
    this->InvokeEvent(DeleteEvent());
    }

  Superclass::SetReferenceCount(ref);
}

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update().

In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject.

Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 528 of file itkProcessObject.cxx.

{
  unsigned int idx;
  
  for (idx = 0; idx < m_Outputs.size(); idx++)
    {
    if (m_Outputs[idx])
      {
      m_Outputs[idx]->SetReleaseDataFlag(val);
      }
    }
}

virtual int itk::ImageSource< TImage >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)			`[protected, virtual, inherited]`

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion".

This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

virtual void itk::ImageSource< TImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, virtual, inherited]`

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData().

This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:: GenerateData(), SplitRequestedRegion()

Reimplemented in itk::LabelMapFilter< TImage, TImage >.

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TImage >::ThreaderCallback ( void * arg ) [static, protected, inherited]

Static function used as a "callback" by the MultiThreader.

The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

void itk::Object::UnRegister ( ) const [virtual, inherited]

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().

{
  // call the parent
  itkDebugMacro(<< "UnRegistered, "
                << "ReferenceCount = " << (m_ReferenceCount-1));

  if ( (m_ReferenceCount-1) <= 0)
    {
    this->InvokeEvent(DeleteEvent());
    }

  Superclass::UnRegister();
}

void itk::ProcessObject::Update ( void ) [virtual, inherited]

Bring this filter up-to-date.

The following methods are used to coordinate the execution of the data processing pipeline.

Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Definition at line 611 of file itkProcessObject.cxx.

Referenced by otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), itk::AutoCropLabelMapFilter< TInputImage >::GenerateOutputInformation(), and itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation().

{
  if (this->GetOutput(0))
    {
    this->GetOutput(0)->Update();
    }
}

void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

Like Update(), but sets the output requested region to the largest possible region for the output.

This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

Definition at line 1120 of file itkProcessObject.cxx.

{
  this->UpdateOutputInformation();

  if (this->GetOutput(0))
    {
    this->GetOutput(0)->SetRequestedRegionToLargestPossibleRegion();
    this->GetOutput(0)->Update();
    }
}

void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output.

prevent chasing our tail

Prepare all the outputs. This may deallocate previous bulk data.

Propagate the update call - make sure everything we might rely on is up-to-date Must call PropagateRequestedRegion before UpdateOutputData if multiple inputs since they may lead back to the same data object.

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Tell all Observers that the filter is starting

GenerateData this object - we have not aborted yet, and our progress before we start to execute is 0.0.

Count the number of required inputs which have been assigned

If we ended due to aborting, push the progress up to 1.0 (since it probably didn't end there)

Notify end event observers

Now we have to mark the data as up to date.

Restore the state of any input ReleaseDataFlags

Release any inputs if marked for release

Reimplemented in otb::StreamingImageFileWriter< TInputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 908 of file itkProcessObject.cxx.

{
  DataObjectPointerArraySizeType idx;

  if (m_Updating)
    {
    return;
    }

  this->PrepareOutputs();

  m_Updating = true;
  if ( m_Inputs.size() == 1 )
    {
    if (m_Inputs[0])
      {
      m_Inputs[0]->UpdateOutputData();
      }
    }
  else
    {
    for (idx = 0; idx < m_Inputs.size(); ++idx)
      {
      if (m_Inputs[idx])
        {
        m_Inputs[idx]->PropagateRequestedRegion();
        m_Inputs[idx]->UpdateOutputData();
        }
      }
    }

  this->CacheInputReleaseDataFlags();
  
  this->InvokeEvent( StartEvent() );

  m_AbortGenerateData = false;
  m_Progress = 0.0f;

  DataObjectPointerArraySizeType ninputs = this->GetNumberOfValidRequiredInputs();
  if (ninputs < m_NumberOfRequiredInputs)
    {
    itkExceptionMacro(<< "At least " << m_NumberOfRequiredInputs 
                      << " inputs are required but only " << ninputs 
                      << " are specified.");
    }
  else
    {
    try
      {
      this->GenerateData();
      }
    catch( ProcessAborted & excp )
      {
      this->InvokeEvent( AbortEvent() );
      this->ResetPipeline();
      this->RestoreInputReleaseDataFlags();
      throw excp;
      }
    catch( ExceptionObject& excp )
      {
      this->ResetPipeline();
      this->RestoreInputReleaseDataFlags();
      throw excp;
      }
    }

  if ( m_AbortGenerateData )
    {
    this->UpdateProgress(1.0f);
    }

  this->InvokeEvent( EndEvent() );

  for (idx = 0; idx < m_Outputs.size(); ++idx)
    {
    if (m_Outputs[idx])
      {
      m_Outputs[idx]->DataHasBeenGenerated();
      }
    }
  
  this->RestoreInputReleaseDataFlags();
  
  this->ReleaseInputs();
  
  // Mark that we are no longer updating the data in this filter
  m_Updating = false;
}

void itk::ProcessObject::UpdateOutputInformation ( void ) [virtual, inherited]

Update the information decribing the output data.

This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Watch out for loops in the pipeline

Since we are in a loop, we will want to update. But if we don't modify this filter, then we will not execute because our OutputInformationMTime will be more recent than the MTime of our output.

We now wish to set the PipelineMTime of each output DataObject to the largest of this ProcessObject's MTime, all input DataObject's PipelineMTime, and all input's MTime. We begin with the MTime of this ProcessObject.

Loop through the inputs

Propagate the UpdateOutputInformation call

What is the PipelineMTime of this input? Compare this against our current computation to find the largest one.

Pipeline MTime of the input does not include the MTime of the data object itself. Factor these mtimes into the next PipelineMTime

Call GenerateOutputInformation for subclass specific information. Since UpdateOutputInformation propagates all the way up the pipeline, we need to be careful here to call GenerateOutputInformation only if necessary. Otherwise, we may cause this source to be modified which will cause it to execute again on the next update.

Keep track of the last time GenerateOutputInformation() was called

Reimplemented in itk::watershed::Segmenter< TInputImage >, itk::VTKImageImport< TOutputImage >, and itk::watershed::Segmenter< InputImageType >.

Definition at line 664 of file itkProcessObject.cxx.

References itk::Object::GetMTime(), itk::DataObject::SetPipelineMTime(), and itk::DataObject::UpdateOutputInformation().

Referenced by itk::VTKImageExportBase::UpdateInformationCallback(), and itk::watershed::Segmenter< TInputImage >::UpdateOutputInformation().

{
  unsigned long t1, t2;
  DataObjectPointerArraySizeType idx;
  DataObject *input;
  DataObject *output;

  if ( m_Updating )
    {
    this->Modified();
    return;
    }

  t1 = this->GetMTime();

  for (idx = 0; idx < m_Inputs.size(); ++idx)
    {
    if (m_Inputs[idx])
      {
      input = m_Inputs[idx];

      m_Updating = true;
      input->UpdateOutputInformation();
      m_Updating = false;
      
      t2 = input->GetPipelineMTime();

      if (t2 > t1)
        {
        t1 = t2;
        }

      t2 = input->GetMTime();
      if (t2 > t1)
        {
        t1 = t2;
        }
      }
    }

  if (t1 > m_OutputInformationMTime.GetMTime())
    {
    for (idx = 0; idx < m_Outputs.size(); ++idx)
      {
      output = this->GetOutput( static_cast<int>( idx ) );
      if (output)
        {
        output->SetPipelineMTime(t1);
        }  
      }
    
    this->GenerateOutputInformation();

    m_OutputInformationMTime.Modified();
    }
}

void itk::ProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

If a ProgressMethod exists, execute it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::watershed::Segmenter< TInputImage >::GenerateData(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

{
  m_Progress = amount;
  this->InvokeEvent( ProgressEvent() );
}

Member Data Documentation

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

These ivars are made protected so filters like itkStreamingImageFilter can access them directly.

This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Reimplemented in otb::HistogramAndTransferFunctionWidget< THistogram, TPixel >, and otb::ImageViewerBase< TPixel, TLabel >.

Definition at line 418 of file itkProcessObject.h.

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

otb::BandMathImageFilter< TImage > Class Template Reference [Filters supporting Streaming]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class TImage> class otb::BandMathImageFilter< TImage >

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

otb::BandMathImageFilter< TImage > Class Template Reference
[Filters supporting Streaming]

template<class TImage>
class otb::BandMathImageFilter< TImage >