resqpy.property.ApsProperty

class resqpy.property.ApsProperty(aps, part)

Bases: object

Class holding a single property with attribute style read access to metadata items.

Public Data Attributes:

part

The part (string) identifier for this property.

node

The xml root node for this property.

uuid

The uuid for this property.

array_ref

The cached numpy array of values for this property.

values

A copy of the numpy array of values for this property.

property_kind

The property kind of this property.

facet_type

The facet type for this property (may be None).

facet

The facet value for this property (may be None).

indexable

The indexable element for this property (synonymous with indexable_element).

indexable_element

The indexable element for this property (synonymous with indexable).

is_continuous

Boolean indicating whether this property is continuous.

is_categorical

Boolean indicating whether this property is categorical.

is_discrete

Boolean indicating whether this property is discrete (False for categorical properties).

is_points

Boolean indicating whether this is a points property.

count

The count (number of sub-elements per element, usually 1) for this property.

uom

The unit of measure for this property (will be None for discrete or categorical properties).

null_value

The null value for this property (will be None for continuous properties, for which NaN is always the null value).

realization

The realisation number for this property (may be None).

time_index

The time index for this property (may be None).

title

The citation title for this property (synonymous with citation_title).

citation_title

The citation title for this property (synonymous with title).

min_value

The minimum value for this property, as stored in xml metadata.

max_value

The maximum value for this property, as stored in xml metadata.

constant_value

The constant value for this property, as stored in xml metadata (usually None).

extra

The extra metadata for this property (synonymous with extra_metadata).

extra_metadata

The extra metadata for this property (synonymous with extra).

source

The source extra metadata value for this property (or None).

support_uuid

The uuid of the supporting representation for this property.

string_lookup_uuid

The uuid of the string lookup table for a categorical property (otherwise None).

time_series_uuid

The uuid of the time series for this property (may be None).

local_property_kind_uuid

The uuid of the local property kind for this property (may be None).

Methods:

__init__(aps, part)

Initialise a single property from a property set with attribute style read access to metadata items.


__init__(aps, part)[source]

Initialise a single property from a property set with attribute style read access to metadata items.

property array_ref

The cached numpy array of values for this property.

property citation_title

The citation title for this property (synonymous with title).

property constant_value

The constant value for this property, as stored in xml metadata (usually None).

property count

The count (number of sub-elements per element, usually 1) for this property.

property extra

The extra metadata for this property (synonymous with extra_metadata).

property extra_metadata

The extra metadata for this property (synonymous with extra).

property facet

The facet value for this property (may be None).

property facet_type

The facet type for this property (may be None).

property indexable

The indexable element for this property (synonymous with indexable_element).

property indexable_element

The indexable element for this property (synonymous with indexable).

property is_categorical

Boolean indicating whether this property is categorical.

property is_continuous

Boolean indicating whether this property is continuous.

property is_discrete

Boolean indicating whether this property is discrete (False for categorical properties).

property is_points

Boolean indicating whether this is a points property.

property local_property_kind_uuid

The uuid of the local property kind for this property (may be None).

property max_value

The maximum value for this property, as stored in xml metadata.

property min_value

The minimum value for this property, as stored in xml metadata.

property node

The xml root node for this property.

property null_value

The null value for this property (will be None for continuous properties, for which NaN is always the null value).

property part

The part (string) identifier for this property.

property property_kind

The property kind of this property.

property realization

The realisation number for this property (may be None).

property source

The source extra metadata value for this property (or None).

property string_lookup_uuid

The uuid of the string lookup table for a categorical property (otherwise None).

property support_uuid

The uuid of the supporting representation for this property.

property time_index

The time index for this property (may be None).

property time_series_uuid

The uuid of the time series for this property (may be None).

property title

The citation title for this property (synonymous with citation_title).

property uom

The unit of measure for this property (will be None for discrete or categorical properties).

property uuid

The uuid for this property.

property values

A copy of the numpy array of values for this property.