Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::HConcaveImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Enhancement Filters]

#include <itkHConcaveImageFilter.h>

Inheritance diagram for itk::HConcaveImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::HConcaveImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::HConcaveImageFilter< TInputImage, TOutputImage >

Identify local minima whose depth below the baseline is greater than h.

HConcaveImageFilter extract local minima that are more than h intensity units below the (local) background. This has the effect of extracting objects that are darker than the background by at least h intensity units.

This filter uses the HMinimaImageFilter.

Geodesic morphology and the H-Convex algorithm is described in Chapter 6 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

See also:: GrayscaleGeodesicDilateImageFilter, HMaximaImageFilter,
MorphologyImageFilter, GrayscaleDilateImageFilter, GrayscaleFunctionDilateImageFilter, BinaryDilateImageFilter Mathematical Morphology Image Filters

Definition at line 43 of file itkHConcaveImageFilter.h.

Public Types

typedef SmartPointer< const
Self > ConstPointer

typedef DataObject::Pointer DataObjectPointer

typedef std::vector< DataObjectPointer > DataObjectPointerArray

typedef InputImageType::ConstPointer InputImageConstPointer

typedef InputImageType::PixelType InputImagePixelType

typedef InputImageType::Pointer InputImagePointer

typedef InputImageType::RegionType InputImageRegionType

typedef TInputImage InputImageType

typedef OutputImageType::ConstPointer OutputImageConstPointer

typedef OutputImageType::PixelType OutputImagePixelType

typedef OutputImageType::Pointer OutputImagePointer

typedef OutputImageType::RegionType OutputImageRegionType

typedef TOutputImage OutputImageType

typedef SmartPointer< Self > Pointer

typedef HConcaveImageFilter Self

typedef ImageToImageFilter<
TInputImage, TOutputImage > Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()

virtual void AbortGenerateDataOn ()

Set Get the height that a
local maximum must be above
the local * background (local contrast) in order to survive the *processing.Local maxima below this value are replaced with an *estimate of the local background.*/virtual void SetHeight(InputImagePixelType _arg)

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

virtual void FullyConnectedOff ()

virtual void FullyConnectedOn ()

virtual const bool & GetAbortGenerateData ()

Command * GetCommand (unsigned long tag)

bool GetDebug () const

virtual const bool & GetFullyConnected ()

virtual InputImagePixelType GetHeight ()

const InputImageType * GetInput (unsigned int idx)

const InputImageType * GetInput (void)

DataObjectPointerArray & GetInputs ()

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

MultiThreader * GetMultiThreader ()

virtual const char * GetNameOfClass () const

std::vector< DataObjectPointer
>::size_type GetNumberOfInputs () const

deprecated *Get the number
of iterations used to produce
the current *output This method
is scheduled for removal since
the *implementation now uses
a noniterative solution *unsigned
long GetNumberOfIterationsUsed ()

std::vector< DataObjectPointer
>::size_type GetNumberOfOutputs () const

virtual const int & GetNumberOfThreads ()

virtual std::vector< DataObjectPointer
>::size_type GetNumberOfValidRequiredInputs () const

OutputImageType * GetOutput (unsigned int idx)

Get the output data of this
process object The output
of this *function is not valid
until an appropriate either
explicitly or implicitly Both
the filter *itself and the
data object have and both
*methods update the data Here
are three ways to use * GetOutput () and make sure the data is valid.In these *examples

Return an array with all the
outputs of this process object
*This is useful for tracing
forward in the pipeline to
contruct *graphs etc *DataObjectPointerArray & GetOutputs ()

virtual const float & GetProgress ()

virtual int GetReferenceCount () const

virtual const bool & GetReleaseDataBeforeUpdateFlag ()

virtual bool GetReleaseDataFlag () const

virtual void GraftNthOutput (unsigned int idx, DataObject *output)

virtual void GraftOutput (DataObject *output)

