the array of point class More...

#include <PointArray.h>

Inheritance diagram for kome::core::PointArray:

Collaboration diagram for kome::core::PointArray:

Public Member Functions
	PointArray ()
	constructor

virtual	~PointArray ()
	destructor

void	sortByX (const bool desc)
	sorts peaks by x More...

void	sortByY (const bool desc)
	sorts peaks by y More...

Public Member Functions inherited from kome::core::XYData
	XYData ()
	constructor

virtual	~XYData ()
	destructor

double	getMinX ()
	gets minimum x More...

double	getMaxX ()
	gets maximum x More...

double	getMinY ()
	gets minimum y More...

double	getMaxY ()
	gets maximum y More...

void	clearPoints ()
	clear all data points

void	addPoint (const double x, const double y)
	adds point More...

void	insertPoint (const unsigned int index, const double x, const double y)
	insertts point More...

void	updatePoint (const unsigned int index, const double x, const double y)
	updates points More...

void	deletePoint (const unsigned int index)
	delete point More...

unsigned int	getLength ()
	gets the number of points @return the number of points

double	getX (const unsigned int index)
	gets x coordinate More...

double	getY (const unsigned int index)
	gets y coordinate More...

void	reserve (const unsigned int num)
	reserves enough contiguous memory of array More...

unsigned long	getVersion ()
	gets the version More...

int	searchIndex (const double x)
	searches index of specified x value. More...

int	getNearestIndex (const double x)
	gets nearest index More...

void	filter (const double absY=0.0, const double relY=0.0)
	executes filter More...

void	getPoints (std::vector< Point< double > > &points, const bool ySort, const bool desc)
	gets points array More...

bool	importData (boost::function< int(void *, int) > readFun)
	imports data More...

bool	exportData (boost::function< int(void *, int) > writeFun)
	exports data More...

Protected Member Functions
virtual void	onClearPoints ()
	This method is called by clearPoints method. (override method)

virtual void	onAddPoint (const double x, const double y)
	This method is called by addPoint method. (override method) More...

virtual void	onInsertPoint (const unsigned int index, const double x, const double y)
	This method is called by insertPoint method. (override method) More...

virtual void	onDeletePoint (const unsigned int index)
	This method is called by deletePoint method. (override method) More...

virtual unsigned int	onGetLength ()
	this method is called by getLength method (override method) More...

virtual double	onGetX (const unsigned int index)
	This method is called by getX method. (override method) More...

virtual double	onGetY (const unsigned int index)
	This method is called by getY method. (override method) More...

virtual void	onReserve (const unsigned int num)
	This method is called by reserve method. (override method) More...

Protected Member Functions inherited from kome::core::XYData
void	updateRange ()
	updates range

virtual bool	onLoadData (boost::function< int(void *, int) > readFun)
	loads data from file More...

virtual bool	onSaveData (boost::function< int(void *, int) > writeFun)
	saves data to file More...

Protected Attributes
std::vector< Point< double > >	m_points

Protected Attributes inherited from kome::core::XYData
bool	m_updated

double	m_minX

double	m_maxX

double	m_minY

double	m_maxY

unsigned long	m_version

Additional Inherited Members
Static Protected Attributes inherited from kome::core::XYData
static unsigned long	m_currentVersion = 0
	version More...

Detailed Description

the array of point class

Definition at line 29 of file PointArray.h.

Member Function Documentation

void kome::core::PointArray::onAddPoint	(	const double	x,
		const double	y
	)

protectedvirtual

This method is called by addPoint method. (override method)

Parameters

[in]	x	x coordinate of point to be added
[in]	y	y coordinate of point to be added

Implements kome::core::XYData.

Definition at line 71 of file PointArray.cpp.

                                                             {
     Point< double > pt( x, y );
     m_points.push_back( pt );
 }

void kome::core::PointArray::onDeletePoint ( const unsigned int index )

protectedvirtual

This method is called by deletePoint method. (override method)

Parameters

[in] index point index

Implements kome::core::XYData.

Definition at line 93 of file PointArray.cpp.

                                                          {
     // check the parameter
     if( index >= m_points.size() ) {
         return;
     }
 
     // delete
     std::vector< Point< double > >::iterator it = m_points.begin() + index;
     m_points.erase( it );
 }

unsigned int kome::core::PointArray::onGetLength ( )

protectedvirtual

this method is called by getLength method (override method)

Returns: the number of points

Implements kome::core::XYData.

Definition at line 105 of file PointArray.cpp.

                                      {
     return m_points.size();
 }

double kome::core::PointArray::onGetX ( const unsigned int index )

protectedvirtual

This method is called by getX method. (override method)

Parameters

[in] index the index of point

Returns: x coordinate

Implements kome::core::XYData.

Definition at line 110 of file PointArray.cpp.

                                                     {
     return m_points[ index ].px;
 }

double kome::core::PointArray::onGetY ( const unsigned int index )

protectedvirtual

This method is called by getY method. (override method)

Parameters

[in] index the index of point

Returns: y coordiante

Implements kome::core::XYData.

Definition at line 115 of file PointArray.cpp.

                                                     {
     return m_points[ index ].py;
 }

void kome::core::PointArray::onInsertPoint	(	const unsigned int	index,
		const double	x,
		const double	y
	)

protectedvirtual

This method is called by insertPoint method. (override method)

Parameters

[in]	index	insert position
[in]	x	x coordinate of point
[in]	y	y coordinate of point

Implements kome::core::XYData.

Definition at line 77 of file PointArray.cpp.

                                                                                          {
     // check the parameter
     if( index >= m_points.size() ) {
         onAddPoint( x, y );
         return;
     }
 
     // position
     std::vector< Point< double > >::iterator it = m_points.begin() + index;
 
     // insert
     Point< double > pt( x, y );
     m_points.insert( it, pt );
 }

Here is the call graph for this function:

void kome::core::PointArray::onReserve ( const unsigned int num )

protectedvirtual

This method is called by reserve method. (override method)

Parameters

[in] num of points to be reserved

Implements kome::core::XYData.

Definition at line 120 of file PointArray.cpp.

                                                    {
     if( num > 0 ) {
         m_points.reserve( num );
     }
 }

void kome::core::PointArray::sortByX ( const bool desc )

sorts peaks by x

Parameters

[in] desc descending order flag

Definition at line 36 of file PointArray.cpp.

                                           {
     // check the array size
     if( m_points.size() <= 1 ) {
         return;
     }
 
     // sort
     std::sort(
         m_points.begin(),
         m_points.end(),
         desc ? Point< double >::greaterX : Point< double >::lessX
     );
 }

void kome::core::PointArray::sortByY ( const bool desc )

sorts peaks by y

Parameters

[in] desc descending order flag

Definition at line 51 of file PointArray.cpp.

                                           {
     // check the array size
     if( m_points.size() <= 1 ) {
         return;
     }
 
     // sort
     std::sort(
         m_points.begin(),
         m_points.end(),
         desc ? Point< double >::greaterY : Point< double >::lessY
     );  
 }

Member Data Documentation

std::vector< Point< double > > kome::core::PointArray::m_points

protected

the array of point

Definition at line 45 of file PointArray.h.

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

CoreToolkits/PointArray.h
CoreToolkits/PointArray.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation