ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::RegionFromReferenceLabelMapFilter< TInputImage > Class Template Reference

#include <itkRegionFromReferenceLabelMapFilter.h>

+ Inheritance diagram for itk::RegionFromReferenceLabelMapFilter< TInputImage >:
+ Collaboration diagram for itk::RegionFromReferenceLabelMapFilter< TInputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef InputImageType::IndexType IndexType
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef
InputImageType::LabelObjectType 
LabelObjectType
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
typedef
Superclass::OutputImagePointer 
OutputImagePointer
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef Superclass::OutputImageType OutputImageType
typedef InputImageType::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef ImageBase
< itkGetStaticConstMacro(ImageDimension) > 
ReferenceImageType
typedef InputImageType::RegionType RegionType
typedef
RegionFromReferenceLabelMapFilter 
Self
typedef InputImageType::SizeType SizeType
typedef
ChangeRegionLabelMapFilter
< TInputImage > 
Superclass
typedef TInputImage TOutputImage
- Public Types inherited from itk::ChangeRegionLabelMapFilter< TInputImage >
typedef
InputImageType::IndexValueType 
IndexValueType
- Public Types inherited from itk::InPlaceLabelMapFilter< TInputImage >
- Public Types inherited from itk::LabelMapFilter< TInputImage, TInputImage >
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
- Public Types inherited from itk::ImageSource< TInputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
const ReferenceImageTypeGetReferenceImage () const
void SetInput1 (const TInputImage *input)
void SetInput2 (const ReferenceImageType *input)
void SetReferenceImage (const ReferenceImageType *image)
virtual void SetRegion (OutputImageRegionType _arg)
virtual const
OutputImageRegionType
GetRegion ()
- Public Member Functions inherited from itk::InPlaceLabelMapFilter< TInputImage >
bool CanRunInPlace () const
virtual void SetInPlace (bool _arg)
virtual bool GetInPlace ()
virtual void InPlaceOn ()
virtual void InPlaceOff ()
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
const InputImageTypeGetInput (void) const
const InputImageTypeGetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TInputImage *image)
- Public Member Functions inherited from itk::ImageSource< TInputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
static const unsigned int ImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ChangeRegionLabelMapFilter< TInputImage >
- Static Public Attributes inherited from itk::InPlaceLabelMapFilter< TInputImage >
- Static Public Attributes inherited from itk::LabelMapFilter< TInputImage, TInputImage >
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
- Static Public Attributes inherited from itk::ImageSource< TInputImage >

Protected Member Functions

virtual void GenerateOutputInformation ()
void PrintSelf (std::ostream &os, Indent indent) const
 RegionFromReferenceLabelMapFilter ()
 ~RegionFromReferenceLabelMapFilter ()
- Protected Member Functions inherited from itk::ChangeRegionLabelMapFilter< TInputImage >
void EnlargeOutputRequestedRegion (DataObject *)
void GenerateData ()
void GenerateInputRequestedRegion ()
virtual void ThreadedProcessLabelObject (LabelObjectType *labelObject)
 ChangeRegionLabelMapFilter ()
 ~ChangeRegionLabelMapFilter ()
- Protected Member Functions inherited from itk::InPlaceLabelMapFilter< TInputImage >
virtual void AllocateOutputs ()
virtual InputImageTypeGetLabelMap ()
 InPlaceLabelMapFilter ()
 ~InPlaceLabelMapFilter ()
- Protected Member Functions inherited from itk::LabelMapFilter< TInputImage, TInputImage >
virtual void AfterThreadedGenerateData ()
virtual void BeforeThreadedGenerateData ()
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 LabelMapFilter ()
 ~LabelMapFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TInputImage >
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

void operator= (const Self &)
 RegionFromReferenceLabelMapFilter (const Self &)

Detailed Description

template<class TInputImage>
class itk::RegionFromReferenceLabelMapFilter< TInputImage >

Set the region from a reference image.

Change the region of a label map to be the same as one of a reference image. This filter implements the same feature as its superclass, but with the input region well integrated in the pipeline architecture. If the output cannot contain some of the objects' lines, they are truncated or removed. All objects fully outside the output region are removed.

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

Author:
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

Definition at line 54 of file itkRegionFromReferenceLabelMapFilter.h.


Member Typedef Documentation

template<class TInputImage >
typedef SmartPointer< const Self > itk::RegionFromReferenceLabelMapFilter< TInputImage >::ConstPointer
template<class TInputImage >
typedef InputImageType::IndexType itk::RegionFromReferenceLabelMapFilter< TInputImage >::IndexType
template<class TInputImage >
typedef InputImageType::ConstPointer itk::RegionFromReferenceLabelMapFilter< TInputImage >::InputImageConstPointer
template<class TInputImage >
typedef InputImageType::PixelType itk::RegionFromReferenceLabelMapFilter< TInputImage >::InputImagePixelType
template<class TInputImage >
typedef InputImageType::Pointer itk::RegionFromReferenceLabelMapFilter< TInputImage >::InputImagePointer
template<class TInputImage >
typedef InputImageType::RegionType itk::RegionFromReferenceLabelMapFilter< TInputImage >::InputImageRegionType
template<class TInputImage >
typedef TInputImage itk::RegionFromReferenceLabelMapFilter< TInputImage >::InputImageType

