ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::ImportImageFilter< TPixel, VImageDimension > Class Template Reference

#include <itkImportImageFilter.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
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, VImageDimension > >
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, VImageDimension >
 
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 ::itk::LightObject::Pointer CreateAnother () const
 
TPixel * GetImportPointer ()
 
virtual const char * GetNameOfClass () const
 
void SetImportPointer (TPixel *ptr, SizeValueType num, bool LetImageContainerManageMemory)
 
- Public Member Functions inherited from itk::ImageSource< Image< TPixel, VImageDimension > >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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
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 Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
using DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >
 
RegionType m_Region
 
SpacingType m_Spacing
 
OriginType m_Origin
 
DirectionType m_Direction
 
ImportImageContainerType::Pointer m_ImportImageContainer
 
SizeValueType m_Size
 
void SetRegion (const RegionType &region)
 
const RegionTypeGetRegion () const
 
virtual void SetSpacing (SpacingType _arg)
 
virtual const SpacingTypeGetSpacing () const
 
virtual void SetSpacing (const float data[])
 
virtual void SetOrigin (OriginType _arg)
 
virtual const OriginTypeGetOrigin () const
 
virtual void SetOrigin (const float data[])
 
virtual void SetDirection (const DirectionType &direction)
 
virtual const DirectionTypeGetDirection () const
 
 ImportImageFilter ()
 
 ~ImportImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 
void GenerateOutputInformation () override
 
void EnlargeOutputRequestedRegion (DataObject *output) override
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageSource< Image< TPixel, VImageDimension > >
static constexpr unsigned int OutputImageDimension
 
- Protected Member Functions inherited from itk::ImageSource< Image< TPixel, VImageDimension > >
 ImageSource ()
 
 ~ImageSource () override=default
 
void GenerateData () override
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< Image< TPixel, VImageDimension > >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< Image< TPixel, VImageDimension > >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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:
Examples
Examples/DataRepresentation/Image/Image5.cxx, SphinxExamples/src/Core/Common/ConvertArrayToImage/Code.cxx, and SphinxExamples/src/Core/Common/ImportPixelBufferIntoAnImage/Code.cxx.

Definition at line 43 of file itkImportImageFilter.h.

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>

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

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

◆ ~ImportImageFilter()

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

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

Member Function Documentation

◆ CreateAnother()

template<typename TPixel , unsigned int VImageDimension = 2>
virtual::itk::LightObject::Pointer itk::ImportImageFilter< TPixel, VImageDimension >::CreateAnother ( ) 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::LightObject.

◆ 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>
virtual const char* itk::ImportImageFilter< TPixel, VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >.

◆ GetOrigin()

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

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

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

◆ 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

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

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

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

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

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 175 of file itkImportImageFilter.h.

◆ m_ImportImageContainer

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

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 177 of file itkImportImageFilter.h.

◆ m_Origin

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

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 174 of file itkImportImageFilter.h.

◆ m_Region

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

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 172 of file itkImportImageFilter.h.

◆ m_Size

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

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 178 of file itkImportImageFilter.h.

◆ m_Spacing

template<typename TPixel , unsigned int VImageDimension = 2>
SpacingType itk::ImportImageFilter< TPixel, VImageDimension >::m_Spacing
private

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 173 of file itkImportImageFilter.h.


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