Compressed normal vectors handler. More...

#include <ecvNormalVectors.h>

Public Types
enum	Orientation { PLUS_X = 0 , MINUS_X = 1 , PLUS_Y = 2 , MINUS_Y = 3 , PLUS_Z = 4 , MINUS_Z = 5 , PLUS_BARYCENTER , MINUS_BARYCENTER = 7 , PLUS_ORIGIN = 8 , MINUS_ORIGIN = 9 , PREVIOUS = 10 , PLUS_SENSOR_ORIGIN , MINUS_SENSOR_ORIGIN , UNDEFINED = 255 }
	'Default' orientations More...

Public Member Functions
const CCVector3 &	getNormal (unsigned normIndex) const
	Returns the precomputed normal corresponding to a given compressed index. More...

CCVector3 &	getNormal (unsigned normIndex)

const std::vector< CCVector3 > &	getNormals () const

std::vector< CCVector3 > &	getNormals ()

virtual	~ccNormalVectors ()
	Default destructor. More...

bool	enableNormalHSVColorsArray ()
	Allocates normal HSV colors array. More...

const ecvColor::Rgb &	getNormalHSVColor (unsigned index) const
	Returns the HSV color equivalent to a given compressed normal index. More...

const std::vector< ecvColor::Rgb > &	getNormalHSVColorArray () const
	Returns the HSV color array. More...

Static Public Member Functions
static ccNormalVectors *	GetUniqueInstance ()
	Returns unique instance. More...

static void	ReleaseUniqueInstance ()
	Releases unique instance. More...

static unsigned	GetNumberOfVectors ()
	Returns the number of compressed normal vectors. More...

static const CCVector3 &	GetNormal (unsigned normIndex)
	Static access to ccNormalVectors::getNormal. More...

static CCVector3 &	GetNormalPtr (unsigned normIndex)

static const std::vector< CCVector3 > &	GetNormals ()

static std::vector< CCVector3 > &	GetNormalsPtr ()

static CompressedNormType	GetNormIndex (const PointCoordinateType N[])
	Returns the compressed index corresponding to a normal vector. More...

static CompressedNormType	GetNormIndex (const CCVector3 &N)
	Returns the compressed index corresponding to a normal vector (shortcut) More...

static bool	ComputeCloudNormals (ccGenericPointCloud cloud, NormsIndexesTableType &theNormsCodes, CV_LOCAL_MODEL_TYPES localModel, PointCoordinateType localRadius, Orientation preferredOrientation=UNDEFINED, cloudViewer::GenericProgressCallback progressCb=nullptr, cloudViewer::DgmOctree *inputOctree=nullptr)
	Computes normal at each point of a given cloud. More...

static PointCoordinateType	GuessNaiveRadius (ccGenericPointCloud *cloud)

static PointCoordinateType	GuessBestRadius (ccGenericPointCloud cloud, cloudViewer::DgmOctree cloudOctree=nullptr, cloudViewer::GenericProgressCallback *progressCb=nullptr)

static bool	UpdateNormalOrientations (ccGenericPointCloud *theCloud, NormsIndexesTableType &theNormsCodes, Orientation preferredOrientation)
	Updates normals orientation based on a preferred orientation. More...

static void	ConvertNormalToStrikeAndDip (const CCVector3 &N, PointCoordinateType &strike_deg, PointCoordinateType &dip_deg)

static void	ConvertNormalToDipAndDipDir (const CCVector3 &N, PointCoordinateType &dip_deg, PointCoordinateType &dipDir_deg)
	Converts a normal vector to geological 'dip direction & dip' parameters. More...

static CCVector3	ConvertDipAndDipDirToNormal (PointCoordinateType dip_deg, PointCoordinateType dipDir_deg, bool upward=true)

static QString	ConvertStrikeAndDipToString (double &strike_deg, double &dip_deg)

static QString	ConvertDipAndDipDirToString (PointCoordinateType dip_deg, PointCoordinateType dipDir_deg)
	Converts geological 'dip direction & dip' parameters to a string. More...

static void	ConvertNormalToHSV (const CCVector3 &N, float &H, float &S, float &V)
	Converts a normal vector to HSV color space. More...

static ecvColor::Rgb	ConvertNormalToRGB (const CCVector3 &N)
	Converts a normal vector to RGB color space. More...

static bool	ComputeNormalWithLS (cloudViewer::GenericIndexedCloudPersist *pointAndNeighbors, CCVector3 &N)
	Helper: computes the normal (with best LS fit) More...

static bool	ComputeNormalWithTri (cloudViewer::GenericIndexedCloudPersist *pointAndNeighbors, CCVector3 &N)
	Helper: computes the normal (with Delaunay 2.5D) More...

