pts.storedtable.conversionspec Namespace Reference

Facilities for representing SKIRT resource conversion specifications. More...

Classes
class	ConversionSpec
	An instance of this class represents a particular specification for converting some original data (in some given format) to the SKIRT stored table format, and it provides facilities to actually perform the specified conversion by calling upon the appropriate functionality outside this module. More...
class	ConversionSpecs
	An instance of this class aggregates a set of ConversionSpec instances with facilities to perform them as a group. More...

Functions
def	createConversionSpecs (inputPath, outputPath, subDirectory)
	This function creates and returns the ConversionSpec instances corresponding to all specifications residing in the nested directory hierarchy below the specified sub-directory within the overall hierarchy rooted at the given input path. More...
def	findSubDirectory (rootPath, subDirectory)
	This helper function locates the specified sub-directory in the nested hierarchy specified by the root path. More...

Detailed Description

Facilities for representing SKIRT resource conversion specifications.

An instance of the ConversionSpec class in this module represents a particular specification for converting some original data (in some given format) to the SKIRT stored table format, and it provides facilities to actually perform the specified conversion by calling upon the appropriate functionality outside this module. A conversion specification is derived from the information in a particular subdirectory of the original data directory hierarchy.

An instance of the ConversionSpecs class in this module aggregates a set of ConversionSpec instances with facilities to perform them as a group.

The createConversionSpecs function creates the ConversionSpec instances corresponding to all specifications residing in a given nested directory hierarchy.

Function Documentation

createConversionSpecs()

def pts.storedtable.conversionspec.createConversionSpecs	(		inputPath,
			outputPath,
			subDirectory
	)

This function creates and returns the ConversionSpec instances corresponding to all specifications residing in the nested directory hierarchy below the specified sub-directory within the overall hierarchy rooted at the given input path.

The output root path is passed on to each conversion spec.

findSubDirectory()

def pts.storedtable.conversionspec.findSubDirectory	(		rootPath,
			subDirectory
	)

This helper function locates the specified sub-directory in the nested hierarchy specified by the root path.