pyidf.performance_tables module¶

Data objects in group “Performance Tables”

class pyidf.performance_tables.TableMultiVariableLookup¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Table:MultiVariableLookup The multi-variable lookup table can represent from 1 to 5 independent variables and can interpolate these independent variables up to a 4th order polynomial. The polynomial order is assumed to be the number of interpolation points (n) minus 1. When any independent variable value is outside the table limits, linear extrapolation is used to predict the table result and is based on the two nearest data points in the table for that particular independent variable.

curve_type¶

field Curve Type

The curve types BiCubic and TriQuadratic may not

be used with Interpolation Method = EvaluateCurveToLimits

Parameters:	value (str) – value for IDD Field Curve Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of curve_type or None if not set
Return type:	str

external_file_name¶

field External File Name

Parameters:	value (str) – value for IDD Field External File Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of external_file_name or None if not set
Return type:	str

field_1_determined_by_the_number_of_independent_variables¶

field Field 1 Determined by the Number of Independent Variables

Parameters:	value (float) – value for IDD Field Field 1 Determined by the Number of Independent Variables
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of field_1_determined_by_the_number_of_independent_variables or None if not set
Return type:	float

field_2_determined_by_the_number_of_independent_variables¶

field Field 2 Determined by the Number of Independent Variables

Parameters:	value (float) – value for IDD Field Field 2 Determined by the Number of Independent Variables
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of field_2_determined_by_the_number_of_independent_variables or None if not set
Return type:	float

input_unit_type_for_x1¶

field Input Unit Type for X1

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x1 or None if not set
Return type:	str

input_unit_type_for_x2¶

field Input Unit Type for X2

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x2 or None if not set
Return type:	str

input_unit_type_for_x3¶

field Input Unit Type for X3

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x3 or None if not set
Return type:	str

input_unit_type_for_x4¶

field Input Unit Type for X4

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x4 or None if not set
Return type:	str

input_unit_type_for_x5¶

field Input Unit Type for X5

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x5 or None if not set
Return type:	str

interpolation_method¶

field Interpolation Method

Default value: LagrangeInterpolationLinearExtrapolation

Parameters:	value (str) – value for IDD Field Interpolation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of interpolation_method or None if not set
Return type:	str

maximum_table_output¶

field Maximum Table Output

Specify the maximum value calculated by this curve object

Units are based on field A13

Parameters:	value (float) – value for IDD Field Maximum Table Output
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_table_output or None if not set
Return type:	float

maximum_value_of_x1¶

field Maximum Value of X1

Units are based on field A8

Parameters:	value (float) – value for IDD Field Maximum Value of X1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x1 or None if not set
Return type:	float

maximum_value_of_x2¶

field Maximum Value of X2

Units are based on field A9

Parameters:	value (float) – value for IDD Field Maximum Value of X2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x2 or None if not set
Return type:	float

maximum_value_of_x3¶

field Maximum Value of X3

Units are based on field A10

Parameters:	value (float) – value for IDD Field Maximum Value of X3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x3 or None if not set
Return type:	float

maximum_value_of_x4¶

field Maximum Value of X4

Units are based on field A11

Parameters:	value (float) – value for IDD Field Maximum Value of X4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x4 or None if not set
Return type:	float

maximum_value_of_x5¶

field Maximum Value of X5

Units are based on field A12

Parameters:	value (float) – value for IDD Field Maximum Value of X5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x5 or None if not set
Return type:	float

minimum_table_output¶

field Minimum Table Output

Specify the minimum value calculated by this curve object

Units are based on field A13

Parameters:	value (float) – value for IDD Field Minimum Table Output
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_table_output or None if not set
Return type:	float

minimum_value_of_x1¶

field Minimum Value of X1

Units are based on field A8

Parameters:	value (float) – value for IDD Field Minimum Value of X1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x1 or None if not set
Return type:	float

minimum_value_of_x2¶

field Minimum Value of X2

Units are based on field A9

Parameters:	value (float) – value for IDD Field Minimum Value of X2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x2 or None if not set
Return type:	float

minimum_value_of_x3¶

field Minimum Value of X3

Units are based on field A10

Parameters:	value (float) – value for IDD Field Minimum Value of X3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x3 or None if not set
Return type:	float

minimum_value_of_x4¶

field Minimum Value of X4

Units are based on field A11

