ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ImportImageFilter< TPixel, VImageDimension > Class Template Reference
Data Processing Objects » Filters » Input and Output Filters | Group Core » Module ITKCommon

#include <itkImportImageFilter.h>

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 2>
class itk::ImportImageFilter< TPixel, VImageDimension >

Import data from a standard C array into an itk::Image.

ImportImageFilter provides a mechanism for importing data into an itk::Image. ImportImageFilter is an image source, so it behaves like any other pipeline object.

This class is templated over the pixel type and the image dimension of the output image.

ITK Sphinx Examples:
  • <a href=
  • <a href=

Definition at line 43 of file itkImportImageFilter.h.

+ Inheritance diagram for itk::ImportImageFilter< TPixel, VImageDimension >:
+ Collaboration diagram for itk::ImportImageFilter< TPixel, VImageDimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >
 
using ImportImageContainerType = ImportImageContainer< SizeValueType, TPixel >
 
using IndexType = Index< VImageDimension >
 
using OriginType = typename OutputImageType::PointType
 
using OutputImagePixelType = TPixel
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageType = Image< TPixel, VImageDimension >
 
using Pointer = SmartPointer< Self >
 
using RegionType = ImageRegion< VImageDimension >
 
using Self = ImportImageFilter
 
using SizeType = Size< VImageDimension >
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageSource< OutputImageType >
 
- Public Types inherited from itk::ImageSource< Image< TPixel, 2 > >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = Image< TPixel, 2 >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const DirectionType & GetDirection () const
 
TPixel * GetImportPointer ()
 
const char * GetNameOfClass () const override
 
const RegionType & GetRegion () const
 
virtual void SetDirection (const DirectionType &direction)
 
void SetImportPointer (TPixel *ptr, SizeValueType num, bool LetImageContainerManageMemory)
 
void SetRegion (const RegionType &region)
 
virtual void SetSpacing (SpacingType _arg)
 
virtual const SpacingType & GetSpacing () const
 
virtual void SetSpacing (const float data[])
 
virtual void SetOrigin (OriginType _arg)
 
virtual const OriginType & GetOrigin () const
 
virtual void SetOrigin (const float data[])
 
- Public Member Functions inherited from itk::ImageSource< Image< TPixel, 2 > >
const char * GetNameOfClass () const override
 
OutputImageType * GetOutput (unsigned int idx)
 
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateData () override
 
void GenerateOutputInformation () override
 
 ImportImageFilter ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImportImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageSource< Image< TPixel, 2 > >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

DirectionType m_Direction { DirectionType::GetIdentity() }
 
ImportImageContainerType::Pointer m_ImportImageContainer {}
 
OriginType m_Origin {}
 
RegionType m_Region {}
 
SizeValueType m_Size {}
 
SpacingType m_Spacing { MakeFilled<SpacingType>(1.0) }
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageSource< Image< TPixel, 2 > >
static constexpr unsigned int OutputImageDimension
 
- Static Protected Member Functions inherited from itk::ImageSource< Image< TPixel, 2 > >
static const ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< Image< TPixel, 2 > >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 59 of file itkImportImageFilter.h.

◆ DirectionType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::DirectionType = Matrix<SpacePrecisionType, VImageDimension, VImageDimension>

Definition at line 133 of file itkImportImageFilter.h.

◆ ImportImageContainerType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::ImportImageContainerType = ImportImageContainer<SizeValueType, TPixel>

Definition at line 53 of file itkImportImageFilter.h.

◆ IndexType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::IndexType = Index<VImageDimension>

Index type alias support An index is used to access pixel values.

Definition at line 68 of file itkImportImageFilter.h.

◆ OriginType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::OriginType = typename OutputImageType::PointType

Definition at line 52 of file itkImportImageFilter.h.

◆ OutputImagePixelType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::OutputImagePixelType = TPixel

Type of the output image pixel type.

Definition at line 78 of file itkImportImageFilter.h.

◆ OutputImagePointer

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 50 of file itkImportImageFilter.h.

◆ OutputImageType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::OutputImageType = Image<TPixel, VImageDimension>

Typedef for the output image.

Definition at line 49 of file itkImportImageFilter.h.

◆ Pointer

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::Pointer = SmartPointer<Self>

Definition at line 58 of file itkImportImageFilter.h.

◆ RegionType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::RegionType = ImageRegion<VImageDimension>

Region type alias support A region is used to specify a subset of an image.

Definition at line 75 of file itkImportImageFilter.h.

◆ Self

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::Self = ImportImageFilter

Standard class type aliases.

Definition at line 56 of file itkImportImageFilter.h.

◆ SizeType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::SizeType = Size<VImageDimension>

Size type alias support A size is used to define region bounds.

Definition at line 71 of file itkImportImageFilter.h.

◆ SpacingType

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::SpacingType = typename OutputImageType::SpacingType

Definition at line 51 of file itkImportImageFilter.h.

◆ Superclass

template<typename TPixel , unsigned int VImageDimension = 2>
using itk::ImportImageFilter< TPixel, VImageDimension >::Superclass = ImageSource<OutputImageType>

Definition at line 57 of file itkImportImageFilter.h.

Constructor & Destructor Documentation

◆ ImportImageFilter()

template<typename TPixel , unsigned int VImageDimension = 2>
itk::ImportImageFilter< TPixel, VImageDimension >::ImportImageFilter ( )
protecteddefault

◆ ~ImportImageFilter()

template<typename TPixel , unsigned int VImageDimension = 2>
itk::ImportImageFilter< TPixel, VImageDimension >::~ImportImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::EnlargeOutputRequestedRegion ( DataObject *  output)
overrideprotectedvirtual