bool HasObserver (const EventObject &event) const

Get the output data of this
process object The output
of this *function is not valid
until an appropriate either
explicitly or implicitly Both
the filter *itself and the
data object have and both
*methods update the data Here
are three ways to use *a image
is a pointer to some Image
and the *particular ProcessObjects
involved are filters The same
*examples apply to non image (e.g.Mesh) data as well.**\code *anotherFilter->SetInput(someFilter->GetOutput())

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)

ImageDimension constants * itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)

virtual DataObjectPointer MakeOutput (unsigned int idx)

virtual void Modified () const

virtual void PopBackInput ()

virtual void PopFrontInput ()

virtual void PrepareOutputs ()

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

virtual void PropagateRequestedRegion (DataObject *output)

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
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 if an application
has *images and they need
to run a filter on then *run
the filter on then run the
filter on 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 this only makes
sense for *filters that single
type of input **Other uses
are also possible For a single
input pushing *and popping
inputs allow the application
to temporarily replace *an
input to a filter **virtual
void PushBackInput (const InputImageType *image)

virtual void PushFrontInput (const InputImageType *image)

virtual void Register () const

virtual void ReleaseDataBeforeUpdateFlagOff ()

virtual void ReleaseDataBeforeUpdateFlagOn ()

void ReleaseDataFlagOff ()

void ReleaseDataFlagOn ()

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

virtual void ResetPipeline ()

virtual void SetAbortGenerateData (bool _arg)

void SetDebug (bool debugFlag) const

*Set Get whether the connected
components are defined strictly
by *face connectivity or by
face edge vertex connectivity
Default is *FullyConnectedOff
For objects that are pixel
use *FullyConnectedOn *virtual
void SetFullyConnected (bool _arg)

virtual void SetInput (unsigned int, const TInputImage *image)

Set Get the image input of
this process object *virtual
void SetInput (const InputImageType *image)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

Get Set the number of threads
to create when executing
*virtual void SetNumberOfThreads (int _arg)

virtual void SetProgress (float _arg)

virtual void SetReferenceCount (int)

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
*virtual void SetReleaseDataFlag (bool flag)

virtual void UnRegister () const

*endcode *In the above the
two lines of code can be in
*either order **Note that
it may be more efficient to
*use a pipeline than to call Update () once for each filter in *turn.**For an image

*endcode *In the above 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\b streaming(using a *StreamingImageFilter) is activated

*endcode **code *someFilter Update ()

*image Update ()

*anotherFilter Update ()

Get the output data of this
process object The output
of this *function is not valid
until an appropriate either
explicitly or implicitly Both
the filter *itself and the
data object have Update () methods

Get the output data of this
process object The output
of this *function is not valid
until an appropriate Update () method has *been called

virtual void UpdateLargestPossibleRegion ()

virtual void UpdateOutputData (DataObject *output)

virtual void UpdateOutputInformation ()

void UpdateProgress (float amount)

Static Public Member Functions

static void BreakOnError ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static Pointer New ()

This is a global flag that
controls whether any warning
*or error messages are displayed
*static void SetGlobalWarningDisplay (bool flag)

Public Attributes

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 unsigned lon AddObserver )(const EventObject &event, Command *) const

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
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 if an application
has *images and they need
to run a filter on then *run
the filter on then run the
filter on 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 is a global flag that
controls whether any debug

*endcode *In the above example

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
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 if an application
has *images and they need
to run a filter on then *run
the filter on then run the
filter on 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 this only makes
sense for *filters that single
type of input **Other uses
are also possible For a single
input filter

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

* image = someFilter->GetOutput()

*endcode **In this a someFilter
and a anotherFilter are said
*to constitute a b pipeline
**code * image = someFilter->GetOutput()

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
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 if an application
has *images and they need
to run a filter on then *run
the filter on then run the
filter on * images

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
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 if an application
has *images and they need
to run a filter on then *run
the filter on images

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
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 if an application
has *images and they need
to run a filter on images

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
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

