HB-Energy Primer
Ladybug Tools for Grasshopper Documentation
  • HB-Energy Primer
  • Components
    • 0 :: Basic Properties
      • Building Vintages
      • Climate Zones
      • Face Energy Attributes
      • Room Energy Attributes
      • Blend ProgramTypes
      • Building Programs
      • ProgramType
      • Search Programs
      • ConstructionSet
      • Construction Set by Climate
      • Construction Types
      • Search Construction Sets
      • Exterior Construction Subset
      • Ground Construction Subset
      • Interior Construction Subset
      • Subface Subset
      • Adiabatic by Type
      • Plenum
      • Ground
      • Internal Mass
      • Other Side Temperature
      • Patch Missing Adjacency
    • 1 :: Constructions
      • Search Constructions
      • Search Materials
      • Deconstruct Construction
      • Deconstruct ConstructionSet
      • Deconstruct ConstructionSet Interior
      • Deconstruct Material
      • Apply ConstructionSet
      • Apply Opaque Construction
      • Apply Shade Construction
      • Apply Window Construction
      • Opaque Construction
      • Shade Construction
      • Window Construction
      • Window Construction Shade
      • Opaque Material
      • Opaque Material No Mass
      • Glass Material
      • Shade Material
      • Window Frame
      • Window Material
      • Blind Material
      • Custom Window Gap Material
      • Vegetation Material
      • Window Construction Dynamic
      • Window Gap Material
    • 2 :: Schedules
      • Gene Pool to Day Schedule
      • Search Schedules
      • Deconstruct Schedule
      • Schedule to Data
      • Apply Room Schedules
      • Apply Shade Schedule
      • Constant Schedule
      • Fixed Interval Schedule
      • Seasonal Schedule
      • Weekly Schedule
      • Type Limit
    • 3 :: Loads
      • Apply ProgramType
      • Deconstruct ProgramType
      • Apply Absolute Load Values
      • Apply Daylight Control
      • Apply Load Values
      • Apply Setpoint Values
      • Equipment
      • Infiltration
      • Lighting
      • People
      • Process Load
      • Service Hot Water
      • Setpoint
      • Ventilation
      • Airflow Newtwork
      • Fan Ventilation
      • Ventilation Control
      • Window Opening
      • Blower Pressure Converter
      • Deconstruct Equipment
      • Deconstruct Hot Water
      • Deconstruct Infiltration
      • Deconstruct Lighting
      • Deconstruct People
      • Deconstruct Setpoint
      • Deconstruct Ventilation
    • 4 :: HVAC
      • IdealAir
      • Set Conditioned
      • All-Air HVAC
      • All-Air HVAC Templates
      • DOAS HVAC
      • DOAS HVAC Templates
      • HeatCool HVAC
      • HeatCool HVAC Templates
      • SHW System
      • SHW Templates
      • Electric Load Center
      • Photovoltaic Properties
      • Detailed HVAC
      • Radiant HVAC Properties
    • 5 :: Simulate
      • Model to OSM
      • Annual Loads
      • Generation Loads
      • Load Shade Benefit
      • Peak Loads
      • Custom Simulation Output
      • Shadow Calculation
      • Simulation Control
      • Simulation Output
      • Simulation Parameter
      • Sizing Parameter
      • Load Measure
      • Run OSW
      • Run IDF
      • Run OSM
      • Create OSM Measure
    • 6 :: Result
      • End Use Intensity
      • Read Custom Result
      • Read Face Result
      • Read HVAC Sizing
      • Read Room Comfort Result
      • Read Room Energy Result
      • Color Faces
      • Color Rooms
      • Read Tabular Data
      • Thermal Load Balance
      • Balance Temperature
      • Carbon Emission Intensity
      • Face Result by Type
      • Normalize by Floor Area
      • Read Generation Result
      • Read Result Dictionary
      • Read Zone Sizing
    • 7 :: Thermal Map
      • Adaptive Comfort Map
      • PMV Comfort Map
      • UTCI Comfort Map
      • Read Thermal Matrix
      • Visualize Thermal Map
      • Read Environment Matrix
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 6 :: Result

Color Rooms

PreviousColor FacesNextRead Tabular Data

Last updated 2 years ago

-

Visualize Room-level energy simulation results as colored Room geometry.

Inputs

  • data [Required]

A list of data collections of the same data type, which will be used to color Rooms. Data collections can be of any class (eg. MonthlyCollection, DailyCollection) but they should originate from an energy simulation sql (with header metadata that has 'Zone' or, in some cases, 'System' keys). These keys will be used to match the data in the collections to the input rooms.

  • rooms_model [Required]

An array of honeybee Rooms or honeybee Models, which will be matched to the data_collections. The length of these Rooms does not have to match the data_collections and this object will only create visualizations for rooms that are found to be matching.

  • norm_by_flr

Boolean to note whether results should be normalized by the floor area of the Room if the data type of the data_colections supports it. If False, values will be generated using sum total of the data collection values. Note that this input has no effect if the data type of the data_collections is not cumulative since data collection values will always be averaged for this case. Default: True.

  • sim_step

An optional integer (greater than or equal to 0) to select a specific step of the data collections for which result values will be generated. If None, the geometry will be colored with the total of resutls in the data_collections if the data type is cumulative or with the average of results if the data type is not cumulative. Default: None.

  • period

A Ladybug analysis period to be applied to all of the input _data.

  • legend_par

An optional LegendParameter object to change the display of the ColorRooms.

Outputs

  • report

...

  • mesh

A colored mesh of the Room floor geometry colored using the input _data. Multiple meshes will be output for several data collections are input.

  • wire_frame

A list of polylines representing the outline of the room volumes.

  • legend

Geometry representing the legend for the colored rooms.

  • title

A text object for the global title.

  • rooms

A list of honeybee Room objects that have been successfully matched to the input _data. This can be plugged into the "HB Visualize Quick" component to get full room volumes that are colored.

  • colors

A list of color objects that align with the output rooms. These can be connected to a native Grasshopper "Custom Preview" component in order to color room volumes with results.

  • values

A list of numbers for each of the rooms, which are used to generate the colors.

  • vis_set

An object containing VisualizationSet arguments for drawing a detailed version of the ColorRoom in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the visualization in Rhino.

[source code]