static bool	ComputeNormalWithQuadric (cloudViewer::GenericIndexedCloudPersist *points, const CCVector3 &P, CCVector3 &N)
	Helper: computes the normal (with Delaunay 2.5D) More...

Protected Member Functions
	ccNormalVectors ()
	Default constructor. More...

bool	init ()
	Inits internal structures. More...

Static Protected Member Functions
static bool	ComputeNormsAtLevelWithQuadric (const cloudViewer::DgmOctree::octreeCell &cell, void *additionalParameters, cloudViewer::NormalizedProgress nProgress=nullptr)
	Cellular method for octree-based normal computation. More...

static bool	ComputeNormsAtLevelWithLS (const cloudViewer::DgmOctree::octreeCell &cell, void *additionalParameters, cloudViewer::NormalizedProgress nProgress=nullptr)
	Cellular method for octree-based normal computation. More...

static bool	ComputeNormsAtLevelWithTri (const cloudViewer::DgmOctree::octreeCell &cell, void *additionalParameters, cloudViewer::NormalizedProgress nProgress=nullptr)
	Cellular method for octree-based normal computation. More...

Protected Attributes
std::vector< CCVector3 >	m_theNormalVectors
	Compressed normal vectors. More...

std::vector< ecvColor::Rgb >	m_theNormalHSVColors
	'HSV' colors corresponding to each compressed normal index More...

Detailed Description

Compressed normal vectors handler.

Definition at line 20 of file ecvNormalVectors.h.

Member Enumeration Documentation

◆ Orientation

enum ccNormalVectors::Orientation

'Default' orientations

Enumerator
PLUS_X	N.x always positive.
MINUS_X	N.x always negative.
PLUS_Y	N.y always positive.
MINUS_Y	N.y always negative.
PLUS_Z	N.z always positive.
MINUS_Z	N.z always negative.
PLUS_BARYCENTER	Normals always opposite to the cloud barycenter.
MINUS_BARYCENTER	Normals always towards the cloud barycenter.
PLUS_ORIGIN	Normals always opposite to the origin.
MINUS_ORIGIN	Normals always towards the origin.
PREVIOUS	Re-use previous normal (if any)
PLUS_SENSOR_ORIGIN	Normals opposite to the associated sensor origin (if any, and if multiple, the first one will be used)
MINUS_SENSOR_ORIGIN	Normals towards the associated sensor origin (if any, and if multiple, the first one will be used)
UNDEFINED	Undefined (no orientation is required)

Definition at line 70 of file ecvNormalVectors.h.

Constructor & Destructor Documentation

◆ ~ccNormalVectors()

virtual ccNormalVectors::~ccNormalVectors ( )

virtual

Default destructor.

◆ ccNormalVectors()

ccNormalVectors::ccNormalVectors ( )

protected

Default constructor.

Shouldn't be called directly. Use 'GetUniqueInstance' instead.

Member Function Documentation

◆ ComputeCloudNormals()

static bool ccNormalVectors::ComputeCloudNormals	(	ccGenericPointCloud *	cloud,
		NormsIndexesTableType &	theNormsCodes,
		CV_LOCAL_MODEL_TYPES	localModel,
		PointCoordinateType	localRadius,
		Orientation	preferredOrientation = `UNDEFINED`,
		cloudViewer::GenericProgressCallback *	progressCb = `nullptr`,
		cloudViewer::DgmOctree *	inputOctree = `nullptr`
	)

static

Computes normal at each point of a given cloud.

Parameters

cloud	point cloud on which to process the normals.
theNormsCodes	array in which the normals indexes are stored
localModel	which kind of model to use for the computation (LS = plane, QUADRIC = quadratic Height Function, TRI = triangulation)
localRadius	local neighborhood radius (not necessary for TRI)
preferredOrientation	specifies a preferred orientation for normals (optional)
progressCb	progress notification (optional)
inputOctree	inputOctree input cloud octree (optional).

Returns: success

◆ ComputeNormalWithLS()

static bool ccNormalVectors::ComputeNormalWithLS	(	cloudViewer::GenericIndexedCloudPersist *	pointAndNeighbors,
		CCVector3 &	N
	)

static

Helper: computes the normal (with best LS fit)

◆ ComputeNormalWithQuadric()

static bool ccNormalVectors::ComputeNormalWithQuadric	(	cloudViewer::GenericIndexedCloudPersist *	points,
		const CCVector3 &	P,
		CCVector3 &	N
	)

static

Helper: computes the normal (with Delaunay 2.5D)

