class URBANopt::GeoJSON::Feature
Attributes
Public Class Methods
Used to validate the feature using the validate_feat
method.
# File lib/urbanopt/geojson/feature.rb, line 18 def initialize(feature) @feature_json = validate_feat(feature) end
Public Instance Methods
Used to calculate the aspect ratio for a given floor polygon.
# File lib/urbanopt/geojson/feature.rb, line 79 def calculate_aspect_ratio multi_polygons = get_multi_polygons(@feature_json) rad_per_deg = 0.017453293 multi_polygons.each do |multi_polygon| if multi_polygon.size > 1 runner.registerWarning('Ignoring holes in polygon') end multi_polygon.each do |polygon| n = polygon.size length = 0 north = 0 east = 0 south = 0 west = 0 aspect_ratio = 0 for i in (0..n - 2) do i vertex_1 = nil vertex_2 = nil if i == n - 2 vertex_1 = polygon[n - 2] vertex_2 = polygon[0] else vertex_1 = polygon[i] vertex_2 = polygon[i + 1] end x_1 = vertex_1[0] y_1 = vertex_1[1] x_2 = vertex_2[0] y_2 = vertex_2[1] dist = (x_2 - x_1)**2 + (y_2 - y_1)**2 length = Math.sqrt(dist) # delta latitude dlat = x_2 - x_1 # delta longitude dlon = y_2 - y_1 # convert radian to degree sin_angle = Math.asin(dlon / length) * (1 / rad_per_deg) sin_angle = sin_angle.round(4) cos_angle = Math.acos(dlat / length) * (1 / rad_per_deg) cos_angle = cos_angle.round(4) if cos_angle >= 45 && cos_angle <= 135 && sin_angle >= 45 && sin_angle <= 90 north += length elsif cos_angle >= 0 && cos_angle < 45 && sin_angle > -45 && sin_angle < 45 east += length elsif cos_angle >= 45 && cos_angle <= 135 && sin_angle >= -90 && sin_angle <= -45 south += length elsif cos_angle > 135 && cos_angle <= 180 && sin_angle > -45 && sin_angle < 45 west += length end if east + west != 0 aspect_ratio = (north + south) / (east + west) else aspect_ratio = 1 end end aspect_ratio = aspect_ratio.round(4) return aspect_ratio end end end
Returns instance of OpenStudio::PointLatLon for latitude and longitude of feature.
- Parameters
-
runner
- An instance ofOpenstudio::Measure::OSRunner
for the measure run.
# File lib/urbanopt/geojson/feature.rb, line 213 def create_origin_lat_lon(runner) min_lon_lat = get_min_lon_lat min_lon = min_lon_lat[0] min_lat = min_lon_lat[1] if min_lon == Float::MAX || min_lat == Float::MAX runner.registerError('Could not determine min_lat and min_lon') return false else runner.registerInfo("Min_lat = #{min_lat}, min_lon = #{min_lon}") end return OpenStudio::PointLatLon.new(min_lat, min_lon, 0) end
Raises an error if the feature_type
is not specified the the Feature's class.
# File lib/urbanopt/geojson/feature.rb, line 50 def feature_type raise 'feature_type not implemented for Feature, override in your class' end
Used to determine the centroid for the feature's geojson coordinates.
- Parameters
-
vertices
- The first set polygon vertices in the array of feature coordinates.
- Returns
-
Returns
Feature
centroid coordinates [long, lat]
# File lib/urbanopt/geojson/feature.rb, line 235 def find_feature_center(vertices) number_of_locations = vertices.length return vertices.first if number_of_locations == 1 x = y = z = 0.0 vertices.each do |station| latitude = station[1] * Math::PI / 180 longitude = station[0] * Math::PI / 180 x += Math.cos(latitude) * Math.cos(longitude) y += Math.cos(latitude) * Math.sin(longitude) z += Math.sin(latitude) end x /= number_of_locations y /= number_of_locations z /= number_of_locations central_longitude = Math.atan2(y, x) central_square_root = Math.sqrt(x * x + y * y) central_latitude = Math.atan2(z, central_square_root) [central_longitude * 180 / Math::PI, central_latitude * 180 / Math::PI] end
Returns coordinate with the minimum longitute and latitude within a given building_json
.
# File lib/urbanopt/geojson/feature.rb, line 161 def get_min_lon_lat min_lon = Float::MAX min_lat = Float::MAX multi_polygons = get_multi_polygons multi_polygons.each do |multi_polygon| multi_polygon.each do |polygon| polygon.each do |point| min_lon = point[0] if point[0] < min_lon min_lat = point[1] if point[1] < min_lat end break end end return [min_lon, min_lat] end
Returns MultiPolygon coordinates (coordinate pairs in double nested Array)
- Parameters
-
json
For example:
polygon = { 'geometry': { 'type': 'Polygon', 'coordinates': [ [ [0, 5], [5, 5], [5, 0] ] ] } }
# File lib/urbanopt/geojson/feature.rb, line 196 def get_multi_polygons(json = @feature_json) geometry_type = json[:geometry][:type] multi_polygons = [] if geometry_type == 'Polygon' polygons = json[:geometry][:coordinates] multi_polygons = [polygons] elsif geometry_type == 'MultiPolygon' multi_polygons = json[:geometry][:coordinates] end return multi_polygons end
Used to calculate the perimeter multiplier given the aspect ratio, original perimeter and area.
# File lib/urbanopt/geojson/feature.rb, line 153 def get_perimeter_multiplier(area, aspect_ratio, perimeter_original) perimeter_new = 2 * (Math.sqrt(area * aspect_ratio) + Math.sqrt(area / aspect_ratio)) perimeter_ratio = perimeter_original / perimeter_new return perimeter_ratio end
Returns the id of the feature.
# File lib/urbanopt/geojson/feature.rb, line 36 def id return @feature_json[:properties][:id] end
rubocop:disable Style/MethodMissing
# File lib/urbanopt/geojson/feature.rb, line 23 def method_missing(name, *args, &blk) # rubocop:enable Style/MethodMissing if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym return @feature_json[:properties][name.to_sym] else super end end
Returns the name of the feature.
# File lib/urbanopt/geojson/feature.rb, line 43 def name return @feature_json[:properties][:name] end
# File lib/urbanopt/geojson/feature.rb, line 61 def schema if @@feature_schema[feature_type].nil? @@schema_file_lock.synchronize do File.open(schema_file, 'r') do |file| @@feature_schema[feature_type] = JSON.parse(file.read, symbolize_names: true) # Allows additional properties. @@feature_schema[feature_type][:additionalProperties] = true end end end return @@feature_schema[feature_type] end
Raises an error if the schema_file
is not specified the the Feature's class.
# File lib/urbanopt/geojson/feature.rb, line 57 def schema_file raise 'schema_file not implemented for Feature, override in your class' end
Private Instance Methods
Used to validate the feature by checking feature_id
, geometry
, properties
and geometry_type
. rubocop:disable Style/CommentedKeyword
# File lib/urbanopt/geojson/feature.rb, line 269 def validate_feat(feature) #:doc: # rubocop:enable Style/CommentedKeyword if feature.nil? || feature.empty? raise("Feature '#{feature_id}' could not be found") return false end if feature[:geometry].nil? raise("No geometry found in '#{feature[:properties][:name]}'") return false end if feature[:properties].nil? raise("No properties found in '#{feature[:properties][:name]}'") return false end unless feature[:properties][:detailed_model_filename] || feature[:properties][:hpxml_directory] errors = JSON::Validator.fully_validate(schema, feature[:properties]) if !errors.empty? raise("Invalid properties for '#{feature[:properties][:name]}'\n #{errors.join('\n ')}") return false end end geometry_type = feature[:geometry][:type] if geometry_type == 'Polygon' elsif geometry_type == 'MultiPolygon' else raise("Unknown geometry type '#{geometry_type}'") return false end return feature end