ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes
itk::JoinImageFilter< TInputImage1, TInputImage2 > Class Template Reference

#include <itkJoinImageFilter.h>

+ Inheritance diagram for itk::JoinImageFilter< TInputImage1, TInputImage2 >:
+ Collaboration diagram for itk::JoinImageFilter< TInputImage1, TInputImage2 >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Functor::MakeJoin
< TInputImage1, TInputImage2 >
::FunctorType 
FunctorType
typedef FunctorType::JoinType OutputImagePixelType
typedef Functor::MakeJoin
< TInputImage1, TInputImage2 >
::ImageType 
OutputImageType
typedef SmartPointer< SelfPointer
typedef JoinImageFilter Self
typedef
BinaryFunctorImageFilter
< TInputImage1, TInputImage2,
OutputImageType, FunctorType
Superclass
- Public Types inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType, Functor::MakeJoin< TInputImage1, TInputImage2 >::FunctorType >
typedef
SimpleDataObjectDecorator
< Input1ImagePixelType
DecoratedInput1ImagePixelType
typedef
SimpleDataObjectDecorator
< Input2ImagePixelType
DecoratedInput2ImagePixelType
typedef Input1ImageType::PixelType Input1ImagePixelType
typedef
Input1ImageType::ConstPointer 
Input1ImagePointer
typedef Input1ImageType::RegionType Input1ImageRegionType
typedef TInputImage1 Input1ImageType
typedef Input2ImageType::PixelType Input2ImagePixelType
typedef
Input2ImageType::ConstPointer 
Input2ImagePointer
typedef Input2ImageType::RegionType Input2ImageRegionType
typedef TInputImage2 Input2ImageType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
- Public Types inherited from itk::InPlaceImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage1 InputImageType
- Public Types inherited from itk::ImageToImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
- Public Types inherited from itk::ImageSource< Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
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
 typedef (Concept::HasPixelTraits< typename TInputImage1::PixelType >) Input1HasPixelTraitsCheck
 typedef (Concept::HasPixelTraits< typename TInputImage2::PixelType >) Input2HasPixelTraitsCheck
 typedef (Concept::HasJoinTraits< typename PixelTraits< typename TInputImage1::PixelType >::ValueType, typename PixelTraits< typename TInputImage2::PixelType >::ValueType >) Input1Input2HasJoinTraitsCheck
- Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType, Functor::MakeJoin< TInputImage1, TInputImage2 >::FunctorType >
virtual const
Input1ImagePixelType
GetConstant1 () const
virtual const
Input2ImagePixelType
GetConstant2 () const
FunctorTypeGetFunctor ()
const FunctorTypeGetFunctor () const
virtual void SetConstant1 (const Input1ImagePixelType &input1)
 typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(InputImage2Dimension) >) SameDimensionCheck1
 typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(OutputImageDimension) >) SameDimensionCheck2
virtual void SetInput1 (const TInputImage1 *image1)
virtual void SetInput1 (const DecoratedInput1ImagePixelType *input1)
virtual void SetInput1 (const Input1ImagePixelType &input1)
virtual void SetInput2 (const TInputImage2 *image2)
virtual void SetInput2 (const DecoratedInput2ImagePixelType *input2)
virtual void SetInput2 (const Input2ImagePixelType &input2)
virtual void SetConstant2 (const Input2ImagePixelType &input2)
void SetConstant (Input2ImagePixelType ct)
const Input2ImagePixelTypeGetConstant () const
void SetFunctor (const FunctorType &functor)
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
virtual bool CanRunInPlace () const
virtual void SetInPlace (bool _arg)
virtual bool GetInPlace () const
virtual void InPlaceOn ()
virtual void InPlaceOff ()
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
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 TInputImage1 *image)
- Public Member Functions inherited from itk::ImageSource< Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
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 void EnlargeOutputRequestedRegion (DataObject *)
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 OutputImageDimension = TInputImage1::ImageDimension
- Static Public Attributes inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType, Functor::MakeJoin< TInputImage1, TInputImage2 >::FunctorType >
static const unsigned int InputImage1Dimension
static const unsigned int InputImage2Dimension
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
static const unsigned int InputImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
- Static Public Attributes inherited from itk::ImageSource< Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
- Protected Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType, Functor::MakeJoin< TInputImage1, TInputImage2 >::FunctorType >
 BinaryFunctorImageFilter ()
virtual void GenerateOutputInformation ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~BinaryFunctorImageFilter ()
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
virtual void AllocateOutputs ()
virtual bool GetRunningInPlace () const
 InPlaceImageFilter ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void ReleaseInputs ()
 ~InPlaceImageFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void GenerateInputRequestedRegion ()
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >
virtual void AfterThreadedGenerateData ()
virtual void BeforeThreadedGenerateData ()
virtual void GenerateData ()
 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 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 ()
 JoinImageFilter ()
virtual ~JoinImageFilter ()
 JoinImageFilter (const Self &)
void operator= (const Self &)

Additional Inherited Members


Detailed Description

template<class TInputImage1, class TInputImage2>
class itk::JoinImageFilter< TInputImage1, TInputImage2 >

Join two images, resulting in an image where each pixel has the components of the first image followed by the components of the second image.