The normal is computed at the first point (assuming the others are its neighbors).

◆ ComputeNormalWithTri()

static bool ccNormalVectors::ComputeNormalWithTri	(	cloudViewer::GenericIndexedCloudPersist *	pointAndNeighbors,
		CCVector3 &	N
	)

static

Helper: computes the normal (with Delaunay 2.5D)

The normal is computed at the first point (assuming the others are its neighbors).

◆ ComputeNormsAtLevelWithLS()

static bool ccNormalVectors::ComputeNormsAtLevelWithLS	(	const cloudViewer::DgmOctree::octreeCell &	cell,
		void **	additionalParameters,
		cloudViewer::NormalizedProgress *	nProgress = `nullptr`
	)

staticprotected

Cellular method for octree-based normal computation.

◆ ComputeNormsAtLevelWithQuadric()

static bool ccNormalVectors::ComputeNormsAtLevelWithQuadric	(	const cloudViewer::DgmOctree::octreeCell &	cell,
		void **	additionalParameters,
		cloudViewer::NormalizedProgress *	nProgress = `nullptr`
	)

staticprotected

Cellular method for octree-based normal computation.

◆ ComputeNormsAtLevelWithTri()

static bool ccNormalVectors::ComputeNormsAtLevelWithTri	(	const cloudViewer::DgmOctree::octreeCell &	cell,
		void **	additionalParameters,
		cloudViewer::NormalizedProgress *	nProgress = `nullptr`
	)

staticprotected

Cellular method for octree-based normal computation.

◆ ConvertDipAndDipDirToNormal()

static CCVector3 ccNormalVectors::ConvertDipAndDipDirToNormal	(	PointCoordinateType	dip_deg,
		PointCoordinateType	dipDir_deg,
		bool	upward = `true`
	)

static

Converts a couple of geological 'dip direction & dip' parameters to a unit normal vector

Parameters

[in]	dip_deg	value (in degrees)
[in]	dipDir_deg	dip direction value(in degrees)
[in]	upward	whether the output normal vector should point towards Z+ (true) or Z- (false)

Returns: unit normal vector

Referenced by ccCompass::importFoliations(), ccCompassImport::importFoliations(), ccApplyTransformationDlg::initFromDipAndDipDir(), ccPlaneEditDlg::onDipDirChanged(), and ccPlaneEditDlg::updatePlane().

◆ ConvertDipAndDipDirToString()

static QString ccNormalVectors::ConvertDipAndDipDirToString	(	PointCoordinateType	dip_deg,
		PointCoordinateType	dipDir_deg
	)

static

Converts geological 'dip direction & dip' parameters to a string.

Parameters

[in]	dip_deg	dip angle value (in degrees)
[in]	dipDir_deg	dip direction value (in degrees)

Returns: formatted string "Dip direction: [dipDir]° - Dip angle: [dip]°"

Referenced by StereogramDialog::init(), and CommandMatchBestFitPlane::process().

◆ ConvertNormalToDipAndDipDir()

static void ccNormalVectors::ConvertNormalToDipAndDipDir	(	const CCVector3 &	N,
		PointCoordinateType &	dip_deg,
		PointCoordinateType &	dipDir_deg
	)

static

Converts a normal vector to geological 'dip direction & dip' parameters.

See http://en.wikipedia.org/wiki/Strike_and_dip The dip direction is the azimuth of the direction (in [0,360[). The dip is always in [0,90].

Parameters

[in]	N	normal (should be normalized!)
[out]	dip_deg	value (in degrees)
[out]	dipDir_deg	dip direction value (in degrees)

Referenced by ccFitPlane::ccFitPlane(), masc::NeighborhoodFeature::computeValue(), qFacets::createFacets(), StereogramDialog::exportCurrentSelection(), ccPropertiesTreeDelegate::fillWithPlanarEntity(), GetFacetMetaData(), FacetsClassifier::GetFamilyIndexes(), StereogramWidget::init(), ccPlaneEditDlg::onNormalChanged(), NormDipAndDipDirFieldWrapper::pointValue(), CommandMatchBestFitPlane::process(), ccFitPlane::updateAttributes(), and StereogramDialog::updateFacetsFilter().

◆ ConvertNormalToHSV()

static void ccNormalVectors::ConvertNormalToHSV	(	const CCVector3 &	N,
		float &	H,
		float &	S,
		float &	V
	)

static

Converts a normal vector to HSV color space.

Uses 'strike & dip' parameters (H=strike, S=dip, V=constant)

Parameters

