ifcopenshell.util.unit

Module Contents

ifcopenshell.util.unit.calculate_unit_scale(ifc_file: ifcopenshell.file, unit_type: str = 'LENGTHUNIT') → float

Returns a unit scale factor to convert to and from IFC project units and SI units.

Example:

ifc_project_length * unit_scale = si_meters
si_meters / unit_scale = ifc_project_length
Parameters:

  • ifc_file (ifcopenshell.file) – The IFC file.

  • unit_type (str) – The type of SI unit, defaults to “LENGTHUNIT”

Returns:

The scale factor

Return type:

float

ifcopenshell.util.unit.convert(value: float, from_prefix: str | None, from_unit: str, to_prefix: str | None, to_unit: str) → float

Converts between length, area, and volume units

In this case, you manually specify the names and (optionally) prefixes to convert to and from. In case you want to automatically convert to units already available as IFC entities, consider using convert_unit() instead.

Parameters:

  • value (float) – The numeric value you want to convert

  • from_prefix (str, optional) – A prefix from IfcSIPrefix. Can be None

  • from_unit (str) – IfcSIUnitName or IfcConversionBasedUnit.Name

  • to_prefix (str, optional) – A prefix from IfcSIPrefix. Can be None

  • to_unit (str) – IfcSIUnitName or IfcConversionBasedUnit.Name

Returns:

The converted value.

Return type:

float

ifcopenshell.util.unit.convert_file_length_units(ifc_file: ifcopenshell.file, target_units: str = 'METER') → ifcopenshell.file

Converts all units in an IFC file to the specified target units. Returns a new file.

ifcopenshell.util.unit.convert_unit(value: float, from_unit: ifcopenshell.entity_instance, to_unit: ifcopenshell.entity_instance) → float

Convert from one unit to another unit

Parameters:
Returns:

The converted value.

Return type:

float

ifcopenshell.util.unit.format_length(value: float, precision: float, decimal_places: int = 2, suppress_zero_inches=True, unit_system: Literal[metric, imperial] = 'imperial', input_unit: Literal[foot, inch] = 'foot', output_unit: Literal[foot, inch] = 'foot') → str

Formats a length for readability and imperial formatting

Parameters:

  • value (float) – The value in meters if metric, or either decimal feet or inches if imperial depending on input_unit.

  • precision (float) – How precise the format should be. I.e. round to nearest. For imperial, it is 1/Nth. E.g. 12 means to the nearest 1/12th of an inch.

  • decimal_places (int) – How many decimal places to display. Defaults to 2.

  • suppress_zero_inches (bool) – If imperial, whether or not to supress the inches if the inches is zero.

  • unit_system (str) – Choose whether your value is “metric” or “imperial”

  • input_unit (str) – If imperial, specify whether your value is “foot” or “inch”.

  • output_unit – If imperial, specify whether your value is “foot” to format as both feet and inches, or “inch” if only inches should be shown.

ifcopenshell.util.unit.get_full_unit_name(unit: ifcopenshell.entity_instance) → str
ifcopenshell.util.unit.get_measure_unit_type(measure_class: str) → str
ifcopenshell.util.unit.get_named_dimensions(name)
ifcopenshell.util.unit.get_prefix(text)
ifcopenshell.util.unit.get_prefix_multiplier(text)
ifcopenshell.util.unit.get_project_unit(ifc_file: ifcopenshell.file, unit_type: str) → ifcopenshell.entity_instance | None

Get the default project unit of a particular unit type

Parameters:

  • ifc_file (ifcopenshell.file) – The IFC file.

  • unit_type (str) – The type of unit, taken from the list of IFC unit types, such as “LENGTHUNIT”.

Returns:

The IFC unit entity, or nothing if there is no default project unit defined.

Return type:

Union[ifcopenshell.entity_instance, None]

ifcopenshell.util.unit.get_property_unit(prop: ifcopenshell.entity_instance, ifc_file: ifcopenshell.file) → ifcopenshell.entity_instance | None
ifcopenshell.util.unit.get_si_dimensions(name)
ifcopenshell.util.unit.get_symbol_measure_class(symbol: str | None = None) → str
ifcopenshell.util.unit.get_symbol_quantity_class(symbol: str | None = None) → str
ifcopenshell.util.unit.get_unit_assignment(ifc_file: ifcopenshell.file) → ifcopenshell.entity_instance | None
ifcopenshell.util.unit.get_unit_measure_class(unit_type: str) → str
ifcopenshell.util.unit.get_unit_name(text: str) → str | None

Get unit name from str, if unit is in SI.

ifcopenshell.util.unit.get_unit_name_universal(text: str) → str | None

Get unit name from str, supports both SI and imperial system.

Can be used to provide units for convert()

ifcopenshell.util.unit.get_unit_symbol(unit: ifcopenshell.entity_instance) → str
ifcopenshell.util.unit.is_attr_type(content_type: ifcopenshell.ifcopenshell_wrapper.parameter_type, ifc_unit_type_name: str) → ifcopenshell.ifcopenshell_wrapper.type_declaration | None
ifcopenshell.util.unit.iter_element_and_attributes_per_type(ifc_file: ifcopenshell.file, attr_type_name: str) → Iterable[tuple[ifcopenshell.entity_instance, ifcopenshell.ifcopenshell_wrapper.attribute, Any]]
ifcopenshell.util.unit.imperial_types
ifcopenshell.util.unit.named_dimensions
ifcopenshell.util.unit.prefix_symbols
ifcopenshell.util.unit.prefixes
ifcopenshell.util.unit.si_conversions
ifcopenshell.util.unit.si_dimensions
ifcopenshell.util.unit.si_offsets
ifcopenshell.util.unit.si_type_names
ifcopenshell.util.unit.unit_names = ['AMPERE', 'BECQUEREL', 'CANDELA', 'COULOMB', 'CUBIC_METRE', 'DEGREE_CELSIUS', 'FARAD', 'GRAM',...
ifcopenshell.util.unit.unit_symbols