Get the output data of this
process object The output
of this *function is not valid
until an appropriate either
explicitly or implicitly Both
the filter *itself and the
data object have and both
*methods update the data Here
are three ways to use *a image
is a pointer to some Image object

*endcode *In the above the
two lines of code can be in
*either order **Note that
it may be more efficient to
*use a pipeline than to call
the data generated is for
the requested * Region

*endcode **In this situation

*Set Get whether the connected
components are defined strictly
by *face connectivity or by
face edge vertex connectivity
Default is *FullyConnectedOff
For objects that are pixel wide

Protected Types

typedef ImageToImageFilterDetail::ImageRegionCopier<
itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) InputToOutputRegionCopierType )

typedef ImageToImageFilterDetail::ImageRegionCopier<
itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) OutputToInputRegionCopierType )

Protected Member Functions

virtual void AddInput (DataObject *input)

virtual void AddOutput (DataObject *output)

virtual void AfterThreadedGenerateData ()

virtual void AllocateOutputs ()

virtual void BeforeThreadedGenerateData ()

virtual void CacheInputReleaseDataFlags ()

virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void EnlargeOutputRequestedRegion (DataObject *)

void GenerateData ()

void GenerateInputRequestedRegion ()

virtual void GenerateOutputInformation ()

virtual void GenerateOutputRequestedRegion (DataObject *output)

const DataObject * GetInput (unsigned int idx) const

virtual const unsigned int & GetNumberOfRequiredInputs ()

virtual const unsigned int & GetNumberOfRequiredOutputs ()

const DataObject * GetOutput (unsigned int idx) const

HConcaveImageFilter ()

ImageToImageFilter ()

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

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

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

virtual void PropagateResetPipeline ()

**these methods end of hiding
the versions from the superclass
*ProcessObject whose arguments
are DataObjects we re expose
*the versions from ProcessObject
to avoid warnings about hiding
*methods from the superclass
*void PushBackInput (const DataObject *input)

* PushBackInput ()

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

void PushFrontInput (const DataObject *input)

virtual void ReleaseInputs ()

virtual void RemoveInput (DataObject *input)

virtual void RemoveOutput (DataObject *output)

virtual void RestoreInputReleaseDataFlags ()

Protected methods for setting
inputs *Subclasses make use
of them for setting input
*virtual void SetNthInput (unsigned int num, DataObject *input)

Protected methods for setting
outputs *Subclasses make use
of them for getting output
*virtual void SetNthOutput (unsigned int num, DataObject *output)

void SetNumberOfInputs (unsigned int num)

void SetNumberOfOutputs (unsigned int num)

virtual void SetNumberOfRequiredInputs (unsigned int _arg)

virtual void SetNumberOfRequiredOutputs (unsigned int _arg)

virtual int SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)

virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

~HConcaveImageFilter ()

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)

Protected Attributes

**these methods end of hiding
the versions from the superclass
*ProcessObject whose arguments
are DataObjects Here

TimeStamp m_OutputInformationMTime

int m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

bool m_Updating

Methods invoked by virtual
Print() to print information
about the object *including
superclasses.Typically not
called by the user(use Print()*instead) but used in the
hierarchical print process
to combine the *output of
several classes.*/virtual
void PrintSelf(std voi PrintHeader )(std::ostream &os, Indent indent) const

Member Typedef Documentation

template<class TInputImage, class TOutputImage>

typedef SmartPointer<const Self> itk::HConcaveImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 52 of file itkHConcaveImageFilter.h.

template<class TOutputImage>

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

Smart Pointer type to a DataObject.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::StatisticsImageFilter< TInputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.
Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects
Definition at line 103 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::ConstPointer itk::HConcaveImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 58 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::PixelType itk::HConcaveImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 60 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::Pointer itk::HConcaveImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 57 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::RegionType itk::HConcaveImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 59 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage itk::HConcaveImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 55 of file itkHConcaveImageFilter.h.

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

