Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage > Class Template Reference

This class remove pixels given in one path. More...

#include <otbRemoveCarvingPathFilter.h>

+ Inheritance diagram for otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >:
+ Collaboration diagram for otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
itk::ImageSliceConstIteratorWithIndex
< InputImageType
InputIteratorType
 
typedef InputPathType::ConstPointer InputPathConstPointer
 
typedef InputPathType::IndexType InputPathIndexType
 
typedef InputPathType::InputType InputPathInputType
 
typedef InputPathType::OffsetType InputPathOffsetType
 
typedef InputPathType::OutputType InputPathOutputType
 
typedef InputPathType::Pointer InputPathPointer
 
typedef TInputPath InputPathType
 
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::ValueType OutputImageValueType
 
typedef
itk::ImageSliceIteratorWithIndex
< OutputImageType
OutputIteratorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef RemoveCarvingPathFilter Self
 
typedef
itk::ImageAndPathToImageFilter
< TInputImage, TInputPath,
TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef InputPathType::ConstPointer InputPathConstPointer
 
typedef InputPathType::IndexType InputPathIndexType
 
typedef InputPathType::InputType InputPathInputType
 
typedef InputPathType::OffsetType InputPathOffsetType
 
typedef InputPathType::OutputType InputPathOutputType
 
typedef InputPathType::Pointer InputPathPointer
 
typedef TInputPath InputPathType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageAndPathToImageFilter Self
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateOutputInformation ()
 
virtual unsigned int GetDirection () const
 
const TInputPath * GetInputPath (void)
 
virtual const char * GetNameOfClass () const
 
virtual const
OutputImagePixelType
GetValue ()
 
virtual void SetDirection (unsigned int _arg)
 
void SetInputPath (const TInputPath *path)
 
virtual void SetValue (OutputImagePixelType _arg)
 
- Public Member Functions inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputImageTypeGetImageInput (void)
 
const InputPathTypeGetPathInput (void)
 
virtual void SetImageInput (const TInputImage *image)
 
virtual void SetPathInput (const TInputPath *path)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 RemoveCarvingPathFilter ()
 
virtual ~RemoveCarvingPathFilter ()
 
virtual void GenerateData ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
 ImageAndPathToImageFilter ()
 
virtual ~ImageAndPathToImageFilter ()
 
InputImageTypeGetNonConstImageInput (void)
 
InputPathTypeGetNonConstPathInput (void)
 

Private Member Functions

 RemoveCarvingPathFilter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

unsigned int m_Direction
 
OutputImagePixelType m_Value
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

Detailed Description

template<class TInputImage, class TInputPath, class TOutputImage>
class otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >

This class remove pixels given in one path.

This filter remove pixels found by the otb::ImageToCarvingPathFilter thus decreasing the image size. the image (if Direction is set to 0) or from left to right (if direction is set to 1).

This is one component necessary to apply the seam carving algorithm published by Shai Avidan, Ariel Shamir, Seam Carving for Content-Aware Image Resizing, ACM Transactions on Graphics, Volume 26, Number 3, SIGGRAPH 2007

INPUTS
The first input is an image, usually, the same one provided to the otb::ImageToCarvingPathFilter The second input is a path, typically the output of otb::ImageToCarvingPathFilter.
OUTPUTS
The output is an image with a smaller size than the input image. There is one less column if direction is 0 and one less line if direction is 1.
See Also
ImageToCarvingPathFilter

Definition at line 60 of file otbRemoveCarvingPathFilter.h.

Member Typedef Documentation

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::ConstPointer

Definition at line 67 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::ConstPointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputImageConstPointer

Definition at line 78 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::PixelType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputImagePixelType

Definition at line 80 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::Pointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputImagePointer

Definition at line 77 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::RegionType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputImageRegionType

Definition at line 79 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef TInputImage otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 73 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::ImageSliceConstIteratorWithIndex<InputImageType> otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputIteratorType

Definition at line 98 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::ConstPointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathConstPointer

Definition at line 83 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::IndexType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathIndexType

Definition at line 86 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::InputType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathInputType

Definition at line 84 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::OffsetType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathOffsetType

Definition at line 87 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::OutputType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathOutputType

Definition at line 85 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::Pointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathPointer

Definition at line 82 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef TInputPath otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathType

Definition at line 81 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::ConstPointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageConstPointer

Definition at line 90 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::PixelType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImagePixelType

Definition at line 93 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::Pointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImagePointer

Definition at line 89 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::RegionType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageRegionType

Definition at line 92 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef TOutputImage otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageType

Definition at line 88 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::ValueType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageValueType

Definition at line 94 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::ImageSliceIteratorWithIndex<OutputImageType> otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::OutputIteratorType

Definition at line 99 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::SmartPointer<Self> otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::Pointer

Definition at line 66 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef RemoveCarvingPathFilter otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::Self

Standard class typedefs.

Definition at line 64 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::ImageAndPathToImageFilter<TInputImage, TInputPath, TOutputImage> otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::Superclass

Definition at line 65 of file otbRemoveCarvingPathFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TInputPath , class TOutputImage >
otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::RemoveCarvingPathFilter ( )
protected

Constructor

Definition at line 32 of file otbRemoveCarvingPathFilter.txx.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::~RemoveCarvingPathFilter ( )
inlineprotectedvirtual

Definition at line 118 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::RemoveCarvingPathFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TInputPath , class TOutputImage >
virtual::itk::LightObject::Pointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::CreateAnother ( void  ) const
template<class TInputImage , class TInputPath , class TOutputImage >
void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::GenerateData ( void  )
protectedvirtual

Main computation method.

Definition at line 60 of file otbRemoveCarvingPathFilter.txx.

References itk::ImageSliceConstIteratorWithIndex< TImage >::SetFirstDirection().

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::GenerateOutputInformation ( void  )
virtual

Definition at line 165 of file otbRemoveCarvingPathFilter.txx.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual unsigned int otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::GetDirection ( ) const
virtual
template<class TInputImage , class TInputPath , class TOutputImage >
const TInputPath * otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::GetInputPath ( void  )

Definition at line 49 of file otbRemoveCarvingPathFilter.txx.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual const char* otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual const OutputImagePixelType& otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::GetValue ( )
virtual
template<class TInputImage , class TInputPath , class TOutputImage >
static Pointer otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TInputPath , class TOutputImage >
void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::SetDirection ( unsigned int  _arg)
virtual

Set and Get direction value

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::SetInputPath ( const TInputPath *  path)
inline

Set/Get the path input of this process object. Note: these methods are adding to get the proper name

Definition at line 41 of file otbRemoveCarvingPathFilter.txx.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::SetValue ( OutputImagePixelType  _arg)
virtual

Member Data Documentation

template<class TInputImage , class TInputPath , class TOutputImage >
unsigned int otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::m_Direction
private

Definition at line 128 of file otbRemoveCarvingPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
OutputImagePixelType otb::RemoveCarvingPathFilter< TInputImage, TInputPath, TOutputImage >::m_Value
private

Definition at line 127 of file otbRemoveCarvingPathFilter.h.


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