Classes | Public Types | Static Public Member Functions
PointMatcherIO< T > Struct Template Reference

IO Functions and classes that are dependant on scalar type are defined in this templatized class. More...

#include <IO.h>

List of all members.

Classes

struct  CsvDescriptor
 A structure to hold information about descriptors contained in a CSV file. More...
struct  FileInfo
 Information to exploit a reading from a file using this library. Fields might be left blank if unused. More...
struct  FileInfoVector
 A vector of file info, to be used in batch processing. More...
class  PLYElement
 Interface for all PLY elements. Implementations must provide definition of getPMType() More...
class  PLYElementF
 Factory for PLY elements. More...
struct  PLYProperty
 Interface for PLY property. More...
class  PLYVertex
 Implementation of PLY vertex element. More...

Public Types

typedef PointMatcher< T >
::DataPoints 
DataPoints
 alias
typedef std::map< std::string,
DescAssociationPair
DescAssociationMap
typedef std::pair< int,
std::string > 
DescAssociationPair
 Pair descriptor column, descriptor name.
typedef PointMatcher< T >
::DataPoints::Label 
Label
 alias
typedef PointMatcher< T >::Matrix Matrix
 alias
typedef PointMatcher< T >::Matrix Parameters
 alias
typedef std::map< std::string,
std::vector< PLYProperty > > 
PLYDescPropMap
enum  SupportedVTKDataTypes { POLYDATA, UNSTRUCTURED_GRID }
 Enumeration of legacy VTK data types that can be parsed. More...
typedef PointMatcher< T >
::TransformationParameters 
TransformationParameters
 alias
typedef PointMatcher< T >::Vector Vector
 alias

Static Public Member Functions

static bool colLabelRegistered (const std::string &colLabel)
 returns true if a particular descriptor dim label is registered (ie nx, red...)
static std::string getColLabel (const Label &label, const int row)
 convert a descriptor label to an appropriate sub-label
static DescAssociationMap getDescAssocationMap ()
 map to store association between common 1d descriptor labels and their PM label and span dimension
static DescAssociationPair getDescAssociationPair (const std::string &colLabel)
 get PM descriptor label associated with sublabel colLabel
static DataPoints loadCSV (const std::string &fileName)
 Load comma separated values (csv) file.
static DataPoints loadCSV (std::istream &is)
 Load comma separated values (csv) file.
static DataPoints loadPCD (const std::string &fileName)
static DataPoints loadPCD (std::istream &is)
 Load PCD file.
static DataPoints loadPLY (const std::string &fileName)
 Load polygon file format (ply) file.
static DataPoints loadPLY (std::istream &is)
 Load polygon file format (PLY) file.
static DataPoints loadVTK (const std::string &fileName)
 Load point cloud from a file as VTK.
static DataPoints loadVTK (std::istream &is)
 Load point cloud from a stream as VTK.
static bool plyPropTypeValid (const std::string &type)
 Check that property defined by type is a valid PLY type note: type must be lowercase.
static void saveCSV (const DataPoints &data, const std::string &fileName)
 Save point cloud to a file as CSV.
static void saveCSV (const DataPoints &data, std::ostream &os)
 Save point cloud to a stream as CSV.
static void savePCD (const DataPoints &data, const std::string &fileName)
 save datapoints to PCD point cloud format
static void savePLY (const DataPoints &data, const std::string &fileName)
 save datapoints to PLY point cloud format
static void saveVTK (const DataPoints &data, const std::string &fileName)
 Save point cloud to a file as VTK.

Detailed Description

template<typename T>
struct PointMatcherIO< T >

IO Functions and classes that are dependant on scalar type are defined in this templatized class.

Definition at line 43 of file IO.h.


Member Typedef Documentation

template<typename T>
typedef PointMatcher<T>::DataPoints PointMatcherIO< T >::DataPoints

alias

Definition at line 47 of file IO.h.

template<typename T>
typedef std::map<std::string, DescAssociationPair > PointMatcherIO< T >::DescAssociationMap

Map to associate common descriptor sublabels to PM descriptor matrix row and labels ex: nx, ny, nz are associated with (0,normals) (1,normals) (2,normals) respectively

Definition at line 57 of file IO.h.

template<typename T>
typedef std::pair<int, std::string > PointMatcherIO< T >::DescAssociationPair

Pair descriptor column, descriptor name.

Definition at line 53 of file IO.h.

template<typename T>
typedef PointMatcher<T>::DataPoints::Label PointMatcherIO< T >::Label

alias

Definition at line 50 of file IO.h.

template<typename T>
typedef PointMatcher<T>::Matrix PointMatcherIO< T >::Matrix

alias

Definition at line 46 of file IO.h.

template<typename T>
typedef PointMatcher<T>::Matrix PointMatcherIO< T >::Parameters

alias

Definition at line 49 of file IO.h.

template<typename T>
typedef std::map<std::string, std::vector<PLYProperty> > PointMatcherIO< T >::PLYDescPropMap

Map from a descriptor name to a list PLY property ex: "normals" -> nx, ny ,nz

Definition at line 160 of file IO.h.

alias

Definition at line 48 of file IO.h.