Typedef for the region copier function object that converts an input region to an output region.
Definition at line 163 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputImageType::ConstPointer itk::HConcaveImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

Definition at line 62 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputImageType::PixelType itk::HConcaveImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TOutputImage >.
Definition at line 64 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputImageType::Pointer itk::HConcaveImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.
Definition at line 61 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputImageType::RegionType itk::HConcaveImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 63 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage itk::HConcaveImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.
Reimplemented from itk::ImageSource< TOutputImage >.
Definition at line 56 of file itkHConcaveImageFilter.h.

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

Typedef for the region copier function object that converts an output region to an input region.
Definition at line 168 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SmartPointer<Self> itk::HConcaveImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 51 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef HConcaveImageFilter itk::HConcaveImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 48 of file itkHConcaveImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilter<TInputImage, TOutputImage> itk::HConcaveImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 50 of file itkHConcaveImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>

itk::HConcaveImageFilter< TInputImage, TOutputImage >::HConcaveImageFilter ( ) [protected]

template<class TInputImage, class TOutputImage>

itk::HConcaveImageFilter< TInputImage, TOutputImage >::~HConcaveImageFilter ( ) [inline, protected]

Definition at line 122 of file itkHConcaveImageFilter.h.

Member Function Documentation

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

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

Turn on and off the AbortGenerateData flag.

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

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

template<class TInputImage, class TOutputImage>

Set Get the height that a local maximum must be above the local* itk::HConcaveImageFilter< TInputImage, TOutputImage >::background ( local contrast )

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

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

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

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::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< TInputImage , TOutputImage >::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).
Reimplemented in itk::ExtractImageFilter< TInputImage, TOutputImage >.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) 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.

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

Turn debugging output off.

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

Turn debugging output on.

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

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

template<class TInputImage, class TOutputImage>

void itk::HConcaveImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject * ) [protected, virtual]

HConcaveImageFilter will produce the entire output.
Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage>

virtual void itk::HConcaveImageFilter< TInputImage, TOutputImage >::FullyConnectedOff ( ) [virtual]

template<class TInputImage, class TOutputImage>

virtual void itk::HConcaveImageFilter< TInputImage, TOutputImage >::FullyConnectedOn ( ) [virtual]

template<class TInputImage, class TOutputImage>

void itk::HConcaveImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

Single-threaded version of GenerateData. This filter delegates to GrayscaleGeodesicErodeImageFilter.
Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>

void itk::HConcaveImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

HConcaveImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

virtual 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. 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)>, and itk::watershed::SegmentTreeGenerator< ScalarType >.

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.

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

Get the value of the debug flag.

template<class TInputImage, class TOutputImage>

virtual const bool& itk::HConcaveImageFilter< TInputImage, TOutputImage >::GetFullyConnected ( ) [virtual]

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

template<class TInputImage, class TOutputImage>

virtual InputImagePixelType itk::HConcaveImageFilter< TInputImage, TOutputImage >::GetHeight ( ) [virtual]

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

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

Reimplemented from itk::ProcessObject.

const InputImageType* itk::ImageToImageFilter< TInputImage , TOutputImage >::GetInput ( void ) [inherited]

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.

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

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:
A reference to this objects MetaDataDictionary.

Warning:
This reference may be changed.

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

Return this objects modified time.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

Return the multithreader used by this class.
Definition at line 281 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

virtual const char* itk::HConcaveImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

std::vector<DataObjectPointer>::size_type 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 115 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

deprecated* Get the number of iterations used to produce the current* output This method is scheduled for removal since the* implementation now uses a noniterative solution* unsigned long itk::HConcaveImageFilter< TInputImage, TOutputImage >::GetNumberOfIterationsUsed ( ) [inline]

