epsproc.util.listFuncs module

ePSproc list functions.

Define data types and generate lists.

Main function for data types is dataTypesList()

epsproc.util.listFuncs.ADMdimList(sType='stacked')

Return standard list of dimensions for frame definitions, from epsproc.sphCalc.setADMs().

Parameters:sType (string, optional, default = 'stacked') – Selected ‘stacked’ or ‘unstacked’ dimensions. Set ‘sDict’ to return a dictionary of unstacked <> stacked dims mappings for use with xr.stack({dim mapping}). Returns:list Return type:set of dimension labels.

epsproc.util.listFuncs.BLMdimList(sType='stacked')

Return standard list of dimensions for calculated BLM.

Parameters:sType (string, optional, default = 'stacked') – Selected ‘stacked’ or ‘unstacked’ dimensions. Set ‘sDict’ to return a dictionary of unstacked <> stacked dims mappings for use with xr.stack({dim mapping}). Returns:list Return type:set of dimension labels.

epsproc.util.listFuncs.dataTypesList()

Return a dict of allowed dataTypes, corresponding to epsproc processed data.

Each dataType lists ‘source’, ‘desc’ and ‘recordType’ fields.

• ‘source’ fields correspond to ePS functions which get or generate the data.
• ‘desc’ brief description of the dataType.
• ‘recordType’ gives the required segment in ePS files (and associated parser). If the segment is not present in the source file, then the dataType will not be available.

TODO: best choice of data structure here? Currently nested dictionary.

epsproc.util.listFuncs.eulerDimList(sType='stacked')

Return standard list of dimensions for frame definitions, from epsproc.sphCalc.setPolGeoms().

Parameters:sType (string, optional, default = 'stacked') – Selected ‘stacked’ or ‘unstacked’ dimensions. Set ‘sDict’ to return a dictionary of unstacked <> stacked dims mappings for use with xr.stack({dim mapping}). Returns:list Return type:set of dimension labels.

epsproc.util.listFuncs.genLM(Lmax)

Return array of (L,M) up to supplied Lmax

TODO: add return type options, include conversion to SHtools types.

epsproc.util.listFuncs.matEdimList(sType='stacked')

Return standard list of dimensions for matrix elements.

Parameters:sType (string, optional, default = 'stacked') – Selected ‘stacked’ or ‘unstacked’ dimensions. Set ‘sDict’ to return a dictionary of unstacked <> stacked dims mappings for use with xr.stack({dim mapping}). Returns:list Return type:set of dimension labels.