template<typename T>
typedef PointMatcher<T>::Vector PointMatcherIO< T >::Vector

alias

Definition at line 45 of file IO.h.


Member Enumeration Documentation

template<typename T>
enum PointMatcherIO::SupportedVTKDataTypes

Enumeration of legacy VTK data types that can be parsed.

Enumerator:
POLYDATA 
UNSTRUCTURED_GRID 

Definition at line 75 of file IO.h.


Member Function Documentation

template<typename T >
bool PointMatcherIO< T >::colLabelRegistered ( const std::string &  colLabel) [static]

returns true if a particular descriptor dim label is registered (ie nx, red...)

Definition at line 446 of file IO.cpp.

template<typename T >
std::string PointMatcherIO< T >::getColLabel ( const Label label,
const int  row 
) [static]

convert a descriptor label to an appropriate sub-label

Definition at line 458 of file IO.cpp.

template<typename T >
PointMatcherIO< T >::DescAssociationMap PointMatcherIO< T >::getDescAssocationMap ( ) [static]

map to store association between common 1d descriptor labels and their PM label and span dimension

Definition at line 411 of file IO.cpp.

template<typename T >
PointMatcherIO< T >::DescAssociationPair PointMatcherIO< T >::getDescAssociationPair ( const std::string &  colLabel) [static]

get PM descriptor label associated with sublabel colLabel

Definition at line 452 of file IO.cpp.

template<typename T >
template PointMatcher< double >::DataPoints PointMatcherIO< T >::loadCSV ( const std::string &  fileName) [static]

Load comma separated values (csv) file.

Parameters:
fileNamea string containing the path and the file name

This loader has 3 behaviors since there is no official standard for csv files. A 2D or 3D point cloud will be created automatically if:

  • there is a header with columns named x, y and optionnaly z
  • there are only 2 or 3 columns in the file

Otherwise, the user is asked to enter column id manually which might block automatic processing.

Definition at line 400 of file IO.cpp.

template<typename T >
PointMatcher< T >::DataPoints PointMatcherIO< T >::loadCSV ( std::istream &  is) [static]

Load comma separated values (csv) file.

See also:
loadCSV()

Definition at line 524 of file IO.cpp.

template<typename T>
static DataPoints PointMatcherIO< T >::loadPCD ( const std::string &  fileName) [static]
template<typename T >
PointMatcherIO< T >::DataPoints PointMatcherIO< T >::loadPCD ( std::istream &  is) [static]

Load PCD file.

See also:
loadPCD()

Definition at line 1777 of file IO.cpp.

template<typename T >
PointMatcherIO< T >::DataPoints PointMatcherIO< T >::loadPLY ( const std::string &  fileName) [static]

Load polygon file format (ply) file.

Parameters:
fileNamea string containing the path and the file name

Note: that the PLY does not define a standard for point clouds Warning: Binary PLY files are not supported, only ASCII Only PLY files with elements named "vertex" are supported "vertex" should have 2 or 3 properties names "x", "y", "z" to define features.

Definition at line 1164 of file IO.cpp.

template<typename T >
PointMatcherIO< T >::DataPoints PointMatcherIO< T >::loadPLY ( std::istream &  is) [static]

Load polygon file format (PLY) file.

See also:
loadPLY()

Definition at line 1180 of file IO.cpp.

template<typename T >
template PointMatcherIO< double >::DataPoints PointMatcherIO< T >::loadVTK ( const std::string &  fileName) [static]

Load point cloud from a file as VTK.

Definition at line 880 of file IO.cpp.

template<typename T >
PointMatcher< T >::DataPoints PointMatcherIO< T >::loadVTK ( std::istream &  is) [static]

Load point cloud from a stream as VTK.

Definition at line 890 of file IO.cpp.

template<typename T >
bool PointMatcherIO< T >::plyPropTypeValid ( const std::string &  type) [static]

Check that property defined by type is a valid PLY type note: type must be lowercase.

Definition at line 1735 of file IO.cpp.

template<typename T >
template void PointMatcherIO< T >::saveCSV ( const DataPoints data,
const std::string &  fileName 
) [static]

Save point cloud to a file as CSV.

Definition at line 806 of file IO.cpp.

template<typename T >
void PointMatcherIO< T >::saveCSV ( const DataPoints data,
std::ostream &  os 
) [static]

Save point cloud to a stream as CSV.

Definition at line 816 of file IO.cpp.

template<typename T >
template void PointMatcherIO< T >::savePCD ( const DataPoints data,
const std::string &  fileName 
) [static]

save datapoints to PCD point cloud format

Definition at line 2089 of file IO.cpp.

template<typename T >
template void PointMatcherIO< T >::savePLY ( const DataPoints data,
const std::string &  fileName 
) [static]

save datapoints to PLY point cloud format

Definition at line 1492 of file IO.cpp.

template<typename T >
template void PointMatcherIO< T >::saveVTK ( const DataPoints data,
const std::string &  fileName 
) [static]

Save point cloud to a file as VTK.

Definition at line 1139 of file IO.cpp.


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


upstream_src
Author(s):
autogenerated on Wed Sep 24 2014 10:42:01