python.data.DataSpecification.DataSpecification Class Reference

The class encapsulates the description of the data set, like names of dimensions and source file. More...

Inheritance diagram for python.data.DataSpecification.DataSpecification:

Public Member Functions
	__init__ (self)
	Constructor.
	addAttribute (self, attributeName, attributeValue)
	Adds an attribute to the attribute collection.
	cleanAttributes (self)
	Deletes all data from attributes collection.
	createNumericAttributes (self, dim)
	Fills data specification with a number of numeric attributes with names x0, x1, x2...
	generateFilename (self)
	Generates a new random file name.
	getAttributes (self)
	Returns the collection of attributes stored in the specification.
	getFilename (self)
	Returns the file name.
	isSaved (self)
	Checks if the data set was already saved as a file.
	setFilename (self, filename)
	Sets the file name.
	setSaved (self)
	Marks the data set as saved.
	toString (self)
	Returns a string that represents the object.

Static Public Attributes
	attributes = None
	Dictionary of attributes.
	filename = None
	The file name.

Detailed Description

The class encapsulates the description of the data set, like names of dimensions and source file.

Constructor & Destructor Documentation

__init__()

python.data.DataSpecification.DataSpecification.__init__

(

self

)

Constructor.

References python.data.DataSpecification.DataSpecification.__isSaved, json::DictNode.attributes, python.data.DataSpecification.DataSpecification.attributes, python.controller.InfoToFile.InfoToFile.filename, python.data.ARFFAdapter.ARFFAdapter.filename, python.data.CSVAdapter.CSVAdapter.filename, python.data.DataSpecification.DataSpecification.filename, python.uq.models.Model.Model.filename, and sgpp::solver::StepsizeControl.filename.

Member Function Documentation

addAttribute()

python.data.DataSpecification.DataSpecification.addAttribute	(		self,
			attributeName,
			attributeValue
	)

Adds an attribute to the attribute collection.

Parameters

attributeName	attribute name
attributeValue	attribute value

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.createNumericAttributes().

cleanAttributes()

python.data.DataSpecification.DataSpecification.cleanAttributes

(

self

)

Deletes all data from attributes collection.

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.createNumericAttributes().

createNumericAttributes()

python.data.DataSpecification.DataSpecification.createNumericAttributes	(		self,
			dim
	)

Fills data specification with a number of numeric attributes with names x0, x1, x2...

Parameters

dim	the number of attributes

References json::Node.addAttribute(), json::DictNode.addAttribute(), python.data.DataSpecification.DataSpecification.addAttribute(), and python.data.DataSpecification.DataSpecification.cleanAttributes().

generateFilename()

python.data.DataSpecification.DataSpecification.generateFilename

(

self

)

Generates a new random file name.

Returns

: new random file name

Referenced by python.data.DataSpecification.DataSpecification.getFilename().

getAttributes()

python.data.DataSpecification.DataSpecification.getAttributes

(

self

)

Returns the collection of attributes stored in the specification.

Returns

: collection of attributes

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.toString().

getFilename()

python.data.DataSpecification.DataSpecification.getFilename

(

self

)

Returns the file name.

Returns

: the file name

References python.controller.InfoToFile.InfoToFile.filename, python.data.ARFFAdapter.ARFFAdapter.filename, python.data.CSVAdapter.CSVAdapter.filename, python.data.DataSpecification.DataSpecification.filename, python.uq.models.Model.Model.filename, sgpp::solver::StepsizeControl.filename, python.data.DataSpecification.DataSpecification.generateFilename(), python.data.DataSpecification.DataSpecification.setFilename(), and python.uq.uq_setting.UQSpecification.UQSpecification.setFilename().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), python.data.DataSpecification.DataSpecification.toString(), and python.uq.uq_setting.UQSetting.UQSetting.writeToFile().

isSaved()

python.data.DataSpecification.DataSpecification.isSaved

(

self

)

Checks if the data set was already saved as a file.

Returns

: True, if data set was saved, otherwise: False

References python.data.DataSpecification.DataSpecification.__isSaved.

setFilename()

python.data.DataSpecification.DataSpecification.setFilename	(		self,
			filename
	)

Sets the file name.

Parameters

filename

new file name

References python.controller.InfoToFile.InfoToFile.filename, python.data.ARFFAdapter.ARFFAdapter.filename, python.data.CSVAdapter.CSVAdapter.filename, python.data.DataSpecification.DataSpecification.filename, python.uq.models.Model.Model.filename, and sgpp::solver::StepsizeControl.filename.

Referenced by python.data.DataSpecification.DataSpecification.getFilename().

setSaved()

python.data.DataSpecification.DataSpecification.setSaved

(

self

)

Marks the data set as saved.

References python.data.DataSpecification.DataSpecification.__isSaved.

toString()

python.data.DataSpecification.DataSpecification.toString

(

self

)

Returns a string that represents the object.

Returns

A string that represents the object.

References python.data.DataSpecification.DataSpecification.getAttributes(), python.data.DataSpecification.DataSpecification.getFilename(), and python.uq.uq_setting.UQSpecification.UQSpecification.getFilename().

Referenced by python.controller.LearnerEventController.LearnerEventController.__repr__(), python.controller.SolverEventController.SolverEventController.__repr__(), python.learner.Learner.Learner.createMemento(), python.uq.learner.Learner.Learner.createMemento(), and python.learner.formatter.GridFormatter.GridFormatter.serialize().

Member Data Documentation

attributes

python.data.DataSpecification.DataSpecification.attributes = None

static

Dictionary of attributes.

Referenced by python.data.DataSpecification.DataSpecification.__init__(), python.data.DataSpecification.DataSpecification.addAttribute(), python.data.DataSpecification.DataSpecification.cleanAttributes(), and python.data.DataSpecification.DataSpecification.getAttributes().

filename

python.data.DataSpecification.DataSpecification.filename = None

static

The file name.

Referenced by python.data.DataSpecification.DataSpecification.__init__(), python.controller.InfoToFile.InfoToFile.__init__(), python.data.ARFFAdapter.ARFFAdapter.__init__(), python.data.CSVAdapter.CSVAdapter.__init__(), python.data.DataSpecification.DataSpecification.getFilename(), python.controller.InfoToFile.InfoToFile.handleLearningEvent(), python.controller.InfoToFile.InfoToFile.handleSolvingEvent(), python.data.ARFFAdapter.ARFFAdapter.loadData(), python.data.CSVAdapter.CSVAdapter.loadData(), python.data.ARFFAdapter.ARFFAdapter.loadSpecification(), python.data.CSVAdapter.CSVAdapter.loadSpecification(), python.data.ARFFAdapter.ARFFAdapter.save(), python.data.CSVAdapter.CSVAdapter.save(), python.data.DataSpecification.DataSpecification.setFilename(), and python.controller.InfoToFile.InfoToFile.toString().

---

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

• datadriven/python/data/DataSpecification.py