Some convenient typedefs.

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 76 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
typedef InputImageType::LabelObjectType itk::RegionFromReferenceLabelMapFilter< TInputImage >::LabelObjectType
template<class TInputImage >
typedef Superclass::OutputImagePixelType itk::RegionFromReferenceLabelMapFilter< TInputImage >::OutputImagePixelType
template<class TInputImage >
typedef Superclass::OutputImagePointer itk::RegionFromReferenceLabelMapFilter< TInputImage >::OutputImagePointer
template<class TInputImage >
typedef Superclass::OutputImageRegionType itk::RegionFromReferenceLabelMapFilter< TInputImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 72 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
typedef Superclass::OutputImageType itk::RegionFromReferenceLabelMapFilter< TInputImage >::OutputImageType

Superclass typedefs.

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 67 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
typedef InputImageType::PixelType itk::RegionFromReferenceLabelMapFilter< TInputImage >::PixelType
template<class TInputImage >
typedef SmartPointer< Self > itk::RegionFromReferenceLabelMapFilter< TInputImage >::Pointer
template<class TInputImage >
typedef ImageBase< itkGetStaticConstMacro(ImageDimension) > itk::RegionFromReferenceLabelMapFilter< TInputImage >::ReferenceImageType

Definition at line 96 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
typedef InputImageType::RegionType itk::RegionFromReferenceLabelMapFilter< TInputImage >::RegionType
template<class TInputImage >
typedef RegionFromReferenceLabelMapFilter itk::RegionFromReferenceLabelMapFilter< TInputImage >::Self

Standard class typedefs.

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 58 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
typedef InputImageType::SizeType itk::RegionFromReferenceLabelMapFilter< TInputImage >::SizeType
template<class TInputImage >
typedef ChangeRegionLabelMapFilter< TInputImage > itk::RegionFromReferenceLabelMapFilter< TInputImage >::Superclass
template<class TInputImage >
typedef TInputImage itk::RegionFromReferenceLabelMapFilter< TInputImage >::TOutputImage

Constructor & Destructor Documentation

template<class TInputImage >
itk::RegionFromReferenceLabelMapFilter< TInputImage >::RegionFromReferenceLabelMapFilter ( )
inlineprotected

Definition at line 116 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
itk::RegionFromReferenceLabelMapFilter< TInputImage >::~RegionFromReferenceLabelMapFilter ( )
inlineprotected

Definition at line 121 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
itk::RegionFromReferenceLabelMapFilter< TInputImage >::RegionFromReferenceLabelMapFilter ( const Self )
private

Member Function Documentation

template<class TInputImage >
virtual::itk::LightObject::Pointer itk::RegionFromReferenceLabelMapFilter< TInputImage >::CreateAnother ( void  ) const
virtual

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

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

template<class TInputImage >
virtual void itk::RegionFromReferenceLabelMapFilter< TInputImage >::GenerateOutputInformation ( )
protectedvirtual

Generate the information describing the output data. 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.

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

template<class TInputImage >
virtual const char* itk::RegionFromReferenceLabelMapFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

template<class TInputImage >
const ReferenceImageType* itk::RegionFromReferenceLabelMapFilter< TInputImage >::GetReferenceImage ( ) const
template<class TInputImage >
static Pointer itk::RegionFromReferenceLabelMapFilter< TInputImage >::New ( )
static

Standard New method.

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

template<class TInputImage >
void itk::RegionFromReferenceLabelMapFilter< TInputImage >::operator= ( const Self )
private

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::ChangeRegionLabelMapFilter< TInputImage >.

template<class TInputImage >
void itk::RegionFromReferenceLabelMapFilter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::ChangeRegionLabelMapFilter< TInputImage >.

template<class TInputImage >
void itk::RegionFromReferenceLabelMapFilter< TInputImage >::SetInput1 ( const TInputImage *  input)
inline

Set the input image

Definition at line 104 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
void itk::RegionFromReferenceLabelMapFilter< TInputImage >::SetInput2 ( const ReferenceImageType input)
inline

Set the reference image

Definition at line 110 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
void itk::RegionFromReferenceLabelMapFilter< TInputImage >::SetReferenceImage ( const ReferenceImageType image)

Copy the output information from another Image.


Member Data Documentation

template<class TInputImage >
const unsigned int itk::RegionFromReferenceLabelMapFilter< TInputImage >::ImageDimension = TOutputImage::ImageDimension
static

ImageDimension constants

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 93 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
const unsigned int itk::RegionFromReferenceLabelMapFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 91 of file itkRegionFromReferenceLabelMapFilter.h.

template<class TInputImage >
const unsigned int itk::RegionFromReferenceLabelMapFilter< TInputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension constants

Reimplemented from itk::ChangeRegionLabelMapFilter< TInputImage >.

Definition at line 92 of file itkRegionFromReferenceLabelMapFilter.h.


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