Parameters:	value (float) – value for IDD Field Minimum Value of X4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x4 or None if not set
Return type:	float

minimum_value_of_x5¶

field Minimum Value of X5

Units are based on field A12

Parameters:	value (float) – value for IDD Field Minimum Value of X5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x5 or None if not set
Return type:	float

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

normalization_reference¶

field Normalization Reference

This field is used to normalize the table output data.
The minimum and maximum table output fields are also normalized.
If this field is blank or 1, the table data will be directly used.
This field is not allowed to be set equal to 0.

Parameters:	value (float) – value for IDD Field Normalization Reference
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalization_reference or None if not set
Return type:	float

number_of_independent_variables¶

field Number of Independent Variables

value <= 5

Parameters:	value (int) – value for IDD Field Number of Independent Variables
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_independent_variables or None if not set
Return type:	int

number_of_interpolation_points¶

field Number of Interpolation Points

Default value: 3
value > 1
value <= 4

Parameters:	value (int) – value for IDD Field Number of Interpolation Points
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_interpolation_points or None if not set
Return type:	int

number_of_values_for_independent_variable_x1¶

field Number of Values for Independent Variable X1

Parameters:	value (int) – value for IDD Field Number of Values for Independent Variable X1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_values_for_independent_variable_x1 or None if not set
Return type:	int

output_unit_type¶

field Output Unit Type

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Output Unit Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of output_unit_type or None if not set
Return type:	str

table_data_format¶

field Table Data Format

Default value: SingleLineIndependentVariableWithMatrix

Parameters:	value (str) – value for IDD Field Table Data Format
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of table_data_format or None if not set
Return type:	str

x1_sort_order¶

field X1 Sort Order

Default value: Ascending

Parameters:	value (str) – value for IDD Field X1 Sort Order
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of x1_sort_order or None if not set
Return type:	str

x2_sort_order¶

field X2 Sort Order

Default value: Ascending

Parameters:	value (str) – value for IDD Field X2 Sort Order
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of x2_sort_order or None if not set
Return type:	str

class pyidf.performance_tables.TableOneIndependentVariable¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Table:OneIndependentVariable Allows entry of tabular data pairs as alternate input for performance curve objects. Performance curve objects can be created using these inputs. Linear Table Equation: Output = a + bX Linear solution requires a minimum of 2 data pairs Quadratic Table Equation: Output = a + b*X + c*X**2 Quadratic solution requires a minimum of 3 data pairs Cubic Table Equation: Output = a + b*X + c* X**2 + d*X**3 Cubic solution requires a minimum of 4 data pairs Quartic Table Equation: Output = a + b*X + c* X**2 + d*X**3 + e*X**4 Quartic solution requires a minimum of 5 data pairs Exponent Table Equation: Output = a + b*X**c Exponent solution requires a minimum of 4 data pairs

add_extensible(x_value_1=None, output_value_1=None)¶

Add values for extensible fields

Parameters:	x_value_1 (float) – value for IDD Field X Value #1 if value is None it will not be checked against the specification and is assumed to be a missing value output_value_1 (float) – value for IDD Field Output Value #1 if value is None it will not be checked against the specification and is assumed to be a missing value

curve_type¶

field Curve Type

Parameters:	value (str) – value for IDD Field Curve Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of curve_type or None if not set
Return type:	str

extensibles¶: Get list of all extensibles

input_unit_type_for_x¶

field Input Unit Type for X

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x or None if not set
Return type:	str

interpolation_method¶

field Interpolation Method

Parameters:	value (str) – value for IDD Field Interpolation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of interpolation_method or None if not set
Return type:	str

maximum_table_output¶

field Maximum Table Output

Specify the maximum value calculated by this table
lookup object
used only when Interpolation Type is Evaluate Curve
to Limits
Units are based on field A5

Parameters:	value (float) – value for IDD Field Maximum Table Output
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_table_output or None if not set
Return type:	float

maximum_value_of_x¶

field Maximum Value of X

used only when Interpolation Type is Evaluate Curve
to Limits
Units are based on field A4

Parameters:	value (float) – value for IDD Field Maximum Value of X
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x or None if not set
Return type:	float

minimum_table_output¶

field Minimum Table Output

Specify the minimum value calculated by this table
lookup object
used only when Interpolation Type is Evaluate Curve
to Limits
Units are based on field A5

