ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkCannySegmentationLevelSetFunction.h>

+ Inheritance diagram for itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >:
+ Collaboration diagram for itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FeatureImageType = TFeatureImageType
 
using FeatureScalarType = typename Superclass::FeatureScalarType
 
using ImageType = typename Superclass::ImageType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using ScalarValueType = typename Superclass::ScalarValueType
 
using Self = CannySegmentationLevelSetFunction
 
using Superclass = SegmentationLevelSetFunction< TImageType, TFeatureImageType >
 
using VectorImageType = typename Superclass::VectorImageType
 
- Public Types inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename InterpolatorType::ContinuousIndexType
 
using FeatureImageType = TFeatureImageType
 
using FeatureScalarType = typename FeatureImageType::PixelType
 
using FloatOffsetType = typename Superclass::FloatOffsetType
 
using GlobalDataStruct = typename Superclass::GlobalDataStruct
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename ImageType::IndexType
 
using InterpolatorType = LinearInterpolateImageFunction< ImageType >
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using PixelRealType = typename Superclass::PixelRealType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using ScalarValueType = typename Superclass::ScalarValueType
 
using Self = SegmentationLevelSetFunction
 
using Superclass = LevelSetFunction< TImageType >
 
using VectorImageType = Image< VectorType, Self::ImageDimension >
 
using VectorInterpolatorType = VectorLinearInterpolateImageFunction< VectorImageType >
 
using VectorType = typename Superclass::VectorType
 
- Public Types inherited from itk::LevelSetFunction< TImageType >
using ConstPointer = SmartPointer< const Self >
 
using FloatOffsetType = typename Superclass::FloatOffsetType
 
using ImageType = typename Superclass::ImageType
 
using NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using PixelRealType = typename Superclass::PixelRealType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using ScalarValueType = PixelType
 
using Self = LevelSetFunction
 
using Superclass = FiniteDifferenceFunction< TImageType >
 
using TimeStepType = double
 
using VectorType = FixedArray< ScalarValueType, Self::ImageDimension >
 
- Public Types inherited from itk::FiniteDifferenceFunction< TImageType >
using ConstPointer = SmartPointer< const Self >
 
using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >
 
using FloatOffsetType = Vector< float, Self::ImageDimension >
 
using ImageType = TImageType
 
using NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >
 
using NeighborhoodType = ConstNeighborhoodIterator< TImageType, DefaultBoundaryConditionType >
 
using PixelRealType = double
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename ConstNeighborhoodIterator< TImageType >::RadiusType
 
using Self = FiniteDifferenceFunction
 
using Superclass = LightObject
 
using TimeStepType = double
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual const FeatureImageTypeGetFeatureImage () const
 
virtual void SetFeatureImage (const FeatureImageType *f)
 
virtual ImageTypeGetSpeedImage ()
 
void SetSpeedImage (ImageType *s)
 
virtual VectorImageTypeGetAdvectionImage () const
 
void SetAdvectionImage (VectorImageType *s)
 
void Initialize (const RadiusType &r) override
 
virtual void AllocateSpeedImage ()
 
virtual void AllocateAdvectionImage ()
 
virtual void ReverseExpansionDirection ()
 
- Public Member Functions inherited from itk::LevelSetFunction< TImageType >
virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=nullptr) const
 
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void SetAdvectionWeight (const ScalarValueType a)
 
ScalarValueType GetAdvectionWeight () const
 
virtual void SetPropagationWeight (const ScalarValueType p)
 
ScalarValueType GetPropagationWeight () const
 
virtual void SetCurvatureWeight (const ScalarValueType c)
 
ScalarValueType GetCurvatureWeight () const
 
void SetLaplacianSmoothingWeight (const ScalarValueType c)
 
ScalarValueType GetLaplacianSmoothingWeight () const
 
void SetEpsilonMagnitude (const ScalarValueType e)
 
ScalarValueType GetEpsilonMagnitude () const
 
PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0)) override
 
TimeStepType ComputeGlobalTimeStep (void *GlobalData) const override
 
void * GetGlobalDataPointer () const override
 
void ReleaseGlobalDataPointer (void *GlobalData) const override
 
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
void SetUseMinimalCurvature (bool b)
 
bool GetUseMinimalCurvature () const
 
void UseMinimalCurvatureOn ()
 
