OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::GroundSpacingImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <otbGroundSpacingImageFunction.h>

+ Inheritance diagram for otb::GroundSpacingImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for otb::GroundSpacingImageFunction< TInputImage, TCoordRep >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef itk::Vector< ValueType, 2 > FloatType
 
typedef Superclass::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef TInputImage InputImageType
 
typedef Superclass::OutputType OutputType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef GroundSpacingImageFunction Self
 
typedef itk::ImageFunction
< TInputImage, FloatType,
TCoordRep > 
Superclass
 
typedef
otb::GenericRSTransform
< double > 
TransformType
 
typedef float ValueType
 
- Public Types inherited from itk::ImageFunction< TInputImage, itk::Vector< float, 2 >, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef itk::Vector< float, 2 > OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, itk::Vector< float, 2 > > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::Vector< float, 2 > >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef itk::Vector< float, 2 > OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase 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 (void) const
 
FloatType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
FloatType EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
PointType GetPixelLocation (const IndexType &index) const
 
FloatType Evaluate (const PointType &point) const override
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, itk::Vector< float, 2 >, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual itk::Vector< float, 2 > Evaluate (const PointType &point) const override=0
 
virtual itk::Vector< float, 2 > EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual itk::Vector< float, 2 > EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual void SetInputImage (const InputImageType *ptr)
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::Vector< float, 2 > >
virtual OutputType Evaluate (const InputType &input) const =0
 
- 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
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () 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 SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- 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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, itk::Vector< float, 2 >, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

 GroundSpacingImageFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~GroundSpacingImageFunction () override
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, itk::Vector< float, 2 >, TCoordRep >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::Vector< float, 2 > >
 FunctionBase ()
 
 ~FunctionBase ()
 
- 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

 GroundSpacingImageFunction (const Self &)=delete
 
void operator= (const Self &)=delete
 

Private Attributes

ValueType m_Deg2radCoef
 
ValueType m_R
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, itk::Vector< float, 2 >, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TInputImage, class TCoordRep = float>
class otb::GroundSpacingImageFunction< TInputImage, TCoordRep >

Calculate the approximate ground spacing in X and Y directions.

This uses the 'Haversine' formula to calculate great-circle distances between the two points (that is, the shortest distance over the Earth's surface) giving an 'as-the-crow-flies' distance between the points (ignoring any hills!).

Definition at line 45 of file otbGroundSpacingImageFunction.h.

Member Typedef Documentation

template<class TInputImage, class TCoordRep = float>
typedef itk::SmartPointer<const Self> otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 63 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::ContinuousIndexType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

Definition at line 75 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::Vector<ValueType, 2> otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::FloatType

Definition at line 57 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::IndexType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::IndexType

Definition at line 74 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef IndexType::IndexValueType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::IndexValueType

Definition at line 80 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef TInputImage otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 69 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::OutputType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::OutputType

Definition at line 73 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::SmartPointer<Self> otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 62 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::PointType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::PointType

Definition at line 76 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef GroundSpacingImageFunction otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 52 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::ImageFunction<TInputImage, FloatType , TCoordRep> otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::Superclass

Definition at line 60 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef otb::GenericRSTransform<double> otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::TransformType

Definition at line 78 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef float otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::ValueType

Datatype used for the density

Definition at line 55 of file otbGroundSpacingImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep >
otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::GroundSpacingImageFunction ( )
protected

Constructor

Definition at line 37 of file otbGroundSpacingImageFunction.hxx.

References otb::CONST_PI.

template<class TInputImage, class TCoordRep = float>
otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::~GroundSpacingImageFunction ( )
inlineoverrideprotected

Definition at line 108 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::GroundSpacingImageFunction ( const Self )
privatedelete

Member Function Documentation

template<class TInputImage, class TCoordRep = float>
virtual::itk::LightObject::Pointer otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TInputImage, class TCoordRep = float>
FloatType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverride

Evaluate the function at non-integer positions

Definition at line 88 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
FloatType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlineoverride

Definition at line 96 of file otbGroundSpacingImageFunction.h.

template<class TInputImage , class TCoordRep >
GroundSpacingImageFunction< TInputImage, TCoordRep >::FloatType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
override

Evalulate the function at specified index

Definition at line 61 of file otbGroundSpacingImageFunction.hxx.

References itk::FixedArray< TValue, VLength >::Fill().

template<class TInputImage, class TCoordRep = float>
virtual const char* otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, itk::Vector< float, 2 >, TCoordRep >.

template<class TInputImage , class TCoordRep >
GroundSpacingImageFunction< TInputImage, TCoordRep >::PointType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::GetPixelLocation ( const IndexType index) const
template<class TInputImage, class TCoordRep = float>
static Pointer otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

template<class TInputImage, class TCoordRep = float>
void otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::operator= ( const Self )
privatedelete
template<class TInputImage , class TCoordRep >
void otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::Object.

Definition at line 49 of file otbGroundSpacingImageFunction.hxx.

Member Data Documentation

template<class TInputImage, class TCoordRep = float>
const unsigned int otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension
static

Definition at line 82 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
ValueType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::m_Deg2radCoef
private

Definition at line 116 of file otbGroundSpacingImageFunction.h.

template<class TInputImage, class TCoordRep = float>
ValueType otb::GroundSpacingImageFunction< TInputImage, TCoordRep >::m_R
private

Definition at line 115 of file otbGroundSpacingImageFunction.h.


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