IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
ipsdk::math::AdaptiveGridPartition Class Reference

Class allowing to create an adaptive partition of data. More...

#include <AdaptiveGridPartition.h>

Inheritance diagram for ipsdk::math::AdaptiveGridPartition:
ipsdk::math::BaseGridPartition ipsdk::math::BaseDataPartition ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

eDataPartitionType getDataPartitionType () const
 retrieve type associated to data partition
 
Constructors and destructor
 AdaptiveGridPartition ()
 
 ~AdaptiveGridPartition ()
 
- Public Member Functions inherited from ipsdk::math::BaseGridPartition
void setNbBucketsByAxis (const ipUInt32 nbBucketsByAxis)
 selection of number of buckets by axis More...
 
ipUInt32 getNbBucketsByAxis () const
 retrieve number of buckets by axis
 
 BaseGridPartition ()
 
virtual ~BaseGridPartition ()=0
 
- Public Member Functions inherited from ipsdk::math::BaseDataPartition
bool isInit () const
 check for object initialization
 
BoolResult init (const ipUInt32 subSetRequestedSize, const DataSet &fullDataSet)
 initialization method More...
 
ipUInt32 getSubSetRequestedSize () const
 retrieve requested size for generate data sub sets More...
 
BoolResult createSubSet (const DataSet &fullDataSet, DataSet &subDataSet)
 method allowing to create a new sub set from data More...
 
void clear ()
 clear of object data
 
 BaseDataPartition ()
 
virtual ~BaseDataPartition ()=0
 
- Public Member Functions inherited from ipsdk::BaseSerializationObject
 BaseSerializationObject ()
 Default constructor.
 
virtual ~BaseSerializationObject ()=0
 destructor
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Static Public Attributes

static const eDataPartitionType::domain g_dataPartitionType = eDataPartitionType::eDPT_Regular
 data partition type
 

Protected Member Functions

BoolResult populateBuckets (const DataSet &fullDataSet, BucketPopulation &bucketPopulation)
 method allowing to compute buckets population More...
 
- Protected Member Functions inherited from ipsdk::math::BaseGridPartition
BoolResult initDerived (const DataSet &fullDataSet, const ipUInt32 subSetRequestedSize)
 initialization method of derived classes More...
 
void clearDerived ()
 clear of derived classes
 
Indexes randomSubSet (const ipUInt32 subSetRequestedSize)
 random selection of a sub set into derived class
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 method allowing to ensure serialization write part for object
 
virtual BoolResult read (BaseIArchive &ar)
 method allowing to ensure serialization read part for object
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 method allowing to retrieve class version information for serialization
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Types inherited from ipsdk::math::BaseGridPartition
typedef std::vector< ipUInt32BucketId
 id for a bucket of data
 
typedef std::vector< ipUInt32DataIdColl
 
typedef std::map< BucketId, DataIdColl > BucketPopulation
 map associating a bucket if to a collection of data ids
 
- Protected Types inherited from ipsdk::math::BaseDataPartition
typedef std::set< ipUInt32Indexes
 collection of unique indexes
 

Detailed Description

Class allowing to create an adaptive partition of data.

Author
E.Noirfalise
Date
2017/06/15

We define a grid such that data are equaly dispatched along each axis (which does not grants that data are equaly dispatched in global grid)

Member Function Documentation

◆ populateBuckets()

BoolResult ipsdk::math::AdaptiveGridPartition::populateBuckets ( const DataSet fullDataSet,
BucketPopulation bucketPopulation 
)
protectedvirtual

method allowing to compute buckets population

Returns
false in case of failure

Implements ipsdk::math::BaseGridPartition.


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