rocslope2.analysisResults.AnalysisResults module#

class ResultsTable(*args: Any, **kwargs: Any)#

Bases: DataFrame

One analysis-type result grid (Excel-equivalent columns), as a DataFrame.

Examples: Code Snippet: Analysis Results

property analysis_type#
property analysis_type_name: str#
getColumnName(column: ResultColumn) → str#

Resolve ResultColumn to the actual DataFrame header (may include units).

getColumn(column: ResultColumn)#

Return the full column Series for the given ResultColumn.

getValue(row_index: int, column: ResultColumn)#

Return one cell by 0-based DataFrame row position (iloc).

Examples: Code Snippet: Analysis Results

getValueById(display_id: int, column: ResultColumn)#

Return one cell by the Excel-style ID column value (1-based).

Examples: Code Snippet: Analysis Results

selectColumns(*columns: ResultColumn) → ResultsTable#

Return a new ResultsTable containing only the requested columns.

class AnalysisResults#

Bases: Dict[AnalysisResultsType, ResultsTable]

Dictionary of result tables keyed by AnalysisResultsType (WEDGE, PLANAR, TOPPLING).

Examples: Code Snippet: Analysis Results

getWedgeResults() → ResultsTable#
getPlanarResults() → ResultsTable#
getTopplingResults() → ResultsTable#
class AnalysisResultsHandler(client: Client, project_id: str)#

Bases: _ProxyObject

getResultsTables(*analysis_types: AnalysisResultsType) → AnalysisResults#