JoinImageFilter combines two images by appending the components of one image to the components of another image. The output image type is always a itk::Vector image and the vector value type will the smallest type that can represent the dynamic range of both the input value types. Hence, joining an image of char and unsigned char results in an image of shorts since that is the smallest datatype with a large enough dynamic range. To define a consistent behavior across different architectures, the join of an int and an unsigned int is float. On a 64 bit architecture, this join could be represented in a long. But on 32 bit architectures, the only safe join value type is a float. For this and similar ambiguous cases, the join value type is promoted to a float.

Note that this filter is not templated over its output image type. Rather the filter determines what its output image type is based on the input data types. To determine the output type, use JoinImageFilter<Image1, Image2>::OutputImageType

Wiki Examples:

Definition at line 209 of file itkJoinImageFilter.h.


Member Typedef Documentation

template<class TInputImage1 , class TInputImage2 >
typedef SmartPointer< const Self > itk::JoinImageFilter< TInputImage1, TInputImage2 >::ConstPointer
template<class TInputImage1 , class TInputImage2 >
typedef Functor::MakeJoin< TInputImage1, TInputImage2 >::FunctorType itk::JoinImageFilter< TInputImage1, TInputImage2 >::FunctorType
template<class TInputImage1 , class TInputImage2 >
typedef FunctorType::JoinType itk::JoinImageFilter< TInputImage1, TInputImage2 >::OutputImagePixelType
template<class TInputImage1 , class TInputImage2 >
typedef Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType itk::JoinImageFilter< TInputImage1, TInputImage2 >::OutputImageType
template<class TInputImage1 , class TInputImage2 >
typedef SmartPointer< Self > itk::JoinImageFilter< TInputImage1, TInputImage2 >::Pointer
template<class TInputImage1 , class TInputImage2 >
typedef JoinImageFilter itk::JoinImageFilter< TInputImage1, TInputImage2 >::Self
template<class TInputImage1 , class TInputImage2 >
typedef BinaryFunctorImageFilter< TInputImage1, TInputImage2, OutputImageType, FunctorType > itk::JoinImageFilter< TInputImage1, TInputImage2 >::Superclass

Constructor & Destructor Documentation

template<class TInputImage1 , class TInputImage2 >
itk::JoinImageFilter< TInputImage1, TInputImage2 >::JoinImageFilter ( )
inlineprotected

End concept checking

Definition at line 260 of file itkJoinImageFilter.h.

template<class TInputImage1 , class TInputImage2 >
virtual itk::JoinImageFilter< TInputImage1, TInputImage2 >::~JoinImageFilter ( )
inlineprotectedvirtual

End concept checking

Definition at line 261 of file itkJoinImageFilter.h.

template<class TInputImage1 , class TInputImage2 >
itk::JoinImageFilter< TInputImage1, TInputImage2 >::JoinImageFilter ( const Self )
private

End concept checking


Member Function Documentation

template<class TInputImage1 , class TInputImage2 >
virtual::itk::LightObject::Pointer itk::JoinImageFilter< TInputImage1, TInputImage2 >::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::BinaryFunctorImageFilter< TInputImage1, TInputImage2, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType, Functor::MakeJoin< TInputImage1, TInputImage2 >::FunctorType >.

template<class TInputImage1 , class TInputImage2 >
virtual const char* itk::JoinImageFilter< TInputImage1, TInputImage2 >::GetNameOfClass ( ) const
virtual
template<class TInputImage1 , class TInputImage2 >
static Pointer itk::JoinImageFilter< TInputImage1, TInputImage2 >::New ( )
static
template<class TInputImage1 , class TInputImage2 >
void itk::JoinImageFilter< TInputImage1, TInputImage2 >::operator= ( const Self )
private
template<class TInputImage1 , class TInputImage2 >
itk::JoinImageFilter< TInputImage1, TInputImage2 >::typedef ( Concept::HasPixelTraits< typename TInputImage1::PixelType >  )

Begin concept checking This class requires Input1HasPixelTraitsCheck in the form of ( Concept::HasPixelTraits< typename TInputImage1::PixelType > )

template<class TInputImage1 , class TInputImage2 >
itk::JoinImageFilter< TInputImage1, TInputImage2 >::typedef ( Concept::HasPixelTraits< typename TInputImage2::PixelType >  )

This class requires Input2HasPixelTraitsCheck in the form of ( Concept::HasPixelTraits< typename TInputImage2::PixelType > )

template<class TInputImage1 , class TInputImage2 >
itk::JoinImageFilter< TInputImage1, TInputImage2 >::typedef ( Concept::HasJoinTraits< typename PixelTraits< typename TInputImage1::PixelType >::ValueType, typename PixelTraits< typename TInputImage2::PixelType >::ValueType >  )

This class requires Input1Input2HasJoinTraitsCheck in the form of ( Concept::HasJoinTraits< typename PixelTraits< typename TInputImage1::PixelType >::ValueType, typename PixelTraits< typename TInputImage2::PixelType >::ValueType > )


Member Data Documentation

template<class TInputImage1 , class TInputImage2 >
const unsigned int itk::JoinImageFilter< TInputImage1, TInputImage2 >::OutputImageDimension = TInputImage1::ImageDimension
static

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