Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage > Class Template Reference

Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of the largest possible region. More...

#include <itkRegionFromReferenceImageFilter.h>

Inheritance diagram for itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >:

Public Types

typedef RegionFromReferenceImageFilter Self
 
typedef ExtractImageFilter< TInputImage, TOutputImage > Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef Superclass::InputImageRegionType InputImageRegionType
 
typedef Superclass::OutputImagePixelType OutputImagePixelType
 
typedef Superclass::InputImagePixelType InputImagePixelType
 
typedef Superclass::OutputImageIndexType OutputImageIndexType
 
typedef Superclass::InputImageIndexType InputImageIndexType
 
typedef Superclass::OutputImageSizeType OutputImageSizeType
 
typedef Superclass::InputImageSizeType InputImageSizeType
 
typedef InputImageSizeType SizeType
 
typedef ImageBase< itkGetStaticConstMacro(ImageDimension) > ReferenceImageType
 
typedef RegionFromReferenceImageFilter Self
 
typedef ExtractImageFilter< TInputImage, TOutputImage > Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef Superclass::InputImageRegionType InputImageRegionType
 
typedef Superclass::OutputImagePixelType OutputImagePixelType
 
typedef Superclass::InputImagePixelType InputImagePixelType
 
typedef Superclass::OutputImageIndexType OutputImageIndexType
 
typedef Superclass::InputImageIndexType InputImageIndexType
 
typedef Superclass::OutputImageSizeType OutputImageSizeType
 
typedef Superclass::InputImageSizeType InputImageSizeType
 
typedef InputImageSizeType SizeType
 
typedef ImageBase< itkGetStaticConstMacro(ImageDimension) > ReferenceImageType
 

Public Member Functions

virtual const char * GetClassName () const
 
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
 
 itkStaticConstMacro (OutputImageDimension, unsigned int, Superclass::OutputImageDimension)
 
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::OutputImageDimension)
 
void SetReferenceImage (const ReferenceImageType *image)
 
const ReferenceImageTypeGetReferenceImage () const
 
void SetInput1 (const TInputImage *input)
 
void SetInput2 (const ReferenceImageType *input)
 
virtual const char * GetClassName () const
 
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
 
 itkStaticConstMacro (OutputImageDimension, unsigned int, Superclass::OutputImageDimension)
 
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::OutputImageDimension)
 
void SetReferenceImage (const ReferenceImageType *image)
 
const ReferenceImageTypeGetReferenceImage () const
 
void SetInput1 (const TInputImage *input)
 
void SetInput2 (const ReferenceImageType *input)
 

Static Public Member Functions

static Pointer New ()
 
static Pointer New ()
 

Protected Member Functions

 RegionFromReferenceImageFilter ()
 
 ~RegionFromReferenceImageFilter () override
 
void GenerateOutputInformation () ITK_OVERRIDE
 
 RegionFromReferenceImageFilter ()
 
 ~RegionFromReferenceImageFilter ()
 
virtual void GenerateOutputInformation () ITK_OVERRIDE
 

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >

Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of the largest possible region.

RegionFromReferenceImageFilter changes the image boundary of an image by removing pixels outside the target region. The target region is not specified in advance, but calculated in BeforeThreadedGenerateData().

This filter uses ExtractImageFilter to perform the cropping.

Definition at line 51 of file PhotoacousticsAlgorithms/ITKFilter/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

Member Typedef Documentation

◆ ConstPointer [1/2]

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

◆ ConstPointer [2/2]

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

◆ InputImageIndexType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImageIndexType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImageIndexType

◆ InputImageIndexType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImageIndexType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImageIndexType

◆ InputImagePixelType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImagePixelType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImagePixelType

◆ InputImagePixelType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImagePixelType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImagePixelType

◆ InputImageRegionType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImageRegionType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImageRegionType

◆ InputImageRegionType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImageRegionType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImageRegionType

◆ InputImageSizeType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImageSizeType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImageSizeType

◆ InputImageSizeType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::InputImageSizeType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::InputImageSizeType