Parameters:	value (float) – value for IDD Field Minimum Table Output
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_table_output or None if not set
Return type:	float

minimum_value_of_x¶

field Minimum Value of X

used only when Interpolation Type is Evaluate Curve
to Limits
Units are based on field A4

Parameters:	value (float) – value for IDD Field Minimum Value of X
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x or None if not set
Return type:	float

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

normalization_reference¶

field Normalization Reference

This field is used to normalize the following ouput data.
The minimum and maximum table output fields are also normalized.
If this field is blank or 1, the table data presented
in the following fields will be used with normalization
reference set to 1.

Parameters:	value (float) – value for IDD Field Normalization Reference
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalization_reference or None if not set
Return type:	float

output_unit_type¶

field Output Unit Type

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Output Unit Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of output_unit_type or None if not set
Return type:	str

class pyidf.performance_tables.TableTwoIndependentVariables¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Table:TwoIndependentVariables Allows entry of tabular data pairs as alternate input for performance curve objects. Performance curve objects can be created using these inputs. BiQuadratic Table Equation: Output = a + bX + cX**2 + dY + eY**2 + fXY BiQuadratic solution requires a minimum of 6 data pairs QuadraticLinear Table Equation: Output = a + bX + cX**2 + dY + eXY + fX**2Y QuadraticLinear solution requires a minimum of 6 data pairs

add_extensible(x_value_1=None, y_value_1=None, output_value_1=None)¶

Add values for extensible fields

Parameters:

x_value_1 (float) – value for IDD Field X Value #1 if value is None it will not be checked against the specification and is assumed to be a missing value
y_value_1 (float) – value for IDD Field Y Value #1 if value is None it will not be checked against the specification and is assumed to be a missing value
output_value_1 (float) – value for IDD Field Output Value #1 if value is None it will not be checked against the specification and is assumed to be a missing value

curve_type¶

field Curve Type

Parameters:	value (str) – value for IDD Field Curve Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of curve_type or None if not set
Return type:	str

extensibles¶: Get list of all extensibles

input_unit_type_for_x¶

field Input Unit Type for X

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for X
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_x or None if not set
Return type:	str

input_unit_type_for_y¶

field Input Unit Type for Y

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Input Unit Type for Y
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of input_unit_type_for_y or None if not set
Return type:	str

interpolation_method¶

field Interpolation Method

Default value: LagrangeInterpolationLinearExtrapolation

Parameters:	value (str) – value for IDD Field Interpolation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of interpolation_method or None if not set
Return type:	str

maximum_table_output¶

field Maximum Table Output

Specify the maximum value calculated by this table lookup object

Units are based on field A6

Parameters:	value (float) – value for IDD Field Maximum Table Output
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_table_output or None if not set
Return type:	float

maximum_value_of_x¶

field Maximum Value of X

Units are based on field A4

Parameters:	value (float) – value for IDD Field Maximum Value of X
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_x or None if not set
Return type:	float

maximum_value_of_y¶

field Maximum Value of Y

Units are based on field A5

Parameters:	value (float) – value for IDD Field Maximum Value of Y
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_value_of_y or None if not set
Return type:	float

minimum_table_output¶

field Minimum Table Output

Specify the minimum value calculated by this table lookup object

Units are based on field A6

Parameters:	value (float) – value for IDD Field Minimum Table Output
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_table_output or None if not set
Return type:	float

minimum_value_of_x¶

field Minimum Value of X

Units are based on field A4

Parameters:	value (float) – value for IDD Field Minimum Value of X
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_x or None if not set
Return type:	float

minimum_value_of_y¶

field Minimum Value of Y

Units are based on field A5

Parameters:	value (float) – value for IDD Field Minimum Value of Y
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_value_of_y or None if not set
Return type:	float

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

normalization_reference¶

field Normalization Reference

This field is used to normalize the following output data.
The minimum and maximum table output fields are also normalized.
If this field is blank or 1, the table data presented below will be used.

Parameters:	value (float) – value for IDD Field Normalization Reference
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalization_reference or None if not set
Return type:	float

output_unit_type¶

field Output Unit Type

Default value: Dimensionless

Parameters:	value (str) – value for IDD Field Output Unit Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of output_unit_type or None if not set
Return type:	str

pyidf.performance_tables module¶

Related Topics

This Page