open_iA 2024.7
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | List of all members
iAFunctionalBoxplot< ArgType, ValType > Class Template Reference

Class for calculating and providing functional boxplot data for arbitrary functions For details on the calculation, see Lopez-Pintado, S.; Romo, J. More...

#include <iAFunctionalBoxplot.h>

Public Types

enum  Index { LOWER , UPPER }
 

Public Member Functions

 iAFunctionalBoxplot (std::vector< iAFunction< ArgType, ValType > * > &functions, iADepthMeasure< ArgType, ValType > *measure, size_t maxBandSize=2)
 Construction & calculation of functional boxplot data.
 
iAFunctionBand< ArgType, ValType > const & getCentralRegion () const
 
iAFunctionBand< ArgType, ValType > const & getEnvelope () const
 
iAFunction< ArgType, ValType > const & getMedian () const
 
std::vector< iAFunction< ArgType, ValType > * > const & getOutliers () const
 

Static Public Attributes

static const unsigned long long MaxOverallFctBoxPlotLoops = 10000000000000
 
static const unsigned long long MinArgsPerBand = 40
 
static const unsigned long long MinBandsPerFct = 40
 

Detailed Description

template<typename ArgType, typename ValType>
class iAFunctionalBoxplot< ArgType, ValType >

Class for calculating and providing functional boxplot data for arbitrary functions For details on the calculation, see Lopez-Pintado, S.; Romo, J.

(2009). "On the Concept of Depth for Functional Data". Journal of the American Statistical Association 104 (486): 718-734. Sun, Y.; Genton, M. G. (2011). "Functional boxplots". Journal of Computational and Graphical Statistics 20: 316-334.

Member Enumeration Documentation

◆ Index

template<typename ArgType , typename ValType >
enum iAFunctionalBoxplot::Index
Enumerator
LOWER 
UPPER 

Constructor & Destructor Documentation

◆ iAFunctionalBoxplot()

template<typename ArgType , typename ValType >
iAFunctionalBoxplot< ArgType, ValType >::iAFunctionalBoxplot ( std::vector< iAFunction< ArgType, ValType > * > & functions,
iADepthMeasure< ArgType, ValType > * measure,
size_t maxBandSize = 2 )

Construction & calculation of functional boxplot data.

Parameters
functionsfunctions for which to calculate band depth
measurethe measure to use to compute the depth (see SimpleDepthMeasure and ModifiedDepthMeasure)
maxBandSizethe maximum band size to consider for band depth calculation (i.e. how many functions at most should be combined to bands). Band depth will be calculated as a combination of all band sizes from 2 to maxBandSize

Member Function Documentation

◆ getCentralRegion()

template<typename ArgType , typename ValType >
iAFunctionBand< ArgType, ValType > const & iAFunctionalBoxplot< ArgType, ValType >::getCentralRegion ( ) const

◆ getEnvelope()

template<typename ArgType , typename ValType >
iAFunctionBand< ArgType, ValType > const & iAFunctionalBoxplot< ArgType, ValType >::getEnvelope ( ) const

◆ getMedian()

template<typename ArgType , typename ValType >
iAFunction< ArgType, ValType > const & iAFunctionalBoxplot< ArgType, ValType >::getMedian ( ) const

◆ getOutliers()

template<typename ArgType , typename ValType >
std::vector< iAFunction< ArgType, ValType > * > const & iAFunctionalBoxplot< ArgType, ValType >::getOutliers ( ) const

Member Data Documentation

◆ MaxOverallFctBoxPlotLoops

template<typename ArgType , typename ValType >
const unsigned long long iAFunctionalBoxplot< ArgType, ValType >::MaxOverallFctBoxPlotLoops = 10000000000000
static

◆ MinArgsPerBand

template<typename ArgType , typename ValType >
const unsigned long long iAFunctionalBoxplot< ArgType, ValType >::MinArgsPerBand = 40
static

◆ MinBandsPerFct

template<typename ArgType , typename ValType >
const unsigned long long iAFunctionalBoxplot< ArgType, ValType >::MinBandsPerFct = 40
static

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