◆ OutputImageIndexType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImageIndexType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 76 of file PhotoacousticsAlgorithms/ITKFilter/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ OutputImageIndexType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImageIndexType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 76 of file US/USHardwareDiPhAS/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ OutputImagePixelType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImagePixelType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 72 of file US/USHardwareDiPhAS/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ OutputImagePixelType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImagePixelType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 72 of file PhotoacousticsAlgorithms/ITKFilter/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ OutputImageRegionType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImageRegionType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

Definition at line 65 of file PhotoacousticsAlgorithms/ITKFilter/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ OutputImageRegionType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImageRegionType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

Definition at line 65 of file US/USHardwareDiPhAS/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ OutputImageSizeType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImageSizeType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

◆ OutputImageSizeType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputImageSizeType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

◆ Pointer [1/2]

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

◆ Pointer [2/2]

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

◆ ReferenceImageType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef ImageBase< itkGetStaticConstMacro( ImageDimension ) > itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::ReferenceImageType

◆ ReferenceImageType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef ImageBase< itkGetStaticConstMacro( ImageDimension ) > itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::ReferenceImageType

◆ Self [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef RegionFromReferenceImageFilter itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 56 of file US/USHardwareDiPhAS/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ Self [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef RegionFromReferenceImageFilter itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::Self

◆ SizeType [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef InputImageSizeType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SizeType

◆ SizeType [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef InputImageSizeType itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SizeType

◆ Superclass [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef ExtractImageFilter<TInputImage,TOutputImage> itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::Superclass

◆ Superclass [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef ExtractImageFilter<TInputImage,TOutputImage> itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

◆ RegionFromReferenceImageFilter() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::RegionFromReferenceImageFilter ( )
inlineprotected

◆ ~RegionFromReferenceImageFilter() [1/2]

◆ RegionFromReferenceImageFilter() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::RegionFromReferenceImageFilter ( )
inlineprotected

◆ ~RegionFromReferenceImageFilter() [2/2]

Member Function Documentation

◆ GenerateOutputInformation() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
protected

◆ GenerateOutputInformation() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
protectedvirtual

◆ GetClassName() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual const char* itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

◆ GetClassName() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual const char* itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

◆ GetReferenceImage() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
const ReferenceImageType* itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::GetReferenceImage ( ) const

◆ GetReferenceImage() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
const ReferenceImageType* itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::GetReferenceImage ( ) const

◆ itkStaticConstMacro() [1/6]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
Superclass::InputImageDimension   
)

ImageDimension constants

◆ itkStaticConstMacro() [2/6]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
Superclass::InputImageDimension   
)

ImageDimension constants

◆ itkStaticConstMacro() [3/6]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( OutputImageDimension  ,
unsigned  int,
Superclass::OutputImageDimension   
)

◆ itkStaticConstMacro() [4/6]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( OutputImageDimension  ,
unsigned  int,
Superclass::OutputImageDimension   
)

◆ itkStaticConstMacro() [5/6]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
Superclass::OutputImageDimension   
)

◆ itkStaticConstMacro() [6/6]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
Superclass::OutputImageDimension   
)

◆ New() [1/2]

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

Method for creation through the object factory.

◆ New() [2/2]

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

Method for creation through the object factory.

◆ SetInput1() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetInput1 ( const TInputImage *  input)
inline

◆ SetInput1() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetInput1 ( const TInputImage *  input)
inline

Set the input image

Definition at line 98 of file US/USHardwareDiPhAS/ITKUltrasound/itkRegionFromReferenceImageFilter.h.

◆ SetInput2() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetInput2 ( const ReferenceImageType input)
inline

◆ SetInput2() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetInput2 ( const ReferenceImageType input)
inline

◆ SetReferenceImage() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetReferenceImage ( const ReferenceImageType image)

Copy the output information from another Image.

◆ SetReferenceImage() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetReferenceImage ( const ReferenceImageType image)

Copy the output information from another Image.

Referenced by itk::RegionFromReferenceImageFilter< TInputImage, TOutputImage >::SetInput2().


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