Definition at line 92 of file itkHConcaveImageFilter.h.
References itkLegacyBody.

std::vector<DataObjectPointer>::size_type itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

Definition at line 132 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

virtual std::vector<DataObjectPointer>::size_type itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid 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 >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

template<class TOutputImage>

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

Reimplemented from itk::ProcessObject.

template<class TOutputImage>

Get the output data of this process object The output of this* function is not valid until an appropriate either explicitly or implicitly Both the filter* itself and the data object have and both* methods update the data Here are three ways to use* itk::ImageSource< TOutputImage >::GetOutput ( void ) [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* DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Definition at line 130 of file itkProcessObject.h.

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.

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

Gets the reference count on this object.
Definition at line 98 of file itkLightObject.h.

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

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

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftNthOutput ( unsigned int idx,

DataObject * output

) [virtual, inherited]

Graft the specified data object onto this ProcessObject's idx'th output. This is the similar to GraftOutput method except is allows you 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.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::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).

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TOutputImage>

Get the output data of this process object The output of this* function is not valid until an appropriate either explicitly or implicitly Both the filter* itself and the data object have and both* methods update the data Here are three ways to use* a image is a pointer to some Image and the* particular ProcessObjects involved are filters The same* examples apply to non itk::ImageSource< TOutputImage >::image ( e.g. Mesh ) [inherited]

itk::ImageToImageFilter< TInputImage , TOutputImage >::ImageToImageFilter ( ) [protected, inherited]

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

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

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TInputImage, class TOutputImage>

itk::HConcaveImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( OutputImageDimension ,

unsigned int,

TOutputImage::ImageDimension

)

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

ImageDimension constants* itk::HConcaveImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( InputImageDimension ,

unsigned int,

TInputImage::ImageDimension

)

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

virtual DataObjectPointer itk::ImageSource< TOutputImage >::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.
Reimplemented in itk::EigenAnalysis2DImageFilter< TInputImage, TEigenValueImage, TEigenVectorImage >, itk::MinimumMaximumImageFilter< TInputImage >, and itk::StatisticsImageFilter< TInputImage >.

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

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputImage, class TOutputImage>

static Pointer itk::HConcaveImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Standard New method.
Reimplemented from itk::Object.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PopBackInput ( ) [virtual, inherited]

Reimplemented from itk::ProcessObject.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PopFrontInput ( ) [virtual, inherited]

Reimplemented from itk::ProcessObject.

virtual 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 >.

void itk::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers ( std::ostream & os,

Indent indent

) const [protected, inherited]

template<class TInputImage, class TOutputImage>

void itk::HConcaveImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream & os,

Indent indent

) const [protected, virtual]

Methods invoked by Print() to print information about the object including 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::ImageToImageFilter< TInputImage, TOutputImage >.

virtual void itk::LightObject::PrintTrailer ( std::ostream & os,

Indent indent

) const [protected, virtual, inherited]

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

Send the requested region information back up the pipeline (to the filters that preceed this one).
Reimplemented in itk::VTKImageImport< TOutputImage >.

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

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

* * these methods end of hiding the versions from the superclass* ProcessObject whose arguments are DataObjects we re expose* the versions from ProcessObject to avoid warnings about hiding* methods from the superclass* void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushBackInput ( const DataObject * input ) [inline, protected, virtual, inherited]

Reimplemented from itk::ProcessObject.
Definition at line 250 of file itkImageToImageFilter.h.