This filter can only produce the amount of data that it is given, so we must override ProcessObject::EnlargeOutputRequestedRegion() (The default implementation of a source produces the amount of data requested. This source, however, can only produce what it is given.)

See also
ProcessObject::EnlargeOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::GenerateData ( )
overrideprotectedvirtual

This filter does not actually "produce" any data, rather it "wraps" the user supplied data into an itk::Image.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputInformation()

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::GenerateOutputInformation ( )
overrideprotectedvirtual

This is a source, so it must set the spacing, size, and largest possible region for the output image that it will produce.

See also
ProcessObject::GenerateOutputInformation()

Reimplemented from itk::ProcessObject.

◆ GetDirection()

template<typename TPixel , unsigned int VImageDimension = 2>
virtual const DirectionType & itk::ImportImageFilter< TPixel, VImageDimension >::GetDirection ( ) const
virtual

Get the direction of the image

See also
SetDirection

◆ GetImportPointer()

template<typename TPixel , unsigned int VImageDimension = 2>
TPixel * itk::ImportImageFilter< TPixel, VImageDimension >::GetImportPointer ( )

Get the pointer from which the image data is imported.

◆ GetNameOfClass()

template<typename TPixel , unsigned int VImageDimension = 2>
const char * itk::ImportImageFilter< TPixel, VImageDimension >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ GetOrigin()

template<typename TPixel , unsigned int VImageDimension = 2>
virtual const OriginType & itk::ImportImageFilter< TPixel, VImageDimension >::GetOrigin ( ) const
virtual

Set the origin of the image.

See also
GetOrigin()

◆ GetRegion()

template<typename TPixel , unsigned int VImageDimension = 2>
const RegionType & itk::ImportImageFilter< TPixel, VImageDimension >::GetRegion ( ) const
inline

Get the region object that defines the size and starting index for the imported image. This will serve as the LargestPossibleRegion, the BufferedRegion, and the RequestedRegion.

See also
ImageRegion

Definition at line 114 of file itkImportImageFilter.h.

◆ GetSpacing()

template<typename TPixel , unsigned int VImageDimension = 2>
virtual const SpacingType & itk::ImportImageFilter< TPixel, VImageDimension >::GetSpacing ( ) const
virtual

Set the spacing (size of a pixel) of the image.

See also
GetSpacing()

◆ New()

template<typename TPixel , unsigned int VImageDimension = 2>
static Pointer itk::ImportImageFilter< TPixel, VImageDimension >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

◆ SetDirection()

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetDirection ( const DirectionType &  direction)
virtual

Set the direction of the image

See also
GetDirection()

◆ SetImportPointer()

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::SetImportPointer ( TPixel *  ptr,
SizeValueType  num,
bool  LetImageContainerManageMemory 
)

Set the pointer from which the image data is imported. "num" is the number of pixels in the block of memory. If "LetImageContainerManageMemory" is false, then the this filter will not free the memory in its destructor and the application providing the buffer retains the responsibility of freeing the memory for this image data. If "LetImageContainerManageMemory" is true, then the ImageContainer will free the memory when it is destroyed.

◆ SetOrigin() [1/2]

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetOrigin ( const float  data[])
virtual

Set the origin of the image.

See also
GetOrigin()

◆ SetOrigin() [2/2]

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetOrigin ( OriginType  _arg)
virtual

Set the origin of the image.

See also
GetOrigin()

◆ SetRegion()

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::SetRegion ( const RegionType &  region)
inline

Set the region object that defines the size and starting index for the imported image. This will serve as the LargestPossibleRegion, the BufferedRegion, and the RequestedRegion.

See also
ImageRegion

Definition at line 99 of file itkImportImageFilter.h.

◆ SetSpacing() [1/2]

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetSpacing ( const float  data[])
virtual

Set the spacing (size of a pixel) of the image.

See also
GetSpacing()

◆ SetSpacing() [2/2]

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetSpacing ( SpacingType  _arg)
virtual

Set the spacing (size of a pixel) of the image.

See also
GetSpacing()

Member Data Documentation

◆ m_Direction

template<typename TPixel , unsigned int VImageDimension = 2>
DirectionType itk::ImportImageFilter< TPixel, VImageDimension >::m_Direction { DirectionType::GetIdentity() }
private

Definition at line 175 of file itkImportImageFilter.h.

◆ m_ImportImageContainer

template<typename TPixel , unsigned int VImageDimension = 2>
ImportImageContainerType::Pointer itk::ImportImageFilter< TPixel, VImageDimension >::m_ImportImageContainer {}
private

Definition at line 177 of file itkImportImageFilter.h.

◆ m_Origin

template<typename TPixel , unsigned int VImageDimension = 2>
OriginType itk::ImportImageFilter< TPixel, VImageDimension >::m_Origin {}
private

Definition at line 174 of file itkImportImageFilter.h.

◆ m_Region

template<typename TPixel , unsigned int VImageDimension = 2>
RegionType itk::ImportImageFilter< TPixel, VImageDimension >::m_Region {}
private

Definition at line 172 of file itkImportImageFilter.h.

◆ m_Size

template<typename TPixel , unsigned int VImageDimension = 2>
SizeValueType itk::ImportImageFilter< TPixel, VImageDimension >::m_Size {}
private

Definition at line 178 of file itkImportImageFilter.h.

◆ m_Spacing

template<typename TPixel , unsigned int VImageDimension = 2>
SpacingType itk::ImportImageFilter< TPixel, VImageDimension >::m_Spacing { MakeFilled<SpacingType>(1.0) }
private

Definition at line 173 of file itkImportImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3