class matlantis_features.features.base.FeatureBaseResult(feature: FeatureBase, call_params: Dict[str, Any], output: FeatureBaseOutput, calculator_info: Optional[Dict[str, Any]], version_info: Dict[str, Any], user_info: Dict[str, Any])#

Bases: object

The base of the matlantis features result classes.

Methods

__init__(feature, call_params, output, …)

from_dict(res)

Construct a FeatureBaseResult object from serialized dict.

load(filename)

Construct a FeatureBaseResult object from serialized dict.

save(filename)

Construct a FeatureBaseResult object from serialized dict.

to_dict()

Dictionary representation of the FeatureBaseResult.
__init__(feature: FeatureBase, call_params: Dict[str, Any], output: FeatureBaseOutput, calculator_info: Optional[Dict[str, Any]], version_info: Dict[str, Any], user_info: Dict[str, Any]) → None#
classmethod from_dict(res: Dict[str, Any]) → FeatureBaseResult#

Construct a FeatureBaseResult object from serialized dict.

Parameters

res (dict[str, Any]) – A dict containing a serialized FeatureBaseResult from to_dict().

Returns

The deserialized object from provided dict.

Return type

FeatureBaseResult

classmethod load(filename: str) → FeatureBaseResult#

Construct a FeatureBaseResult object from serialized dict.

Parameters

filename (str) – Name of file to save the FeatureBaseResult to.

Returns

The FeatureBaseResult object if loading was successful.

Return type

FeatureBaseResult

save(filename: str) → bool#

Construct a FeatureBaseResult object from serialized dict.

Parameters

filename (str) – Name of file to save the FeatureBaseResult to.

Returns

Whether saving the result was successful or not.

Return type

bool

to_dict() → Dict[str, Any]#

Dictionary representation of the FeatureBaseResult.

Returns

A dict containing a serialized FeatureBaseResult.

Return type

dict[str, Any]

Attributes

feature: FeatureBase#
call_params: Dict[str, Any]#
output: FeatureBaseOutput#
calculator_info: Optional[Dict[str, Any]]#
version_info: Dict[str, Any]#
user_info: Dict[str, Any]#