ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::BinShrinkImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkBinShrinkImageFilter.h>

+ Inheritance diagram for itk::BinShrinkImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::BinShrinkImageFilter< TInputImage, TOutputImage >:

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::BinShrinkImageFilter< TInputImage, TOutputImage >

Reduce the size of an image by an integer factor in each dimension while performing averaging of an input neighborhood.

The output image size in each dimension is given by:

outputSize[j] = max( std::floor(inputSize[j]/shrinkFactor[j]), 1 );

The algorithm implemented can be describe with the following equation for 2D:

\[ \mathsf{I}_{out}(x_o,x_1) = \frac{\sum_{i=0}^{f_0}\sum_{j=0}^{f_1}\mathsf{I}_{in}(f_0 x_o+i,f_1 x_1+j)}{f_0 f_1} \]

This filter is implemented so that the starting extent of the first pixel of the output matches that of the input.

BinShrinkGrid.png
The change in image geometry from a 5x5 image binned by a factor of 2x2.

This code was contributed in the Insight Journal paper: "BinShrink: A multi-resolution filter with cache efficient averaging" by Lowekamp B., Chen D. http://hdl.handle.net/10380/3450

Definition at line 58 of file itkBinShrinkImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::Pointer InputImagePointer
 
typedef TInputImage InputImageType
 
typedef TInputImage::IndexType InputIndexType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef TOutputImage::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef TOutputImage::IndexType OutputIndexType
 
typedef TOutputImage::OffsetType OutputOffsetType
 
typedef SmartPointer< SelfPointer
 
typedef BinShrinkImageFilter Self
 
typedef FixedArray< unsigned
int, ImageDimension
ShrinkFactorsType
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputInformation () override
 
virtual const char * GetNameOfClass () const
 
virtual const ShrinkFactorsTypeGetShrinkFactors () const
 
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
 
 typedef (Concept::SameDimension< ImageDimension, OutputImageDimension >) SameDimensionCheck
 
virtual void SetShrinkFactors (ShrinkFactorsType _arg)
 
void SetShrinkFactors (unsigned int factor)
 
void SetShrinkFactor (unsigned int i, unsigned int factor)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
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 >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
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)
 
void SetProgress (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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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 ()
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 ()
 

Static Public Attributes

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

Protected Member Functions

 BinShrinkImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) 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 ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, 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 &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (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
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

 BinShrinkImageFilter (const Self &)
 
void operator= (const Self &)
 
template<class TOutputType , class TInputType >
EnableIfC< std::numeric_limits
< TOutputType >::is_integer,
TOutputType >::Type 
RoundIfInteger (TInputType input)
 
template<class TOutputType , class TInputType >
DisableIfC
< std::numeric_limits
< TOutputType >::is_integer,
TOutputType >::Type 
RoundIfInteger (const TInputType &input,...)
 

Private Attributes

ShrinkFactorsType m_ShrinkFactors
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage >
typedef SmartPointer<const Self> itk::BinShrinkImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 66 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef InputImageType::ConstPointer itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Definition at line 79 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef InputImageType::Pointer itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 78 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputImageType

Definition at line 76 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage::IndexType itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputIndexType

Definition at line 83 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef OutputImageType::Pointer itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 77 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage::RegionType itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type.

Definition at line 86 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImageType

Typedef to images

Definition at line 72 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage::IndexType itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputIndexType

Definition at line 82 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage::OffsetType itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputOffsetType

Definition at line 81 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef SmartPointer<Self> itk::BinShrinkImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 65 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef BinShrinkImageFilter itk::BinShrinkImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 63 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef FixedArray< unsigned int, ImageDimension > itk::BinShrinkImageFilter< TInputImage, TOutputImage >::ShrinkFactorsType

Definition at line 95 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef ImageToImageFilter<TInputImage,TOutputImage> itk::BinShrinkImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 64 of file itkBinShrinkImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >
itk::BinShrinkImageFilter< TInputImage, TOutputImage >::BinShrinkImageFilter ( )
protected

End concept checking

template<typename TInputImage , typename TOutputImage >
itk::BinShrinkImageFilter< TInputImage, TOutputImage >::BinShrinkImageFilter ( const Self )
private

Member Function Documentation

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::BinShrinkImageFilter< 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.

template<typename TInputImage , typename TOutputImage >
virtual void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overridevirtual

BinShrinkImageFilter needs a larger input requested region than the output requested region. As such, BinShrinkImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See Also
ProcessObject::GenerateInputRequestedRegion()

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

template<typename TInputImage , typename TOutputImage >
virtual void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overridevirtual

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.

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::BinShrinkImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

template<typename TInputImage , typename TOutputImage >
virtual const ShrinkFactorsType& itk::BinShrinkImageFilter< TInputImage, TOutputImage >::GetShrinkFactors ( ) const
virtual

Get the shrink factors.

template<typename TInputImage , typename TOutputImage >
static Pointer itk::BinShrinkImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >
void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<typename TInputImage , typename TOutputImage >
void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage >
template<class TOutputType , class TInputType >
EnableIfC<std::numeric_limits<TOutputType>::is_integer, TOutputType>::Type itk::BinShrinkImageFilter< TInputImage, TOutputImage >::RoundIfInteger ( TInputType  input)
inlineprivate

Round different pixel types.

Definition at line 143 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
template<class TOutputType , class TInputType >
DisableIfC<std::numeric_limits<TOutputType>::is_integer, TOutputType>::Type itk::BinShrinkImageFilter< TInputImage, TOutputImage >::RoundIfInteger ( const TInputType &  input,
  ... 
)
inlineprivate

Definition at line 152 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactor ( unsigned int  i,
unsigned int  factor 
)

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.

template<typename TInputImage , typename TOutputImage >
virtual void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactors ( ShrinkFactorsType  _arg)
virtual

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.

template<typename TInputImage , typename TOutputImage >
void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactors ( unsigned int  factor)

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.

template<typename TInputImage , typename TOutputImage >
void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See Also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TOutputImage >
itk::BinShrinkImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >  )

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of (Concept::Convertible<typename TInputImage::PixelType, typename TOutputImage::PixelType>)

template<typename TInputImage , typename TOutputImage >
itk::BinShrinkImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< ImageDimension, OutputImageDimension )

This class requires SameDimensionCheck in the form of (Concept::SameDimension<ImageDimension, OutputImageDimension>)

Member Data Documentation

template<typename TInputImage , typename TOutputImage >
const unsigned int itk::BinShrinkImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
static

ImageDimension enumeration.

Definition at line 90 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ShrinkFactorsType itk::BinShrinkImageFilter< TInputImage, TOutputImage >::m_ShrinkFactors
private

Definition at line 138 of file itkBinShrinkImageFilter.h.

template<typename TInputImage , typename TOutputImage >
const unsigned int itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension enumeration.

Definition at line 92 of file itkBinShrinkImageFilter.h.


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