void UseMinimalCurvatureOff ()
 
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
const RadiusTypeGetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
virtual void InitializeIteration ()
 
void SetRadius (const RadiusType &r)
 
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
 
- 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
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LevelSetFunction< TImageType >
static Pointer New ()
 
static void SetMaximumCurvatureTimeStep (double n)
 
static double GetMaximumCurvatureTimeStep ()
 
static void SetMaximumPropagationTimeStep (double n)
 
static double GetMaximumPropagationTimeStep ()
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::LevelSetFunction< TImageType >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
static constexpr unsigned int ImageDimension = ImageType::ImageDimension
 
ScalarValueType m_Variance
 
double m_Threshold
 
CannyEdgeDetectionImageFilter< ImageType, ImageType >::Pointer m_Canny
 
DanielssonDistanceMapImageFilter< ImageType, ImageType >::Pointer m_Distance
 
CastImageFilter< FeatureImageType, ImageType >::Pointer m_Caster
 
void SetThreshold (ScalarValueType v)
 
ScalarValueType GetThreshold () const
 
void SetVariance (double v)
 
double GetVariance () const
 
void CalculateSpeedImage () override
 
void CalculateAdvectionImage () override
 
virtual void CalculateDistanceImage ()
 
void Initialize (const RadiusType &r) override
 
ImageTypeGetCannyImage ()
 
 CannySegmentationLevelSetFunction ()
 
 ~CannySegmentationLevelSetFunction () override=default
 
template<typename DummyImagePointerType >
void AssignCannyInput (typename FeatureImageType::Pointer &feature, DummyImagePointerType &)
 
void AssignCannyInput (typename FeatureImageType::Pointer &feature, typename FeatureImageType::Pointer &)
 

Additional Inherited Members

- Protected Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
 ~SegmentationLevelSetFunction () override=default
 
 SegmentationLevelSetFunction ()
 
- Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
 LevelSetFunction ()
 
 ~LevelSetFunction () override=default
 
void PrintSelf (std::ostream &s, Indent indent) const override
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
 FiniteDifferenceFunction ()
 
 ~FiniteDifferenceFunction () override=default
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
 
- Protected Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
FeatureImageType::ConstPointer m_FeatureImage
 
ImageType::Pointer m_SpeedImage
 
VectorImageType::Pointer m_AdvectionImage
 
InterpolatorType::Pointer m_Interpolator
 
VectorInterpolatorType::Pointer m_VectorInterpolator
 
- Protected Attributes inherited from itk::LevelSetFunction< TImageType >
std::slice x_slice [Self::ImageDimension]
 
OffsetValueType m_Center { 0 }
 
OffsetValueType m_xStride [Self::ImageDimension]
 
bool m_UseMinimalCurvature { false }
 
ScalarValueType m_EpsilonMagnitude
 
ScalarValueType m_AdvectionWeight
 
ScalarValueType m_PropagationWeight
 
ScalarValueType m_CurvatureWeight
 
ScalarValueType m_LaplacianSmoothingWeight
 
- Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
RadiusType m_Radius
 
PixelRealType m_ScaleCoefficients [ImageDimension]
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 
- Static Protected Attributes inherited from itk::LevelSetFunction< TImageType >
static double m_WaveDT
 
static double m_DT
 
static VectorType m_ZeroVectorConstant
 

Detailed Description

template<typename TImageType, typename TFeatureImageType = TImageType>
class itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >

A refinement of the standard level-set function which computes a speed term and advection term based on pseudo-Canny edges. See CannySegmentationLevelSetImageFilter for complete information.

Definition at line 35 of file itkCannySegmentationLevelSetFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkCannySegmentationLevelSetFunction.h.

◆ FeatureImageType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType = TFeatureImageType

Definition at line 46 of file itkCannySegmentationLevelSetFunction.h.

◆ FeatureScalarType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType = typename Superclass::FeatureScalarType

Definition at line 58 of file itkCannySegmentationLevelSetFunction.h.

◆ ImageType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageType = typename Superclass::ImageType

Extract some parameters from the superclass.

Definition at line 55 of file itkCannySegmentationLevelSetFunction.h.

◆ Pointer

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkCannySegmentationLevelSetFunction.h.

◆ RadiusType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::RadiusType = typename Superclass::RadiusType

Definition at line 59 of file itkCannySegmentationLevelSetFunction.h.

◆ ScalarValueType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType = typename Superclass::ScalarValueType

Definition at line 56 of file itkCannySegmentationLevelSetFunction.h.

◆ Self

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::Self = CannySegmentationLevelSetFunction

Standard class type aliases.

Definition at line 42 of file itkCannySegmentationLevelSetFunction.h.

◆ Superclass

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::Superclass = SegmentationLevelSetFunction<TImageType, TFeatureImageType>

Definition at line 43 of file itkCannySegmentationLevelSetFunction.h.

◆ VectorImageType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType = typename Superclass::VectorImageType

Definition at line 57 of file itkCannySegmentationLevelSetFunction.h.

Constructor & Destructor Documentation

◆ CannySegmentationLevelSetFunction()

template<typename TImageType , typename TFeatureImageType = TImageType>
itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CannySegmentationLevelSetFunction ( )
inlineprotected

◆ ~CannySegmentationLevelSetFunction()

template<typename TImageType , typename TFeatureImageType = TImageType>
itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::~CannySegmentationLevelSetFunction ( )
overrideprotecteddefault

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Member Function Documentation

◆ AssignCannyInput() [1/2]

template<typename TImageType , typename TFeatureImageType = TImageType>
template<typename DummyImagePointerType >
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::AssignCannyInput ( typename FeatureImageType::Pointer &  feature,
DummyImagePointerType &   
)
inlineprivate

◆ AssignCannyInput() [2/2]

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::AssignCannyInput ( typename FeatureImageType::Pointer &  feature,
typename FeatureImageType::Pointer &   
)
inlineprivate

If FeatureImageType == ImageType, assign directly to the Canny filter

Definition at line 158 of file itkCannySegmentationLevelSetFunction.h.

References itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput().

◆ CalculateAdvectionImage()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateAdvectionImage ( )
overridevirtual

Compute the advection image. The Advection Image is the gradient image attenuated with the distance to the canny edges.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

◆ CalculateDistanceImage()

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateDistanceImage ( )
virtual

Compute the distance image. This is the distance to the canny edges.

◆ CalculateSpeedImage()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( )
overridevirtual

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

◆ CreateAnother()

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual::itk::LightObject::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::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::LightObject.

◆ GetCannyImage()

template<typename TImageType , typename TFeatureImageType = TImageType>
ImageType* itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetCannyImage ( )
inline

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 116 of file itkCannySegmentationLevelSetFunction.h.

◆ GetNameOfClass()

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual const char* itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

◆ GetThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetThreshold ( ) const
inline

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 71 of file itkCannySegmentationLevelSetFunction.h.

◆ GetVariance()

template<typename TImageType , typename TFeatureImageType = TImageType>
double itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetVariance ( ) const
inline

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 84 of file itkCannySegmentationLevelSetFunction.h.

◆ Initialize()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r)
inlineoverridevirtual

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 106 of file itkCannySegmentationLevelSetFunction.h.

◆ New()

template<typename TImageType , typename TFeatureImageType = TImageType>
static Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::New ( )
static

Method for creation through the object factory.

◆ SetThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetThreshold ( ScalarValueType  v)
inline

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 66 of file itkCannySegmentationLevelSetFunction.h.

◆ SetVariance()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetVariance ( double  v)
inline

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 79 of file itkCannySegmentationLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TImageType , typename TFeatureImageType = TImageType>
constexpr unsigned int itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Extract some parameters from the superclass.

Definition at line 62 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Canny

template<typename TImageType , typename TFeatureImageType = TImageType>
CannyEdgeDetectionImageFilter<ImageType, ImageType>::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Canny
private

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 137 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Caster

template<typename TImageType , typename TFeatureImageType = TImageType>
CastImageFilter<FeatureImageType, ImageType>::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Caster
private

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 141 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Distance

template<typename TImageType , typename TFeatureImageType = TImageType>
DanielssonDistanceMapImageFilter<ImageType, ImageType>::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Distance
private

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 139 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Threshold

template<typename TImageType , typename TFeatureImageType = TImageType>
double itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Threshold
private

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 135 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Variance

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Variance
private

Compute the Speed Image. The Speed Image is the distance to the canny edges.

Definition at line 134 of file itkCannySegmentationLevelSetFunction.h.


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