#include <itkPyImageFilter.h>

Detailed Description

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

ImageToImageFilter subclass that calls a Python callable object, e.g. a Python function or a class with a call method.

For more information on ITK filters, the GenerateData() method, and other filter pipeline methods, see the ITK Software Guide.

Definition at line 42 of file itkPyImageFilter.h.

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

Collaboration diagram for itk::PyImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = PyImageFilter

using	Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType

using	OutputImageRegionType

using	Pointer = SmartPointer<Self>

using	Self = ImageToImageFilter

using	Superclass = ImageSource<TOutputImage>

Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage

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
void	_SetSelf (PyObject *self)

virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override

void	SetPyEnlargeOutputRequestedRegion (PyObject *obj)

void	SetPyGenerateData (PyObject *obj)

void	SetPyGenerateInputRequestedRegion (PyObject *obj)

void	SetPyGenerateOutputInformation (PyObject *obj)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

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

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
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	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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

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

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

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 void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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

Static Public Attributes
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	EnlargeOutputRequestedRegion (DataObject *dataObject) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

	PyImageFilter ()=default

	~PyImageFilter () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

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

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual void	DynamicMultiThreadingOff ()

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

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

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
PyObject *	m_EnlargeOutputRequestedRegionCallable { nullptr }

PyObject *	m_GenerateDataCallable { nullptr }

PyObject *	m_GenerateInputRequestedRegionCallable { nullptr }

PyObject *	m_GenerateOutputInformationCallable { nullptr }

PyObject *	m_Self

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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< TOutputImage >
bool	m_DynamicMultiThreading { true }

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<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 51 of file itkPyImageFilter.h.

◆ InputImagePixelType

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 63 of file itkPyImageFilter.h.

◆ InputImagePointer

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 61 of file itkPyImageFilter.h.

◆ InputImageRegionType

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 62 of file itkPyImageFilter.h.

◆ InputImageType

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 60 of file itkPyImageFilter.h.

◆ OutputImagePixelType

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 67 of file itkPyImageFilter.h.

◆ OutputImagePointer

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 65 of file itkPyImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 66 of file itkPyImageFilter.h.

◆ OutputImageType

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 64 of file itkPyImageFilter.h.

◆ Pointer

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 50 of file itkPyImageFilter.h.

◆ Self

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::Self = PyImageFilter

Standard class type aliases.

Definition at line 48 of file itkPyImageFilter.h.

◆ Superclass

template<class TInputImage, class TOutputImage>

using itk::PyImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 49 of file itkPyImageFilter.h.

Constructor & Destructor Documentation

◆ PyImageFilter()

template<class TInputImage, class TOutputImage>

itk::PyImageFilter< TInputImage, TOutputImage >::PyImageFilter ( )

protecteddefault

Referenced by GetNameOfClass().

◆ ~PyImageFilter()

template<class TInputImage, class TOutputImage>

itk::PyImageFilter< TInputImage, TOutputImage >::~PyImageFilter ( )

overrideprotected

Member Function Documentation

◆ _SetSelf()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::_SetSelf ( PyObject * self )

inline

Python internal method to pass a pointer to the wrapping Python object.

Definition at line 99 of file itkPyImageFilter.h.

References m_Self.

◆ CreateAnother()

template<class TInputImage, class TOutputImage>

virtual::itk::LightObject::Pointer itk::PyImageFilter< TInputImage, TOutputImage >::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::Object.

◆ EnlargeOutputRequestedRegion()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject * output )

overrideprotectedvirtual

Give the process object a chance to indicate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

◆ GenerateOutputInformation()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

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

◆ GetNameOfClass()

template<class TInputImage, class TOutputImage>

const char * itk::PyImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods).

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

References PyImageFilter().

◆ New()

template<class TInputImage, class TOutputImage>

static Pointer itk::PyImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ SetPyEnlargeOutputRequestedRegion()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::SetPyEnlargeOutputRequestedRegion ( PyObject * obj )

Python callable called during the filter's EnlargeOutputRequestedRegion.

The callable takes two arguments: the PyImageFilter Python instance and the output image instance.

◆ SetPyGenerateData()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::SetPyGenerateData ( PyObject * obj )

Python callable called during the filter's GenerateData.

The callable takes one argument: the PyImageFilter Python instance.

◆ SetPyGenerateInputRequestedRegion()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::SetPyGenerateInputRequestedRegion ( PyObject * obj )

Python callable called during the filter's GenerateInputRequestedRegion.

The callable takes one argument: the PyImageFilter Python instance.

◆ SetPyGenerateOutputInformation()

template<class TInputImage, class TOutputImage>

void itk::PyImageFilter< TInputImage, TOutputImage >::SetPyGenerateOutputInformation ( PyObject * obj )

Python callable called during the filter's GenerateOutputInformation.

The callable takes one argument: the PyImageFilter Python instance.

Member Data Documentation

◆ InputImageDimension

template<class TInputImage, class TOutputImage>

unsigned int itk::PyImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension enumeration

Definition at line 70 of file itkPyImageFilter.h.

◆ m_EnlargeOutputRequestedRegionCallable

template<class TInputImage, class TOutputImage>

PyObject* itk::PyImageFilter< TInputImage, TOutputImage >::m_EnlargeOutputRequestedRegionCallable { nullptr }

private

Definition at line 124 of file itkPyImageFilter.h.

◆ m_GenerateDataCallable

template<class TInputImage, class TOutputImage>

PyObject* itk::PyImageFilter< TInputImage, TOutputImage >::m_GenerateDataCallable { nullptr }

private

Definition at line 125 of file itkPyImageFilter.h.

◆ m_GenerateInputRequestedRegionCallable

template<class TInputImage, class TOutputImage>

PyObject* itk::PyImageFilter< TInputImage, TOutputImage >::m_GenerateInputRequestedRegionCallable { nullptr }

private

Definition at line 122 of file itkPyImageFilter.h.

◆ m_GenerateOutputInformationCallable

template<class TInputImage, class TOutputImage>

PyObject* itk::PyImageFilter< TInputImage, TOutputImage >::m_GenerateOutputInformationCallable { nullptr }

private

Definition at line 123 of file itkPyImageFilter.h.

◆ m_Self

template<class TInputImage, class TOutputImage>

PyObject* itk::PyImageFilter< TInputImage, TOutputImage >::m_Self

private

Definition at line 121 of file itkPyImageFilter.h.

Referenced by _SetSelf().

◆ OutputImageDimension

template<class TInputImage, class TOutputImage>

unsigned int itk::PyImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 71 of file itkPyImageFilter.h.

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

itkPyImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ PyImageFilter()

◆ ~PyImageFilter()

Member Function Documentation

◆ _SetSelf()

◆ CreateAnother()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetNameOfClass()

◆ New()

◆ SetPyEnlargeOutputRequestedRegion()

◆ SetPyGenerateData()

◆ SetPyGenerateInputRequestedRegion()

◆ SetPyGenerateOutputInformation()

Member Data Documentation

◆ InputImageDimension

◆ m_EnlargeOutputRequestedRegionCallable

◆ m_GenerateDataCallable

◆ m_GenerateInputRequestedRegionCallable

◆ m_GenerateOutputInformationCallable

◆ m_Self

◆ OutputImageDimension