[in]	N	normal (should be normalized!)
[out]	H	hue [0;360[
[out]	S	saturation [0;1]
[out]	V	value [0;1]

◆ ConvertNormalToRGB()

static ecvColor::Rgb ccNormalVectors::ConvertNormalToRGB ( const CCVector3 & N )

static

Converts a normal vector to RGB color space.

Uses 'ConvertNormalToHSV' then converts HSV to RGB.

Parameters

[in] N normal (should be normalized!)

Returns: RGB value (components between 0 and MAX_COLOR_COMP)

◆ ConvertNormalToStrikeAndDip()

static void ccNormalVectors::ConvertNormalToStrikeAndDip	(	const CCVector3 &	N,
		PointCoordinateType &	strike_deg,
		PointCoordinateType &	dip_deg
	)

static

Converts a normal vector to geological 'strike & dip' parameters (N[dip]°E - [strike]°)

Parameters

[in]	N	normal (should be normalized!)
[out]	strike_deg	strike value (in degrees)
[out]	dip_deg	dip value (in degrees)

◆ ConvertStrikeAndDipToString()

static QString ccNormalVectors::ConvertStrikeAndDipToString	(	double &	strike_deg,
		double &	dip_deg
	)

static

Converts geological 'strike & dip' parameters (N[dip]°E - [strike]°) to a string

Parameters

[in]	strike_deg	strike value (in degrees)
[in]	dip_deg	dip value (in degrees)

Returns: formatted string "N[strike]°E - [dip]°"

◆ enableNormalHSVColorsArray()

bool ccNormalVectors::enableNormalHSVColorsArray ( )

Allocates normal HSV colors array.

Mandatory for HSV color related methods (getNormalHSVColor, etc.)

◆ GetNormal()

static const CCVector3& ccNormalVectors::GetNormal ( unsigned normIndex )

inlinestatic

Static access to ccNormalVectors::getNormal.

Definition at line 37 of file ecvNormalVectors.h.

Referenced by ComputeM3C2DistForPoint(), define_ccNormalVectors(), ccTrace::fitPlane(), qM3C2Normals::MakeNormalsHorizontal(), OrientPointNormalWithCloud(), and ToFbxMesh().

◆ getNormal() [1/2]

CCVector3& ccNormalVectors::getNormal ( unsigned normIndex )

inline

Definition at line 54 of file ecvNormalVectors.h.

◆ getNormal() [2/2]

const CCVector3& ccNormalVectors::getNormal ( unsigned normIndex ) const

inline

Returns the precomputed normal corresponding to a given compressed index.

Definition at line 51 of file ecvNormalVectors.h.

◆ getNormalHSVColor()

const ecvColor::Rgb& ccNormalVectors::getNormalHSVColor ( unsigned index ) const

Returns the HSV color equivalent to a given compressed normal index.

◆ getNormalHSVColorArray()

const std::vector<ecvColor::Rgb>& ccNormalVectors::getNormalHSVColorArray ( ) const

inline

Returns the HSV color array.

Definition at line 224 of file ecvNormalVectors.h.

◆ GetNormalPtr()

static CCVector3& ccNormalVectors::GetNormalPtr ( unsigned normIndex )

inlinestatic

Definition at line 40 of file ecvNormalVectors.h.

◆ GetNormals()

static const std::vector<CCVector3>& ccNormalVectors::GetNormals ( )

inlinestatic

Definition at line 43 of file ecvNormalVectors.h.

◆ getNormals() [1/2]

std::vector<CCVector3>& ccNormalVectors::getNormals ( )

inline

Definition at line 60 of file ecvNormalVectors.h.

◆ getNormals() [2/2]

const std::vector<CCVector3>& ccNormalVectors::getNormals ( ) const

inline

Definition at line 57 of file ecvNormalVectors.h.

◆ GetNormalsPtr()

static std::vector<CCVector3>& ccNormalVectors::GetNormalsPtr ( )

inlinestatic

Definition at line 46 of file ecvNormalVectors.h.

◆ GetNormIndex() [1/2]

static CompressedNormType ccNormalVectors::GetNormIndex ( const CCVector3 & N )

inlinestatic

Returns the compressed index corresponding to a normal vector (shortcut)

Definition at line 65 of file ecvNormalVectors.h.

References Tuple3Tpl< Type >::u.

◆ GetNormIndex() [2/2]

static CompressedNormType ccNormalVectors::GetNormIndex ( const PointCoordinateType N[] )

static

Returns the compressed index corresponding to a normal vector.

Referenced by ComputeCorePointNormal(), define_ccNormalVectors(), FromFbxMesh(), qM3C2Normals::MakeNormalsHorizontal(), and OrientPointNormalWithCloud().

◆ GetNumberOfVectors()

static unsigned ccNormalVectors::GetNumberOfVectors ( )

inlinestatic

Returns the number of compressed normal vectors.

Definition at line 31 of file ecvNormalVectors.h.

Referenced by define_ccNormalVectors().

◆ GetUniqueInstance()

static ccNormalVectors* ccNormalVectors::GetUniqueInstance ( )

static

Returns unique instance.

Referenced by define_ccNormalVectors(), and InitEnvironment().

◆ GuessBestRadius()

static PointCoordinateType ccNormalVectors::GuessBestRadius	(	ccGenericPointCloud *	cloud,
		cloudViewer::DgmOctree *	cloudOctree = `nullptr`,
		cloudViewer::GenericProgressCallback *	progressCb = `nullptr`
	)

static

Tries to guess the best 'local radius' for normals computation (see ComputeCloudNormals)

Parameters

cloud	point cloud on which to process the normals.
cloudOctree	input cloud octree (optional)
progressCb	progress notification (optional)

Returns: the best radius (strictly positive value) or 0 if an error occurred

Referenced by ccNormalComputationDlg::autoEstimateRadius(), and CommandOctreeNormal::process().

◆ GuessNaiveRadius()

static PointCoordinateType ccNormalVectors::GuessNaiveRadius ( ccGenericPointCloud * cloud )

static

Tries to guess a very naive 'local radius' for normals computation (see ComputeCloudNormals)

Parameters

cloud point cloud on which to process the normals.

Returns: naive radius (percentage of the cloud bounding-box)

Referenced by ccEntityAction::computeNormals().

◆ init()

bool ccNormalVectors::init ( )

protected

Inits internal structures.

◆ ReleaseUniqueInstance()

static void ccNormalVectors::ReleaseUniqueInstance ( )

static

Releases unique instance.

Call to this method is now optional.

Referenced by define_ccNormalVectors().

◆ UpdateNormalOrientations()

static bool ccNormalVectors::UpdateNormalOrientations	(	ccGenericPointCloud *	theCloud,
		NormsIndexesTableType &	theNormsCodes,
		Orientation	preferredOrientation
	)

static

Updates normals orientation based on a preferred orientation.

Parameters

theCloud	point cloud on which to process the normals.
theNormsCodes	array in which the normals indexes are stored
preferredOrientation	specifies a preferred orientation for normals

Returns: success

Referenced by qM3C2Process::Compute().

Member Data Documentation

◆ m_theNormalHSVColors

std::vector<ecvColor::Rgb> ccNormalVectors::m_theNormalHSVColors

protected

'HSV' colors corresponding to each compressed normal index

In fact, HSV color has already been converted to RGB here for faster display.

Definition at line 266 of file ecvNormalVectors.h.

◆ m_theNormalVectors

std::vector<CCVector3> ccNormalVectors::m_theNormalVectors

protected

Compressed normal vectors.

Definition at line 260 of file ecvNormalVectors.h.

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

/root/ACloudViewer/libs/CV_db/include/ecvNormalVectors.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Orientation

Constructor & Destructor Documentation

◆ ~ccNormalVectors()

◆ ccNormalVectors()

Member Function Documentation

◆ ComputeCloudNormals()

◆ ComputeNormalWithLS()

◆ ComputeNormalWithQuadric()

◆ ComputeNormalWithTri()

◆ ComputeNormsAtLevelWithLS()

◆ ComputeNormsAtLevelWithQuadric()

◆ ComputeNormsAtLevelWithTri()

◆ ConvertDipAndDipDirToNormal()

◆ ConvertDipAndDipDirToString()

◆ ConvertNormalToDipAndDipDir()

◆ ConvertNormalToHSV()

◆ ConvertNormalToRGB()

◆ ConvertNormalToStrikeAndDip()

◆ ConvertStrikeAndDipToString()

◆ enableNormalHSVColorsArray()

◆ GetNormal()

◆ getNormal() [1/2]

◆ getNormal() [2/2]

◆ getNormalHSVColor()

◆ getNormalHSVColorArray()

◆ GetNormalPtr()

◆ GetNormals()

◆ getNormals() [1/2]

◆ getNormals() [2/2]

◆ GetNormalsPtr()

◆ GetNormIndex() [1/2]

◆ GetNormIndex() [2/2]

◆ GetNumberOfVectors()

◆ GetUniqueInstance()

◆ GuessBestRadius()

◆ GuessNaiveRadius()

◆ init()

◆ ReleaseUniqueInstance()

◆ UpdateNormalOrientations()

Member Data Documentation

◆ m_theNormalHSVColors

◆ m_theNormalVectors