* itk::ImageToImageFilter< TInputImage , TOutputImage >::PushBackInput ( ) [protected, 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 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 if an application has* images and they need to run a filter on then* run the filter on then run the filter on 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 this only makes sense for* filters that single type of input* * Other uses are also possible For a single input pushing* and popping inputs allow the application to temporarily replace* an input to a filter** virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushBackInput ( const InputImageType * image ) [virtual, inherited]

* itk::ImageToImageFilter< TInputImage , TOutputImage >::PushFronInput ( ) [protected, inherited]

void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushFrontInput ( const DataObject * input ) [inline, protected, virtual, inherited]

Reimplemented from itk::ProcessObject.
Definition at line 252 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushFrontInput ( const InputImageType * image ) [virtual, inherited]

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

Increase the reference count (mark as used by another object).
Reimplemented from itk::LightObject.

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

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

void itk::ProcessObject::ReleaseDataFlagOff ( ) [inline, inherited]

Definition at line 254 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

Definition at line 253 of file itkProcessObject.h.

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

Remove all observers .

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

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

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

virtual 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.

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

Restore the cached input ReleaseDataFlags.

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.

template<class TInputImage, class TOutputImage>

* Set Get whether the connected components are defined strictly by* face connectivity or by face edge vertex connectivity Default is* FullyConnectedOff For objects that are pixel use* FullyConnectedOn* virtual void itk::HConcaveImageFilter< TInputImage, TOutputImage >::SetFullyConnected ( bool _arg ) [virtual]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::SetInput ( unsigned int,

const TInputImage * image

) [virtual, inherited]

Set Get the image input of this process object* virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::SetInput ( const InputImageType * image ) [virtual, inherited]

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

Returns:
Set the MetaDataDictionary

Protected methods for setting inputs* Subclasses make use of them for setting input* virtual void itk::ProcessObject::SetNthInput ( unsigned int num,

DataObject * input

) [protected, virtual, inherited]

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetReferenceImage(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

Protected methods for setting outputs* Subclasses make use of them for getting output* virtual void itk::ProcessObject::SetNthOutput ( unsigned int num,

DataObject * output

) [protected, virtual, inherited]

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< TInputImage >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< TInputImage >::SetSegmentTable().

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

Called to allocate the input array. Copies old inputs.

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

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

Get Set the number of threads to create when executing* virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

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.

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

Sets the reference count (use with care)
Reimplemented from itk::LightObject.

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* virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

template<class TOutputImage>

virtual int itk::ImageSource< TOutputImage >::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".

template<class TOutputImage>

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TOutputImage >::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().

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

Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.

template<class TOutputImage>

* endcode* In the above the two lines of code can be in* either order* * Note that it may be more efficient to* use a pipeline than to call itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

* endcode* In the above the two lines of code can be in* either order* * Note that itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

* endcode* * code* someFilter itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

* image itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

* anotherFilter itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

Get the output data of this process object The output of this* function is not valid until an appropriate either explicitly or implicitly Both the filter* itself and the data object have itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

template<class TOutputImage>

Get the output data of this process object The output of this* function is not valid until an appropriate itk::ImageSource< TOutputImage >::Update ( ) [virtual, inherited]

Bring this filter up-to-date. 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.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::HistogramMatchingImageFilter< TInputImage, TOutputImage >.

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

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

Actually generate new output
Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateOutputInformation ( ) [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.
Reimplemented in itk::watershed::Segmenter< TInputImage >, and itk::VTKImageImport< TOutputImage >.

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.

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [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 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 if an application has* images and they need to run a filter on then* run the filter on then run the filter on 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 itk::ImageToImageFilter< TInputImage , TOutputImage >::Again [inherited]

Definition at line 103 of file itkImageToImageFilter.h.

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<class TOutputImage>

* endcode* In the above itk::ImageSource< TOutputImage >::example [inherited]

Reimplemented in itk::VotingBinaryHoleFillingImageFilter< TInputImage, TOutputImage >, and itk::VotingBinaryIterativeHoleFillingImageFilter< TImage >.
Definition at line 100 of file itkImageSource.h.

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 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 if an application has* images and they need to run a filter on then* run the filter on then run the filter on 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 this only makes sense for* filters that single type of input* * Other uses are also possible For a single input itk::ImageToImageFilter< TInputImage , TOutputImage >::filter [inherited]

Definition at line 103 of file itkImageToImageFilter.h.

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 itk::ImageToImageFilter< TInputImage , TOutputImage >::filters [inherited]

Reimplemented from itk::ProcessObject.
Definition at line 103 of file itkImageToImageFilter.h.

* * these methods end of hiding the versions from the superclass* ProcessObject whose arguments are DataObjects itk::ImageToImageFilter< TInputImage , TOutputImage >::Here [protected, inherited]

Definition at line 246 of file itkImageToImageFilter.h.

template<class TOutputImage>

* itk::ImageSource< TOutputImage >::image = someFilter->GetOutput() [inherited]

Reimplemented in itk::ExtractImageFilter< TInputImage, TOutputImage >.
Definition at line 98 of file itkImageSource.h.

template<class TOutputImage>

* endcode* * In this a someFilter and a anotherFilter are said* to constitute a b pipeline* * code* itk::ImageSource< TOutputImage >::image = someFilter->GetOutput() [inherited]

Reimplemented in itk::ExtractImageFilter< TInputImage, TOutputImage >.
Definition at line 92 of file itkImageSource.h.

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

Time when GenerateOutputInformation was last called.
Definition at line 428 of file itkProcessObject.h.

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

Number of uses of this object by other objects.
Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count
Definition at line 122 of file itkLightObject.h.

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

This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.
Definition at line 425 of file itkProcessObject.h.

template<class TOutputImage>

Get the output data of this process object The output of this* function is not valid until an appropriate either explicitly or implicitly Both the filter* itself and the data object have and both* methods update the data Here are three ways to use* a image is a pointer to some Image itk::ImageSource< TOutputImage >::object [inherited]

Definition at line 79 of file itkImageSource.h.

Methods invoked by virtual Print () to print information about the object * including superclasses. Typically not called by the user (use Print() * instead) but used in the hierarchical print process to combine the * output of several classes. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

template<class TOutputImage>

* endcode* In the above the two lines of code can be in* either order* * Note that it may be more efficient to* use a pipeline than to call the data generated is for the requested* itk::ImageSource< TOutputImage >::Region [inherited]

Definition at line 110 of file itkImageSource.h.

template<class TOutputImage>

* endcode* * In this itk::ImageSource< TOutputImage >::situation [inherited]

Definition at line 88 of file itkImageSource.h.

template<class TInputImage, class TOutputImage>

* Set Get whether the connected components are defined strictly by* face connectivity or by face edge vertex connectivity Default is* FullyConnectedOff For objects that are pixel itk::HConcaveImageFilter< TInputImage, TOutputImage >::wide

Definition at line 94 of file itkHConcaveImageFilter.h.

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

itkHConcaveImageFilter.h

Generated at Sun Jul 9 20:02:24 2006 for ITK by


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef HConcaveImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
Set Get the height that a local maximum must be above the local *	background (local contrast) in order to survive the processing.Local maxima below this value are replaced with an estimate of the local background.*/virtual void SetHeight(InputImagePixelType _arg)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	FullyConnectedOff ()
virtual void	FullyConnectedOn ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const bool &	GetFullyConnected ()
virtual InputImagePixelType	GetHeight ()
const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
std::vector< DataObjectPointer >::size_type	GetNumberOfInputs () const
deprecated Get the number of iterations used to produce the current output This method is scheduled for removal since the implementation now uses a noniterative solution unsigned long	GetNumberOfIterationsUsed ()
std::vector< DataObjectPointer >::size_type	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
virtual std::vector< DataObjectPointer >::size_type	GetNumberOfValidRequiredInputs () const
OutputImageType *	GetOutput (unsigned int idx)
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have and both methods update the data Here are three ways to use	GetOutput () and make sure the data is valid.In these *examples
Return an array with all the outputs of this process object This is useful for tracing forward in the pipeline to contruct graphs etc *DataObjectPointerArray &	GetOutputs ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have and both methods update the data Here are three ways to use a image is a pointer to some Image and the particular ProcessObjects involved are filters The same examples apply to non	image (e.g.Mesh) data as well.*\code anotherFilter->SetInput(someFilter->GetOutput())
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
ImageDimension constants *	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
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 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 if an application has images and they need to run a filter on then run the filter on then run the filter on 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 this only makes sense for filters that single type of input Other uses are also possible For a single input pushing and popping inputs allow the application to temporarily replace an input to a filter *virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	Register () const
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
Set Get whether the connected components are defined strictly by face connectivity or by face edge vertex connectivity Default is FullyConnectedOff For objects that are pixel use FullyConnectedOn *virtual void	SetFullyConnected (bool _arg)
virtual void	SetInput (unsigned int, const TInputImage *image)
Set Get the image input of this process object *virtual void	SetInput (const InputImageType *image)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Get Set the number of threads to create when executing *virtual void	SetNumberOfThreads (int _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
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 *virtual void	SetReleaseDataFlag (bool flag)
virtual void	UnRegister () const
endcode In the above the two lines of code can be in either order Note that it may be more efficient to use a pipeline than to call	Update () once for each filter in turn.*For an image
endcode In the above 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\b streaming(using a StreamingImageFilter) is activated
endcode code someFilter	Update ()
*image	Update ()
*anotherFilter	Update ()
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have	Update () methods
Get the output data of this process object The output of this *function is not valid until an appropriate	Update () method has *been called
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
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 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 if an application has images and they need to run a filter on then run the filter on then run the filter on 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 is a global flag that controls whether any	debug
endcode In the above	example
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 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 if an application has images and they need to run a filter on then run the filter on then run the filter on 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 this only makes sense for filters that single type of input *Other uses are also possible For a single input	filter
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
*	image = someFilter->GetOutput()
endcode In this a someFilter and a anotherFilter are said to constitute a b pipeline *code	image = someFilter->GetOutput()
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 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 if an application has images and they need to run a filter on then run the filter on then run the filter on *	images
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 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 if an application has images and they need to run a filter on then run the filter on	images
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 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 if an application has *images and they need to run a filter on	images
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 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
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have and both methods update the data Here are three ways to use a image is a pointer to some Image	object
endcode In the above the two lines of code can be in either order Note that it may be more efficient to use a pipeline than to call the data generated is for the requested *	Region
endcode *In this	situation
Set Get whether the connected components are defined strictly by face connectivity or by face edge vertex connectivity Default is *FullyConnectedOff For objects that are pixel	wide
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)	InputToOutputRegionCopierType )
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)	OutputToInputRegionCopierType )
Protected Member Functions
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
	HConcaveImageFilter ()
	ImageToImageFilter ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
*these methods end of hiding the versions from the superclass ProcessObject whose arguments are DataObjects we re expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass *void	PushBackInput (const DataObject *input)
*	PushBackInput ()
*	PushFronInput () in the public section force the *input to be the type expected by an ImageToImageFilter.However
void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	RestoreInputReleaseDataFlags ()
Protected methods for setting inputs Subclasses make use of them for setting input virtual void	SetNthInput (unsigned int num, DataObject *input)
Protected methods for setting outputs Subclasses make use of them for getting output virtual void	SetNthOutput (unsigned int num, DataObject *output)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
	~HConcaveImageFilter ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
*these methods end of hiding the versions from the superclass ProcessObject whose arguments are DataObjects	Here
TimeStamp	m_OutputInformationMTime
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating
Methods invoked by virtual Print() to print information about the object including superclasses.Typically not called by the user(use Print()instead) but used in the hierarchical print process to combine the output of several classes./virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

itk::HConcaveImageFilter< TInputImage, TOutputImage > Class Template Reference [Image Enhancement Filters]

Detailed Description

template<class TInputImage, class TOutputImage> class itk::HConcaveImageFilter< TInputImage, TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions