PeriPyDIC
Public Member Functions | Public Attributes | List of all members
IO.dic.DICreader2D Class Reference

A class for reading VIC3D CSV grid exports and converting them into list objects usable by other classes. More...

Collaboration diagram for IO.dic.DICreader2D:
Collaboration graph

Public Member Functions

def __init__ (self, path)
 Constructor Reads the CSV file provided, determines the unit horizon of this data and and creates node initial and node actual attributes of the class usable by the other modules. More...
 
def read (self, path)
 Read the values provided by the dic and stores it to the data array path Path and appended file name for the csv file to proceed. More...
 
def sortData (self)
 Deprecated, not necessary anymore Sorts the data from the csv file with respect to the first and second pixel. More...
 
def determineUnitHorizon (self)
 Find unique values for x. More...
 
def extractData (self)
 Stores the data extracted from the CSV file in objects which can be manipulated by other modules. More...
 

Public Attributes

 dim
 Dimension of the problem (2D for DIC)
 
 data
 Temporary variable internal to this class.
 
 length
 Total number of points in the DIC CSV file.
 
 delta_x
 The minimal nodal spacing, extracted from DIC.
 
 x
 Vector containing x nodes from DIC.
 
 y
 Vector containing y nodes from DIC.
 
 volumes
 Vector containing columes for each point.
 
 nodes
 Nodes initial positions.
 
 act
 Nodes actual positions.
 

Detailed Description

A class for reading VIC3D CSV grid exports and converting them into list objects usable by other classes.

Constructor & Destructor Documentation

§ __init__()

def IO.dic.DICreader2D.__init__ (   self,
  path 
)

Constructor Reads the CSV file provided, determines the unit horizon of this data and and creates node initial and node actual attributes of the class usable by the other modules.

Parameters
pathThe path to the VIC3D CSV export data

Member Function Documentation

§ determineUnitHorizon()

def IO.dic.DICreader2D.determineUnitHorizon (   self)

Find unique values for x.

Parameters
selfObject pointer

§ extractData()

def IO.dic.DICreader2D.extractData (   self)

Stores the data extracted from the CSV file in objects which can be manipulated by other modules.

Parameters
selfObject pointer

§ read()

def IO.dic.DICreader2D.read (   self,
  path 
)

Read the values provided by the dic and stores it to the data array path Path and appended file name for the csv file to proceed.

Parameters
pathThe path to the VIC3D CSV export data

§ sortData()

def IO.dic.DICreader2D.sortData (   self)

Deprecated, not necessary anymore Sorts the data from the csv file with respect to the first and second pixel.

Parameters
selfObject pointer

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